Bug 39025

Summary: Minor changes in section 3.9 of the Handbook
Product: Documentation Reporter: Marc Fonvieille <marc>
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
chapter.sgml.diff none

Description Marc Fonvieille 2002-06-08 14:20:01 UTC 
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.

Fix: Apply the patch to handbook/basics/chapter.sgml
Comment 1 Giorgos Keramidas freebsd_committer freebsd_triage 2002-06-12 01:30:15 UTC 
: --- 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
Comment 2 Marc Fonvieille 2002-06-12 11:19:15 UTC 
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
Comment 3 Jim Mock freebsd_committer freebsd_triage 2002-07-03 23:54:27 UTC 
State Changed
From-To: open->closed

Committed with the suggestions in the audit-trail.