summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorhubertf <hubertf>2004-11-09 17:37:50 +0000
committerhubertf <hubertf>2004-11-09 17:37:50 +0000
commite4620df6c4e2618f993490795e06a35e84430192 (patch)
treee9ccd8867ca022d28ea6e7bf3f1559ced7c82a28 /doc
parent193e753e65f27562b2d7e8471b73a83ea42f06ca (diff)
downloadpkgsrc-e4620df6c4e2618f993490795e06a35e84430192.tar.gz
Update a bit to reflect current practice of updating both pkgsrc/doc
and htdocs
Diffstat (limited to 'doc')
-rw-r--r--doc/guide/files/editing.xml32
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>