From martin@sumuk.de  Sun Jan 27 03:49:28 2002
Return-Path: <martin@sumuk.de>
Received: from Kain.sumuk.de (Kain.sumuk.de [213.221.86.114])
	by hub.freebsd.org (Postfix) with ESMTP id 630D237B400
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 27 Jan 2002 03:49:23 -0800 (PST)
Received: from Moses.earth.sol (Moses.earth.sol [192.168.1.1])
	by Kain.sumuk.de (8.11.6/8.11.5) with ESMTP id g0RBnL905230
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 27 Jan 2002 12:49:22 +0100 (CET)
	(envelope-from martin@sumuk.de)
Received: (from vincent@localhost)
	by Moses.earth.sol (8.11.6/8.11.6) id g0RBnLM38583;
	Sun, 27 Jan 2002 12:49:21 +0100 (CET)
	(envelope-from vincent)
Message-Id: <200201271149.g0RBnLM38583@sumuk.de>
Date: Sun, 27 Jan 2002 12:49:21 +0100 (CET)
From: Martin Heinen <martin@sumuk.de>
Reply-To: Martin Heinen <martin@sumuk.de>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [PATCH] minor corrections to chapter kernelconfig
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         34328
>Category:       docs
>Synopsis:       [PATCH] minor corrections to chapter kernelconfig
>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:   Sun Jan 27 03:50:01 PST 2002
>Closed-Date:    Fri Feb 1 01:55:38 PST 2002
>Last-Modified:  Fri Feb 01 01:55:57 PST 2002
>Originator:     Martin Heinen
>Release:        FreeBSD 4.4-STABLE i386
>Organization:
>Environment:
System: FreeBSD Moses.earth.sol 4.4-STABLE FreeBSD 4.4-STABLE #0: Sat Dec 22 07:35:30 CET 2001 toor@Moses.earth.sol:/usr/obj/usr/src/sys/MOSES i386


	
>Description:
	removed a blank,
	removed <filename> from <userinput> line,
        marked up root with <username>,
	put 'ee', 'make world' inside <command>,
	added missing periods,
	made Star Office an application,
	marked up enter with <keycap>
>How-To-Repeat:
	read the kernelconfig chapter
>Fix:

Index: chapter.sgml
===================================================================
RCS file: /u/cvs/doc/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml,v
retrieving revision 1.73
diff -u -r1.73 chapter.sgml
--- chapter.sgml	26 Jan 2002 00:20:31 -0000	1.73
+++ chapter.sgml	26 Jan 2002 17:15:30 -0000
@@ -162,10 +162,10 @@
 	<literal>src</literal>, then <literal>sys</literal>.  If you
 	have an aversion to <application>sysinstall</application> and
 	you have access to an <quote>official</quote> FreeBSD CDROM, then
-	you can also install the source from the command line :</para>
+	you can also install the source from the command line:</para>
 
       <screen>&prompt.root; <userinput>mount</userinput> /cdrom
-&prompt.root; <userinput>mkdir -p</userinput> <filename>/usr/src/sys</filename>
+&prompt.root; <userinput>mkdir -p</userinput> /usr/src/sys
 &prompt.root; <userinput>ln -s</userinput> /usr/src/sys /sys
 &prompt.root; <userinput>cat /cdrom/sys/ssys.[a-d]* | tar -xzvf</userinput></screen>
     </note>
@@ -206,7 +206,7 @@
 
     <note>
       <para>You must execute these and all of the following commands under
-	the root account or you will get <errortype>permission
+	the <username>root</username> account or you will get <errortype>permission
 	denied</errortype> errors.</para>
     </note>
 
@@ -215,7 +215,7 @@
       will probably be <command>vi</command>, which is too complex to
       explain here, but is covered well in many books in the <link
       linkend="bibliography">bibliography</link>.  However, FreeBSD does
-      offer an easier editor called <quote>ee</quote> which, if you are a
+      offer an easier editor called <command>ee</command> which, if you are a
       beginner, should be your editor of choice.  Feel free to change the
       comment lines at the top to reflect your configuration or the
       changes you have made to differentiate it from
@@ -256,7 +256,7 @@
       <listitem>
 	<para>If you are running a FreeBSD version prior to 4.0, and you are
 	  <emphasis>not</emphasis> upgrading to FreeBSD 4.0 or higher using
