Annotation of htdocs/docs/pkgsrc/components.html, revision 1.7
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">
1.5 rillig 5: <title>Chapter 11. Package components - files, directories and contents</title>
1.2 rillig 6: <link rel="stylesheet" href="/global.css" type="text/css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <link rel="start" href="index.html" title="The pkgsrc guide">
9: <link rel="up" href="developers-guide.html" title="Part II. The pkgsrc developer's guide">
1.5 rillig 10: <link rel="prev" href="creating.html" title="Chapter 10. Creating a new pkgsrc package from scratch">
11: <link rel="next" href="makefile.html" title="Chapter 12. Programming in Makefiles">
1.1 dsieger 12: </head>
13: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14: <div class="navheader">
15: <table width="100%" summary="Navigation header">
1.5 rillig 16: <tr><th colspan="3" align="center">Chapter 11. Package components - files, directories and contents</th></tr>
1.1 dsieger 17: <tr>
18: <td width="20%" align="left">
19: <a accesskey="p" href="creating.html">Prev</a> </td>
20: <th width="60%" align="center">Part II. The pkgsrc developer's guide</th>
21: <td width="20%" align="right"> <a accesskey="n" href="makefile.html">Next</a>
22: </td>
23: </tr>
24: </table>
25: <hr>
26: </div>
27: <div class="chapter" lang="en">
28: <div class="titlepage"><div><div><h2 class="title">
1.5 rillig 29: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 30: <div class="toc">
31: <p><b>Table of Contents</b></p>
32: <dl>
1.5 rillig 33: <dt><span class="sect1"><a href="components.html#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
34: <dt><span class="sect1"><a href="components.html#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
35: <dt><span class="sect1"><a href="components.html#components.patches">11.3. patches/*</a></span></dt>
1.1 dsieger 36: <dd><dl>
1.5 rillig 37: <dt><span class="sect2"><a href="components.html#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
38: <dt><span class="sect2"><a href="components.html#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
39: <dt><span class="sect2"><a href="components.html#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
40: <dt><span class="sect2"><a href="components.html#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
41: <dt><span class="sect2"><a href="components.html#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 42: </dl></dd>
1.5 rillig 43: <dt><span class="sect1"><a href="components.html#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
44: <dt><span class="sect1"><a href="components.html#components.optional">11.5. Optional files</a></span></dt>
1.1 dsieger 45: <dd><dl>
1.5 rillig 46: <dt><span class="sect2"><a href="components.html#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
47: <dt><span class="sect2"><a href="components.html#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
48: <dt><span class="sect2"><a href="components.html#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 49: </dl></dd>
1.5 rillig 50: <dt><span class="sect1"><a href="components.html#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
51: <dt><span class="sect1"><a href="components.html#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 52: </dl>
53: </div>
54: <p>Whenever you're preparing a package, there are a number of
55: files involved which are described in the following
56: sections.</p>
57: <div class="sect1" lang="en">
58: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 59: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 60: </h2></div></div></div>
61: <p>Building, installation and creation of a binary package are all
62: controlled by the package's <code class="filename">Makefile</code>.
63: The <code class="filename">Makefile</code> describes various things about
64: a package, for example from where to get it, how to configure,
65: build, and install it.</p>
66: <p>A package <code class="filename">Makefile</code> contains several
67: sections that describe the package.</p>
68: <p>In the first section there are the following variables, which
69: should appear exactly in the order given here. The order and
70: grouping of the variables is mostly historical and has no further
71: meaning.</p>
72: <div class="itemizedlist"><ul type="disc">
73: <li><p><code class="varname">DISTNAME</code> is the basename of the
74: distribution file to be downloaded from the package's
75: website.</p></li>
76: <li><p><code class="varname">PKGNAME</code> is the name of the
77: package, as used by pkgsrc. You only need to provide it if
78: <code class="varname">DISTNAME</code> (which is the default) is not a good
79: name for the package in pkgsrc. Usually it is the pkgsrc
80: directory name together with the version number. It must match the
81: regular expression
82: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
83: starts with a letter or digit, and contains only letters, digits,
84: dashes, underscores, dots and plus signs.</p></li>
85: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
86: the package file to create if the <code class="varname">PKGNAME</code>
87: isn't unique on a SVR4 system. The default is
88: <code class="varname">PKGNAME</code>, which may be shortened when you use
89: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>. Only add
90: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
91: does not produce an unique package name on a SVR4 system.
92: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
93: characters.</p></li>
94: <li>
95: <p><code class="varname">CATEGORIES</code> is a list of categories
96: which the package fits in. You can choose any of the top-level
97: directories of pkgsrc for it.</p>
98: <p>Currently the following values are available for
99: <code class="varname">CATEGORIES</code>. If more than
100: one is used, they need to be separated by spaces:</p>
101: <pre class="programlisting">
102: archivers cross geography meta-pkgs security
103: audio databases graphics misc shells
104: benchmarks devel ham multimedia sysutils
105: biology editors inputmethod net textproc
106: cad emulators lang news time
107: chat finance mail parallel wm
108: comms fonts math pkgtools www
109: converters games mbone print x11
110: </pre>
111: </li>
112: <li><p><code class="varname">MASTER_SITES</code>,
113: <code class="varname">DYNAMIC_MASTER_SITES</code>,
114: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
115: and <code class="varname">DISTFILES</code> are discussed in detail in
1.6 hubertf 116: <a class="xref" href="build.html#build.fetch" title="17.5. The fetch phase">Section 17.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.1 dsieger 117: </ul></div>
118: <p>The second section contains information about separately
119: downloaded patches, if any.
120: </p>
121: <div class="itemizedlist"><ul type="disc">
122: <li><p><code class="varname">PATCHFILES:</code>
123: Name(s) of additional files that contain distribution patches.
124: There is no default. pkgsrc will look for them at
125: <code class="varname">PATCH_SITES</code>.
126: They will automatically be uncompressed before patching if
127: the names end with <code class="filename">.gz</code> or
128: <code class="filename">.Z</code>.</p></li>
129: <li><p><code class="varname">PATCH_SITES</code>:
130: Primary location(s) for distribution patch files (see
131: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
132: </ul></div>
133: <p>The third section contains the following variables.
134: </p>
135: <div class="itemizedlist"><ul type="disc">
136: <li><p><code class="varname">MAINTAINER</code> is the email address
137: of the person who feels responsible for this package, and who is
138: most likely to look at problems or questions regarding this
1.6 hubertf 139: package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>. Other
1.1 dsieger 140: developers should contact the <code class="varname">MAINTAINER</code> before
141: making major changes to the package. When packaging a new program,
142: set <code class="varname">MAINTAINER</code> to yourself. If you really can't
143: maintain the package for future updates, set it to
1.6 hubertf 144: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.1 dsieger 145: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
146: find more information about the package.</p></li>
147: <li><p><code class="varname">COMMENT</code> is a one-line
148: description of the package (should not include the package
149: name).</p></li>
150: </ul></div>
151: <p>Other variables that affect the build:
152: </p>
153: <div class="itemizedlist"><ul type="disc"><li>
154: <p><code class="varname">WRKSRC</code>: The directory where the
155: interesting distribution files of the package are found. The
156: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
157: works for most packages.</p>
158: <p>If a package doesn't create a subdirectory for itself
159: (most GNU software does, for instance), but extracts itself in
160: the current directory, you should set
161: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
162: <p>If a package doesn't create a subdirectory with the
163: name of <code class="varname">DISTNAME</code> but some different name,
164: set <code class="varname">WRKSRC</code> to point to the proper name in
165: <code class="filename">${WRKDIR}</code>, for example
166: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
167: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
168: <p>The name of the working directory created by pkgsrc is
169: taken from the <code class="varname">WRKDIR_BASENAME</code>
170: variable. By default, its value is
171: <code class="filename">work</code>. If you want to use the same
172: pkgsrc tree for building different kinds of binary packages,
173: you can change the variable according to your needs. Two
174: other variables handle common cases of setting
175: <code class="varname">WRKDIR_BASENAME</code> individually. If
176: <code class="varname">OBJHOSTNAME</code> is defined in
1.6 hubertf 177: <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 178: the host's name is attached to the directory name. If
179: <code class="varname">OBJMACHINE</code> is defined, the platform name
180: is attached, which might look like
181: <code class="filename">work.i386</code> or
182: <code class="filename">work.sparc</code>.</p>
183: </li></ul></div>
184: <p>Please pay attention to the following gotchas:</p>
185: <div class="itemizedlist"><ul type="disc">
186: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
187: installed in compressed form by the package. For packages using
188: BSD-style makefiles which honor MANZ, there is
189: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
190: <li><p>Replace <code class="filename">/usr/local</code> with
191: “<span class="quote">${PREFIX}</span>” in all files (see patches,
192: below).</p></li>
1.6 hubertf 193: <li><p>If the package installs any info files, see <a class="xref" href="fixes.html#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, “Packages installing info files”</a>.</p></li>
1.1 dsieger 194: </ul></div>
195: </div>
196: <div class="sect1" lang="en">
197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 198: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 199: </h2></div></div></div>
200: <p>The <code class="filename">distinfo</code> file contains the message
201: digest, or checksum, of each distfile needed for the package. This
202: ensures that the distfiles retrieved from the Internet have not been
203: corrupted during transfer or altered by a malign force to introduce
204: a security hole. Due to recent rumor about weaknesses of digest
205: algorithms, all distfiles are protected using both SHA1 and RMD160
206: message digests, as well as the file size.</p>
207: <p>The <code class="filename">distinfo</code> file also contains the
208: checksums for all the patches found in the
1.6 hubertf 209: <code class="filename">patches</code> directory (see <a class="xref" href="components.html#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
1.1 dsieger 210: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.6 hubertf 211: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1 dsieger 212: command.</p>
213: <p>Some packages have different sets of distfiles depending on
214: the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/navigator/README.html" target="_top"><code class="filename">www/navigator</code></a>). These are kept in the same
215: <code class="filename">distinfo</code> file and care should be taken when
216: upgrading such a package to ensure distfile information is not
217: lost.</p>
218: </div>
219: <div class="sect1" lang="en">
220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 221: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1 dsieger 222: <p>Many packages still don't work out-of-the box on the various
223: platforms that are supported by pkgsrc. Therefore, a number of custom
224: patch files are needed to make the package work. These patch files are
225: found in the <code class="filename">patches/</code> directory.</p>
226: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
227: applied to the files in <code class="varname">WRKSRC</code> directory after
1.6 hubertf 228: extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.1 dsieger 229: order</a>, so <code class="filename">patch-aa</code> is applied before
230: <code class="filename">patch-ab</code>, etc.</p>
231: <div class="sect2" lang="en">
232: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 233: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 234: <p>The <code class="filename">patch-*</code> files should be in
1.6 hubertf 235: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 236: problems. (To force patches to apply with fuzz you can set
237: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
238: should contain only changes for a single file, and no file should be
239: patched by more than one patch file. This helps to keep future
240: modifications simple.</p>
241: <p>Each patch file is structured as follows: In the first line,
242: there is the RCS Id of the patch itself. The second line should be
243: empty for aesthetic reasons. After that, there should be a comment for
244: each change that the patch does. There are a number of standard
245: cases:</p>
246: <div class="itemizedlist"><ul type="disc">
247: <li><p>Patches that replace the <code class="literal">==</code>
1.6 hubertf 248: operator for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?test+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">test</span>(1)</span></a> with <code class="literal">=</code> in shell scripts
1.7 ! rillig 249: are so common that they don't need a comment at all.</p></li>
1.1 dsieger 250: <li><p>Patches for commonly known vulnerabilities should
251: mention the vulnerability ID (CAN, CVE).</p></li>
252: <li><p>Patches that change source code should mention the
253: platform and other environment (for example, the compiler) that the
254: patch is needed for.</p></li>
255: </ul></div>
256: <p>In all other cases, the patch should be commented so that any
257: developer who knows the code of the application can make some use of
258: the patch. Special care should be taken for the upstream developers,
259: since we generally want that they accept our patches, so we have less
260: work in the future.</p>
261: </div>
262: <div class="sect2" lang="en">
263: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 264: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 265: <p>One important thing to mention is to pay attention that no RCS
266: IDs get stored in the patch files, as these will cause problems when
267: later checked into the NetBSD CVS tree. Use the
1.6 hubertf 268: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.1 dsieger 269: problems.</p>
270: <p>For even more automation, we recommend using
1.6 hubertf 271: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 272: whole set of patches. You just have to backup files before you
273: edit them to <code class="filename">filename.orig</code>, e.g. with
1.6 hubertf 274: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
275: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 276: you upgrade a package this way, you can easily compare the new
277: set of patches with the previously existing one with
1.6 hubertf 278: <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.1 dsieger 279: or update from the <code class="filename">work/.newpatches</code>
280: directory to <code class="filename">patches/</code>.</p>
281: <p>When you have finished a package, remember to generate
1.6 hubertf 282: the checksums for the patch files by using the <span class="command"><strong>make
283: makepatchsum</strong></span> command, see <a class="xref" href="components.html#components.distinfo" title="11.2. distinfo">Section 11.2, “<code class="filename">distinfo</code>”</a>.</p>
1.1 dsieger 284: <p>When adding a patch that corrects a problem in the
285: distfile (rather than e.g. enforcing pkgsrc's view of where
286: man pages should go), send the patch as a bug report to the
287: maintainer. This benefits non-pkgsrc users of the package,
288: and usually makes it possible to remove the patch in future
289: version.</p>
1.2 rillig 290: <p>The file names of the patch files are usually of the form
291: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.1 dsieger 292: </div>
293: <div class="sect2" lang="en">
294: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 295: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 296: <p>If you want to share patches between multiple packages
297: in pkgsrc, e.g. because they use the same distfiles, set
298: <code class="varname">PATCHDIR</code> to the path where the patch files
299: can be found, e.g.:</p>
300: <pre class="programlisting">
301: PATCHDIR= ${.CURDIR}/../xemacs/patches
302: </pre>
303: <p>Patch files that are distributed by the author or other
304: maintainers can be listed in
305: <code class="varname">PATCHFILES</code>.</p>
306: <p>If it is desired to store any patches that should not be
307: committed into pkgsrc, they can be kept outside the pkgsrc
308: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
309: directory tree there is expected to have the same
310: “<span class="quote">category/package</span>” structure as pkgsrc, and
311: patches are expected to be stored inside these dirs (also
312: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
313: example, if you want to keep a private patch for
314: <code class="filename">pkgsrc/graphics/png</code>, keep it in
315: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
316: files in the named directory are expected to be patch files,
317: and <span class="emphasis"><em>they are applied after pkgsrc patches are
318: applied</em></span>.</p>
319: </div>
320: <div class="sect2" lang="en">
321: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 322: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 323: <p>When fixing a portability issue in the code do not use
324: preprocessor magic to check for the current operating system nor
325: platform. Doing so hurts portability to other platforms because
326: the OS-specific details are not abstracted appropriately.</p>
327: <p>The general rule to follow is: instead of checking for the
328: operating system the application is being built on, check for the
329: specific <span class="emphasis"><em>features</em></span> you need. For example,
330: instead of assuming that kqueue is available under NetBSD and
331: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.7 ! rillig 332: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 333: yes, this generally involves patching the
1.6 hubertf 334: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 335: that prevents some OSes from adopting interfaces from other OSes
336: (e.g. Linux implementing kqueue), something that the above checks
337: cannot take into account.</p>
338: <p>Of course, checking for features generally involves more
339: work on the developer's side, but the resulting changes are
340: cleaner and there are chances they will work on many other
341: platforms. Not to mention that there are higher chances of being
342: later integrated into the mainstream sources. Remember:
343: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
344: <p>Some typical examples:</p>
345: <div class="table">
1.5 rillig 346: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1 dsieger 347: <div class="table-contents"><table summary="Patching examples" border="1">
348: <colgroup>
349: <col>
350: <col>
351: <col>
352: </colgroup>
353: <thead><tr>
354: <th>Where</th>
355: <th>Incorrect</th>
356: <th>Correct</th>
357: </tr></thead>
358: <tbody>
359: <tr>
360: <td>configure script</td>
361: <td>
362: <pre class="programlisting">
363: case ${target_os} in
364: netbsd*) have_kvm=yes ;;
365: *) have_kvm=no ;;
366: esac
367: </pre>
368: </td>
369: <td>
370: <pre class="programlisting">
371: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
372: </pre>
373: </td>
374: </tr>
375: <tr>
376: <td>C source file</td>
377: <td>
378: <pre class="programlisting">
379: #if defined(__NetBSD__)
380: # include <sys/event.h>
381: #endif
382: </pre>
383: </td>
384: <td>
385: <pre class="programlisting">
386: #if defined(HAVE_SYS_EVENT_H)
387: # include <sys/event.h>
388: #endif
389: </pre>
390: </td>
391: </tr>
392: <tr>
393: <td>C source file</td>
394: <td>
395: <pre class="programlisting">
396: int
397: monitor_file(...)
398: {
399: #if defined(__NetBSD__)
400: int fd = kqueue();
401: ...
402: #else
403: ...
404: #endif
405: }
406: </pre>
407: </td>
408: <td>
409: <pre class="programlisting">
410: int
411: monitor_file(...)
412: {
413: #if defined(HAVE_KQUEUE)
414: int fd = kqueue();
415: ...
416: #else
417: ...
418: #endif
419: }
420: </pre>
421: </td>
422: </tr>
423: </tbody>
424: </table></div>
425: </div>
426: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.6 hubertf 427: packager-friendly software</em></span> article (<a class="ulink" href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
428: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 429: 2</a>). It summarizes multiple details on how to make
430: software easier to package; all the suggestions in it were
431: collected from our experience in pkgsrc work, so they are possibly
432: helpful when creating patches too.</p>
433: </div>
434: <div class="sect2" lang="en">
435: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 436: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 437: <p>Always, always, <span class="strong"><strong>always</strong></span>
438: feed back any <span class="emphasis"><em>portability fixes</em></span> or
439: improvements you do to a package to the mainstream developers.
440: This is the only way to get their attention on portability issues
441: and to ensure that future versions can be built out-of-the box on
442: NetBSD. Furthermore, any user that gets newer distfiles will get
443: the fixes straight from the packaged code.</p>
444: <p>This generally involves cleaning up the patches
445: (because sometimes the patches that are
446: added to pkgsrc are quick hacks), filling bug reports in the
447: appropriate trackers for the projects and working with the
448: mainstream authors to accept your changes. It is
449: <span class="emphasis"><em>extremely important</em></span> that you do it so that
450: the packages in pkgsrc are kept simple and thus further changes
451: can be done without much hassle.</p>
452: <p>Support the idea of free software!</p>
453: </div>
454: </div>
455: <div class="sect1" lang="en">
456: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 457: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.1 dsieger 458: <div class="variablelist"><dl>
459: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
460: <dd><p>A multi-line description of the piece of software. This should include
461: any credits where they are due. Please bear in mind that others do not
462: share your sense of humour (or spelling idiosyncrasies), and that others
463: will read everything that you write here.</p></dd>
464: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
465: <dd><p>This file governs the files that are installed on your
466: system: all the binaries, manual pages, etc. There are other
467: directives which may be entered in this file, to control the
468: creation and deletion of directories, and the location of
1.6 hubertf 469: inserted files. See <a class="xref" href="plist.html" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1 dsieger 470: information.</p></dd>
471: </dl></div>
472: </div>
473: <div class="sect1" lang="en">
474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 475: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.1 dsieger 476: <div class="sect2" lang="en">
477: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 478: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.1 dsieger 479: <div class="variablelist"><dl>
480: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.6 hubertf 481: <dd><p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1 dsieger 482: First time after package extraction and before files are
483: moved in place, the second time after the files to install
484: are moved in place. This can be used to do any custom
485: procedures not possible with @exec commands in
1.6 hubertf 486: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
487: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information. See also <a class="xref" href="pkginstall.html#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a>.</p></dd>
1.1 dsieger 488: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
489: <dd><p>This script is executed before and after any files are removed. It is
490: this script's responsibility to clean up any additional messy details
491: around the package's installation, since all pkg_delete knows is how to
492: delete the files created in the original distribution.
1.6 hubertf 493: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
494: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.</p></dd>
1.1 dsieger 495: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
496: <dd>
497: <p>This file is displayed after installation of the package.
498: Useful for things like legal notices on almost-free
499: software and hints for updating config files after
500: installing modules for apache, PHP etc.
501: Please note that you can modify variables in it easily by using
502: <code class="varname">MESSAGE_SUBST</code> in the package's
503: <code class="filename">Makefile</code>:</p>
504: <pre class="programlisting">
505: MESSAGE_SUBST+= SOMEVAR="somevalue"
506: </pre>
507: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
508: <code class="filename">MESSAGE</code>. By default, substitution is
509: performed for <code class="varname">PKGNAME</code>,
510: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
511: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
512: <code class="varname">X11BASE</code>,
513: <code class="varname">PKG_SYSCONFDIR</code>,
514: <code class="varname">ROOT_GROUP</code>, and
515: <code class="varname">ROOT_GROUP</code>.</p>
516: <p>You can display a different or additional files by
517: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
518: default is <code class="filename">MESSAGE</code>, if the file
519: exists.</p>
520: </dd>
521: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
522: <dd><p>FIXME: There is no documentation on the
523: alternatives framework.</p></dd>
524: </dl></div>
525: </div>
526: <div class="sect2" lang="en">
527: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 528: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.1 dsieger 529: <div class="variablelist"><dl>
530: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
531: <dd><p>This file contains arbitrary things that could
532: also go into a <code class="filename">Makefile</code>, but its purpose is
533: to be used by more than one package. This file should only be
534: used when the packages that will use the file are known in
535: advance. For other purposes it is often better to write a
536: <code class="filename">*.mk</code> file and give it a good name that
537: describes what it does.</p></dd>
538: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
539: <dd><p>This file contains the dependency information
1.6 hubertf 540: for the buildlink3 framework (see <a class="xref" href="buildlink.html" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.1 dsieger 541: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
542: <dd><p>This file contains workarounds for compiler bugs
543: and similar things. It is included automatically by the pkgsrc
544: infrastructure, so you don't need an extra
545: <code class="literal">.include</code> line for
546: it.</p></dd>
547: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
548: <dd><p>This file contains the code for the
1.6 hubertf 549: package-specific options (see <a class="xref" href="options.html" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.1 dsieger 550: selected by the user. If a package has only one or two options,
551: it is equally acceptable to put the code directly into the
552: <code class="filename">Makefile</code>.</p></dd>
553: </dl></div>
554: </div>
555: <div class="sect2" lang="en">
556: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 557: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.1 dsieger 558: <div class="variablelist"><dl>
559: <dt><span class="term"><code class="filename">README*</code></span></dt>
560: <dd><p>These files do not take place in the creation of
561: a package and thus are purely informative to the package
562: developer.</p></dd>
563: <dt><span class="term"><code class="filename">TODO</code></span></dt>
564: <dd><p>This file contains things that need to be done
565: to make the package even
566: better.</p></dd>
567: </dl></div>
568: </div>
569: </div>
570: <div class="sect1" lang="en">
571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 572: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 573: </h2></div></div></div>
1.6 hubertf 574: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 575: unpacked into the directory denoted by
576: <code class="varname">WRKDIR</code>. It can be removed by running
1.6 hubertf 577: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 578: directory is also used to keep various timestamp files.
579: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
580: The default is <code class="filename">${.CURDIR}/work</code>
581: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
582: if <code class="varname">OBJMACHINE</code> is set.</p>
583: </div>
584: <div class="sect1" lang="en">
585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 586: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 587: </h2></div></div></div>
588: <p>If you have any files that you wish to be placed in the package prior
589: to configuration or building, you could place these files here and use
1.6 hubertf 590: a <span class="command"><strong>${CP}</strong></span> command in the
1.1 dsieger 591: “<span class="quote">pre-configure</span>” target to achieve
592: this. Alternatively, you could simply diff the file against
593: <code class="filename">/dev/null</code> and use the patch mechanism to manage
594: the creation of this file.</p>
595: <p>If you want to share files in this way with other
596: packages, set the <code class="varname">FILESDIR</code> variable to point
597: to the other package's <code class="filename">files</code> directory,
598: e.g.:</p>
599: <pre class="programlisting">
600: FILESDIR=${.CURDIR}/../xemacs/files
601: </pre>
602: </div>
603: </div>
604: <div class="navfooter">
605: <hr>
606: <table width="100%" summary="Navigation footer">
607: <tr>
608: <td width="40%" align="left">
609: <a accesskey="p" href="creating.html">Prev</a> </td>
610: <td width="20%" align="center"><a accesskey="u" href="developers-guide.html">Up</a></td>
611: <td width="40%" align="right"> <a accesskey="n" href="makefile.html">Next</a>
612: </td>
613: </tr>
614: <tr>
1.5 rillig 615: <td width="40%" align="left" valign="top">Chapter 10. Creating a new pkgsrc package from scratch </td>
1.1 dsieger 616: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
1.5 rillig 617: <td width="40%" align="right" valign="top"> Chapter 12. Programming in <code class="filename">Makefile</code>s</td>
1.1 dsieger 618: </tr>
619: </table>
620: </div>
621: </body>
622: </html>
CVSweb <webmaster@jp.NetBSD.org>