From martin@sumuk.de  Sun Feb  3 07:24:42 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 D9C5F37B404
	for <FreeBSD-gnats-submit@freebsd.org>; Sun,  3 Feb 2002 07:24:40 -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 g13FOd917950
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 3 Feb 2002 16:24:39 +0100 (CET)
	(envelope-from martin@sumuk.de)
Received: (from vincent@localhost)
	by Moses.earth.sol (8.11.6/8.11.6) id g13FObm68457;
	Sun, 3 Feb 2002 16:24:37 +0100 (CET)
	(envelope-from vincent)
Message-Id: <200202031524.g13FObm68457@sumuk.de>
Date: Sun, 3 Feb 2002 16:24:37 +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 for kernelconfig
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         34587
>Category:       docs
>Synopsis:       [PATCH] minor corrections for 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 Feb 03 07:30:01 PST 2002
>Closed-Date:    Sun Feb 10 18:03:26 PST 2002
>Last-Modified:  Sun Feb 10 18:03:52 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:
	completed a sentence,
	added a missing space
>How-To-Repeat:
	read the handbook section on kernel configuration
>Fix:

Index: chapter.sgml
===================================================================
RCS file: /u/cvs/doc/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml,v
retrieving revision 1.74
diff -u -r1.74 chapter.sgml
--- chapter.sgml	1 Feb 2002 09:54:51 -0000	1.74
+++ chapter.sgml	3 Feb 2002 10:37:08 -0000
@@ -616,7 +616,7 @@
     <programlisting>options          SOFTUPDATES  #Enable FFS soft updates support</programlisting>
 
     <para>This option enables soft updates in the kernel, this will help speed
-      up write access on the disks.  They enabled by default in the 4.X branch
+      up write access on the disks.  They are enabled by default in the 4.X branch
       but may not be turned on.  Review the output from &man.mount.8; to see
       if you have them enabled.  If you do not see the soft-updates option then
       you will need to activate it using the &man.tunefs.8; or &man.newfs.8;
@@ -1318,7 +1318,7 @@
 	    counts down from 10.  Hit any key except for the
             <keycap>enter</keycap> key, type <command>unload</command>
             and then type
-	    <command>boot<replaceable>kernel.old</replaceable></command>,
+	    <command>boot <replaceable>kernel.old</replaceable></command>,
             or the filename of any other kernel that will boot properly.
             When reconfiguring a kernel, it is always a good idea to keep
             a kernel that is known to work on hand.</para>
>Release-Note:
>Audit-Trail:

From: Tom Rhodes <darklogik@pittgoth.com>
To: FreeBSD-gnats-submit@FreeBSD.org
Cc:  
Subject: Re: docs/34587: Adding Feedback on the issue
Date: Mon, 04 Feb 2002 11:44:25 -0500

 <command>boot <replaceable>kernel.old</replaceable></command>
 
 I just do not really agree with this line, should whitespace be in the 
 actual tags, I think someone pointed out to me that no whitespace should 
 exsist here.  Something better would be:
 
 <command>boot</command> <replaceable>kernel.old</replaceable> or maybe
 <command>boot</command> <filename>kernel.old</filename>
 
 although, the first actually sounds a bit more 'realistic' as kernel.old 
 would be a replaceable file, HOWEVER, the 'make install' would mv the 
 kernel to kernel.old meaning it would be on the system regardless...
 
 Anyone with more experiance wish to comment, maybe fill me in what to do 
 here ;)
 
 -- 
 Tom (Darklogik) Rhodes
 www.Pittgoth.com Gothic Liberation Front
 www.FreeBSD.org  The Power To Serve
 

