[pkgsrc/trunk]: pkgsrc/doc/guide/files add notice on tools needed to build th...

[hubertf <hubertf%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/09eb19efe331
branches:  trunk
changeset: 483884:09eb19efe331
user:      hubertf <hubertf%pkgsrc.org@localhost>
date:      Sun Nov 21 03:50:09 2004 +0000

description:
add notice on tools needed to build the pkgsrc guide

diffstat:

 doc/guide/files/editing.xml |  52 ++++++++++++++++++++++++++++++++------------
 1 files changed, 37 insertions(+), 15 deletions(-)

diffs (100 lines):

diff -r 671ffa5ca66b -r 09eb19efe331 doc/guide/files/editing.xml
--- a/doc/guide/files/editing.xml       Sun Nov 21 02:43:36 2004 +0000
+++ b/doc/guide/files/editing.xml       Sun Nov 21 03:50:09 2004 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: editing.xml,v 1.2 2004/11/09 17:37:50 hubertf Exp $ -->
+<!-- $NetBSD: editing.xml,v 1.3 2004/11/21 03:50:09 hubertf Exp $ -->
 
 <appendix id="editing">
   <title>Editing guidelines for the pkgsrc guide</title>
@@ -40,6 +40,20 @@
        changes haven't broken the build!
         </para>
       </listitem>
+      
+      <listitem>
+        <para>
+          <filename>http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf</filename>:
+         PDF version of the pkgsrc guide.
+        </para>
+      </listitem>
+      
+      <listitem>
+        <para>
+          <filename>http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps</filename>:
+         PostScript version of the pkgsrc guide.
+        </para>
+      </listitem>
     </itemizedlist>
   </sect1>
 
@@ -53,15 +67,31 @@
     <itemizedlist>
       <listitem>
         <para>
-          Edit the XML file(s) in <filename>pkgsrc/doc/guide/files</filename>
+          Make sure you have the packages needed to re-generate the
+          pkgsrc guide (and other XML-based NetBSD documentation)
+          installed. These are <quote>pkgsrc-doc</quote> for creating the
+          ASCII- and HTML-version, and
+          <quote>pkgsrc-doc-print</quote>for the PostScript- and PDF
+          version. You will need both packages installed, to make sure
+          documentation is consistent across all formats. The packages
+          can be found in
+          <filename>pkgsrc/meta-pkgs/netbsd-doc</filename> and
+          <filename>pkgsrc/meta-pkgs/netbsd-doc-print</filename>. 
         </para>
       </listitem>
       
       <listitem>
         <para>
-          Run <command>make do-lint</command> in
+          Edit the XML file(s) in
+          <filename>pkgsrc/doc/guide/files</filename>. 
+        </para>
+      </listitem>
+      
+      <listitem>
+        <para>
+          Run <command>make extract &amp;&amp; make do-lint</command> in
           <filename>pkgsrc/doc/guide</filename> to check the XML
-          syntax, and fix it if needed
+          syntax, and fix it if needed.
         </para>
       </listitem>
       
@@ -69,15 +99,7 @@
         <para>
           Run <command>make</command> in
           <filename>pkgsrc/doc/guide</filename> to build the HTML and
-          ASCII version
-        </para>
-      </listitem>
-      
-      <listitem>
-        <para>
-          Run <command>make OUTPUT=pdf</command> in
-          <filename>pkgsrc/doc/guide</filename> to build the PDF
-          version. 
+          ASCII version.
         </para>
       </listitem>
       
@@ -96,7 +118,7 @@
       
       <listitem>
         <para>
-          <command>cvs commit pkgsrc/doc/pkgsrc.{html,txt}</command>
+          <command>cvs commit -m re-generate pkgsrc/doc/pkgsrc.{html,txt}</command>
         </para>
       </listitem>
       
@@ -106,7 +128,7 @@
           automatically to pick up changes to the pkgsrc guide
           automatically, also run <command>make install-htdoc
           HTDOCSDIR=../../../htdocs</command> (or similar, adjust
-          <varname>HTDOCSDIR</varname>!)
+          <varname>HTDOCSDIR</varname>!).
         </para>
       </listitem>