Annotation of htdocs/docs/pkgsrc/creating.html, revision 1.133

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

CVSweb <webmaster@jp.NetBSD.org>