Annotation of htdocs/docs/pkgsrc/editing.html, revision 1.8
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>Appendix D. Editing guidelines for the pkgsrc guide</title>
1.6 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.4 rillig 8: <link rel="home" href="index.html" title="The pkgsrc guide">
1.1 dsieger 9: <link rel="up" href="index.html" title="The pkgsrc guide">
10: <link rel="prev" href="ftp-layout.html" title="Appendix C. Directory layout of the pkgsrc FTP server">
11: </head>
12: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13: <div class="navheader">
14: <table width="100%" summary="Navigation header">
15: <tr><th colspan="3" align="center">Appendix D. Editing guidelines for the pkgsrc guide</th></tr>
16: <tr>
17: <td width="20%" align="left">
18: <a accesskey="p" href="ftp-layout.html">Prev</a> </td>
19: <th width="60%" align="center"> </th>
20: <td width="20%" align="right"> </td>
21: </tr>
22: </table>
23: <hr>
24: </div>
1.7 asau 25: <div class="appendix">
26: <div class="titlepage"><div><div><h1 class="title">
27: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 28: <div class="toc">
29: <p><b>Table of Contents</b></p>
30: <dl>
31: <dt><span class="sect1"><a href="editing.html#targets">D.1. Make targets</a></span></dt>
32: <dt><span class="sect1"><a href="editing.html#procedure">D.2. Procedure</a></span></dt>
33: </dl>
34: </div>
35: <p>This section contains information on editing the pkgsrc
36: guide itself.</p>
1.7 asau 37: <div class="sect1">
1.1 dsieger 38: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
39: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
40: <p>The pkgsrc guide's source code is stored in
41: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
42: are created from it:</p>
1.7 asau 43: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.5 wiz 44: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
45: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
46: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
47: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1 dsieger 48: The PDF version of the pkgsrc guide.</p></li>
1.5 wiz 49: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1 dsieger 50: PostScript version of the pkgsrc guide.</p></li>
51: </ul></div>
52: </div>
1.7 asau 53: <div class="sect1">
1.1 dsieger 54: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
55: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
56: <p>The procedure to edit the pkgsrc guide is:</p>
1.5 wiz 57: <div class="procedure"><ol class="procedure" type="1">
1.7 asau 58: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 59: regenerate the pkgsrc guide (and other XML-based NetBSD
1.8 ! obache 60: documentation) installed. These are automatically installed when
! 61: you install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.7 asau 62: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 63: right directory. All further steps will take place
64: here.</p></li>
1.7 asau 65: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 66: <code class="filename">files/</code>.</p></li>
1.7 asau 67: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 68: guide for valid XML and to build the final output files. If you
69: get any errors at this stage, you can just edit the files, as
70: there are only symbolic links in the working directory, pointing
71: to the files in <code class="filename">files/</code>.</p></li>
1.7 asau 72: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 73: commit)</strong></span></p></li>
1.7 asau 74: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 75: regenerate the output files with the proper RCS
76: Ids.</p></li>
1.7 asau 77: <li class="step">
1.3 hubertf 78: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 79: commit the files in both <code class="filename">pkgsrc/doc</code> and
80: <code class="filename">htdocs</code>.</p>
1.7 asau 81: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 82: <h3 class="title">Note</h3>
83: <p>If you have added, removed or renamed some chapters,
1.3 hubertf 84: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
85: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 86: directory.</p>
87: </div>
88: </li>
89: </ol></div>
90: </div>
91: </div>
92: <div class="navfooter">
93: <hr>
94: <table width="100%" summary="Navigation footer">
95: <tr>
96: <td width="40%" align="left">
97: <a accesskey="p" href="ftp-layout.html">Prev</a> </td>
98: <td width="20%" align="center"> </td>
99: <td width="40%" align="right"> </td>
100: </tr>
101: <tr>
102: <td width="40%" align="left" valign="top">Appendix C. Directory layout of the pkgsrc FTP server </td>
103: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
104: <td width="40%" align="right" valign="top"> </td>
105: </tr>
106: </table>
107: </div>
108: </body>
109: </html>
CVSweb <webmaster@jp.NetBSD.org>