Annotation of htdocs/docs/pkgsrc/devfaq.html, revision 1.175
1.115 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.149 rillig 5: <title>Chapter 24. Frequently Asked Questions</title>
1.24 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.13 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.149 rillig 10: <link rel="prev" href="submit.html" title="Chapter 23. Submitting and Committing">
1.170 rillig 11: <link rel="next" href="infrastructure.html" title="Part III. The pkgsrc infrastructure internals">
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.149 rillig 16: <tr><th colspan="3" align="center">Chapter 24. Frequently Asked Questions</th></tr>
1.1 dsieger 17: <tr>
18: <td width="20%" align="left">
19: <a accesskey="p" href="submit.html">Prev</a> </td>
20: <th width="60%" align="center">Part II. The pkgsrc developer's guide</th>
1.170 rillig 21: <td width="20%" align="right"> <a accesskey="n" href="infrastructure.html">Next</a>
1.1 dsieger 22: </td>
23: </tr>
24: </table>
25: <hr>
26: </div>
1.40 asau 27: <div class="chapter">
1.1 dsieger 28: <div class="titlepage"><div><div><h2 class="title">
1.149 rillig 29: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 30: <p>This section contains the answers to questions that may
31: arise when you are writing a package. If you don't find your
32: question answered here, first have a look in the other chapters,
33: and if you still don't have the answer, ask on the
34: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.40 asau 35: <div class="qandaset">
1.169 leot 36: <a name="devfaq.qandaset"></a><dl>
1.149 rillig 37: <dt>24.1. <a href="devfaq.html#devfaq.makeflags">What is the difference between
1.1 dsieger 38: MAKEFLAGS, .MAKEFLAGS and
39: MAKE_FLAGS?</a>
40: </dt>
1.149 rillig 41: <dt>24.2. <a href="devfaq.html#devfaq.make">What is the difference between
1.1 dsieger 42: MAKE, GMAKE and
43: MAKE_PROGRAM?</a>
44: </dt>
1.149 rillig 45: <dt>24.3. <a href="devfaq.html#devfaq.cc">What is the difference between
1.1 dsieger 46: CC, PKG_CC and
47: PKGSRC_COMPILER?</a>
48: </dt>
1.174 nia 49: <dt>24.4. <a href="devfaq.html#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 50: VARNAME=BUILDLINK_PREFIX.foo
51: say it's empty?</a>
52: </dt>
1.174 nia 53: <dt>24.5. <a href="devfaq.html#devfaq.master_sites">What does
1.1 dsieger 54: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
55: don't understand the := inside
56: it.</a>
57: </dt>
1.174 nia 58: <dt>24.6. <a href="devfaq.html#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 59: developers?</a>
60: </dt>
1.174 nia 61: <dt>24.7. <a href="devfaq.html#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 62: documentation?</a>
63: </dt>
1.174 nia 64: <dt>24.8. <a href="devfaq.html#devfaq.too-much-time">I have a little time to kill.
1.169 leot 65: What shall I do?</a>
1.1 dsieger 66: </dt>
67: </dl>
1.40 asau 68: <table border="0" style="width: 100%;">
69: <colgroup>
1.1 dsieger 70: <col align="left" width="1%">
1.22 wiz 71: <col>
1.40 asau 72: </colgroup>
1.1 dsieger 73: <tbody>
1.40 asau 74: <tr class="question">
1.1 dsieger 75: <td align="left" valign="top">
1.169 leot 76: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.1 dsieger 77: </td>
78: <td align="left" valign="top"><p>What is the difference between
79: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
80: <code class="varname">MAKE_FLAGS</code>?</p></td>
81: </tr>
82: <tr class="answer">
83: <td align="left" valign="top"></td>
1.174 nia 84: <td align="left" valign="top">
85: <p><code class="varname">MAKEFLAGS</code> are the flags passed
1.175 ! leot 86: to the pkgsrc-internal invocations of <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.</p>
1.174 nia 87: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
88: passed to the <code class="varname">MAKE_PROGRAM</code> when building the
89: package.</p>
90: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
91: <span class="command"><strong>bmake</strong></span> and should not be used by
92: packages.</p>
93: </td>
1.1 dsieger 94: </tr>
1.40 asau 95: <tr class="question">
1.1 dsieger 96: <td align="left" valign="top">
1.169 leot 97: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.1 dsieger 98: </td>
99: <td align="left" valign="top"><p>What is the difference between
100: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
101: <code class="varname">MAKE_PROGRAM</code>?</p></td>
102: </tr>
103: <tr class="answer">
104: <td align="left" valign="top"></td>
1.174 nia 105: <td align="left" valign="top">
106: <p><code class="varname">MAKE</code> is the path to the
1.175 ! leot 107: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.174 nia 108: infrastructure.</p>
109: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
110: need to say <code class="varname">USE_TOOLS+=gmake</code> to use
111: that.</p>
112: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
113: program that is used for building the package.</p>
114: </td>
1.1 dsieger 115: </tr>
1.40 asau 116: <tr class="question">
1.1 dsieger 117: <td align="left" valign="top">
1.169 leot 118: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.1 dsieger 119: </td>
120: <td align="left" valign="top"><p>What is the difference between
121: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
122: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
123: </tr>
124: <tr class="answer">
125: <td align="left" valign="top"></td>
126: <td align="left" valign="top">
1.174 nia 127: <p><code class="varname">CC</code> is the path to the real C
128: compiler, which can be configured by the pkgsrc user.</p>
129: <p><code class="varname">PKG_CC</code> is the path to the compiler
130: wrapper.</p>
131: <p><code class="varname">PKGSRC_COMPILER</code> is
132: <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
133: compiler that should be used. See
134: <code class="filename">mk/compiler.mk</code> for more information about
135: the latter variable.</p>
1.1 dsieger 136: </td>
137: </tr>
1.40 asau 138: <tr class="question">
1.1 dsieger 139: <td align="left" valign="top">
1.174 nia 140: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.4.</b></p>
1.1 dsieger 141: </td>
1.8 hubertf 142: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 143: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
144: say it's empty?</p></td>
145: </tr>
146: <tr class="answer">
147: <td align="left" valign="top"></td>
148: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.22 wiz 149: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
150: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.8 hubertf 151: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 152: command.</p></td>
153: </tr>
1.40 asau 154: <tr class="question">
1.1 dsieger 155: <td align="left" valign="top">
1.174 nia 156: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.5.</b></p>
1.1 dsieger 157: </td>
158: <td align="left" valign="top"><p>What does
1.103 rillig 159: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
160: don't understand the <code class="code">:=</code> inside
1.1 dsieger 161: it.</p></td>
162: </tr>
163: <tr class="answer">
164: <td align="left" valign="top"></td>
1.174 nia 165: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
166: assignment operator, even though it may look like one.
1.1 dsieger 167: Instead, it is a degenerate form of
1.103 rillig 168: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.175 ! leot 169: which is documented in the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.103 rillig 170: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 171: case of <code class="varname">MASTER_SITE_*</code>,
172: <em class="replaceable"><code>old_string</code></em> is the empty string and
173: <em class="replaceable"><code>new_string</code></em> is
1.103 rillig 174: <code class="code">package/</code>. That's where the
175: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 176: together.</p></td>
177: </tr>
1.40 asau 178: <tr class="question">
1.1 dsieger 179: <td align="left" valign="top">
1.174 nia 180: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.6.</b></p>
1.1 dsieger 181: </td>
182: <td align="left" valign="top"><p>Which mailing lists are there for package
183: developers?</p></td>
184: </tr>
185: <tr class="answer">
186: <td align="left" valign="top"></td>
1.40 asau 187: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.169 leot 188: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1 dsieger 189: <dd><p>This is a list for technical discussions related
190: to pkgsrc development, e.g. soliciting feedback for changes to
191: pkgsrc infrastructure, proposed new features, questions related
192: to porting pkgsrc to a new platform, advice for maintaining a
193: package, patches that affect many packages, help requests moved
194: from pkgsrc-users when an infrastructure bug is found,
195: etc.</p></dd>
1.169 leot 196: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1 dsieger 197: <dd><p>All bug reports in category "pkg" sent with
1.175 ! leot 198: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1 dsieger 199: directly; use one of the other mailing
200: lists.</p></dd>
201: </dl></div></td>
202: </tr>
1.40 asau 203: <tr class="question">
1.1 dsieger 204: <td align="left" valign="top">
1.174 nia 205: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.7.</b></p>
1.1 dsieger 206: </td>
207: <td align="left" valign="top"><p>Where is the pkgsrc
208: documentation?</p></td>
209: </tr>
210: <tr class="answer">
211: <td align="left" valign="top"></td>
212: <td align="left" valign="top">
213: <p>There are many places where you can find
214: documentation about pkgsrc:</p>
1.40 asau 215: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.22 wiz 216: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 217: of chapters that explain large parts of pkgsrc, but some
218: chapters tend to be outdated. Which ones they are is hard to
219: say.</p></li>
1.169 leot 220: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>), you can find discussions
1.1 dsieger 221: about certain features, announcements of new parts of the pkgsrc
222: infrastructure and sometimes even announcements that a certain
223: feature has been marked as obsolete. The benefit here is that
224: each message has a date appended to it.</p></li>
1.22 wiz 225: <li class="listitem"><p>Many of the files in the
1.1 dsieger 226: <code class="filename">mk/</code> directory start with a comment that
227: describes the purpose of the file and how it can be used by the
228: pkgsrc user and package authors. An easy way to find this
1.8 hubertf 229: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 230: help</strong></span>.</p></li>
1.22 wiz 231: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 232: information, but they tend to be highly abbreviated, especially
233: for actions that occur often. Some contain a detailed
234: description of what has changed, but they are geared towards the
235: other pkgsrc developers, not towards an average pkgsrc user.
236: They also only document <span class="emphasis"><em>changes</em></span>, so if you
237: don't know what has been before, these messages may not be worth
238: too much to you.</p></li>
1.22 wiz 239: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
240: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 241: mind of the developer who wrote the code. To get this
1.8 hubertf 242: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 243: to see who has written it and ask on the
244: <code class="literal">tech-pkg</code> mailing list, so that others can
245: find your questions later (see above). To be sure that the
246: developer in charge reads the mail, you may CC him or
247: her.</p></li>
248: </ul></div>
249: </td>
250: </tr>
1.40 asau 251: <tr class="question">
1.1 dsieger 252: <td align="left" valign="top">
1.174 nia 253: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.8.</b></p>
1.1 dsieger 254: </td>
1.174 nia 255: <td align="left" valign="top"><p>I have a little time to kill.
1.169 leot 256: What shall I do?</p></td>
1.1 dsieger 257: </tr>
258: <tr class="answer">
259: <td align="left" valign="top"></td>
260: <td align="left" valign="top">
261: <p>This is not really an FAQ yet, but here's the answer
262: anyway.</p>
1.40 asau 263: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.22 wiz 264: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.173 leot 265: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.1 dsieger 266: will tell you about newer versions of installed packages that are
267: available, but not yet updated in pkgsrc.</p></li>
1.22 wiz 268: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.12 jmcneill 269: — it contains a list of suggested new packages and a list of
1.1 dsieger 270: cleanups and enhancements for pkgsrc that would be nice to
271: have.</p></li>
1.22 wiz 272: <li class="listitem"><p>Review packages for which review was requested on
1.169 leot 273: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 274: mailing list.</p></li>
275: </ul></div>
276: </td>
277: </tr>
278: </tbody>
279: </table>
280: </div>
281: </div>
282: <div class="navfooter">
283: <hr>
284: <table width="100%" summary="Navigation footer">
285: <tr>
286: <td width="40%" align="left">
287: <a accesskey="p" href="submit.html">Prev</a> </td>
288: <td width="20%" align="center"><a accesskey="u" href="developers-guide.html">Up</a></td>
1.170 rillig 289: <td width="40%" align="right"> <a accesskey="n" href="infrastructure.html">Next</a>
1.1 dsieger 290: </td>
291: </tr>
292: <tr>
1.149 rillig 293: <td width="40%" align="left" valign="top">Chapter 23. Submitting and Committing </td>
1.1 dsieger 294: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
1.170 rillig 295: <td width="40%" align="right" valign="top"> Part III. The pkgsrc infrastructure internals</td>
1.1 dsieger 296: </tr>
297: </table>
298: </div>
299: </body>
300: </html>
CVSweb <webmaster@jp.NetBSD.org>