blob: ddf471077d412c4d65b5c8b6820ae912587baa7c (
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
<!-- $NetBSD: editing.xml,v 1.7 2005/05/24 12:14:42 wiz 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>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>
<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>
<filename>http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf</filename>:
PDF version of the pkgsrc guide.
</para>
</listitem>
<listitem>
<para>
<filename>http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps</filename>:
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>
<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-version, and
<quote>netbsd-doc-print</quote>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
<filename>pkgsrc/meta-pkgs/netbsd-doc</filename> and
<filename>pkgsrc/meta-pkgs/netbsd-doc-print</filename>.
</para>
</listitem>
<listitem>
<para>
Edit the XML file(s) in
<filename>pkgsrc/doc/guide/files</filename>.
</para>
</listitem>
<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>
<listitem>
<para>
Run <command>make</command> in
<filename>pkgsrc/doc/guide</filename> to build the HTML and
ASCII version.
</para>
</listitem>
<listitem>
<para>
If all is well, run <command>make install-doc</command> to put
the generated files into <filename>pkgsrc/doc</filename>.
</para>
</listitem>
<listitem>
<para>
<command>cvs commit pkgsrc/doc/guide/files</command>
</para>
</listitem>
<listitem>
<para>
<command>cvs commit -m re-generate pkgsrc/doc/pkgsrc.{html,txt}</command>
</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-htdocs
HTDOCSDIR=../../../htdocs</command> (or similar, adjust
<varname>HTDOCSDIR</varname>!).
</para>
</listitem>
<listitem>
<para>
<command>cvs commit htdocs/Documentation/pkgsrc</command>
</para>
</listitem>
</itemizedlist>
</sect1>
</appendix>
|
