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

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

CVSweb <webmaster@jp.NetBSD.org>