From hitenp@hpdi.ath.cx  Fri Mar 15 19:30:31 2002
Return-Path: <hitenp@hpdi.ath.cx>
Received: from hpdi.ath.cx (pc2-nthf5-0-cust237.not.cable.ntl.com [80.4.35.237])
	by hub.freebsd.org (Postfix) with ESMTP id 4754B37B402
	for <FreeBSD-gnats-submit@freebsd.org>; Fri, 15 Mar 2002 19:30:29 -0800 (PST)
Received: (from hitenp@hpdi.ath.cx)
	by hpdi.ath.cx (8.11.6/8.11.6) id g2G3RTO81130;
	Sat, 16 Mar 2002 03:27:29 GMT
	(envelope-from hitenp@hpdi.ath.cx)
Message-Id: <200203160327.g2G3RTO81130@hpdi.ath.cx>
Date: Sat, 16 Mar 2002 03:27:29 GMT
From: Hiten Pandya <hiten@uk.FreeBSD.org>
Reply-To: Hiten Pandya <hiten@uk.FreeBSD.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [PATCH] rtprio(1) man page uses incorrect english
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         35949
>Category:       docs
>Synopsis:       [PATCH] rtprio(1) man page uses incorrect english
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Mar 15 19:40:01 PST 2002
>Closed-Date:    Tue Apr 16 17:15:10 PDT 2002
>Last-Modified:  Tue Apr 16 17:15:10 PDT 2002
>Originator:     Hiten Pandya
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD hpdi.ath.cx 5.0-CURRENT FreeBSD 5.0-CURRENT #3: Wed Mar 13 23:44:48 GMT 2002 hitenp@hpdi.ath.cx:/c1/obj/data/dev/src/sys/CURRENT5 i386

>Description:

	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>
	  
>How-To-Repeat:
	visit the rtprio(1) manual page.	
>Fix:

	The following patch should be applied to src/usr.sbin/rtprio/rtprio.1
	
--- rtprio.1.old	Sat Mar 16 02:22:41 2002
+++ rtprio.1	Sat Mar 16 03:03:58 2002
@@ -108,7 +108,9 @@
 .Ar Pid
 of 0 means "the current process".
 .Pp
-Only root is allowed to set realtime or idle priority for a process.
+Only 
+.Sy root 
+is allowed to set realtime or idle priority for a process.
 .Sh DIAGNOSTICS
 If
 .Nm
@@ -184,16 +186,16 @@
 (swapper) (see
 .Xr ps 1 ) .
 .Pp
-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
 the process may be stopped for pagein (see
 .Xr mprotect 2 ,
 .Xr madvise 2 ) .
 .Pp
 Under
-.Fx
-system calls are currently never preempted, therefore non-realtime
+.Fx ,
+system calls are currently not preempted, therefore non-realtime
 processes can starve realtime processes, or idletime processes can
 starve normal priority processes.
 .Sh AUTHORS
>Release-Note:
>Audit-Trail:

From: Giorgos Keramidas <keramida@freebsd.org>
To: Hiten Pandya <hiten@uk.FreeBSD.org>
Cc: bug-followup@freebsd.org
Subject: Re: docs/35949: [PATCH] rtprio(1) man page uses incorrect english
Date: Tue, 19 Mar 2002 12:21:49 +0200 (EET)

 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.
 

From: Hiten Pandya <hitmaster2k@yahoo.com>
To: Giorgos Keramidas <keramida@freebsd.org>
Cc: bug-followup@freebsd.org
Subject: Re: docs/35949: [PATCH] rtprio(1) man page uses incorrect english
Date: Tue, 19 Mar 2002 02:47:59 -0800 (PST)

 --- 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/
State-Changed-From-To: open->closed 
State-Changed-By: trhodes 
State-Changed-When: Tue Apr 16 17:14:03 PDT 2002 
State-Changed-Why:  
Originator agrees in the closing of this PR as the patch is not required. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=35949 
>Unformatted:
