From marc@blackend.org  Sat Jun  8 06:15:10 2002
Return-Path: <marc@blackend.org>
Received: from abigail.blackend.org (blackend.org [212.11.50.35])
	by hub.freebsd.org (Postfix) with ESMTP id 5E6F037B40B
	for <FreeBSD-gnats-submit@freebsd.org>; Sat,  8 Jun 2002 06:15:08 -0700 (PDT)
Received: from abigail.blackend.org (localhost [127.0.0.1])
	by abigail.blackend.org (8.12.3/8.12.3/ - 15/04/02) with ESMTP id g58DAMfA025723
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 8 Jun 2002 15:10:22 +0200 (CEST)
	(envelope-from marc@abigail.blackend.org)
Received: (from marc@localhost)
	by abigail.blackend.org (8.12.3/8.12.3/Submit) id g58DAMG9025722;
	Sat, 8 Jun 2002 15:10:22 +0200 (CEST)
	(envelope-from marc)
Message-Id: <200206081310.g58DAMG9025722@abigail.blackend.org>
Date: Sat, 8 Jun 2002 15:10:22 +0200 (CEST)
From: Marc Fonvieille <marc@blackend.org>
Reply-To: Marc Fonvieille <marc@blackend.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: Minor changes in section 3.9 of the Handbook
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         39025
>Category:       docs
>Synopsis:       Minor changes in section 3.9 of the Handbook
>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:   Sat Jun 08 06:20:01 PDT 2002
>Closed-Date:    Wed Jul 03 15:54:47 PDT 2002
>Last-Modified:  Wed Jul 03 15:54:47 PDT 2002
>Originator:     Marc Fonvieille
>Release:        FreeBSD 4.6-PRERELEASE i386
>Organization:
>Environment:
System: FreeBSD abigail.blackend.org 4.6-PRERELEASE FreeBSD 4.6-PRERELEASE #5: Sun May 12 00:30:43 CEST 2002 marc@abigail.blackend.org:/usr/src/sys/compile/ABIGAIL i386


	
>Description:
Minor changes in section 3.9 of the Handbook:

- a typo: "a device driver often-times needs to be created." should be 
"a device node often-times needs to be created."

- addition of literal tags for devfs.

Read the patch below for more details.
	
>How-To-Repeat:
	
>Fix:
Apply the patch to handbook/basics/chapter.sgml
	

--- chapter.sgml.diff begins here ---
--- chapter.sgml.org	Sat Jun  8 14:42:30 2002
+++ chapter.sgml	Sat Jun  8 15:03:28 2002
@@ -1308,12 +1308,12 @@
     <sect2>
       <title>Creating Device Nodes</title>
       <para>When adding a new device to your system, or compiling
-	in support for additional devices, a device driver
+	in support for additional devices, a device node
 	often-times needs to be created.</para>
 
       <sect3>
 	<title>MAKEDEV Script</title>
-	<para>On systems without DEVFS, device nodes are created
+	<para>On systems without <literal>devfs</literal>, device nodes are created
 	  using the &man.MAKEDEV.8; script as shown below:</para>
 
 	<screen>&prompt.root; cd /dev
@@ -1327,15 +1327,15 @@
       <sect3>
 	<title>devfs (Device File System)</title>
 
-	<para> The device filesystem, or devfs, provides access to
+	<para> The device filesystem, or <literal>devfs</literal>, provides access to
 	  kernel's device namespace in the global filesystem namespace.
 	  Instead of having to create and modify device nodes,
-	  devfs maintains this particular filesystem for you.</para>
+	  <literal>devfs</literal> maintains this particular filesystem for you.</para>
 
 	<para>See the &man.devfs.5; man page for more
 	  information.</para>
 
-	<para>devfs is used by default in FreeBSD 5.0.</para>
+	<para><literal>devfs</literal> is used by default in FreeBSD 5.0.</para>
       </sect3>
     </sect2>
   </sect1>
--- chapter.sgml.diff ends here ---


>Release-Note:
>Audit-Trail:

From: <keramida@FreeBSD.org>
To: marc@blackend.org
Cc: bug-followup@freebsd.org
Subject: Re: docs/39025: Minor changes in section 3.9 of the Handbook
Date: Tue, 11 Jun 2002 17:30:15 -0700 (PDT)

 : --- chapter.sgml.org	Sat Jun  8 14:42:30 2002
 : +++ chapter.sgml	Sat Jun  8 15:03:28 2002
 : @@ -1308,12 +1308,12 @@
 :      <sect2>
 :        <title>Creating Device Nodes</title>
 :        <para>When adding a new device to your system, or compiling
 : -	in support for additional devices, a device driver
 : +	in support for additional devices, a device node
 :  	often-times needs to be created.</para>
 
 I am not sure I understand "often-times" here.  This part will
 probably look better after a minor rewrite.  Perhaps something like
 the following?
 
 	<para>When adding a new device to your system, or compiling in
 	  support for additional devices, you might need to create a
 	  one or more devices node for the new devices.</para>
 
 What do you think?
 
 : -	<para>On systems without DEVFS, device nodes are created
 : +	<para>On systems without <literal>devfs</literal>, device nodes are created
 
 The option in the kernel config file is DEVFS (capitalized).
 I think this should probably stay DEVFS or even <literal>DEVFS</literal>.
 
 Ditto for the next parts that change DEVFS-related things.
 
 - Giorgos

From: Marc Fonvieille <marc@blackend.org>
To: keramida@FreeBSD.org
Cc: bug-followup@FreeBSD.org
Subject: Re: docs/39025: Minor changes in section 3.9 of the Handbook
Date: Wed, 12 Jun 2002 12:19:15 +0200

 On Tue, Jun 11, 2002 at 05:30:15PM -0700, keramida@FreeBSD.org wrote:
 > 	<para>When adding a new device to your system, or compiling in
 > 	  support for additional devices, you might need to create a
 > 	  one or more devices node for the new devices.</para>
 > 
 > What do you think?
 
 Indeed better.
 
 > 
 > : -	<para>On systems without DEVFS, device nodes are created
 > : +	<para>On systems without <literal>devfs</literal>, device nodes are created
 > 
 > The option in the kernel config file is DEVFS (capitalized).
 > I think this should probably stay DEVFS or even <literal>DEVFS</literal>.
 > 
 > Ditto for the next parts that change DEVFS-related things.
 > 
 
 Yes, the next part is quite confusing with lower/uppercase, the title of
 the part should be:
 
 <title><literal>DEVFS</literal> (DEVice File System)</title>
 
 or something like that, same for DEVFS-related things. The fact it's
 default in 5-X was a problem at my eyes cause at this moment it's not a
 kernel option anymore, i wondered if i had to "capitalize" or not the
 word.
 
 Marc
State-Changed-From-To: open->closed 
State-Changed-By: jim 
State-Changed-When: Wed Jul 3 15:54:27 PDT 2002 
State-Changed-Why:  
Committed with the suggestions in the audit-trail. 

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