-	  the <quote>make world</quote> procedure, use procedure 1.</para>
+	  the <command>make world</command> procedure, use procedure 1.</para>
       </listitem>
 
       <listitem>
@@ -266,8 +266,8 @@
       </listitem>
 
       <listitem>
-	<para>If you are rebuilding the kernel as part of a <quote>make
-	    world</quote> process, use procedure 2.</para>
+	<para>If you are rebuilding the kernel as part of a <command>make
+	    world</command> process, use procedure 2.</para>
       </listitem>
     </itemizedlist>
     
@@ -305,7 +305,7 @@
 	way</title>
       
       <step>
-	<para>Change to the <filename>/usr/src</filename> directory</para>
+	<para>Change to the <filename>/usr/src</filename> directory.</para>
 	
 	<screen>&prompt.root; <userinput>cd /usr/src</userinput></screen>
       </step>
@@ -327,7 +327,7 @@
       <para>In FreeBSD 4.2 and older you must replace
         <literal>KERNCONF=</literal> with <literal>KERNEL=</literal>.
         4.2-STABLE that was fetched after Feb 2nd, 2001 does
-        recognize <literal>KERNCONF=</literal></para>
+        recognize <literal>KERNCONF=</literal>.</para>
     </note>
 
     <indexterm>
@@ -737,8 +737,8 @@
 options 	_KPOSIX_PRIORITY_SCHEDULING</programlisting>
 
     <para>Real-time extensions added in the 1993 POSIX.  Certain
-      applications in the ports collection use these (such as Star
-      Office).</para>
+      applications in the ports collection use these (such as <application>Star
+      Office</application>).</para>
 
     <indexterm>
       <primary>kernel options</primary>
@@ -1021,7 +1021,7 @@
       <literal>device miibus</literal> to the kernel config pulls in
       support for the generic miibus API and all of the PHY drivers,
       including a generic one for PHYs that are not specifically handled
-      by an individual driver</para>
+      by an individual driver.</para>
 
     <programlisting>device          dc         # DEC/Intel 21143 and various workalikes
 device          rl         # RealTek 8129/8139
@@ -1303,7 +1303,7 @@
 	    an excellent mechanism for recovering from incompatible
 	    kernels.  Simply choose the kernel you want to boot from at
 	    the FreeBSD boot loader. You can access this when the system
-	    counts down from 10.  Hit any key except for the enter key,
+	    counts down from 10.  Hit any key except for <keycap>Enter</keycap>,
             type <command>unload</command> and then type
 	    <command>boot
 	    <replaceable>kernel.old</replaceable></command>, or the
@@ -1381,4 +1381,3 @@
      sgml-parent-document: ("../book.sgml" "part" "chapter")
      End:
 -->
-
>Release-Note:
>Audit-Trail:

From: Tom Rhodes <darklogik@pittgoth.com>
To: FreeBSD-gnats-submit@FreeBSD.org
Cc:  
Subject: Re: docs/34328: Minor corrections to kernelconfig
Date: Thu, 31 Jan 2002 12:33:35 -0500

 Recently looking this over, we have 2 prs for the kernelconfig chapter, 
 they will cancell each other out in line variances, and i'm going to 
 combine them...
 
 I see your logic in this, but I will point out a few things that I don't 
 agree with:
 
 you have: <command>vi</command> and <command>ee</command>
 which will work, yes, but the sentence does not push the user to look at 
 a command, in hence, it sounds more like you want to refer to a utility 
 or application.  The new patch will hug vi and ee in the <application> tags.
 
 You have <command>make world</command> when the FDP primer requests the 
 use of <maketarget> as "make world" is more of a target.
 
 Some of your other ideas I agree with, mainly the grammer, but I will 
 submit a patch with your changes, my changes and cover pr: 34137 in 
 it...  Thanks for pointing these out!
 
 -- 
 Tom (Darklogik) Rhodes
 www.Pittgoth.com Gothic Liberation Front
 www.FreeBSD.org  The Power To Serve
 
State-Changed-From-To: open->closed 
State-Changed-By: jim 
State-Changed-When: Fri Feb 1 01:55:38 PST 2002 
State-Changed-Why:  
Closed by docs/34499. 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=34328 
>Unformatted:
