Annotation of htdocs/docs/pkgsrc/components.html, revision 1.35
1.32 sevan 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
1.1 dsieger 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>
1.28 leot 32: <dl class="toc">
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.30 rillig 35: <dt><span class="sect1"><a href="components.html#components.patches">11.3. <code class="filename">patches/*</code></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.21 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
1.21 wiz 123: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
124: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.35 ! leot 125: an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.1.2"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.21 wiz 126: help find the correct files to patch. It defaults to
127: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 128: </ul></div>
129: <p>The third section contains the following variables.
130: </p>
1.18 asau 131: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.12 wiz 132: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.9 jmcneill 133: address of the person who feels responsible for this package,
134: and who is most likely to look at problems or questions regarding
1.35 ! leot 135: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.1.2"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.9 jmcneill 136: Other developers may contact the <code class="varname">MAINTAINER</code>
137: before making changes to the package, but are not required to
138: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
139: to yourself. If you really can't maintain the package for future
140: updates, set it to
1.6 hubertf 141: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.12 wiz 142: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.9 jmcneill 143: of <code class="varname">MAINTAINER</code> when you do not want other
144: developers to update or change the package without contacting
145: you first. A package Makefile should contain one of
146: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
147: not both. </p></li>
1.12 wiz 148: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 149: find more information about the package.</p></li>
1.12 wiz 150: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 151: description of the package (should not include the package
152: name).</p></li>
1.33 leot 153: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
154: applicable for the package. See <a class="xref" href="fixes.html#handling-licenses" title="19.1.3. Handling licenses">Section 19.1.3, “Handling licenses”</a> for further details.</p></li>
1.1 dsieger 155: </ul></div>
156: <p>Other variables that affect the build:
157: </p>
1.18 asau 158: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 159: <p><code class="varname">WRKSRC</code>: The directory where the
160: interesting distribution files of the package are found. The
161: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
162: works for most packages.</p>
163: <p>If a package doesn't create a subdirectory for itself
164: (most GNU software does, for instance), but extracts itself in
165: the current directory, you should set
166: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
167: <p>If a package doesn't create a subdirectory with the
168: name of <code class="varname">DISTNAME</code> but some different name,
169: set <code class="varname">WRKSRC</code> to point to the proper name in
170: <code class="filename">${WRKDIR}</code>, for example
171: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.35 ! leot 172: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.1 dsieger 173: <p>The name of the working directory created by pkgsrc is
174: taken from the <code class="varname">WRKDIR_BASENAME</code>
175: variable. By default, its value is
176: <code class="filename">work</code>. If you want to use the same
177: pkgsrc tree for building different kinds of binary packages,
178: you can change the variable according to your needs. Two
179: other variables handle common cases of setting
180: <code class="varname">WRKDIR_BASENAME</code> individually. If
181: <code class="varname">OBJHOSTNAME</code> is defined in
1.6 hubertf 182: <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 183: the host's name is attached to the directory name. If
184: <code class="varname">OBJMACHINE</code> is defined, the platform name
185: is attached, which might look like
186: <code class="filename">work.i386</code> or
187: <code class="filename">work.sparc</code>.</p>
188: </li></ul></div>
189: <p>Please pay attention to the following gotchas:</p>
1.18 asau 190: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.12 wiz 191: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 192: installed in compressed form by the package. For packages using
193: BSD-style makefiles which honor MANZ, there is
194: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.12 wiz 195: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
196: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 197: below).</p></li>
1.12 wiz 198: <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 199: </ul></div>
200: </div>
1.18 asau 201: <div class="sect1">
1.1 dsieger 202: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 203: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 204: </h2></div></div></div>
205: <p>The <code class="filename">distinfo</code> file contains the message
206: digest, or checksum, of each distfile needed for the package. This
207: ensures that the distfiles retrieved from the Internet have not been
208: corrupted during transfer or altered by a malign force to introduce
1.30 rillig 209: a security hole. To provide maximum security, all distfiles are
210: protected using three different message digest algorithms (SHA1,
211: RMD160, SHA512), as well as the file size.</p>
1.1 dsieger 212: <p>The <code class="filename">distinfo</code> file also contains the
213: checksums for all the patches found in the
1.30 rillig 214: <code class="filename">patches</code> directory (see <a class="xref" href="components.html#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a>).</p>
1.1 dsieger 215: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.30 rillig 216: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1 dsieger 217: <p>Some packages have different sets of distfiles depending on
1.35 ! leot 218: the platform, for example <a href="https://cdn.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 219: <code class="filename">distinfo</code> file and care should be taken when
220: upgrading such a package to ensure distfile information is not
221: lost.</p>
222: </div>
1.18 asau 223: <div class="sect1">
1.1 dsieger 224: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.30 rillig 225: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
226: </h2></div></div></div>
227: <p>Some packages don't work out-of-the box on the various
228: platforms that are supported by pkgsrc. These packages need
229: to be patched to make them work. The patch files can be
1.1 dsieger 230: found in the <code class="filename">patches/</code> directory.</p>
231: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
232: applied to the files in <code class="varname">WRKSRC</code> directory after
1.30 rillig 233: extracting them, in alphabetic order.</p>
1.18 asau 234: <div class="sect2">
1.1 dsieger 235: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 236: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 237: <p>The <code class="filename">patch-*</code> files should be in
1.6 hubertf 238: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 239: problems. (To force patches to apply with fuzz you can set
240: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
241: should contain only changes for a single file, and no file should be
242: patched by more than one patch file. This helps to keep future
243: modifications simple.</p>
244: <p>Each patch file is structured as follows: In the first line,
245: there is the RCS Id of the patch itself. The second line should be
246: empty for aesthetic reasons. After that, there should be a comment for
247: each change that the patch does. There are a number of standard
248: cases:</p>
1.18 asau 249: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.12 wiz 250: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 251: mention the vulnerability ID (CAN, CVE).</p></li>
1.12 wiz 252: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 253: platform and other environment (for example, the compiler) that the
254: patch is needed for.</p></li>
255: </ul></div>
1.30 rillig 256: <p>The patch should be commented so that any
1.1 dsieger 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>
1.18 asau 262: <div class="sect2">
1.1 dsieger 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.35 ! leot 268: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.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.13 wiz 278: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
279: are replaced by new files, so carefully check if you want to take all
280: the changes.</p>
1.1 dsieger 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
1.12 wiz 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
1.13 wiz 291: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
292: Many packages still use the previous convention
293: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
294: but new patches should be of the form containing the filename.
1.35 ! leot 295: <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.13 wiz 296: automatically.</p>
1.1 dsieger 297: </div>
1.18 asau 298: <div class="sect2">
1.1 dsieger 299: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 300: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 301: <p>If you want to share patches between multiple packages
302: in pkgsrc, e.g. because they use the same distfiles, set
303: <code class="varname">PATCHDIR</code> to the path where the patch files
304: can be found, e.g.:</p>
305: <pre class="programlisting">
306: PATCHDIR= ${.CURDIR}/../xemacs/patches
307: </pre>
308: <p>Patch files that are distributed by the author or other
309: maintainers can be listed in
310: <code class="varname">PATCHFILES</code>.</p>
311: <p>If it is desired to store any patches that should not be
312: committed into pkgsrc, they can be kept outside the pkgsrc
313: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
314: directory tree there is expected to have the same
1.12 wiz 315: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 316: patches are expected to be stored inside these dirs (also
317: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
318: example, if you want to keep a private patch for
319: <code class="filename">pkgsrc/graphics/png</code>, keep it in
320: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
321: files in the named directory are expected to be patch files,
322: and <span class="emphasis"><em>they are applied after pkgsrc patches are
323: applied</em></span>.</p>
324: </div>
1.18 asau 325: <div class="sect2">
1.1 dsieger 326: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 327: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 328: <p>When fixing a portability issue in the code do not use
329: preprocessor magic to check for the current operating system nor
330: platform. Doing so hurts portability to other platforms because
331: the OS-specific details are not abstracted appropriately.</p>
332: <p>The general rule to follow is: instead of checking for the
333: operating system the application is being built on, check for the
334: specific <span class="emphasis"><em>features</em></span> you need. For example,
335: instead of assuming that kqueue is available under NetBSD and
336: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.9 jmcneill 337: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 338: yes, this generally involves patching the
1.6 hubertf 339: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 340: that prevents some OSes from adopting interfaces from other OSes
341: (e.g. Linux implementing kqueue), something that the above checks
342: cannot take into account.</p>
343: <p>Of course, checking for features generally involves more
344: work on the developer's side, but the resulting changes are
345: cleaner and there are chances they will work on many other
346: platforms. Not to mention that there are higher chances of being
347: later integrated into the mainstream sources. Remember:
348: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
349: <p>Some typical examples:</p>
350: <div class="table">
1.5 rillig 351: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.29 tnn 352: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1 dsieger 353: <colgroup>
354: <col>
355: <col>
356: <col>
357: </colgroup>
358: <thead><tr>
359: <th>Where</th>
360: <th>Incorrect</th>
361: <th>Correct</th>
362: </tr></thead>
363: <tbody>
364: <tr>
365: <td>configure script</td>
366: <td>
367: <pre class="programlisting">
368: case ${target_os} in
369: netbsd*) have_kvm=yes ;;
370: *) have_kvm=no ;;
371: esac
372: </pre>
373: </td>
374: <td>
375: <pre class="programlisting">
376: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
377: </pre>
378: </td>
379: </tr>
380: <tr>
381: <td>C source file</td>
382: <td>
383: <pre class="programlisting">
384: #if defined(__NetBSD__)
385: # include <sys/event.h>
386: #endif
387: </pre>
388: </td>
389: <td>
390: <pre class="programlisting">
391: #if defined(HAVE_SYS_EVENT_H)
392: # include <sys/event.h>
393: #endif
394: </pre>
395: </td>
396: </tr>
397: <tr>
398: <td>C source file</td>
399: <td>
400: <pre class="programlisting">
401: int
402: monitor_file(...)
403: {
404: #if defined(__NetBSD__)
405: int fd = kqueue();
406: ...
407: #else
408: ...
409: #endif
410: }
411: </pre>
412: </td>
413: <td>
414: <pre class="programlisting">
415: int
416: monitor_file(...)
417: {
418: #if defined(HAVE_KQUEUE)
419: int fd = kqueue();
420: ...
421: #else
1.31 rillig 422: ...
1.1 dsieger 423: #endif
424: }
425: </pre>
426: </td>
427: </tr>
428: </tbody>
429: </table></div>
430: </div>
431: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.6 hubertf 432: 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
433: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 434: 2</a>). It summarizes multiple details on how to make
435: software easier to package; all the suggestions in it were
436: collected from our experience in pkgsrc work, so they are possibly
437: helpful when creating patches too.</p>
438: </div>
1.18 asau 439: <div class="sect2">
1.1 dsieger 440: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 441: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 442: <p>Always, always, <span class="strong"><strong>always</strong></span>
443: feed back any <span class="emphasis"><em>portability fixes</em></span> or
444: improvements you do to a package to the mainstream developers.
445: This is the only way to get their attention on portability issues
446: and to ensure that future versions can be built out-of-the box on
447: NetBSD. Furthermore, any user that gets newer distfiles will get
448: the fixes straight from the packaged code.</p>
449: <p>This generally involves cleaning up the patches
450: (because sometimes the patches that are
1.17 wiz 451: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 452: appropriate trackers for the projects and working with the
453: mainstream authors to accept your changes. It is
454: <span class="emphasis"><em>extremely important</em></span> that you do it so that
455: the packages in pkgsrc are kept simple and thus further changes
456: can be done without much hassle.</p>
1.13 wiz 457: <p>When you have done this, please add a URL to the upstream
458: bug report to the patch comment.</p>
1.1 dsieger 459: <p>Support the idea of free software!</p>
460: </div>
461: </div>
1.18 asau 462: <div class="sect1">
1.1 dsieger 463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 464: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.18 asau 465: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 466: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
467: <dd><p>A multi-line description of the piece of software. This should include
468: any credits where they are due. Please bear in mind that others do not
469: share your sense of humour (or spelling idiosyncrasies), and that others
470: will read everything that you write here.</p></dd>
471: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
472: <dd><p>This file governs the files that are installed on your
473: system: all the binaries, manual pages, etc. There are other
474: directives which may be entered in this file, to control the
475: creation and deletion of directories, and the location of
1.6 hubertf 476: 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 477: information.</p></dd>
478: </dl></div>
479: </div>
1.18 asau 480: <div class="sect1">
1.1 dsieger 481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 482: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.18 asau 483: <div class="sect2">
1.1 dsieger 484: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 485: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.18 asau 486: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 487: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.15 wiz 488: <dd>
1.35 ! leot 489: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1 dsieger 490: First time after package extraction and before files are
491: moved in place, the second time after the files to install
492: are moved in place. This can be used to do any custom
493: procedures not possible with @exec commands in
1.35 ! leot 494: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
! 495: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.1.2"><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 496: Please note that you can modify variables in it easily by using
497: <code class="varname">FILES_SUBST</code> in the package's
498: <code class="filename">Makefile</code>:</p>
499: <pre class="programlisting">
500: FILES_SUBST+= SOMEVAR="somevalue"
501: </pre>
502: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
503: <code class="filename">INSTALL</code>. By default, substitution is
504: performed for <code class="varname">PREFIX</code>,
505: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
506: <code class="varname">VARBASE</code>, and a few others, type
507: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
508: complete list.</p>
509: </dd>
1.1 dsieger 510: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
511: <dd><p>This script is executed before and after any files are removed. It is
512: this script's responsibility to clean up any additional messy details
513: around the package's installation, since all pkg_delete knows is how to
514: delete the files created in the original distribution.
1.35 ! leot 515: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1.2"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
! 516: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.1.2"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.15 wiz 517: The same methods to replace variables can be used as for
518: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 519: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
520: <dd>
521: <p>This file is displayed after installation of the package.
522: Useful for things like legal notices on almost-free
523: software and hints for updating config files after
524: installing modules for apache, PHP etc.
525: Please note that you can modify variables in it easily by using
526: <code class="varname">MESSAGE_SUBST</code> in the package's
527: <code class="filename">Makefile</code>:</p>
528: <pre class="programlisting">
529: MESSAGE_SUBST+= SOMEVAR="somevalue"
530: </pre>
1.12 wiz 531: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 532: <code class="filename">MESSAGE</code>. By default, substitution is
533: performed for <code class="varname">PKGNAME</code>,
534: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.27 sevan 535: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 536: <code class="varname">PKG_SYSCONFDIR</code>,
537: <code class="varname">ROOT_GROUP</code>, and
1.11 jnemeth 538: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 539: <p>You can display a different or additional files by
540: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
541: default is <code class="filename">MESSAGE</code>, if the file
542: exists.</p>
543: </dd>
544: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.19 asau 545: <dd>
546: <p>This file is used by the alternatives framework.
547: It creates, configures, and destroys generic wrappers used to
548: run programs with similar interfaces.
549: See pkg_alternatives(8) from pkgtools/pkg_alternatives
550: for more information.</p>
551: <p>Each line of the file contains two filenames, first
552: the wrapper and then the alternative provided by the package.
553: Both paths are relative to <code class="varname">PREFIX</code>.</p>
554: </dd>
1.1 dsieger 555: </dl></div>
556: </div>
1.18 asau 557: <div class="sect2">
1.1 dsieger 558: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 559: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.18 asau 560: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 561: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
562: <dd><p>This file contains arbitrary things that could
563: also go into a <code class="filename">Makefile</code>, but its purpose is
564: to be used by more than one package. This file should only be
565: used when the packages that will use the file are known in
566: advance. For other purposes it is often better to write a
567: <code class="filename">*.mk</code> file and give it a good name that
568: describes what it does.</p></dd>
569: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
570: <dd><p>This file contains the dependency information
1.6 hubertf 571: 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 572: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
573: <dd><p>This file contains workarounds for compiler bugs
574: and similar things. It is included automatically by the pkgsrc
575: infrastructure, so you don't need an extra
576: <code class="literal">.include</code> line for
577: it.</p></dd>
578: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
579: <dd><p>This file contains the code for the
1.6 hubertf 580: 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 581: selected by the user. If a package has only one or two options,
582: it is equally acceptable to put the code directly into the
583: <code class="filename">Makefile</code>.</p></dd>
584: </dl></div>
585: </div>
1.18 asau 586: <div class="sect2">
1.1 dsieger 587: <div class="titlepage"><div><div><h3 class="title">
1.5 rillig 588: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.18 asau 589: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 590: <dt><span class="term"><code class="filename">README*</code></span></dt>
591: <dd><p>These files do not take place in the creation of
592: a package and thus are purely informative to the package
593: developer.</p></dd>
594: <dt><span class="term"><code class="filename">TODO</code></span></dt>
595: <dd><p>This file contains things that need to be done
596: to make the package even
597: better.</p></dd>
598: </dl></div>
599: </div>
600: </div>
1.18 asau 601: <div class="sect1">
1.1 dsieger 602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 603: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 604: </h2></div></div></div>
1.6 hubertf 605: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 606: unpacked into the directory denoted by
607: <code class="varname">WRKDIR</code>. It can be removed by running
1.6 hubertf 608: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 609: directory is also used to keep various timestamp files.
610: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
611: The default is <code class="filename">${.CURDIR}/work</code>
612: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
613: if <code class="varname">OBJMACHINE</code> is set.</p>
614: </div>
1.18 asau 615: <div class="sect1">
1.1 dsieger 616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.5 rillig 617: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 618: </h2></div></div></div>
619: <p>If you have any files that you wish to be placed in the package prior
620: to configuration or building, you could place these files here and use
1.6 hubertf 621: a <span class="command"><strong>${CP}</strong></span> command in the
1.12 wiz 622: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 623: this. Alternatively, you could simply diff the file against
624: <code class="filename">/dev/null</code> and use the patch mechanism to manage
625: the creation of this file.</p>
626: <p>If you want to share files in this way with other
627: packages, set the <code class="varname">FILESDIR</code> variable to point
628: to the other package's <code class="filename">files</code> directory,
629: e.g.:</p>
630: <pre class="programlisting">
631: FILESDIR=${.CURDIR}/../xemacs/files
632: </pre>
633: </div>
634: </div>
635: <div class="navfooter">
636: <hr>
637: <table width="100%" summary="Navigation footer">
638: <tr>
639: <td width="40%" align="left">
640: <a accesskey="p" href="creating.html">Prev</a> </td>
641: <td width="20%" align="center"><a accesskey="u" href="developers-guide.html">Up</a></td>
642: <td width="40%" align="right"> <a accesskey="n" href="makefile.html">Next</a>
643: </td>
644: </tr>
645: <tr>
1.5 rillig 646: <td width="40%" align="left" valign="top">Chapter 10. Creating a new pkgsrc package from scratch </td>
1.1 dsieger 647: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
1.12 wiz 648: <td width="40%" align="right" valign="top"> Chapter 12. Programming in <code class="filename">Makefile</code>s</td>
1.1 dsieger 649: </tr>
650: </table>
651: </div>
652: </body>
653: </html>
CVSweb <webmaster@jp.NetBSD.org>