diff options
| author | hubertf <hubertf@pkgsrc.org> | 2004-11-09 17:37:50 +0000 |
|---|---|---|
| committer | hubertf <hubertf@pkgsrc.org> | 2004-11-09 17:37:50 +0000 |
| commit | f2f7e534ae1ec73fedbc104a36977e7062c7fa69 (patch) | |
| tree | e9ccd8867ca022d28ea6e7bf3f1559ced7c82a28 | |
| parent | a00032656e758d49e727019335e18a8cbd8eedb2 (diff) | |
| download | pkgsrc-f2f7e534ae1ec73fedbc104a36977e7062c7fa69.tar.gz | |
Update a bit to reflect current practice of updating both pkgsrc/doc
and htdocs
| -rw-r--r-- | doc/guide/files/editing.xml | 32 |
1 files changed, 27 insertions, 5 deletions
diff --git a/doc/guide/files/editing.xml b/doc/guide/files/editing.xml index 65fd37d45b3..4589ad0a976 100644 --- a/doc/guide/files/editing.xml +++ b/doc/guide/files/editing.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: editing.xml,v 1.1 2004/10/22 00:26:56 hubertf Exp $ --> +<!-- $NetBSD: editing.xml,v 1.2 2004/11/09 17:37:50 hubertf Exp $ --> <appendix id="editing"> <title>Editing guidelines for the pkgsrc guide</title> @@ -59,6 +59,14 @@ <listitem> <para> + Run <command>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</command> in <filename>pkgsrc/doc/guide</filename> to build the HTML and ASCII version @@ -69,16 +77,14 @@ <para> Run <command>make OUTPUT=pdf</command> in <filename>pkgsrc/doc/guide</filename> to build the PDF - version. Dont' omit this, as this does a very strict SGML - test, and doing this properly is important for getting proper - documentation on the web server! + version. </para> </listitem> <listitem> <para> If all is well, run <command>make install-doc</command> to put - the generated files into <filename>pkgserc/doc</filename>. + the generated files into <filename>pkgsrc/doc</filename>. </para> </listitem> @@ -94,6 +100,22 @@ </para> </listitem> + <listitem> + <para> + Until the webserver on www.NetBSD.org is really updated + 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>!) + </para> + </listitem> + + <listitem> + <para> + <command>cvs commit htdocs/Documentation/pkgsrc</command> + </para> + </listitem> + </itemizedlist> </sect1> |