diff options
author | bacon <bacon@pkgsrc.org> | 2020-08-12 14:42:36 +0000 |
---|---|---|
committer | bacon <bacon@pkgsrc.org> | 2020-08-12 14:42:36 +0000 |
commit | 8130747ce0e6e9f1fcb8eab8eeb0ce88f4ccb00d (patch) | |
tree | e5982eb1b0b59fb7b51e07f5e0fb9a6c8395ca2a /doc/pkgsrc.txt | |
parent | 9d2999200cc3ab70fc45606f3c6c61ddb21b5ff1 (diff) | |
download | pkgsrc-8130747ce0e6e9f1fcb8eab8eeb0ce88f4ccb00d.tar.gz |
doc/pkgsrc.*: regen
Diffstat (limited to 'doc/pkgsrc.txt')
-rw-r--r-- | doc/pkgsrc.txt | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/doc/pkgsrc.txt b/doc/pkgsrc.txt index a3e725cea8a..d08a0817861 100644 --- a/doc/pkgsrc.txt +++ b/doc/pkgsrc.txt @@ -9826,26 +9826,30 @@ E.2. Procedure The procedure to edit the pkgsrc guide is: - 1. Make sure you have the packages needed to regenerate the pkgsrc guide (and + 1. Make sure you have checked out the htdocs repository into a sibling + directory of your pkgsrc directory. You will need the ability to commit + from both pkgsrc and htdocs. + + 2. 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. - 2. Run cd doc/guide to get to the right directory. All further steps will take + 3. Run cd doc/guide to get to the right directory. All further steps will take place here. - 3. Edit the XML file(s) in files/. + 4. Edit the XML file(s) in files/. - 4. Run bmake to check the pkgsrc guide for valid XML and to build the final + 5. 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/. - 5. (cd files && cvs commit) + 6. (cd files && cvs commit) - 6. Run bmake clean && bmake to regenerate the output files with the proper RCS + 7. Run bmake clean && bmake to regenerate the output files with the proper RCS Ids. - 7. Run bmake regen to install and commit the files in both pkgsrc/doc and + 8. Run bmake regen to install and commit the files in both pkgsrc/doc and htdocs. Note |