From chris@milan.hitnet.rwth-aachen.de  Sat Aug 10 17:16:35 2002
Return-Path: <chris@milan.hitnet.rwth-aachen.de>
Received: from mx1.FreeBSD.org (mx1.FreeBSD.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id A2B5337B400
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 10 Aug 2002 17:16:35 -0700 (PDT)
Received: from milan.hitnet.rwth-aachen.de (milan.hitnet.RWTH-Aachen.DE [137.226.181.144])
	by mx1.FreeBSD.org (Postfix) with ESMTP id AC52843E7B
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 10 Aug 2002 17:16:34 -0700 (PDT)
	(envelope-from chris@milan.hitnet.rwth-aachen.de)
Received: by milan.hitnet.rwth-aachen.de (Postfix, from userid 1001)
	id 34F43ABAE; Sun, 11 Aug 2002 02:16:33 +0200 (CEST)
Message-Id: <20020811001633.34F43ABAE@milan.hitnet.rwth-aachen.de>
Date: Sun, 11 Aug 2002 02:16:33 +0200 (CEST)
From: Christian Brueffer <chris@unixpages.org>
Reply-To: Christian Brueffer <chris@unixpages.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [PATCH] Various fixes to books/porters-handbook/book.sgml
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         41534
>Category:       docs
>Synopsis:       [PATCH] Various fixes to books/porters-handbook/book.sgml
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    blackend
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Aug 10 17:20:01 PDT 2002
>Closed-Date:    Thu Aug 22 08:10:51 PDT 2002
>Last-Modified:  Thu Aug 22 08:10:51 PDT 2002
>Originator:     Christian Brueffer
>Release:        FreeBSD 4.6-STABLE i386
>Organization:
>Environment:
System: FreeBSD milan.hitnet.rwth-aachen.de 4.6-STABLE FreeBSD 4.6-STABLE #2: Fri Jun 28 12:47:08 CEST 2002 chris@milan.hitnet.rwth-aachen.de:/usr/obj/usr/src/sys/LORIEN i386


	
>Description:
	- add missing tags
	- fix some typos and missing characters
	- grammar fixes
>How-To-Repeat:
	
>Fix:

	

--- porters-handbook.diff begins here ---
--- book.sgml.orig	Fri Aug  9 17:56:36 2002
+++ book.sgml	Sun Aug 11 02:09:49 2002
@@ -325,7 +325,7 @@
             port_dir`</command> in a bug report and send it with the
             &man.send-pr.1; program (see <ulink url="../../articles/contributing/contrib-how.html#CONTRIB-GENERAL">Bug
             Reports and General Commentary</ulink> for more information about
-            &man.send-pr.1;.  If the uncompressed port is larger than 20KB,
+            &man.send-pr.1;).  If the uncompressed port is larger than 20KB,
           you should compress it into a tarfile and use &man.uuencode.1;
           before including it in the bug report (uuencoded tarfiles are
           acceptable even if the bug report is smaller than 20KB but are not
@@ -1552,7 +1552,8 @@
               <row>
                 <entry><filename>textproc</filename></entry>
                 <entry>Text processing utilities.  It does not include
-                  desktop publishing tools, which go to print/.</entry>
+                  desktop publishing tools, which go to
+                  <filename>print</filename>.</entry>
               </row>
 
               <row>
@@ -1603,7 +1604,7 @@
               </row>
 
               <row>
-                <entry>x11</entry>
+                <entry><filename>x11</filename></entry>
                 <entry>The X window system and friends.  This category is only
                   for software that directly supports the window system.  Do not
                   put regular X applications here.  If your port is an X
@@ -2264,7 +2265,7 @@
             variable <makevar>${NONEXISTENT}</makevar> as the first field 
             of <makevar>BUILD_DEPENDS</makevar> or
             <makevar>RUN_DEPENDS</makevar>.  Use this only when you need to
-            the to get to the source of the other port.  You can often save
+            get to the source of the other port.  You can often save
             compilation time by specifying the target too.  For
             instance
 
@@ -2291,8 +2292,8 @@
 	want those libraries or applications, the ports system
 	provides hooks that the port author can use to decide which
 	configuration should be built. Supporting these properly will
-	make uses happy, and effectively provide 2 or more ports for the
-	price of one.</para>
+	make users happy, and effectively provide 2 or more ports for
+	the price of one.</para>
 	
       <para>The easiest of these to use is
 	<makevar>WITHOUT_X11</makevar>. If the port can be built both
@@ -2341,7 +2342,7 @@
       <sect2>
 	<title><makevar>WRKSRC</makevar></title>
 
-	<para>The variable lists the name of the directoy that is created when
+	<para>The variable lists the name of the directory that is created when
 	  the application's distfiles are extracted.  If our previous example
 	  extracted into a directory called <filename>foo</filename> (and not
 	  <filename>foo-1.0</filename>) you would write:</para>
@@ -2431,8 +2432,8 @@
           deinstallation will not cause the system to still believe the
           library is there.</para>
 
-        <para>If you need, you can override default location where the new
-          library is installed by defining <makevar>LDCONFIG_DIRS</makevar>
+        <para>If you need, you can override the default location where the new
+          library is installed by defining the <makevar>LDCONFIG_DIRS</makevar>
           make variable, which should contain a list of directories into which
           shared libraries are to be installed.  For example if your port
           installs shared libraries into
@@ -3679,7 +3680,7 @@
           <makevar>PLIST_SUB</makevar> variable with a list of
           <literal><replaceable>VAR</replaceable>=<replaceable>VALUE</replaceable></literal>
           pairs and instances of
-          <literal>%%<replaceable>VAR</replaceable>%%</literal>' will be
+          <literal>%%<replaceable>VAR</replaceable>%%</literal> will be
           substituted with <replaceable>VALUE</replaceable> in the
           <filename>pkg-plist</filename>.</para>
 
@@ -3803,7 +3804,7 @@
           <filename>/usr/local</filename>), unless
           <makevar>USE_X_PREFIX</makevar> or <makevar>USE_IMAKE</makevar> is
           set, in which case it will be <makevar>X11BASE</makevar> (default
-          <filename>/usr/X11R6</filename>).)</para>
+          <filename>/usr/X11R6</filename>).</para>
 
         <para>Not hard-coding <filename>/usr/local</filename> or
           <filename>/usr/X11R6</filename> anywhere in the source will make the
@@ -3831,7 +3832,7 @@
 	or correct use of <makevar>LOCALBASE</makevar> for references to
 	files from other ports.  Testing the installation in
 	<filename>/var/tmp/<replaceable>port-name</replaceable></filename>
-	to do that that while you have it installed would do that.</para>
+	to do that while you have it installed would do that.</para>
 
         <para>Do not set <makevar>USE_X_PREFIX</makevar> unless your port
           truly requires it (i.e., it links against X libs or it needs to
@@ -3868,8 +3869,9 @@
         version from the original authors, first make sure you have the latest
         port.  You can find them in the
         <filename>ports/ports-current</filename> directory of the FTP mirror
-        sites.  You may also use CVSup to keep your whole ports collection
-        up-to-date, as described in <ulink url="../handbook/synching.html#CVSUP-CONFIG">the Handbook</ulink>.</para>
+        sites.  You may also use <application>CVSup</application> to
+        keep your whole ports collection up-to-date, as described in
+        <ulink url="../handbook/synching.html#CVSUP-CONFIG">the Handbook</ulink>.</para>
 
       <para>The next step is to send a mail to the maintainer, if one is
         listed in the port's <filename>Makefile</filename>.  That person may
--- porters-handbook.diff ends here ---


>Release-Note:
>Audit-Trail:

From: Christian Brueffer <chris@unixpages.org>
To: FreeBSD-gnats-submit@FreeBSD.ORG
Cc:  
Subject: Re: docs/41534: [PATCH] Various fixes to books/porters-handbook/book.sgml
Date: Fri, 16 Aug 2002 18:01:18 +0000

 I've created new patches with the changes recently made by blackend
 to the porters-handbook removed. Also this one fixes some stupidities I've made.
 
 The whole thing is separated into real fixes (first patch) and
 whitespace fixes (second patch).
 
 
 
 --- book.sgml   Tue Aug 13 20:24:21 2002
 +++ book.sgml.fixes     Fri Aug 16 17:14:00 2002
 @@ -325,7 +325,7 @@
              port_dir`</command> in a bug report and send it with the
              &man.send-pr.1; program (see <ulink url="../../articles/contributing/contrib-how.html#CONTRIB-GENERAL">Bug
              Reports and General Commentary</ulink> for more information about
 -            &man.send-pr.1;.  If the uncompressed port is larger than 20KB,
 +            &man.send-pr.1;).  If the uncompressed port is larger than 20KB,
            you should compress it into a tarfile and use &man.uuencode.1;
            before including it in the bug report (uuencoded tarfiles are
            acceptable even if the bug report is smaller than 20KB but are not
 @@ -1552,7 +1552,7 @@
                <row>
                  <entry><filename>textproc</filename></entry>
                  <entry>Text processing utilities.  It does not include
 -                  desktop publishing tools, which go to print/.</entry>
 +                  desktop publishing tools, which go to <filename>print</filename>.</entry>
                </row>
  
                <row>
 @@ -2263,8 +2263,8 @@
            <para>To depend on another port unconditionally, use the
              variable <makevar>${NONEXISTENT}</makevar> as the first field 
              of <makevar>BUILD_DEPENDS</makevar> or
 -            <makevar>RUN_DEPENDS</makevar>.  Use this only when you need to
 -            the to get to the source of the other port.  You can often save
 +            <makevar>RUN_DEPENDS</makevar>.  Use this only when you need
 +            the port to get to the source of the other port.  You can often save
              compilation time by specifying the target too.  For
              instance
  
 @@ -2291,7 +2291,7 @@
         want those libraries or applications, the ports system
         provides hooks that the port author can use to decide which
         configuration should be built. Supporting these properly will
 -       make uses happy, and effectively provide 2 or more ports for the
 +       make users happy, and effectively provide 2 or more ports for the
         price of one.</para>
         
        <para>The easiest of these to use is
 @@ -2341,7 +2341,7 @@
        <sect2>
         <title><makevar>WRKSRC</makevar></title>
  
 -       <para>The variable lists the name of the directoy that is created when
 +       <para>The variable lists the name of the directory that is created when
           the application's distfiles are extracted.  If our previous example
           extracted into a directory called <filename>foo</filename> (and not
           <filename>foo-1.0</filename>) you would write:</para>
 @@ -2431,8 +2431,8 @@
            deinstallation will not cause the system to still believe the
            library is there.</para>
  
 -        <para>If you need, you can override default location where the new
 -          library is installed by defining <makevar>LDCONFIG_DIRS</makevar>
 +        <para>If you need, you can override the default location where the new
 +          library is installed by defining the <makevar>LDCONFIG_DIRS</makevar>
            make variable, which should contain a list of directories into which
            shared libraries are to be installed.  For example if your port
            installs shared libraries into
 @@ -3680,7 +3680,7 @@
            <makevar>PLIST_SUB</makevar> variable with a list of
            <literal><replaceable>VAR</replaceable>=<replaceable>VALUE</replaceable></literal>
            pairs and instances of
 -          <literal>%%<replaceable>VAR</replaceable>%%</literal>' will be
 +          <literal>%%<replaceable>VAR</replaceable>%%</literal> will be
            substituted with <replaceable>VALUE</replaceable> in the
            <filename>pkg-plist</filename>.</para>
  
 @@ -3799,12 +3799,12 @@
          <title><makevar>PREFIX</makevar></title>
  
          <para>Do try to make your port install relative to
 -          <makevar>PREFIX</makevar>.  (The value of this variable will be set
 +          <makevar>PREFIX</makevar> (the value of this variable will be set
            to <makevar>LOCALBASE</makevar> (default
            <filename>/usr/local</filename>), unless
            <makevar>USE_X_PREFIX</makevar> or <makevar>USE_IMAKE</makevar> is
            set, in which case it will be <makevar>X11BASE</makevar> (default
 -          <filename>/usr/X11R6</filename>).)</para>
 +          <filename>/usr/X11R6</filename>)).</para>
  
          <para>Not hard-coding <filename>/usr/local</filename> or
            <filename>/usr/X11R6</filename> anywhere in the source will make the
 @@ -3832,7 +3832,7 @@
         or correct use of <makevar>LOCALBASE</makevar> for references to
         files from other ports.  Testing the installation in
         <filename>/var/tmp/<replaceable>port-name</replaceable></filename>
 -       to do that that while you have it installed would do that.</para>
 +       to do that while you have it installed would do that.</para>
  
          <para>Do not set <makevar>USE_X_PREFIX</makevar> unless your port
            truly requires it (i.e., it links against X libs or it needs to
 @@ -3885,7 +3885,7 @@
          version from the original authors, first make sure you have the latest
          port.  You can find them in the
          <filename>ports/ports-current</filename> directory of the FTP mirror
 -        sites.  You may also use CVSup to keep your whole ports collection
 +        sites.  You may also use <application>CVSup</application> to keep your whole ports collection
          up-to-date, as described in <ulink url="../handbook/synching.html#CVSUP-CONFIG">the Handbook</ulink>.</para>
  
        <para>The next step is to send a mail to the maintainer, if one is
 
 
 
 --- book.sgml.fixes     Fri Aug 16 17:14:00 2002
 +++ book.sgml.whitespace        Fri Aug 16 17:19:14 2002
 @@ -1552,7 +1552,8 @@
                <row>
                  <entry><filename>textproc</filename></entry>
                  <entry>Text processing utilities.  It does not include
 -                  desktop publishing tools, which go to <filename>print</filename>.</entry>
 +                  desktop publishing tools, which go to
 +                  <filename>print</filename>.</entry>
                </row>
  
                <row>
 @@ -2291,8 +2292,8 @@
         want those libraries or applications, the ports system
         provides hooks that the port author can use to decide which
         configuration should be built. Supporting these properly will
 -       make users happy, and effectively provide 2 or more ports for the
 -       price of one.</para>
 +       make users happy, and effectively provide 2 or more ports for
 +       the price of one.</para>
         
        <para>The easiest of these to use is
         <makevar>WITHOUT_X11</makevar>. If the port can be built both
 @@ -3885,8 +3886,9 @@
          version from the original authors, first make sure you have the latest
          port.  You can find them in the
          <filename>ports/ports-current</filename> directory of the FTP mirror
 -        sites.  You may also use <application>CVSup</application> to keep your whole ports collection
 -        up-to-date, as described in <ulink url="../handbook/synching.html#CVSUP-CONFIG">the Handbook</ulink>.</para>
 +        sites.  You may also use <application>CVSup</application> to
 +        keep your whole ports collection up-to-date, as described in
 +        <ulink url="../handbook/synching.html#CVSUP-CONFIG">the Handbook</ulink>.</para>
  
        <para>The next step is to send a mail to the maintainer, if one is
          listed in the port's <filename>Makefile</filename>.  That person may
 
 
 - Christian
 
 -- 
 http://www.unixpages.org			chris@unixpages.org
 GPG Pub-Key    : www.unixpages.org/cbrueffer.asc
 GPG Fingerprint: 0DB5 8563 2473 C72A A8D1  56EA DAD2 B05D 5F3C 3185
 GPG Key ID     : DAD2B05D5F3C3185
Responsible-Changed-From-To: freebsd-doc->blackend 
Responsible-Changed-By: blackend 
Responsible-Changed-When: Fri Aug 16 09:06:16 PDT 2002 
Responsible-Changed-Why:  
I'll take this :) 

http://www.freebsd.org/cgi/query-pr.cgi?pr=41534 
State-Changed-From-To: open->closed 
State-Changed-By: blackend 
State-Changed-When: Thu Aug 22 08:09:04 PDT 2002 
State-Changed-Why:  
I committed what I did not fix in my previous commits, thanks. 

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