Bug 41534

Summary: [PATCH] Various fixes to books/porters-handbook/book.sgml
Product: Documentation Reporter: Christian Brueffer <chris>
Component: Books & ArticlesAssignee: Marc Fonvieille <blackend>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
porters-handbook.diff none

Description Christian Brueffer 2002-08-11 01:20:01 UTC
	- add missing tags
	- fix some typos and missing characters
	- grammar fixes
Comment 1 Marc Fonvieille freebsd_committer freebsd_triage 2002-08-16 17:06:16 UTC
Responsible Changed
From-To: freebsd-doc->blackend

I'll take this :)
Comment 2 Christian Brueffer 2002-08-16 19:01:18 UTC
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
Comment 3 Marc Fonvieille freebsd_committer freebsd_triage 2002-08-22 16:09:04 UTC
State Changed
From-To: open->closed

I committed what I did not fix in my previous commits, thanks.