Annotation of htdocs/docs/pkgsrc/creating.html, revision 1.134
1.120 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.128 rillig 5: <title>Chapter 12. Creating a new pkgsrc package from scratch</title>
1.26 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.15 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.128 rillig 10: <link rel="prev" href="help-devel.html" title="Chapter 11. Getting help">
11: <link rel="next" href="components.html" title="Chapter 13. Package components - files, directories and contents">
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.128 rillig 16: <tr><th colspan="3" align="center">Chapter 12. Creating a new pkgsrc package from scratch</th></tr>
1.1 dsieger 17: <tr>
18: <td width="20%" align="left">
1.128 rillig 19: <a accesskey="p" href="help-devel.html">Prev</a> </td>
1.1 dsieger 20: <th width="60%" align="center">Part II. The pkgsrc developer's guide</th>
21: <td width="20%" align="right"> <a accesskey="n" href="components.html">Next</a>
22: </td>
23: </tr>
24: </table>
25: <hr>
26: </div>
1.42 asau 27: <div class="chapter">
1.1 dsieger 28: <div class="titlepage"><div><div><h2 class="title">
1.128 rillig 29: <a name="creating"></a>Chapter 12. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 30: <div class="toc">
31: <p><b>Table of Contents</b></p>
1.100 leot 32: <dl class="toc">
1.128 rillig 33: <dt><span class="sect1"><a href="creating.html#creating.common">12.1. Common types of packages</a></span></dt>
1.1 dsieger 34: <dd><dl>
1.128 rillig 35: <dt><span class="sect2"><a href="creating.html#creating.perl-module">12.1.1. Perl modules</a></span></dt>
36: <dt><span class="sect2"><a href="creating.html#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.132 brook 37: <dt><span class="sect2"><a href="creating.html#creating.R-package">12.1.3. R packages</a></span></dt>
38: <dt><span class="sect2"><a href="creating.html#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1 dsieger 39: </dl></dd>
1.128 rillig 40: <dt><span class="sect1"><a href="creating.html#creating.examples">12.2. Examples</a></span></dt>
41: <dd><dl><dt><span class="sect2"><a href="creating.html#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.1 dsieger 42: </dl>
43: </div>
44: <p>When you find a package that is not yet in pkgsrc, you
45: most likely have a URL from where you can download the source
46: code. Starting with this URL, creating a package involves only a
47: few steps.</p>
1.24 wiz 48: <div class="procedure"><ol class="procedure" type="1">
1.126 leot 49: <li class="step"><p>First, install the packages <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.42 asau 50: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 51: category in which you want to place your package. You can also create a
52: directory of your own (maybe called <code class="filename">local</code>). In that
53: category directory, create another directory for your package and change
54: into it.</p></li>
1.42 asau 55: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 56: you for a URL. Enter the URL of the distribution file (in most cases a
57: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
58: of your package are created automatically. The distribution file is
59: extracted automatically to fill in some details in the
60: <code class="filename">Makefile</code> that would otherwise have to be done
61: manually.</p></li>
1.42 asau 62: <li class="step">
1.1 dsieger 63: <p>Examine the extracted files to determine the dependencies of
64: your package. Ideally, this is mentioned in some
65: <code class="filename">README</code> file, but things may differ. For each of
66: these dependencies, look where it exists in pkgsrc, and if there is a
67: file called <code class="filename">buildlink3.mk</code> in that directory, add a
68: line to your package <code class="filename">Makefile</code> which includes that
69: file just before the last line. If the
1.26 spz 70: <code class="filename">buildlink3.mk</code> file does not exist, it must be
1.133 leot 71: created first. The <code class="filename">buildlink3.mk</code> file makes sure
72: that the package's include files and libraries are provided.</p>
1.26 spz 73: <p>If you just need binaries from a package, add a
1.1 dsieger 74: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
75: version of the dependency and where it can be found in pkgsrc. This line
76: should be placed in the third paragraph. If the dependency is only
77: needed for building the package, but not when using it, use
1.129 leot 78: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
79: instead of <code class="varname">DEPENDS</code>.
80: The difference between <code class="varname">TOOL_DEPENDS</code> and
81: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
82: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
83: packages, i.e. packages for the architecture where the package
84: is built;
85: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
86: packages, i.e. packages for the architecture for which the package
1.134 ! gutterid 87: is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
! 88: to specify a dependency used only for testing the resulting package
! 89: built, using the upstream project's included test suite.
1.1 dsieger 90: Your package may then look like this:</p>
91: <pre class="programlisting">
92: [...]
93:
1.129 leot 94: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 95: DEPENDS+= screen-[0-9]*:../../misc/screen
96: DEPENDS+= screen>=4.0:../../misc/screen
97:
98: [...]
99:
100: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
101: .include "../../devel/glib2/buildlink3.mk"
102: .include "../../mk/bsd.pkg.mk"
103: </pre>
104: </li>
1.42 asau 105: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.24 wiz 106: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.10 hubertf 107: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
108: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 109: -e</strong></span>, which outputs additional
110: explanations.</p></li>
1.42 asau 111: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.128 rillig 112: find instructions for the most common cases in the next section, <a class="xref" href="creating.html#creating.common" title="12.1. Common types of packages">Section 12.1, “Common types of packages”</a>. After you have followed the instructions
1.1 dsieger 113: over there, you can hopefully continue here.</p></li>
1.42 asau 114: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 115: directory from the extracted files. Besides these files, a lot of cache
116: files and other system information has been saved in the working
117: directory, which may become wrong after you edited the
118: <code class="filename">Makefile</code>.</p></li>
1.42 asau 119: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.128 rillig 120: the various things that can go wrong in this phase, consult <a class="xref" href="fixes.html" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.42 asau 121: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 122: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 123: everything works.</p></li>
1.42 asau 124: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 125: contains a list of the files that are installed by the package, is
1.10 hubertf 126: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 127: >PLIST</strong></span> to generate a probably correct list. Check
128: the file using your preferred text editor to see if the list of
129: files looks plausible.</p></li>
1.42 asau 130: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 131: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.42 asau 132: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 133: has been registered in the database of installed files, but with an
1.10 hubertf 134: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
135: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 136: registered with the list of files from
137: <code class="filename">PLIST</code>.</p></li>
1.42 asau 138: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 139: package from the set of installed files.</p></li>
140: </ol></div>
1.42 asau 141: <div class="sect1">
1.1 dsieger 142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.128 rillig 143: <a name="creating.common"></a>12.1. Common types of packages</h2></div></div></div>
1.42 asau 144: <div class="sect2">
1.1 dsieger 145: <div class="titlepage"><div><div><h3 class="title">
1.128 rillig 146: <a name="creating.perl-module"></a>12.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 147: <p>Simple Perl modules are handled automatically by
1.10 hubertf 148: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 149: </div>
1.42 asau 150: <div class="sect2">
1.1 dsieger 151: <div class="titlepage"><div><div><h3 class="title">
1.128 rillig 152: <a name="creating.python-module"></a>12.1.2. Python modules and programs</h3></div></div></div>
1.17 imil 153: <p>Python modules and programs packages are easily created using a
154: set of predefined variables.</p>
155: <p>
1.63 wiz 156: If some Python versions are not supported by the software, set the
157: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
158: that are not supported, e.g.
1.17 imil 159: </p>
160: <pre class="programlisting">
1.93 sevan 161: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 162: </pre>
163: <p>
1.103 wiz 164: If the packaged software is a Python module, include one of
165: <code class="filename">../../lang/python/egg.mk</code>,
166: <code class="filename">../../lang/python/distutils.mk</code>, or
167: <code class="filename">../../lang/python/extension.mk</code>.</p>
168: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
169: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
1.134 ! gutterid 170: If the packaged software is using setuptools, you only need
1.103 wiz 171: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
172: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
1.134 ! gutterid 173: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>,
1.103 wiz 174: so pkgsrc will use this framework.
1.134 ! gutterid 175: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>;
1.103 wiz 176: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
177: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
178: to the name of the script.</p>
179: <p>Either way, the package directory should be called
1.24 wiz 180: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
181: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 182: </p>
183: <pre class="programlisting">
184: DISTNAME= foopymodule-1.2.10
185: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
186: </pre>
1.63 wiz 187: <p>If it is an application, include
188: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
189: In order to correctly set the path to the Python interpreter, use the
1.17 imil 190: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.36 wiz 191: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 192: For example:
1.17 imil 193: </p>
194: <pre class="programlisting">
1.36 wiz 195: REPLACE_PYTHON= *.py
1.17 imil 196: </pre>
1.63 wiz 197: <p>Some Python modules have separate distributions for Python-2.x
198: and Python-3.x support. In pkgsrc this is handled by the
199: <code class="filename">versioned_dependencies.mk</code> file. Set
200: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
201: packages that should be depended upon and include
202: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
203: then the pkgsrc infrastructure will depend on the appropriate package
204: version. For example:
205: </p>
206: <pre class="programlisting">
1.125 wiz 207: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.63 wiz 208: </pre>
209: <p>
210: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
211: of supported packages.</p>
1.17 imil 212: </div>
1.132 brook 213: <div class="sect2">
214: <div class="titlepage"><div><div><h3 class="title">
215: <a name="creating.R-package"></a>12.1.3. R packages</h3></div></div></div>
216: <p>Simple R packages from <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>
217: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
218: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/README.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
219: Individual packages (and optionally their dependencies) may be created
220: and updated. R packages generally follow the same form, and most of
221: the relevant information needed is contained in a
222: <code class="filename">DESCRIPTION</code> file as part of each R package on
223: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
224: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
225: creates or updates a package in the canonical form. The resulting
226: package should be reviewed for correctness.</p>
227: </div>
228: <div class="sect2">
229: <div class="titlepage"><div><div><h3 class="title">
230: <a name="creating.TeX-package"></a>12.1.4. TeXlive packages</h3></div></div></div>
231: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
232: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/README.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
233: <p>If the TeXlive package name is not known, it may be useful to
234: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
235: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
236: identifies the basename of the package file in the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
237: archive</a>.</p>
238: <p>If the TeXlive package name is known, download the files from
239: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
240: archive</a>. For package <code class="filename">foo</code>, you will need
241: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
242: also have associated documentation packages, so download
243: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
244: should be placed in the appropriate category directory, which is often
245: but not always <code class="filename">print</code>. Then run the following
246: command in the category directory.</p>
247: <pre class="programlisting">
248: texlive2pkg foo.tar.xz foo.doc.tar.xz
249: </pre>
250: <p>This will create two packages, <code class="filename">tex-foo</code> and
251: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
252: are correct.</p>
253: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
254: currently does not include version information in package filenames
255: and changes their contents periodically when updates occur.
256: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
257: pkgsrc archives. For each new or updated TeXlive package, e.g., the
258: main one and the corresponding documentation, upload the distfiles
259: with the following command in each package directory.</p>
260: <pre class="programlisting">
261: make upload-distfiles
262: </pre>
263: </div>
1.1 dsieger 264: </div>
1.42 asau 265: <div class="sect1">
1.1 dsieger 266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.128 rillig 267: <a name="creating.examples"></a>12.2. Examples</h2></div></div></div>
1.42 asau 268: <div class="sect2">
1.1 dsieger 269: <div class="titlepage"><div><div><h3 class="title">
1.128 rillig 270: <a name="creating.nvu"></a>12.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.42 asau 271: <div class="sect3">
1.1 dsieger 272: <div class="titlepage"><div><div><h4 class="title">
1.128 rillig 273: <a name="creating.nvu.init"></a>12.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 274: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.24 wiz 275: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 276: pkgsrc. As the description says it has to do with the web, the obvious
1.24 wiz 277: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 278: <pre class="programlisting">
279: <code class="prompt">$</code> mkdir www/nvu
280: <code class="prompt">$</code> cd www/nvu
281: </pre>
282: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 283: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 284: <pre class="programlisting">
285: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
286: </pre>
287: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
288: below the <code class="varname">DISTNAME</code> line, as the package name should
1.24 wiz 289: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 290: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
291: <code class="varname">COMMENT</code> fields. Then the package
292: <code class="filename">Makefile</code> looked like that:</p>
293: <pre class="programlisting">
1.121 sevan 294: # $NetBSD $
1.1 dsieger 295: #
296:
297: DISTNAME= nvu-1.0-sources
298: PKGNAME= nvu-1.0
299: CATEGORIES= www
300: MASTER_SITES= http://cvs.nvu.com/download/
301: EXTRACT_SUFX= .tar.bz2
302:
303: MAINTAINER= rillig@NetBSD.org
304: HOMEPAGE= http://cvs.nvu.com/
305: COMMENT= Web Authoring System
306:
307: # url2pkg-marker (please do not remove this line.)
308: .include "../../mk/bsd.pkg.mk"
309: </pre>
1.123 wiz 310: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.121 sevan 311: this is a workaround to prevent CVS expanding to the filename of the
312: guide.</p>
1.1 dsieger 313: <p>Then, I quit the editor and watched pkgsrc downloading a large
314: source archive:</p>
315: <pre class="programlisting">
316: url2pkg> Running "make makesum" ...
317: => Required installed package digest>=20010302: digest-20060826 found
318: => Fetching nvu-1.0-sources.tar.bz2
319: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
320: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
321: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
322: url2pkg> Running "make extract" ...
323: => Required installed package digest>=20010302: digest-20060826 found
324: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
325: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
326: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
327: ===> Installing dependencies for nvu-1.0
328: ===> Overriding tools for nvu-1.0
329: ===> Extracting for nvu-1.0
330: url2pkg> Adjusting the Makefile.
331:
332: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
333:
334: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
335: </pre>
336: </div>
1.42 asau 337: <div class="sect3">
1.1 dsieger 338: <div class="titlepage"><div><div><h4 class="title">
1.128 rillig 339: <a name="creating.nvu.problems"></a>12.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.1 dsieger 340: <p>Now that the package has been extracted, let's see what's inside
341: it. The package has a <code class="filename">README.txt</code>, but that only
342: says something about mozilla, so it's probably useless for seeing what
343: dependencies this package has. But since there is a GNU configure script
344: in the package, let's hope that it will complain about everything it
345: needs.</p>
346: <pre class="programlisting">
347: <code class="prompt">$</code> bmake
348: => Required installed package digest>=20010302: digest-20060826 found
349: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
350: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
351: ===> Patching for nvu-1.0
352: ===> Creating toolchain wrappers for nvu-1.0
353: ===> Configuring for nvu-1.0
354: [...]
355: configure: error: Perl 5.004 or higher is required.
356: [...]
357: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
358: [...]
359: </pre>
360: <p>That worked quite well. So I opened the package Makefile in my
361: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.24 wiz 362: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 363: package have changed now, and since a perl wrapper is automatically
1.24 wiz 364: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 365: from scratch.</p>
366: <pre class="programlisting">
367: <code class="prompt">$</code> bmake clean
368: ===> Cleaning for nvu-1.0
369: <code class="prompt">$</code> bmake
370: [...]
371: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
372: GNU Make. You will not be able to build Mozilla without GNU Make.
373: [...]
374: </pre>
1.24 wiz 375: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 376: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
377: <pre class="programlisting">
378: [...]
379: checking for GTK - version >= 1.2.0... no
380: *** Could not run GTK test program, checking why...
381: [...]
382: </pre>
383: <p>Now to the other dependencies. The first question is: Where is the
384: GTK package hidden in pkgsrc?</p>
385: <pre class="programlisting">
386: <code class="prompt">$</code> echo ../../*/gtk*
387: [many packages ...]
388: <code class="prompt">$</code> echo ../../*/gtk
389: ../../x11/gtk
390: <code class="prompt">$</code> echo ../../*/gtk2
391: ../../x11/gtk2
392: <code class="prompt">$</code> echo ../../*/gtk2/bui*
393: ../../x11/gtk2/buildlink3.mk
394: </pre>
395: <p>The first try was definitely too broad. The second one had exactly
396: one result, which is very good. But there is one pitfall with GNOME
397: packages. Before GNOME 2 had been released, there were already many
398: GNOME 1 packages in pkgsrc. To be able to continue to use these
399: packages, the GNOME 2 packages were imported as separate packages, and
1.24 wiz 400: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 401: whether this was the case here, and indeed it was.</p>
402: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
403: file, adding the dependency is very easy. I just inserted an
404: <code class="literal">.include</code> line before the last line of the package
405: <code class="filename">Makefile</code>, so that it now looks like this:</p>
406: <pre class="programlisting">
407: [...]
408: .include "../../x11/gtk2/buildlink3.mk"
409: .include "../../mk/bsd.pkg.mk
410: </pre>
1.10 hubertf 411: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 412: was:</p>
413: <pre class="programlisting">
414: [...]
415: checking for gtk-config... /home/roland/pkg/bin/gtk-config
416: checking for GTK - version >= 1.2.0... no
417: *** Could not run GTK test program, checking why...
418: *** The test program failed to compile or link. See the file config.log for the
419: *** exact error that occured. This usually means GTK was incorrectly installed
420: *** or that you have moved GTK since it was installed. In the latter case, you
421: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
422: configure: error: Test for GTK failed.
423: [...]
424: </pre>
1.24 wiz 425: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
426: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 427: told me that this package really wanted to have the GNOME 1 version of
428: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 429: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 430: So I changed the <code class="literal">x11/gtk2</code> to
431: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
432: and tried again.</p>
433: <pre class="programlisting">
434: [...]
1.59 jnemeth 435: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 436: In file included from xpidl.c:42:
437: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
438: In file included from xpidl.c:42:
439: xpidl.h:132: error: parse error before "IDL_ns"
440: [...]
441: </pre>
442: <p>The package still does not find all of its dependencies. Now the
443: question is: Which package provides the
444: <code class="filename">libIDL/IDL.h</code> header file?</p>
445: <pre class="programlisting">
446: <code class="prompt">$</code> echo ../../*/*idl*
447: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
448: <code class="prompt">$</code> echo ../../*/*IDL*
449: ../../net/libIDL
450: </pre>
451: <p>Let's take the one from the second try. So I included the
452: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
453: again. But the error didn't change. After digging through some of the
454: code, I concluded that the build process of the package was broken and
455: couldn't have ever worked, but since the Mozilla source tree is quite
456: large, I didn't want to fix it. So I added the following to the package
457: <code class="filename">Makefile</code> and tried again:</p>
458: <pre class="programlisting">
459: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.127 leot 460: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.1 dsieger 461: </pre>
462: <p>The latter line is needed because the package expects the library
463: <code class="filename">libIDL.so</code>, but only
464: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
465: wrapper to rewrite that on the fly.</p>
466: <p>The next problem was related to a recent change of the FreeType
1.126 leot 467: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.1 dsieger 468: which patch files were relevant for this issue and copied them to the
469: <code class="filename">patches</code> directory. Then I retried, fixed the
470: patches so that they applied cleanly and retried again. This time,
471: everything worked.</p>
472: </div>
1.42 asau 473: <div class="sect3">
1.1 dsieger 474: <div class="titlepage"><div><div><h4 class="title">
1.128 rillig 475: <a name="creating.nvu.inst"></a>12.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 476: <pre class="programlisting">
477: <code class="prompt">$</code> bmake CHECK_FILES=no install
478: [...]
479: <code class="prompt">$</code> bmake print-PLIST >PLIST
480: <code class="prompt">$</code> bmake deinstall
481: <code class="prompt">$</code> bmake install
482: </pre>
483: </div>
484: </div>
485: </div>
486: </div>
487: <div class="navfooter">
488: <hr>
489: <table width="100%" summary="Navigation footer">
490: <tr>
491: <td width="40%" align="left">
1.128 rillig 492: <a accesskey="p" href="help-devel.html">Prev</a> </td>
1.1 dsieger 493: <td width="20%" align="center"><a accesskey="u" href="developers-guide.html">Up</a></td>
494: <td width="40%" align="right"> <a accesskey="n" href="components.html">Next</a>
495: </td>
496: </tr>
497: <tr>
1.128 rillig 498: <td width="40%" align="left" valign="top">Chapter 11. Getting help </td>
1.1 dsieger 499: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
1.128 rillig 500: <td width="40%" align="right" valign="top"> Chapter 13. Package components - files, directories and contents</td>
1.1 dsieger 501: </tr>
502: </table>
503: </div>
504: </body>
505: </html>
CVSweb <webmaster@jp.NetBSD.org>