docs/123143: [patch] Fix <replaceable> tags in Handbook Chapter 8

Gabor PALI pgj at FreeBSD.org
Sun Apr 27 11:50:01 UTC 2008


>Number:         123143
>Category:       docs
>Synopsis:       [patch] Fix <replaceable> tags in Handbook Chapter 8
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Apr 27 11:50:00 UTC 2008
>Closed-Date:
>Last-Modified:
>Originator:     Gabor PALI
>Release:        FreeBSD 6.3-STABLE i386
>Organization:
>Environment:
System: FreeBSD disznohal 6.3-STABLE FreeBSD 6.3-STABLE #4: Fri Apr 4 23:29:43 CEST 2008 dezzy at disznohal:/usr/obj/usr/src/sys/GENERIC_ i386

>Description:
	I found a substle inconsistency in the use of <replaceable>
	tags in Chapter 8 (``Configuring the FreeBSD Kernel'') of
	the FreeBSD Handbook. I created a patch to address this.

>How-To-Repeat:

>Fix:

	The patch itself:

--- kernelconfig.patch.diff begins here ---
Index: chapter.sgml
===================================================================
RCS file: /doc/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml,v
retrieving revision 1.181
diff -u -r1.181 chapter.sgml
--- chapter.sgml	12 Apr 2008 21:44:53 -0000	1.181
+++ chapter.sgml	27 Apr 2008 11:42:35 -0000
@@ -272,12 +272,12 @@
       name you want to give your kernel.  For example:</para>
 
     <screen>&prompt.root; <userinput>cd /usr/src/sys/<replaceable>i386</replaceable>/conf</userinput>
-&prompt.root; <userinput>cp GENERIC MYKERNEL</userinput></screen>
+&prompt.root; <userinput>cp GENERIC <replaceable>MYKERNEL</replaceable></userinput></screen>
 
     <para>Traditionally, this name is in all capital letters and, if you
       are maintaining multiple &os; machines with different hardware,
       it is a good idea to name it after your machine's hostname.  We will
-      call it <filename>MYKERNEL</filename> for the purpose of this
+      call it <filename><replaceable>MYKERNEL</replaceable></filename> for the purpose of this
       example.</para>
 
     <tip>
@@ -305,7 +305,7 @@
 &prompt.root; <userinput>ln -s /root/kernels/<replaceable>MYKERNEL</replaceable></userinput></screen>
     </tip>
 
-    <para>Now, edit <filename>MYKERNEL</filename> with your favorite text
+    <para>Now, edit <filename><replaceable>MYKERNEL</replaceable></filename> with your favorite text
       editor.  If you are just starting out, the only editor available
       will probably be <application>vi</application>, which is too complex to
       explain here, but is covered well in many books in the <link
@@ -506,7 +506,7 @@
 
     <para>This is the identification of the kernel.  You should change
       this to whatever you named your kernel,
-      i.e. <literal>MYKERNEL</literal> if you have followed the
+      i.e. <literal><replaceable>MYKERNEL</replaceable></literal> if you have followed the
       instructions of the previous examples.  The value you put in the
       <literal>ident</literal> string will print when you boot up the
       kernel, so it is useful to give the new kernel a different name if you
@@ -1445,7 +1445,7 @@
 	      as &man.ps.1; may not work properly.  To do this, simply
 	      rename the directory containing the good kernel:</para>
 
-	    <screen>&prompt.root; <userinput>mv /boot/kernel /boot/kernel.bad</userinput>
+	    <screen>&prompt.root; <userinput>mv /boot/kernel <replaceable>/boot/kernel.bad</replaceable></userinput>
 &prompt.root; <userinput>mv /boot/<replaceable>kernel.good</replaceable> /boot/kernel</userinput></screen>
 
 	  </note>
--- kernelconfig.patch.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted:



More information about the freebsd-doc mailing list