From pepper@guest.reppep.com  Mon Jun  3 20:09:23 2002
Return-Path: <pepper@guest.reppep.com>
Received: from guest.reppep.com (guest.reppep.com [64.81.19.110])
	by hub.freebsd.org (Postfix) with ESMTP id 99B2237B403
	for <FreeBSD-gnats-submit@freebsd.org>; Mon,  3 Jun 2002 20:09:22 -0700 (PDT)
Received: (from pepper@localhost)
	by guest.reppep.com (8.11.6/8.11.6) id g5439Nx04058;
	Mon, 3 Jun 2002 23:09:23 -0400 (EDT)
	(envelope-from pepper)
Message-Id: <200206040309.g5439Nx04058@guest.reppep.com>
Date: Mon, 3 Jun 2002 23:09:23 -0400 (EDT)
From: Chris Pepper <pepper@rockefeller.edu>
Reply-To: Chris Pepper <pepper@rockefeller.edu>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: Typo fixes in doc/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         38880
>Category:       docs
>Synopsis:       Typo fixes in doc/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    keramida
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Jun 03 20:10:01 PDT 2002
>Closed-Date:    Sun Jun 23 14:15:45 PDT 2002
>Last-Modified:  Sun Jun 23 14:15:45 PDT 2002
>Originator:     Chris Pepper
>Release:        FreeBSD 4.6-RC i386
>Organization:
>Environment:
System: FreeBSD guest.reppep.com 4.6-RC FreeBSD 4.6-RC #0: Fri May 31 22:33:23 EDT 2002 root@guest.reppep.com:/usr/obj/usr/src/sys/GENERIC i386


	
>Description:
	Clean up some typos.
	Fix some odd quote tags -- they appeared to work, but were confusing, e.g., "<quote/make world/"
	put 'make' into an entity.
>How-To-Repeat:
	
>Fix:
	Proposed patch follows.

--- chapter.sgml.diff begins here ---
Index: chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml,v
retrieving revision 1.125
diff -u -r1.125 chapter.sgml
--- chapter.sgml	2002/05/22 04:37:41	1.125
+++ chapter.sgml	2002/06/04 03:05:47
@@ -683,7 +683,7 @@
     </sect2>
 
     <sect2>
-      <title>Update the files of <filename>/etc</filename></title>
+      <title>Update the files in <filename>/etc</filename></title>
 
       <para>The <filename>/etc</filename> directory contains a large part
 	of your system's configuration information, as well as scripts
@@ -1205,7 +1205,7 @@
 	files, determining how they differ with your existing files.</para>
     
       <para>Note that some of the files that will have been installed in
-	<filename>/var/tmp/root</filename> have a leading <quote/./.  At the
+	<filename>/var/tmp/root</filename> have a leading <quote>.</quote>.  At the
 	time of writing the only files like this are shell startup files in
 	<filename>/var/tmp/root/</filename> and
 	<filename>/var/tmp/root/root/</filename>, although there may be others
@@ -1451,7 +1451,7 @@
 	    <para>At the end of the day, it is your call.  You might be happy
 	      re-making the world every fortnight say, and let changes
 	      accumulate over that fortnight.  Or you might want to re-make
-	      just those things that have changed, and are confident you can
+	      just those things that have changed, and be confident you can
 	      spot all the dependencies.</para>
       
 	    <para>And, of course, this all depends on how often you want to
@@ -1495,14 +1495,14 @@
       
 	    <para><filename>/usr/obj</filename> contains all the object files
 	      that were produced during the compilation phase.  Normally, one
-	      of the first steps in the <quote/make world/ process is to
+	      of the first steps in the <quote>make world</quote> process is to
 	      remove this directory and start afresh.  In this case, keeping
 	      <filename>/usr/obj</filename> around after you have finished
 	      makes little sense, and will free up a large chunk of disk space
 	      (currently about 340MB).</para>
       
 	    <para>However, if you know what you are doing you can have
-	      <quote/make world/ skip this step.  This will make subsequent
+	      <quote>make world</quote> skip this step.  This will make subsequent
 	      builds run much faster, since most of sources will not need to
 	      be recompiled.  The flip side of this is that subtle dependency
 	      problems can creep in, causing your build to fail in odd ways.
@@ -1511,8 +1511,8 @@
 	      realising that it is because they have tried to cut
 	      corners.</para>
       
-	    <para>If you want to live dangerously then make the world, passing
-	      the <makevar>NOCLEAN</makevar> definition to <command>make</command>, like
+	    <para>If you want to live dangerously then <command>make</command> the world, passing
+	      the <makevar>NOCLEAN</makevar> option to the <command>make</command>, like
 	      this:</para>
 
 	    <screen>&prompt.root; <userinput>make -DNOCLEAN world</userinput></screen>
@@ -1606,7 +1606,7 @@
 	      </listitem>
 	      
 	      <listitem>
-		<para>Pass the <option>-j&lt;n&gt;</option> option to make to
+		<para>Pass the <option>-j&lt;n&gt;</option> option to &man.make.1; to
 		  run multiple processes in parallel.  This usually helps 
 		  regardless of whether you have a single or a multi processor
 		  machine.</para>
--- chapter.sgml.diff ends here ---


>Release-Note:
>Audit-Trail:

From: Giorgos Keramidas <keramida@FreeBSD.org>
To: Chris Pepper <pepper@rockefeller.edu>
Cc: bug-followup@FreeBSD.org
Subject: Re: docs/38880: Typo fixes in doc/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml
Date: Wed, 5 Jun 2002 04:04:05 +0300

 On 2002-06-03 23:09 -0400, Chris Pepper wrote:
 > -	<filename>/var/tmp/root</filename> have a leading <quote/./.  At the
 > +	<filename>/var/tmp/root</filename> have a leading <quote>.</quote>.  At the
 
 This is not really a typo.  It's valid SGML, AFAIK.
 What do you all others think?  Is this (and similar parts of the
 patch) worth the change?
 
 > -	      just those things that have changed, and are confident you can
 > +	      just those things that have changed, and be confident you can
 
 Good catch :)
 
 > -	    <para>If you want to live dangerously then make the world, passing
 > -	      the <makevar>NOCLEAN</makevar> definition to <command>make</command>, like
 > +	    <para>If you want to live dangerously then <command>make</command> the world, passing
 > +	      the <makevar>NOCLEAN</makevar> option to the <command>make</command>, like
 >  	      this:</para>
 
 I am almost convinced that this part can be deleted.  We don't want
 the users to live dangerously.  IMHO, those that can live dangerously
 and still get away with it, won't need the Handbook to tell them what
 needs to be done.
 
 > -		<para>Pass the <option>-j&lt;n&gt;</option> option to make to
 > +		<para>Pass the <option>-j&lt;n&gt;</option> option to &man.make.1; to
 
 I'd probably use <command>make</command> but this is OK too, I guess.
 
 Giorgos.
 
State-Changed-From-To: open->closed 
State-Changed-By: keramida 
State-Changed-When: Sun Jun 23 14:13:51 PDT 2002 
State-Changed-Why:  
The changes have been committed, thanks :) 
I just removed the living dangerously part. 
We need a way to describe all the make options in one place. 
Having options scattered around the docs is not quite right, 
and I don't like the 'dangerously' part of it too much. 


Responsible-Changed-From-To: freebsd-doc->keramida 
Responsible-Changed-By: keramida 
Responsible-Changed-When: Sun Jun 23 14:13:51 PDT 2002 
Responsible-Changed-Why:  

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