o Correct some markup (<literal> -> <filename>)

o st0 -> sa0

o Document when and where you should quote numbers in the config file.

I've modified Chris' patch slightly, any errors are mine.

PR:             docs/12181
Submitted by:   Chris Costello <chris@calldei.com>

1 files changed, 32 insertions, 19 deletions

diff --git a/en/handbook/kernelconfig/chapter.sgml b/en/handbook/kernelconfig/chapter.sgml
index b7dc62b9ac..0cbc400919 100644
--- a/en/handbook/kernelconfig/chapter.sgml
+++ b/en/handbook/kernelconfig/chapter.sgml
@@ -1,7 +1,7 @@
 <!--
      The FreeBSD Documentation Project
 
-     $Id: chapter.sgml,v 1.16 1999-05-28 00:31:25 dwhite Exp $
+     $Id: chapter.sgml,v 1.17 1999-07-27 18:20:11 nik Exp $
 -->
 
 <chapter id="kernelconfig">
@@ -21,7 +21,7 @@
     <para>Building a custom kernel is one of the most important rites of
       passage every Unix system administrator must endure.  This process,
       while time-consuming, will provide many benefits to your FreeBSD system.
-      Unlike the <literal>GENERIC</literal> kernel, which must support every
+      Unlike the <filename>GENERIC</filename> kernel, which must support every
       possible SCSI and network card, along with tons of other rarely used
       hardware support, a custom kernel only contains support for
       <emphasis>your</emphasis> PC's hardware.  This has a number of
@@ -188,6 +188,26 @@
       with <emphasis>arch</emphasis> being for example
       <filename>i386</filename>.</para>
 
+    <important>
+      <title>Quoting numbers</title>
+
+      <para>In all versions of FreeBSD up to and including 3-stable,
+	  &man.config.8; required that any strings in the configuration file
+	that contained numbers used as text had to be enclosed in double
+	quotes.</para>
+
+      <para>Where numbers are used as numbers, as in <literal>maxusers
+	  64</literal>, the quotation marks are <emphasis>not</emphasis>
+	required.</para>
+
+      <para>This requirement was removed in FreeBSD-current (the 4.0 release
+	candidate).</para>
+
+      <para>The examples here include the quote marks (<literal>"</literal>).
+	If you are building a kernel on a -current system you should omit
+	them.</para>
+    </important>
+
     <sect2>
       <title>Mandatory Keywords</title>
       
@@ -195,7 +215,8 @@
       
       <variablelist>
 	<varlistentry>
-	  <term><literal>machine "i386"</literal></term>
+	  <term><literal>machine <replaceable>arch</replaceable></literal>
+	  </term>
 	  
 	  <listitem>
 	    <para>The first keyword is <literal>machine</literal>, which,
@@ -203,14 +224,6 @@
 	      DEC Alpha processors, will be either 
 	      <replaceable>i386</replaceable> or 
 	      <replaceable>alpha</replaceable>.</para>
-
-	    <note>
-	      <para>Any keyword which contains numbers used as text must be
-		enclosed in quotation marks, otherwise
-		<command>config</command> gets confused and thinks you mean
-		the actual number 386 if you enter 
-		<literal>machine i386</literal>.</para>
-	    </note>
 	  </listitem>
 	</varlistentry>
 	
@@ -272,19 +285,19 @@
 	  <listitem>
 	    <para>Next, we have <literal>ident</literal>, which is the
 	      identification of the kernel.  You should change this from
-	      <literal>GENERIC</literal> to whatever you named your kernel, in
-	      this example, <literal>MYKERNEL</literal>.  The value you put in
+	      <filename>GENERIC</filename> to whatever you named your kernel, in
+	      this example, <filename>MYKERNEL</filename>.  The value you put in
 	      <literal>ident</literal> will print when you boot up the kernel,
 	      so it is useful to give a kernel a different name if you want to
 	      keep it separate from your usual kernel (if you want to build an
 	      experimental kernel, for example).  Note that, as with
-	      <literal>machine</literal> and <literal> cpu</literal>, enclose
+	      <literal>machine</literal> and <literal>cpu</literal>, enclose
 	      your kernel's name in quotation marks if it contains any
 	      numbers.</para>
 		  
 	    <para>Since this name is passed to the C compiler as a
 	      <option>-D</option> switch, do not use names like
-	      <literal>DEBUG</literal>, or something that could be confused
+	      <filename>DEBUG</filename>, or something that could be confused
 	      with another machine or CPU name, like
 	      <literal>vax</literal>.</para>
 	  </listitem>
@@ -870,7 +883,7 @@
 	</varlistentry>
 	
 	<varlistentry>
-	  <term><literal>device st0</literal></term>
+	  <term><literal>device sa0</literal></term>
 	  
 	  <listitem>
 	    <para>Support for SCSI tape drives.</para>
@@ -1403,9 +1416,9 @@
 	  <title>Sound cards</title>
       
       <para>This is the first section containing lines that are not in the
-	GENERIC kernel.  To include sound card support, you will have to copy
-	the appropriate lines from the LINT kernel (which contains support for
-	<emphasis>every</emphasis> device) as follows:</para>
+	<filename>GENERIC</filename> kernel.  To include sound card support, you
+	will have to copy the appropriate lines from the LINT kernel (which
+	support for <emphasis>every</emphasis> device) as follows:</para>
 	  
       
       <variablelist>