blob: 840e1dd24518d5b96837e0fb3c95ebac68339db8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
<!-- $NetBSD: editing.xml,v 1.14 2007/07/02 19:00:01 tnn Exp $ -->
<appendix id="editing">
<title>Editing guidelines for the pkgsrc guide</title>
<para>This section contains information on editing the pkgsrc
guide itself.</para>
<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>
<itemizedlist>
<listitem><para><filename>pkgsrc/doc/pkgsrc.txt</filename></para></listitem>
<listitem><para><filename>pkgsrc/doc/pkgsrc.html</filename></para></listitem>
<listitem><para><ulink
url="http://www.NetBSD.org/docs/pkgsrc/"/></para></listitem>
<listitem><para><ulink
url="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf"/>:
The PDF version of the pkgsrc guide.</para></listitem>
<listitem><para><ulink
url="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps"/>:
PostScript version of the pkgsrc guide.</para></listitem>
</itemizedlist>
</sect1>
<sect1 id="procedure">
<title>Procedure</title>
<para>The procedure to edit the pkgsrc guide is:</para>
<procedure>
<step><para>Make sure you have the packages needed to
regenerate 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>
<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>
<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>
<step><para><command>(cd files && cvs
commit)</command></para></step>
<step><para>Run <command>bmake clean && bmake</command> to
regenerate the output files with the proper RCS
Ids.</para></step>
<step><para>Run <command>bmake regen</command> to install and
commit the files in both <filename>pkgsrc/doc</filename> and
<filename>htdocs</filename>.</para>
<note><para>If you have added, removed or renamed some chapters,
you need to synchronize them using <command>cvs add</command> or
<command>cvs delete</command> in the htdocs
directory.</para></note>
</step>
</procedure>
</sect1>
</appendix>
|
