pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc/guide/files Updated the chapter on editing the pkg...
details: https://anonhg.NetBSD.org/pkgsrc/rev/57e8584b1a7c
branches: trunk
changeset: 515280:57e8584b1a7c
user: rillig <rillig%pkgsrc.org@localhost>
date: Fri Jun 30 09:25:34 2006 +0000
description:
Updated the chapter on editing the pkgsrc guide. It had been outdated.
diffstat:
doc/guide/files/editing.xml | 190 ++++++++++++++++---------------------------
1 files changed, 71 insertions(+), 119 deletions(-)
diffs (218 lines):
diff -r 05ef9f8ecf00 -r 57e8584b1a7c doc/guide/files/editing.xml
--- a/doc/guide/files/editing.xml Fri Jun 30 08:58:16 2006 +0000
+++ b/doc/guide/files/editing.xml Fri Jun 30 09:25:34 2006 +0000
@@ -1,143 +1,95 @@
-<!-- $NetBSD: editing.xml,v 1.10 2006/02/12 14:44:59 rillig Exp $ -->
+<!-- $NetBSD: editing.xml,v 1.11 2006/06/30 09:25:34 rillig Exp $ -->
<appendix id="editing">
- <title>Editing guidelines for the pkgsrc guide</title>
+<title>Editing guidelines for the pkgsrc guide</title>
- <para>
- This section contains information on editing the pkgsrc guide
- itself.
- </para>
+ <para>This section contains information on editing the pkgsrc
+ guide itself.</para>
- <sect1 id="targets">
- <title>Targets</title>
+<sect1 id="targets">
+<title>Make targets</title>
- <para>
- The pkgsrc guide's source code is stored in
- <filename>pkgsrc/doc/guide/files</filename>, and several files are
- created from it:
- </para>
+ <para>The pkgsrc guide's source code is stored in
+ <filename>pkgsrc/doc/guide/files</filename>, and several files
+ are created from it:</para>
- <itemizedlist>
- <listitem>
- <para>
- <filename>pkgsrc/doc/pkgsrc.txt</filename>
- </para>
- </listitem>
+ <itemizedlist>
- <listitem>
- <para>
- <filename>pkgsrc/doc/pkgsrc.html</filename>
- </para>
- </listitem>
+ <listitem><para><filename>pkgsrc/doc/pkgsrc.txt</filename></para></listitem>
+
+ <listitem><para><filename>pkgsrc/doc/pkgsrc.html</filename></para></listitem>
- <listitem>
- <para>
- <filename>http://www.NetBSD.org/Documentation/pkgsrc/</filename>:
- the documentation on the NetBSD website will be built from
- pkgsrc and kept up to date on the web server itself. This
- means you <emphasis>must</emphasis> make sure that your
- changes haven't broken the build!
- </para>
- </listitem>
+ <listitem><para><ulink
+ url="http://www.NetBSD.org/Documentation/pkgsrc/"/></para></listitem>
+
+ <listitem><para><ulink
+ url="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf"/>:
+ The PDF version of the pkgsrc guide.</para></listitem>
- <listitem>
- <para>
- <filename>http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf</filename>:
- PDF version of the pkgsrc guide.
- </para>
- </listitem>
+ <listitem><para><ulink
+ url="http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps"/>:
+ PostScript version of the pkgsrc guide.</para></listitem>
+
+ </itemizedlist>
- <listitem>
- <para>
- <filename>http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps</filename>:
- PostScript version of the pkgsrc guide.
- </para>
- </listitem>
- </itemizedlist>
- </sect1>
+</sect1>
+<sect1 id="procedure">
+<title>Procedure</title>
- <sect1 id="procedure">
- <title>Procedure</title>
+ <para>The procedure to edit the pkgsrc guide is:</para>
- <para>
- The procedure to edit the pkgsrc guide is:
- </para>
+ <procedure>
- <itemizedlist>
- <listitem>
- <para>
- Make sure you have the packages needed to re-generate the
- pkgsrc guide (and other XML-based NetBSD documentation)
- installed. These are <quote>netbsd-doc</quote> for creating the
- ASCII and HTML versions, and
- <quote>netbsd-doc-print</quote> for the PostScript and PDF
- versions. 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>
+ <step><para>Make sure you have the packages needed to
+ re-generate the pkgsrc guide (and other XML-based NetBSD
+ documentation) installed. These are <filename
+ role="pkg">meta-pkgs/netbsd-doc</filename> for creating the
+ ASCII and HTML versions, and <filename
+ role="pkg">meta-pkgs/netbsd-doc-print</filename> for the
+ PostScript and PDF versions. You will need both packages
+ installed, to make sure documentation is consistent across all
+ formats.</para></step>
- <listitem>
- <para>
- Edit the XML file(s) in
- <filename>pkgsrc/doc/guide/files</filename>.
- </para>
- </listitem>
+ <step><para>Run <command>cd doc/guide</command> to get to the
+ right directory. All further steps will take place
+ here.</para></step>
+
+ <step><para>Edit the XML file(s) in
+ <filename>files/</filename>.</para></step>
- <listitem>
- <para>
- 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>
+ <step><para>Run <command>bmake</command> to check the pkgsrc
+ guide for valid XML and to build the final output files. If you
+ get any errors at this stage, you can just edit the files, as
+ there are only symbolic links in the working directory, pointing
+ to the files in <filename>files/</filename>.</para></step>
- <listitem>
- <para>
- Run <command>make</command> in
- <filename>pkgsrc/doc/guide</filename> to build the HTML and
- ASCII version.
- </para>
- </listitem>
+ <step><para><command>(cd files && cvs
+ commit)</command></para></step>
- <listitem>
- <para>
- If all is well, run <command>make install-doc</command> to put
- the generated files into <filename>pkgsrc/doc</filename>.
- </para>
- </listitem>
+ <step><para>Run <command>bmake clean && bmake</command> to
+ regenerate the output files with the proper RCS
+ Ids.</para></step>
- <listitem>
- <para>
- <command>cvs commit pkgsrc/doc/guide/files</command>
- </para>
- </listitem>
+ <step><para>Run <command>(cd .. && cvs update pkgsrc.*)
+ && bmake install-doc</command> to put the generated
+ files into <filename>pkgsrc/doc</filename>.</para></step>
- <listitem>
- <para>
- <command>cvs commit -m re-generate pkgsrc/doc/pkgsrc.{html,txt}</command>
- </para>
- </listitem>
+ <step><para>Run <command>(cd .. && cvs commit -m
+ "regenerated." pkgsrc.{html,txt})</command> to commit the
+ generated documentation.</para></step>
- <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-htdocs
- HTDOCSDIR=../../../htdocs</command> (or similar, adjust
- <varname>HTDOCSDIR</varname>!).
- </para>
- </listitem>
+ <step><para>Run <command>(cd
+ ../../../htdocs/Documentation/pkgsrc && cvs update)
+ && bmake install-htdocs</command> to generate all the
+ files for the web server.</para></step>
- <listitem>
- <para>
- <command>cvs commit htdocs/Documentation/pkgsrc</command>
- </para>
- </listitem>
+ <step><para>Run <command>(cd
+ ../../../htdocs/Documentation/pkgsrc && cvs commit -m
+ "regenerated.")</command> to update the files on the web server.
+ If you have added a chapter, don't forget to run <command>cvs
+ add *.html</command> before you commit the files.</para></step>
- </itemizedlist>
+ </procedure>
- </sect1>
+</sect1>
</appendix>
Home |
Main Index |
Thread Index |
Old Index