Editing guidelines for the pkgsrc guide
This section contains information on editing the pkgsrc
guide itself.
Make targets
The pkgsrc guide's source code is stored in
pkgsrc/doc/guide/files, and several files
are created from it:
pkgsrc/doc/pkgsrc.txt
pkgsrc/doc/pkgsrc.html
:
The PDF version of the pkgsrc guide.
:
PostScript version of the pkgsrc guide.
Procedure
The procedure to edit the pkgsrc guide is:
Make sure you have the packages needed to
regenerate the pkgsrc guide (and other XML-based NetBSD
documentation) installed. These are automatically installed when
you install the meta-pkgs/pkgsrc-guide-tools package.
Run cd doc/guide to get to the
right directory. All further steps will take place
here.
Edit the XML file(s) in
files/.
Run bmake 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 files/.
(cd files && cvs
commit)
Run bmake clean && bmake to
regenerate the output files with the proper RCS
Ids.
Run bmake regen to install and
commit the files in both pkgsrc/doc and
htdocs.
If you have added, removed or renamed some chapters,
you need to synchronize them using cvs add or
cvs delete in the htdocs
directory.