Bug 35949

Summary: [PATCH] rtprio(1) man page uses incorrect english
Product: Documentation Reporter: Hiten Pandya <hiten>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Hiten Pandya 2002-03-16 03:40:01 UTC 
	The rtprio(1) uses incorrect english in the BUGS section.  The
	provided patch will fix that, and also _boldface_ the "root"
	user in the man page (mdoc(1) change).  Also, instead of:

		"system calls are currently never preempted"
	
	It will substitute it with:

		"system calls are currently not preempted"
	
	Thanks,
	
	  -- Hiten Pandya
	  -- <hiten@uk.FreeBSD.org>

Fix: The following patch should be applied to src/usr.sbin/rtprio/rtprio.1
	
How-To-Repeat: 	visit the rtprio(1) manual page.
Comment 1 Giorgos Keramidas freebsd_committer freebsd_triage 2002-03-19 10:21:49 UTC 
Adding to audit trail:

| Date: Sat, 16 Mar 2002 10:33:16 +0000 (GMT)
| From: Andrew McKay <andy@openirc.co.uk>
| Subject: Re: docs/35949: [PATCH] rtprio(1) man page uses incorrect english
|
| On Sat, 16 Mar 2002, Hiten Pandya wrote:
|
| > 	The rtprio(1) uses incorrect english in the BUGS section.
|
| Not true.
|
| > -There is in
| > -.Fx
| > -no way to ensure that a process page is present in memory therefore
| > +There is no way in
| > +.Fx ,
| > +to ensure that a process page is present in memory therefore
|
| This replaces correct grammar with correct grammar.  It also shifts the
| emphasis away from 'in FreeBSD' which, I assume, is where it is meant to
| lie otherwise the inclusion of 'in FreeBSD' is unnecessary.  If this
| absolutely needs to be changed, which, imho, it does not, then 'In FreeBSD
| there is no way...' would be the more correct way to change it.
|
| > -system calls are currently never preempted, therefore non-realtime
| > +system calls are currently not preempted, therefore non-realtime
|
| Why? If they are not preempted then they must never be preempted.  I would
| argue that 'never' is more correct and less ambiguous unless the statement
| is untrue in which case the statement is also untrue as changed.  This
| seems to be a gratuitous change although the addition of a comma after
| FreeBSD is most welcome.  Personally I'd remove 'Under', which
| would alleviate the need for a comma altogether and make the sentence
| cleaner and terser.
Comment 2 hiten pandya 2002-03-19 10:47:59 UTC 
--- Giorgos Keramidas <keramida@freebsd.org> wrote:
> | Not true.

[ ... message snipped ... ]

Hmm, OK.  If you guys think the patch is not worth it to go into the
rtprio(1) man page, and the previous english is/was correct, then you
can close the PR with success.  Otherwise I can submit another patch
which has the type of clarity wanted (the comma stuff). 8-)

Thanks,
Regards,

  -- Hiten Pandya
  -- <hiten@uk.FreeBSD.org>


__________________________________________________
Do You Yahoo!?
Yahoo! Sports - live college hoops coverage
http://sports.yahoo.com/
Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2002-04-17 01:14:03 UTC 
State Changed
From-To: open->closed

Originator agrees in the closing of this PR as the patch is not required.