From pali.gabor@googlemail.com  Sun Apr 27 11:46:04 2008
Return-Path: <pali.gabor@googlemail.com>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 995A510656CD
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 27 Apr 2008 11:46:04 +0000 (UTC)
	(envelope-from pali.gabor@googlemail.com)
Received: from ug-out-1314.google.com (ug-out-1314.google.com [66.249.92.174])
	by mx1.freebsd.org (Postfix) with ESMTP id 2120C8FC28
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 27 Apr 2008 11:46:03 +0000 (UTC)
	(envelope-from pali.gabor@googlemail.com)
Received: by ug-out-1314.google.com with SMTP id y2so513263uge.37
        for <FreeBSD-gnats-submit@freebsd.org>; Sun, 27 Apr 2008 04:46:03 -0700 (PDT)
Received: by 10.66.220.12 with SMTP id s12mr3252436ugg.15.1209296762518;
        Sun, 27 Apr 2008 04:46:02 -0700 (PDT)
Received: from pgj@FreeBSD.org ( [80.98.116.90])
        by mx.google.com with ESMTPS id z37sm7345092ikz.1.2008.04.27.04.46.00
        (version=TLSv1/SSLv3 cipher=OTHER);
        Sun, 27 Apr 2008 04:46:01 -0700 (PDT)
Received: by pgj@FreeBSD.org (sSMTP sendmail emulation); Sun, 27 Apr 2008 13:46:00 +0200
Message-Id: <48146779.2534440a.1132.ffffd6d0@mx.google.com>
Date: Sun, 27 Apr 2008 13:46:00 +0200
From: "Gabor PALI" <pgj@FreeBSD.org>
Sender: =?UTF-8?B?UMOBTEkgR8OhYm9yIErDoW5vcw==?= <pali.gabor@googlemail.com>
Reply-To: Gabor PALI <pgj@FreeBSD.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [patch] Fix <replaceable> tags in Handbook Chapter 8
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         123143
>Category:       docs
>Synopsis:       [patch] Fix <replaceable> tags in Handbook Chapter 8
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    gabor
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Apr 27 11:50:00 UTC 2008
>Closed-Date:    Mon May 05 22:46:06 UTC 2008
>Last-Modified:  Mon May 05 22:46:06 UTC 2008
>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@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:
Responsible-Changed-From-To: freebsd-doc->gabor 
Responsible-Changed-By: gabor 
Responsible-Changed-When: Fri May 2 20:30:05 UTC 2008 
Responsible-Changed-Why:  
Take. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=123143 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/123143: commit references a PR
Date: Mon,  5 May 2008 14:06:21 +0000 (UTC)

 gabor       2008-05-05 14:06:18 UTC
 
   FreeBSD doc repository
 
   Modified files:
     en_US.ISO8859-1/books/handbook/kernelconfig chapter.sgml 
   Log:
   - Add some replaceable elements to granularize the markup
   
   PR:             docs/123143
   Submitted by:   pgj
   
   Revision  Changes    Path
   1.182     +5 -5      doc/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: open->closed 
State-Changed-By: gabor 
State-Changed-When: Mon May 5 22:45:12 UTC 2008 
State-Changed-Why:  
Committed, thanks! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=123143 
>Unformatted:
