svn commit: r44287 - head/en_US.ISO8859-1/books/handbook/kernelconfig

[Dru Lavigne]

Author: dru
Date: Wed Mar 19 15:55:02 2014
New Revision: 44287
URL: http://svnweb.freebsd.org/changeset/doc/44287

Log:
  Comment out the kernel walk-through as it is out-of-date and
  architecture specific.
  Comment out the PAE section as it deals with ancient hardware.
  Some small editorial fixes.
  
  Sponsored by: iXsystems

Modified:
  head/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.xml

Modified: head/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.xml	Wed Mar 19 14:08:07 2014	(r44286)
+++ head/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.xml	Wed Mar 19 15:55:02 2014	(r44287)
@@ -250,7 +250,7 @@ ath_hal(4)               - Atheros Hardw
 
     <para>If <filename>/usr/src/</filename> does not exist or it is
       empty, source has not been installed.  Source can be installed
-      using <application>Subversion</application>, which is described
+      using <application>Subversion</application> and the instructions
       in <xref linkend="svn"/>.</para>
       
     <para>Once source is installed, review the contents of
@@ -268,25 +268,13 @@ ath_hal(4)               - Atheros Hardw
       The convention is to use a name with all capital letters.  When
       maintaining multiple &os; machines with different hardware, it
       is a good idea to name it after the machine's hostname.  This
-      example creates a custom configuration file for the
+      example creates a copy, named <filename>MYKERNEL</filename>, of the
+      <filename>GENERIC</filename> configuration file for the
       <literal>amd64</literal> architecture:</para>
 
     <screen>&prompt.root; <userinput>cd /usr/src/sys/amd64/conf</userinput>
 &prompt.root; <userinput>cp GENERIC MYKERNEL</userinput></screen>
 
-    <tip>
-      <para>When finished customizing the kernel configuration file,
-	save a backup copy to a location outside of <filename>/usr/src</filename>.</para>
-
-      <para>Alternately, keep the kernel configuration file elsewhere
-	and create a symbolic link to the file:</para>
-
-      <screen>&prompt.root; <userinput>cd /usr/src/sys/amd64/conf</userinput>
-&prompt.root; <userinput>mkdir /root/kernels</userinput>
-&prompt.root; <userinput>cp GENERIC /root/kernels/MYKERNEL</userinput>
-&prompt.root; <userinput>ln -s /root/kernels/MYKERNEL</userinput></screen>
-    </tip>
-
     <para>The configuration file
       <filename>MYKERNEL</filename> can now be customized
       with any ASCII text editor.  The default editor is
@@ -320,13 +308,26 @@ ath_hal(4)               - Atheros Hardw
       For architecture independent options, refer to
       <filename>/usr/src/sys/conf/NOTES</filename>.</para>
 
+    <tip>
+      <para>When finished customizing the kernel configuration file,
+	save a backup copy to a location outside of <filename>/usr/src</filename>.</para>
+
+      <para>Alternately, keep the kernel configuration file elsewhere
+	and create a symbolic link to the file:</para>
+
+      <screen>&prompt.root; <userinput>cd /usr/src/sys/amd64/conf</userinput>
+&prompt.root; <userinput>mkdir /root/kernels</userinput>
+&prompt.root; <userinput>cp GENERIC /root/kernels/MYKERNEL</userinput>
+&prompt.root; <userinput>ln -s /root/kernels/MYKERNEL</userinput></screen>
+    </tip>
+
     <para>An <literal>include</literal> directive is available for use
       in configuration files.  This allows another configuration file
       to be included in the current one, making it easy to maintain
-      small changes relative to an existing file.  For example, if
+      small changes relative to an existing file.  If
       only a small number of additional options or drivers are
       required, this allows a delta to be maintained with respect
-      to GENERIC:</para>
+      to <filename>GENERIC</filename>, as seen in this example:</para>
 
     <programlisting>include GENERIC
 ident MYKERNEL
@@ -351,12 +352,14 @@ options         IPDIVERT</programlisting
       <screen>&prompt.root; <userinput>cd /usr/src/sys/<replaceable>arch</replaceable>/conf && make LINT</userinput></screen>
     </note>
 
-
+<!--
     <indexterm>
       <primary>kernel options</primary>
       <secondary>ident</secondary>
     </indexterm>
 
+This is outdated and specific to one architecture.
+
     <programlisting>ident          GENERIC</programlisting>
 
     <para>This is the identification of the kernel.  Change
@@ -1064,7 +1067,10 @@ device          fwe           # Ethernet
     <para>For more information and additional devices supported by
       &os;, see
       <filename>/usr/src/sys/<replaceable>arch</replaceable>/conf/NOTES</filename>.</para>
-
+      -->
+      
+  <!--
+  This section refers to ancient hardware.
     <sect2>
       <title>Large Memory Configurations
 	(<acronym>PAE</acronym>)</title>
@@ -1151,6 +1157,7 @@ device          fwe           # Ethernet
 	  consult &man.tuning.7;.  &man.pae.4; contains up-to-date
 	  information on &os;'s <acronym>PAE</acronym> support.</para>
       </sect2>
+-->
     </sect1>
 
   <sect1 xml:id="kernelconfig-building">