pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc Re-gen for notice on needed tools to update the pk...
details: https://anonhg.NetBSD.org/pkgsrc/rev/684ad7d7d1d3
branches: trunk
changeset: 483885:684ad7d7d1d3
user: hubertf <hubertf%pkgsrc.org@localhost>
date: Sun Nov 21 03:50:45 2004 +0000
description:
Re-gen for notice on needed tools to update the pkgsrc guide
diffstat:
doc/pkgsrc.html | 62 ++++++++++++++++++++++++++++++++++++++------------------
doc/pkgsrc.txt | 33 ++++++++++++++++++++----------
2 files changed, 64 insertions(+), 31 deletions(-)
diffs (193 lines):
diff -r 09eb19efe331 -r 684ad7d7d1d3 doc/pkgsrc.html
--- a/doc/pkgsrc.html Sun Nov 21 03:50:09 2004 +0000
+++ b/doc/pkgsrc.html Sun Nov 21 03:50:45 2004 +0000
@@ -740,7 +740,7 @@
<dt><span class="sect1"><a href="#id2575861">D.1.
Targets</a></span></dt>
- <dt><span class="sect1"><a href="#id2576046">D.2.
+ <dt><span class="sect1"><a href="#id2576068">D.2.
Procedure</a></span></dt>
</dl>
</dd>
@@ -4250,7 +4250,7 @@
audit-packages installation procedure:</p>
<pre class="screen">
===========================================================================
-$NetBSD: faq.xml,v 1.1.1.1 2004/10/21 14:27:43 grant Exp $
+$NetBSD: faq.xml,v 1.2 2004/11/20 13:25:22 hubertf Exp $
You may wish to have the vulnerabilities file downloaded daily so that
it remains current. This may be done by adding an appropriate entry
@@ -10861,7 +10861,7 @@
<dt><span class="sect1"><a href="#id2575861">D.1.
Targets</a></span></dt>
- <dt><span class="sect1"><a href="#id2576046">D.2.
+ <dt><span class="sect1"><a href="#id2576068">D.2.
Procedure</a></span></dt>
</dl>
</div>
@@ -10905,6 +10905,18 @@
"emphasis"><em>must</em></span> make sure that your
changes haven't broken the build!</p>
</li>
+
+ <li>
+ <p><tt class=
+ "filename">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf</tt>:
+ PDF version of the pkgsrc guide.</p>
+ </li>
+
+ <li>
+ <p><tt class=
+ "filename">http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps</tt>:
+ PostScript version of the pkgsrc guide.</p>
+ </li>
</ul>
</div>
</div>
@@ -10914,8 +10926,8 @@
<div>
<div>
<h2 class="title" style="clear: both"><a name=
- "id2576046" id=
- "id2576046"></a>D.2. Procedure</h2>
+ "id2576068" id=
+ "id2576068"></a>D.2. Procedure</h2>
</div>
</div>
</div>
@@ -10925,28 +10937,38 @@
<div class="itemizedlist">
<ul type="disc">
<li>
- <p>Edit the XML file(s) in <tt class=
- "filename">pkgsrc/doc/guide/files</tt></p>
+ <p>Make sure you have the packages needed to
+ re-generate the pkgsrc guide (and other XML-based
+ NetBSD documentation) installed. These are
+ “<span class="quote">pkgsrc-doc</span>”
+ for creating the ASCII- and HTML-version, and
+ “<span class=
+ "quote">pkgsrc-doc-print</span>”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 <tt class=
+ "filename">pkgsrc/meta-pkgs/netbsd-doc</tt> and
+ <tt class=
+ "filename">pkgsrc/meta-pkgs/netbsd-doc-print</tt>.</p>
</li>
<li>
- <p>Run <span><b class="command">make
- do-lint</b></span> in <tt class=
+ <p>Edit the XML file(s) in <tt class=
+ "filename">pkgsrc/doc/guide/files</tt>.</p>
+ </li>
+
+ <li>
+ <p>Run <span><b class="command">make extract
+ && make do-lint</b></span> in <tt class=
"filename">pkgsrc/doc/guide</tt> to check the XML
- syntax, and fix it if needed</p>
+ syntax, and fix it if needed.</p>
</li>
<li>
<p>Run <span><b class="command">make</b></span> in
<tt class="filename">pkgsrc/doc/guide</tt> to build
- the HTML and ASCII version</p>
- </li>
-
- <li>
- <p>Run <span><b class="command">make
- OUTPUT=pdf</b></span> in <tt class=
- "filename">pkgsrc/doc/guide</tt> to build the PDF
- version.</p>
+ the HTML and ASCII version.</p>
</li>
<li>
@@ -10961,7 +10983,7 @@
</li>
<li>
- <p><span><b class="command">cvs commit
+ <p><span><b class="command">cvs commit -m re-generate
pkgsrc/doc/pkgsrc.{html,txt}</b></span></p>
</li>
@@ -10971,7 +10993,7 @@
pkgsrc guide automatically, also run <span><b class=
"command">make install-htdoc
HTDOCSDIR=../../../htdocs</b></span> (or similar,
- adjust <tt class="varname">HTDOCSDIR</tt>!)</p>
+ adjust <tt class="varname">HTDOCSDIR</tt>!).</p>
</li>
<li>
diff -r 09eb19efe331 -r 684ad7d7d1d3 doc/pkgsrc.txt
--- a/doc/pkgsrc.txt Sun Nov 21 03:50:09 2004 +0000
+++ b/doc/pkgsrc.txt Sun Nov 21 03:50:45 2004 +0000
@@ -1662,7 +1662,7 @@
procedure:
===========================================================================
-$NetBSD: faq.xml,v 1.1.1.1 2004/10/21 14:27:43 grant Exp $
+$NetBSD: faq.xml,v 1.2 2004/11/20 13:25:22 hubertf Exp $
You may wish to have the vulnerabilities file downloaded daily so that
it remains current. This may be done by adding an appropriate entry
@@ -4690,29 +4690,40 @@
server itself. This means you must make sure that your changes haven't
broken the build!
+ * http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf: PDF version of the
+ pkgsrc guide.
+
+ * http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps: PostScript version of
+ the pkgsrc guide.
+
D.2. Procedure
The procedure to edit the pkgsrc guide is:
- * Edit the XML file(s) in pkgsrc/doc/guide/files
-
- * Run make do-lint in pkgsrc/doc/guide to check the XML syntax, and fix it if
- needed
-
- * Run make in pkgsrc/doc/guide to build the HTML and ASCII version
-
- * Run make OUTPUT=pdf in pkgsrc/doc/guide to build the PDF version.
+ * Make sure you have the packages needed to re-generate the pkgsrc guide (and
+ other XML-based NetBSD documentation) installed. These are "pkgsrc-doc" for
+ creating the ASCII- and HTML-version, and "pkgsrc-doc-print"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 pkgsrc/meta-pkgs/netbsd-doc and pkgsrc/meta-pkgs/netbsd-doc-print.
+
+ * Edit the XML file(s) in pkgsrc/doc/guide/files.
+
+ * Run make extract && make do-lint in pkgsrc/doc/guide to check the XML
+ syntax, and fix it if needed.
+
+ * Run make in pkgsrc/doc/guide to build the HTML and ASCII version.
* If all is well, run make install-doc to put the generated files into pkgsrc
/doc.
* cvs commit pkgsrc/doc/guide/files
- * cvs commit pkgsrc/doc/pkgsrc.{html,txt}
+ * cvs commit -m re-generate pkgsrc/doc/pkgsrc.{html,txt}
* Until the webserver on www.NetBSD.org is really updated automatically to
pick up changes to the pkgsrc guide automatically, also run make
- install-htdoc HTDOCSDIR=../../../htdocs (or similar, adjust HTDOCSDIR!)
+ install-htdoc HTDOCSDIR=../../../htdocs (or similar, adjust HTDOCSDIR!).
* cvs commit htdocs/Documentation/pkgsrc
Home |
Main Index |
Thread Index |
Old Index