diff options
| author | hubertf <hubertf@pkgsrc.org> | 2004-11-21 03:50:09 +0000 |
|---|---|---|
| committer | hubertf <hubertf@pkgsrc.org> | 2004-11-21 03:50:09 +0000 |
| commit | 76985a937641307209f118a31cf5d2d39b08b4d8 (patch) | |
| tree | 5b68781e42cee1cbaaaa5e33577b29397df0df11 /doc/guide | |
| parent | 935ab6efa2ede5e38905f5c4dd178723f74d18a7 (diff) | |
| download | pkgsrc-76985a937641307209f118a31cf5d2d39b08b4d8.tar.gz | |
add notice on tools needed to build the pkgsrc guide
Diffstat (limited to 'doc/guide')
| -rw-r--r-- | doc/guide/files/editing.xml | 48 |
1 files changed, 35 insertions, 13 deletions
diff --git a/doc/guide/files/editing.xml b/doc/guide/files/editing.xml index 4589ad0a976..88c289f0eee 100644 --- a/doc/guide/files/editing.xml +++ b/doc/guide/files/editing.xml @@ -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,31 +67,39 @@ <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 - <filename>pkgsrc/doc/guide</filename> to check the XML - syntax, and fix it if needed + Edit the XML file(s) in + <filename>pkgsrc/doc/guide/files</filename>. </para> </listitem> <listitem> <para> - Run <command>make</command> in - <filename>pkgsrc/doc/guide</filename> to build the HTML and - ASCII version + Run <command>make extract && make do-lint</command> in + <filename>pkgsrc/doc/guide</filename> to check the XML + syntax, and fix it if needed. </para> </listitem> <listitem> <para> - Run <command>make OUTPUT=pdf</command> in - <filename>pkgsrc/doc/guide</filename> to build the PDF - version. + Run <command>make</command> in + <filename>pkgsrc/doc/guide</filename> to build the HTML and + 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> |