Annotation of htdocs/docs/pkgsrc/components.html, revision 1.20
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.14 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.10 rillig 8: <link rel="home" href="index.html" title="The pkgsrc guide">
1.1 dsieger 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>
1.18 asau 27: <div class="chapter">
1.1 dsieger 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.12 wiz 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>
1.5 rillig 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.12 wiz 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>
1.18 asau 57: <div class="sect1">
1.1 dsieger 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>
1.18 asau 72: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.12 wiz 73: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 74: distribution file to be downloaded from the package's
75: website.</p></li>
1.12 wiz 76: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.19 asau 77: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 78: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.19 asau 79: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
80: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 81: directory name together with the version number. It must match the
82: regular expression
83: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
84: starts with a letter or digit, and contains only letters, digits,
85: dashes, underscores, dots and plus signs.</p></li>
1.12 wiz 86: <li class="listitem">
1.1 dsieger 87: <p><code class="varname">CATEGORIES</code> is a list of categories
88: which the package fits in. You can choose any of the top-level
89: directories of pkgsrc for it.</p>
90: <p>Currently the following values are available for
91: <code class="varname">CATEGORIES</code>. If more than
92: one is used, they need to be separated by spaces:</p>
93: <pre class="programlisting">
94: archivers cross geography meta-pkgs security
95: audio databases graphics misc shells
96: benchmarks devel ham multimedia sysutils
97: biology editors inputmethod net textproc
98: cad emulators lang news time
99: chat finance mail parallel wm
100: comms fonts math pkgtools www
101: converters games mbone print x11
102: </pre>
103: </li>
1.12 wiz 104: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 105: <code class="varname">DYNAMIC_MASTER_SITES</code>,
106: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
107: and <code class="varname">DISTFILES</code> are discussed in detail in
1.12 wiz 108: <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 109: </ul></div>
110: <p>The second section contains information about separately
111: downloaded patches, if any.
112: </p>
1.18 asau 113: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.12 wiz 114: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.1 dsieger 115: Name(s) of additional files that contain distribution patches.
116: There is no default. pkgsrc will look for them at
117: <code class="varname">PATCH_SITES</code>.
118: They will automatically be uncompressed before patching if
119: the names end with <code class="filename">.gz</code> or
120: <code class="filename">.Z</code>.</p></li>
1.12 wiz 121: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 122: Primary location(s) for distribution patch files (see
123: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
124: </ul></div>
125: <p>The third section contains the following variables.
126: </p>
1.18 asau 127: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.12 wiz 128: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.9 jmcneill 129: address of the person who feels responsible for this package,
130: and who is most likely to look at problems or questions regarding
1.16 dholland 131: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.9 jmcneill 132: Other developers may contact the <code class="varname">MAINTAINER</code>
133: before making changes to the package, but are not required to
134: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
135: to yourself. If you really can't maintain the package for future
136: updates, set it to
1.6 hubertf 137: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.12 wiz 138: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.9 jmcneill 139: of <code class="varname">MAINTAINER</code> when you do not want other
140: developers to update or change the package without contacting
141: you first. A package Makefile should contain one of
142: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
143: not both. </p></li>
1.12 wiz 144: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 145: find more information about the package.</p></li>
1.12 wiz 146: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 147: description of the package (should not include the package
148: name).</p></li>
149: </ul></div>
150: <p>Other variables that affect the build:
151: </p>
1.18 asau 152: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 153: <p><code class="varname">WRKSRC</code>: The directory where the
154: interesting distribution files of the package are found. The
155: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
156: works for most packages.</p>
157: <p>If a package doesn't create a subdirectory for itself
158: (most GNU software does, for instance), but extracts itself in
159: the current directory, you should set
160: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
161: <p>If a package doesn't create a subdirectory with the
162: name of <code class="varname">DISTNAME</code> but some different name,
163: set <code class="varname">WRKSRC</code> to point to the proper name in
164: <code class="filename">${WRKDIR}</code>, for example
165: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
166: <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>
167: <p>The name of the working directory created by pkgsrc is
168: taken from the <code class="varname">WRKDIR_BASENAME</code>
169: variable. By default, its value is
170: <code class="filename">work</code>. If you want to use the same
171: pkgsrc tree for building different kinds of binary packages,
172: you can change the variable according to your needs. Two
173: other variables handle common cases of setting
174: <code class="varname">WRKDIR_BASENAME</code> individually. If
175: <code class="varname">OBJHOSTNAME</code> is defined in
1.6 hubertf 176: <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 177: the host's name is attached to the directory name. If
178: <code class="varname">OBJMACHINE</code> is defined, the platform name
179: is attached, which might look like
180: <code class="filename">work.i386</code> or
181: <code class="filename">work.sparc</code>.</p>
182: </li></ul></div>
183: <p>Please pay attention to the following gotchas:</p>
1.18 asau 184: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.12 wiz 185: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 186: installed in compressed form by the package. For packages using
187: BSD-style makefiles which honor MANZ, there is
188: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.12 wiz 189: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
190: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 191: below).</p></li>
1.12 wiz 192: <li class="listitem"><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 193: </ul></div>
194: </div>
1.18 asau 195: <div class="sect1">
1.1 dsieger 196: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 197: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 198: </h2></div></div></div>
199: <p>The <code class="filename">distinfo</code> file contains the message
200: digest, or checksum, of each distfile needed for the package. This
201: ensures that the distfiles retrieved from the Internet have not been
202: corrupted during transfer or altered by a malign force to introduce
203: a security hole. Due to recent rumor about weaknesses of digest
204: algorithms, all distfiles are protected using both SHA1 and RMD160
205: message digests, as well as the file size.</p>
206: <p>The <code class="filename">distinfo</code> file also contains the
207: checksums for all the patches found in the
1.6 hubertf 208: <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 209: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.6 hubertf 210: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1 dsieger 211: command.</p>
212: <p>Some packages have different sets of distfiles depending on
1.12 wiz 213: the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.1 dsieger 214: <code class="filename">distinfo</code> file and care should be taken when
215: upgrading such a package to ensure distfile information is not
216: lost.</p>
217: </div>
1.18 asau 218: <div class="sect1">
1.1 dsieger 219: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 220: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1 dsieger 221: <p>Many packages still don't work out-of-the box on the various
222: platforms that are supported by pkgsrc. Therefore, a number of custom
223: patch files are needed to make the package work. These patch files are
224: found in the <code class="filename">patches/</code> directory.</p>
225: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
226: applied to the files in <code class="varname">WRKSRC</code> directory after
1.6 hubertf 227: 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.13 wiz 228: order</a>.</p>
1.18 asau 229: <div class="sect2">
1.1 dsieger 230: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 231: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 232: <p>The <code class="filename">patch-*</code> files should be in
1.6 hubertf 233: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 234: problems. (To force patches to apply with fuzz you can set
235: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
236: should contain only changes for a single file, and no file should be
237: patched by more than one patch file. This helps to keep future
238: modifications simple.</p>
239: <p>Each patch file is structured as follows: In the first line,
240: there is the RCS Id of the patch itself. The second line should be
241: empty for aesthetic reasons. After that, there should be a comment for
242: each change that the patch does. There are a number of standard
243: cases:</p>
1.18 asau 244: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.12 wiz 245: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 246: mention the vulnerability ID (CAN, CVE).</p></li>
1.12 wiz 247: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 248: platform and other environment (for example, the compiler) that the
249: patch is needed for.</p></li>
250: </ul></div>
1.13 wiz 251: <p>In all, the patch should be commented so that any
1.1 dsieger 252: developer who knows the code of the application can make some use of
253: the patch. Special care should be taken for the upstream developers,
254: since we generally want that they accept our patches, so we have less
255: work in the future.</p>
256: </div>
1.18 asau 257: <div class="sect2">
1.1 dsieger 258: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 259: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 260: <p>One important thing to mention is to pay attention that no RCS
261: IDs get stored in the patch files, as these will cause problems when
262: later checked into the NetBSD CVS tree. Use the
1.6 hubertf 263: <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 264: problems.</p>
265: <p>For even more automation, we recommend using
1.6 hubertf 266: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 267: whole set of patches. You just have to backup files before you
268: edit them to <code class="filename">filename.orig</code>, e.g. with
1.6 hubertf 269: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
270: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 271: you upgrade a package this way, you can easily compare the new
272: set of patches with the previously existing one with
1.13 wiz 273: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
274: are replaced by new files, so carefully check if you want to take all
275: the changes.</p>
1.1 dsieger 276: <p>When you have finished a package, remember to generate
1.6 hubertf 277: the checksums for the patch files by using the <span class="command"><strong>make
1.12 wiz 278: 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 279: <p>When adding a patch that corrects a problem in the
280: distfile (rather than e.g. enforcing pkgsrc's view of where
281: man pages should go), send the patch as a bug report to the
282: maintainer. This benefits non-pkgsrc users of the package,
283: and usually makes it possible to remove the patch in future
284: version.</p>
1.2 rillig 285: <p>The file names of the patch files are usually of the form
1.13 wiz 286: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
287: Many packages still use the previous convention
288: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
289: but new patches should be of the form containing the filename.
290: <span class="command"><strong>mkpatches</strong></span> included in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
291: automatically.</p>
1.1 dsieger 292: </div>
1.18 asau 293: <div class="sect2">
1.1 dsieger 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
1.12 wiz 310: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 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>
1.18 asau 320: <div class="sect2">
1.1 dsieger 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.9 jmcneill 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>
1.18 asau 434: <div class="sect2">
1.1 dsieger 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
1.17 wiz 446: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 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>
1.13 wiz 452: <p>When you have done this, please add a URL to the upstream
453: bug report to the patch comment.</p>
1.1 dsieger 454: <p>Support the idea of free software!</p>
455: </div>
456: </div>
1.18 asau 457: <div class="sect1">
1.1 dsieger 458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 459: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.18 asau 460: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 461: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
462: <dd><p>A multi-line description of the piece of software. This should include
463: any credits where they are due. Please bear in mind that others do not
464: share your sense of humour (or spelling idiosyncrasies), and that others
465: will read everything that you write here.</p></dd>
466: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
467: <dd><p>This file governs the files that are installed on your
468: system: all the binaries, manual pages, etc. There are other
469: directives which may be entered in this file, to control the
470: creation and deletion of directories, and the location of
1.6 hubertf 471: 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 472: information.</p></dd>
473: </dl></div>
474: </div>
1.18 asau 475: <div class="sect1">
1.1 dsieger 476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 477: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.18 asau 478: <div class="sect2">
1.1 dsieger 479: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 480: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.18 asau 481: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 482: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.15 wiz 483: <dd>
1.16 dholland 484: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1 dsieger 485: First time after package extraction and before files are
486: moved in place, the second time after the files to install
487: are moved in place. This can be used to do any custom
488: procedures not possible with @exec commands in
1.16 dholland 489: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
490: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><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>.
1.15 wiz 491: Please note that you can modify variables in it easily by using
492: <code class="varname">FILES_SUBST</code> in the package's
493: <code class="filename">Makefile</code>:</p>
494: <pre class="programlisting">
495: FILES_SUBST+= SOMEVAR="somevalue"
496: </pre>
497: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
498: <code class="filename">INSTALL</code>. By default, substitution is
499: performed for <code class="varname">PREFIX</code>,
500: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
501: <code class="varname">VARBASE</code>, and a few others, type
502: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
503: complete list.</p>
504: </dd>
1.1 dsieger 505: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
506: <dd><p>This script is executed before and after any files are removed. It is
507: this script's responsibility to clean up any additional messy details
508: around the package's installation, since all pkg_delete knows is how to
509: delete the files created in the original distribution.
1.16 dholland 510: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
511: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.15 wiz 512: The same methods to replace variables can be used as for
513: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 514: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
515: <dd>
516: <p>This file is displayed after installation of the package.
517: Useful for things like legal notices on almost-free
518: software and hints for updating config files after
519: installing modules for apache, PHP etc.
520: Please note that you can modify variables in it easily by using
521: <code class="varname">MESSAGE_SUBST</code> in the package's
522: <code class="filename">Makefile</code>:</p>
523: <pre class="programlisting">
524: MESSAGE_SUBST+= SOMEVAR="somevalue"
525: </pre>
1.12 wiz 526: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 527: <code class="filename">MESSAGE</code>. By default, substitution is
528: performed for <code class="varname">PKGNAME</code>,
529: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
530: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
531: <code class="varname">X11BASE</code>,
532: <code class="varname">PKG_SYSCONFDIR</code>,
533: <code class="varname">ROOT_GROUP</code>, and
1.11 jnemeth 534: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 535: <p>You can display a different or additional files by
536: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
537: default is <code class="filename">MESSAGE</code>, if the file
538: exists.</p>
539: </dd>
540: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.19 asau 541: <dd>
542: <p>This file is used by the alternatives framework.
543: It creates, configures, and destroys generic wrappers used to
544: run programs with similar interfaces.
545: See pkg_alternatives(8) from pkgtools/pkg_alternatives
546: for more information.</p>
547: <p>Each line of the file contains two filenames, first
548: the wrapper and then the alternative provided by the package.
549: Both paths are relative to <code class="varname">PREFIX</code>.</p>
550: </dd>
1.1 dsieger 551: </dl></div>
552: </div>
1.18 asau 553: <div class="sect2">
1.1 dsieger 554: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 555: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.18 asau 556: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 557: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
558: <dd><p>This file contains arbitrary things that could
559: also go into a <code class="filename">Makefile</code>, but its purpose is
560: to be used by more than one package. This file should only be
561: used when the packages that will use the file are known in
562: advance. For other purposes it is often better to write a
563: <code class="filename">*.mk</code> file and give it a good name that
564: describes what it does.</p></dd>
565: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
566: <dd><p>This file contains the dependency information
1.6 hubertf 567: 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 568: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
569: <dd><p>This file contains workarounds for compiler bugs
570: and similar things. It is included automatically by the pkgsrc
571: infrastructure, so you don't need an extra
572: <code class="literal">.include</code> line for
573: it.</p></dd>
574: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
575: <dd><p>This file contains the code for the
1.6 hubertf 576: 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 577: selected by the user. If a package has only one or two options,
578: it is equally acceptable to put the code directly into the
579: <code class="filename">Makefile</code>.</p></dd>
580: </dl></div>
581: </div>
1.18 asau 582: <div class="sect2">
1.1 dsieger 583: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 584: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.18 asau 585: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 586: <dt><span class="term"><code class="filename">README*</code></span></dt>
587: <dd><p>These files do not take place in the creation of
588: a package and thus are purely informative to the package
589: developer.</p></dd>
590: <dt><span class="term"><code class="filename">TODO</code></span></dt>
591: <dd><p>This file contains things that need to be done
592: to make the package even
593: better.</p></dd>
594: </dl></div>
595: </div>
596: </div>
1.18 asau 597: <div class="sect1">
1.1 dsieger 598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 599: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 600: </h2></div></div></div>
1.6 hubertf 601: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 602: unpacked into the directory denoted by
603: <code class="varname">WRKDIR</code>. It can be removed by running
1.6 hubertf 604: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 605: directory is also used to keep various timestamp files.
606: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
607: The default is <code class="filename">${.CURDIR}/work</code>
608: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
609: if <code class="varname">OBJMACHINE</code> is set.</p>
610: </div>
1.18 asau 611: <div class="sect1">
1.1 dsieger 612: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 613: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 614: </h2></div></div></div>
615: <p>If you have any files that you wish to be placed in the package prior
616: to configuration or building, you could place these files here and use
1.6 hubertf 617: a <span class="command"><strong>${CP}</strong></span> command in the
1.12 wiz 618: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 619: this. Alternatively, you could simply diff the file against
620: <code class="filename">/dev/null</code> and use the patch mechanism to manage
621: the creation of this file.</p>
622: <p>If you want to share files in this way with other
623: packages, set the <code class="varname">FILESDIR</code> variable to point
624: to the other package's <code class="filename">files</code> directory,
625: e.g.:</p>
626: <pre class="programlisting">
627: FILESDIR=${.CURDIR}/../xemacs/files
628: </pre>
629: </div>
630: </div>
631: <div class="navfooter">
632: <hr>
633: <table width="100%" summary="Navigation footer">
634: <tr>
635: <td width="40%" align="left">
636: <a accesskey="p" href="creating.html">Prev</a> </td>
637: <td width="20%" align="center"><a accesskey="u" href="developers-guide.html">Up</a></td>
638: <td width="40%" align="right"> <a accesskey="n" href="makefile.html">Next</a>
639: </td>
640: </tr>
641: <tr>
1.5 rillig 642: <td width="40%" align="left" valign="top">Chapter 10. Creating a new pkgsrc package from scratch </td>
1.1 dsieger 643: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
1.12 wiz 644: <td width="40%" align="right" valign="top"> Chapter 12. Programming in <code class="filename">Makefile</code>s</td>
1.1 dsieger 645: </tr>
646: </table>
647: </div>
648: </body>
649: </html>
CVSweb <webmaster@jp.NetBSD.org>