From pepper@reppep.com  Sat Nov 30 21:28:20 2002
Return-Path: <pepper@reppep.com>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id E2B6637B401
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 30 Nov 2002 21:28:20 -0800 (PST)
Received: from www.reppep.com (www.reppep.com [66.92.104.200])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 691BA43EA9
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 30 Nov 2002 21:28:20 -0800 (PST)
	(envelope-from pepper@reppep.com)
Received: by www.reppep.com (Postfix, from userid 501)
	id F18DCFFEA; Sun,  1 Dec 2002 00:28:20 -0500 (EST)
Message-Id: <20021201052820.F18DCFFEA@www.reppep.com>
Date: Sun,  1 Dec 2002 00:28:20 -0500 (EST)
From: Chris Pepper <pepper@rockefeller.edu>
Reply-To: Chris Pepper <pepper@rockefeller.edu>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: Language improvements to device.hints.5
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         45893
>Category:       docs
>Synopsis:       Language improvements to device.hints.5
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    trhodes
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Nov 30 21:30:01 PST 2002
>Closed-Date:    Thu Dec 19 10:28:41 PST 2002
>Last-Modified:  Thu Dec 19 10:28:41 PST 2002
>Originator:     Chris Pepper
>Release:        FreeBSD 4.7-STABLE i386
>Organization:
>Environment:
System: FreeBSD www.reppep.com 4.7-STABLE FreeBSD 4.7-STABLE #1: Tue Nov 26 17:46:15 EST 2002 root@www.reppep.com:/usr/obj/usr/src/sys/GENERIC i386


	
>Description:
	device.hints.5 contains infelicities. "by" is used in several places where "with" would be better, and there are a few others.
	
>How-To-Repeat:
	Visit <http://www.freebsd.org/cgi/man.cgi?query=device.hints&sektion=5&manpath=FreeBSD+5.0-current> and <http://www.freebsd.org/cgi/cvsweb.cgi/src/share/man/man5/device.hints.5?rev=1.7&content-type=text/x-cvsweb-markup&only_with_tag=HEAD>.
	
>Fix:
	Apply this patch.

--- device.hints.5.patch begins here ---
--- device.hints.5	Sun Dec  1 00:23:28 2002
+++ device.hints.5.fixed	Sun Dec  1 00:23:19 2002
@@ -36,7 +36,7 @@
 .Nm
 file is read in by the boot
 .Xr loader 8
-when the system is about to start and its contents will be
+when the system is about to start, and its contents are
 passed to the kernel.
 It contains various variables to control the boot behavior of
 the kernel.
@@ -51,19 +51,19 @@
 character are comments and are ignored by the boot loader.
 .Pp
 After the file is read by the boot loader, you may examine
-the variables by the
+the variables with the
 .Ic show
-command, and may add a new variable, modify existing one,
-or delete one by the
+command, and may add a new variable, modify an existing one,
+or delete a variable with the
 .Ic set
 and
 .Ic unset
-commands of the boot loader
+commands in the boot loader
 (see
 .Xr loader 8 ) .
 .Pp
 After the system has started, you can dump these variables
-by the
+with the
 .Xr kenv 1
 command.
 .Sh DEVICE HINTS
@@ -83,7 +83,7 @@
 .Ar driver
 is the name of a device driver,
 .Ar unit
-is the unit number,
+is the unit number, and
 .Ar keyword
 is the keyword of the hint.
 The keyword may be:
@@ -98,11 +98,11 @@
 .It Li drq
 is the DMA channel number.
 .It Li maddr
-specifies the physical memory address occupied by the device.
+specifies the physical memory address used by the device.
 .It Li flags
 sets various flag bits for the device.
 .It Li disabled
-is set to
+can set to
 .Qq 1
 to disable the device.
 .El
--- device.hints.5.patch ends here ---


>Release-Note:
>Audit-Trail:

From: swear@attbi.com (Gary W. Swearingen)
To: Chris Pepper <pepper@rockefeller.edu>
Cc: FreeBSD-gnats-submit@FreeBSD.org
Subject: Re: docs/45893: Language improvements to device.hints.5
Date: 02 Dec 2002 11:23:50 -0800

 Chris Pepper <pepper@rockefeller.edu> writes:
 
 > -commands of the boot loader
 > +commands in the boot loader
 
 Unnecessary change.  The old version is arguably better.
 
 >  sets various flag bits for the device.
 >  .It Li disabled
 > -is set to
 > +can set to
 
 Shouldn't that be "+can be set to"?
Responsible-Changed-From-To: freebsd-doc->trhodes 
Responsible-Changed-By: trhodes 
Responsible-Changed-When: Fri Dec 6 10:55:26 PST 2002 
Responsible-Changed-Why:  
I've been working on device.hints(5) for awhile now.  Therefor, over to me. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=45893 
State-Changed-From-To: open->closed 
State-Changed-By: trhodes 
State-Changed-When: Thu Dec 19 10:26:48 PST 2002 
State-Changed-Why:  
Taking Gary's comments into account, I've applied all portions of the patch 
and then manually modified the page to add back the original line of: 

commannds of the boot loader 
&& 
can be set to. 

Thanks for the submission! 

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