From: Martin Heinen <martin@sumuk.de>
To: Tom Rhodes <darklogik@pittgoth.com>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: docs/34587: Adding Feedback on the issue
Date: Tue, 5 Feb 2002 00:19:08 +0100

 On Mon, Feb 04, 2002 at 08:40:04AM -0800, Tom Rhodes wrote:
 
 >  <command>boot <replaceable>kernel.old</replaceable></command>
 >  
 >  I just do not really agree with this line, should whitespace be in the 
 >  actual tags, I think someone pointed out to me that no whitespace should 
 >  exsist here.  Something better would be:
 >  
 >  <command>boot</command> <replaceable>kernel.old</replaceable> or maybe
 >  <command>boot</command> <filename>kernel.old</filename>
 
 According to 'DocBook - The Definitive Guide' <command> describes
 an executable program or a text of a command.  <replaceable> is listed
 as valid content for <command>.
 
 The <medialabel> tag seems similar to <command> (in usage terms) and
 the following example is given:
 
 | ... <medialabel>Backup <replaceable>nn</replaceable></medialabel>
 
 Note that <replaceable> and a space are included in the medialabel
 element.
 
 >  although, the first actually sounds a bit more 'realistic' as kernel.old 
 >  would be a replaceable file, HOWEVER, the 'make install' would mv the 
 >  kernel to kernel.old meaning it would be on the system regardless...
 
 Following the Guide, the content of <command> will be restricted to
 #PCDATA, Replaceable, or InlineGraphic in DocBook 4.0, leaving
 the first example.
 
 >  Anyone with more experiance wish to comment, maybe fill me in what to do 
 >  here ;)
 
 Further comments are welcome too.
 
 Martin
 
 -- 
 Marxpitn

From: Giorgos Keramidas <keramida@ceid.upatras.gr>
To: Tom Rhodes <darklogik@pittgoth.com>
Cc: bug-followup@freebsd.org
Subject: Re: docs/34587: Adding Feedback on the issue
Date: Tue, 5 Feb 2002 05:00:19 +0200

 On 2002-02-04 08:40, Tom Rhodes wrote:
 
 > <command>boot <replaceable>kernel.old</replaceable></command>
 >  
 > I just do not really agree with this line, should whitespace be in the 
 > actual tags, I think someone pointed out to me that no whitespace should 
 > exsist here.  Something better would be:
 >
 > <command>boot</command> <replaceable>kernel.old</replaceable> or maybe
 > <command>boot</command> <filename>kernel.old</filename>
 
 
 The SGML markup is not a way to describe the 'format' of a document.
 It is though something we (as in 'we the SGML fans of the universe')
 use to denote the 'structure' of a document.
 
 If you convert the initial SGML to a tree-like structure you'll get:
 
 	(outter
 	  (command
 	    "boot"
 	    (whitespace)
 	    (replaceable "kernel.old")))
 
 The second one will be converted to:
 
 	(outter
 	  (command "boot")
 	  (whitespace)
 	  (replaceable "kernel.old"))
 
 The first rendering of the SGML entity clearly denotes that
 <replaceable> is a "part of <command>".
 
 What you suggest, looks a lot like what a user that reads the text on
 screen would do to mark up documents using a WYSIWIG editor.  But you
 can't tell the computer that the <replaceable> entity is a part of the
 <commmand> tag if you use this form of marking up documents.  Then you
 have lost part of the structural information that the original SGML
 markup shows :(
 
 Structure *is* important.  Imagine an SGML parser that will swallow
 the entire doc/ tree and look for complete <command> entities, and
 spit out a shell script that has ALL the examples of the docs, ready
 to be copy-pasted to a shell prompt.  If you break the structure of
 the entities, and <replaceable> is no longer a part of the original
 <command> tag, then there is no way for the tool I described to know
 where in the text of the document the parameters of the command are.
 
 -- 
 Giorgos Keramidas . . . . . . . . . keramida@{ceid.upatras.gr,freebsd.org}
 FreeBSD Documentation Project . . . http://www.freebsd.org/docproj/
 FreeBSD: The power to serve . . . . http://www.freebsd.org/
State-Changed-From-To: open->closed 
State-Changed-By: keramida 
State-Changed-When: Sun Feb 10 18:03:26 PST 2002 
State-Changed-Why:  
Fixed in revision 1.75 of file 
doc/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml 
Thanks :) 

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