Annotation of htdocs/docs/pkgsrc/pkgsrc.txt, revision 1.248
1.1 dsieger 1: The pkgsrc guide
2:
3: Documentation on the NetBSD packages system
4:
5: Alistair Crooks
6:
7: <agc@NetBSD.org>
8:
9: Hubert Feyrer
10:
11: <hubertf@NetBSD.org>
12:
13: The pkgsrc Developers
14:
1.231 jnemeth 15: Copyright 1994-2023 The NetBSD Foundation, Inc
1.1 dsieger 16:
1.231 jnemeth 17: $NetBSD: pkgsrc.xml,v 1.42 2023/01/02 05:45:23 jnemeth Exp $
1.1 dsieger 18:
19: Abstract
20:
21: pkgsrc is a centralized package management system for Unix-like operating
22: systems. This guide provides information for users and developers of pkgsrc. It
23: covers installation of binary and source packages, creation of binary and
24: source packages and a high-level overview about the infrastructure.
25:
26: -------------------------------------------------------------------------------
27:
28: Table of Contents
29:
30: 1. What is pkgsrc?
31: 1.1. Introduction
32: 1.1.1. Why pkgsrc?
33: 1.1.2. Supported platforms
34: 1.2. Overview
35: 1.3. Terminology
36: 1.3.1. Roles involved in pkgsrc
37: 1.4. Typography
38: I. The pkgsrc user's guide
1.154 rillig 39: 2. Getting help
40: 3. Where to get pkgsrc and how to keep it up-to-date
41: 3.1. Getting pkgsrc for the first time
42: 3.1.1. As tar archive
43: 3.1.2. Via anonymous CVS
44: 3.2. Keeping pkgsrc up-to-date
45: 3.2.1. Via tar files
46: 3.2.2. Via CVS
47: 4. Using pkgsrc on systems other than NetBSD
48: 4.1. Binary distribution
49: 4.2. Bootstrapping pkgsrc
50: 5. Using pkgsrc
51: 5.1. Using binary packages
52: 5.1.1. Finding binary packages
53: 5.1.2. Installing binary packages
1.202 nia 54: 5.1.3. Updating packages
55: 5.1.4. Deinstalling packages
56: 5.1.5. Getting information about installed packages
57: 5.1.6. Checking for security vulnerabilities in installed packages
58: 5.1.7. Finding if newer versions of your installed packages are in
1.232 gutterid 59: pkgsrc
1.202 nia 60: 5.1.8. Other administrative functions
1.154 rillig 61: 5.2. Building packages from source
62: 5.2.1. Requirements
63: 5.2.2. Fetching distfiles
64: 5.2.3. How to build and install
65: 6. Configuring pkgsrc
66: 6.1. General configuration
67: 6.2. Variables affecting the build process
1.241 rillig 68: 6.3. Preferences for native or pkgsrc software
69: 6.4. Variables affecting the installation process
70: 6.5. Selecting and configuring the compiler
71: 6.5.1. Selecting the compiler
72: 6.5.2. Additional flags to the compiler (CFLAGS)
73: 6.5.3. Additional flags to the linker (LDFLAGS)
74: 6.6. Developer/advanced settings
75: 6.7. Selecting Build Options
1.154 rillig 76: 7. Creating binary packages
77: 7.1. Building a single binary package
78: 7.2. Settings for creation of binary packages
79: 8. Creating binary packages for everything in pkgsrc (bulk builds)
80: 8.1. Preparations
1.180 rillig 81: 8.2. Running a bulk build
1.154 rillig 82: 8.2.1. Configuration
83: 8.3. Requirements of a full bulk build
1.178 rillig 84: 8.4. Bulk build variants
1.179 rillig 85: 8.4.1. Detect unknown configure options
86: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 87: 8.4.3. Force compiler options only in the build phase
88: 8.4.4. Use custom directories
89: 8.4.5. Turn warnings into errors
90: 8.4.6. Reject packages for which pkglint reports errors
91: 8.4.7. Reject packages that contain forbidden strings
92: 8.4.8. Reject packages whose self-test fails
93: 8.4.9. Reject packages that use undefined shell variables
94: 8.4.10. Turn off verbose logging
1.178 rillig 95: 8.5. Creating a multiple CD-ROM packages collection
96: 8.5.1. Example of cdpack
1.154 rillig 97: 9. Directory layout of the installed files
98: 9.1. File system layout in ${LOCALBASE}
99: 9.2. File system layout in ${VARBASE}
100: 10. Frequently Asked Questions
101: 10.1. Are there any mailing lists for pkg-related discussion?
102: 10.2. Utilities for package management (pkgtools)
103: 10.3. How to use pkgsrc as non-root
104: 10.4. How to resume transfers when fetching distfiles?
105: 10.5. How can I install/use modular X.org from pkgsrc?
106: 10.6. How to fetch files from behind a firewall
107: 10.7. How to fetch files from HTTPS sites
108: 10.8. How do I tell make fetch to do passive FTP?
109: 10.9. How to fetch all distfiles at once
110: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc"
1.232 gutterid 111: mean?
1.154 rillig 112: 10.11. What does "Could not find bsd.own.mk" mean?
1.221 nia 113: 10.12. Using 'sudo' or `priv` with pkgsrc
1.154 rillig 114: 10.13. How do I change the location of configuration files?
115: 10.14. Automated security checks
116: 10.15. Why do some packages ignore my CFLAGS?
117: 10.16. A package does not build. What shall I do?
118: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/???
1.232 gutterid 119: merge conflicts" mean?
1.1 dsieger 120: II. The pkgsrc developer's guide
1.154 rillig 121: 11. Getting help
1.184 rillig 122: 12. Package components - files, directories and contents
123: 12.1. Makefile
124: 12.2. distinfo
125: 12.3. patches/*
126: 12.3.1. Structure of a single patch file
127: 12.3.2. Creating patch files
128: 12.3.3. Sources where the patch files come from
129: 12.3.4. Patching guidelines
130: 12.3.5. Feedback to the author
131: 12.4. Other mandatory files
132: 12.5. Optional files
133: 12.5.1. Files affecting the binary package
134: 12.5.2. Files affecting the build process
135: 12.5.3. Files affecting nothing at all
136: 12.6. work*
137: 12.7. files/*
138: 13. The build process
139: 13.1. Introduction
140: 13.2. Program location
141: 13.3. Directories used during the build process
142: 13.4. Running a phase
143: 13.5. The fetch phase
144: 13.5.1. What to fetch and where to get it from
145: 13.5.2. How are the files fetched?
146: 13.6. The checksum phase
147: 13.7. The extract phase
148: 13.8. The patch phase
149: 13.9. The tools phase
150: 13.10. The wrapper phase
151: 13.11. The configure phase
152: 13.12. The build phase
153: 13.13. The test phase
154: 13.14. The install phase
155: 13.15. The package phase
156: 13.16. Cleaning up
157: 13.17. Other helpful targets
158: 14. Creating a new pkgsrc package from scratch
159: 14.1. Common types of packages
1.219 nia 160: 14.1.1. Python modules and programs
161: 14.1.2. R packages
162: 14.1.3. TeXlive packages
1.184 rillig 163: 14.2. Examples
164: 14.2.1. How the www/nvu package came into pkgsrc
165: 15. Programming in Makefiles
166: 15.1. Caveats
167: 15.2. Makefile variables
168: 15.2.1. Naming conventions
169: 15.3. Code snippets
170: 15.3.1. Adding things to a list
171: 15.3.2. Echoing a string exactly as-is
172: 15.3.3. Passing CFLAGS to GNU configure scripts
173: 15.3.4. Handling possibly empty variables
1.229 gutterid 174: 15.3.5. Testing yes/no variables in conditions
1.184 rillig 175: 16. Options handling
176: 16.1. Global default options
177: 16.2. Converting packages to use bsd.options.mk
178: 16.3. Option Names
179: 16.4. Determining the options of dependencies
180: 17. Tools needed for building or running
181: 17.1. Tools for pkgsrc builds
182: 17.2. Tools needed by packages
183: 17.3. Tools provided by platforms
184: 18. Buildlink methodology
185: 18.1. Converting packages to use buildlink3
186: 18.2. Writing buildlink3.mk files
187: 18.2.1. Anatomy of a buildlink3.mk file
188: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and
1.232 gutterid 189: BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files
1.184 rillig 190: 18.3. Writing builtin.mk files
191: 18.3.1. Anatomy of a builtin.mk file
192: 19. PLIST issues
193: 19.1. RCS ID
194: 19.2. Semi-automatic PLIST generation
195: 19.3. Tweaking output of make print-PLIST
196: 19.4. Variable substitution in PLIST
197: 19.5. Man page compression
198: 19.6. Changing PLIST source with PLIST_SRC
199: 19.7. Platform-specific and differing PLISTs
200: 19.8. Build-specific PLISTs
201: 19.9. Sharing directories between packages
202: 20. The pkginstall framework
203: 20.1. Files and directories outside the installation prefix
204: 20.1.1. Directory manipulation
205: 20.1.2. File manipulation
206: 20.2. Configuration files
207: 20.2.1. How PKG_SYSCONFDIR is set
208: 20.2.2. Telling the software where configuration files are
1.239 dholland 209: 20.2.3. Patching installation
210: 20.2.4. Declaring configuration files
211: 20.2.5. Disabling handling of configuration files
1.184 rillig 212: 20.3. System startup scripts
213: 20.3.1. Disabling handling of system startup scripts
214: 20.4. System users and groups
215: 20.5. System shells
216: 20.5.1. Disabling shell registration
217: 20.6. Fonts
218: 20.6.1. Disabling automatic update of the fonts databases
1.154 rillig 219: 21. Making your package work
220: 21.1. General operation
221: 21.1.1. How to pull in user-settable variables from mk.conf
222: 21.1.2. User interaction
223: 21.1.3. Handling licenses
224: 21.1.4. Restricted packages
225: 21.1.5. Handling dependencies
226: 21.1.6. Handling conflicts with other packages
227: 21.1.7. Packages that cannot or should not be built
228: 21.1.8. Packages which should not be deleted, once installed
229: 21.1.9. Handling packages with security problems
230: 21.1.10. How to handle incrementing versions when fixing an
1.232 gutterid 231: existing package
1.154 rillig 232: 21.1.11. Substituting variable text in the package files (the SUBST
1.232 gutterid 233: framework)
1.154 rillig 234: 21.2. The fetch phase
235: 21.2.1. Packages whose distfiles aren't available for plain
1.232 gutterid 236: downloading
1.154 rillig 237: 21.2.2. How to handle modified distfiles with the 'old' name
238: 21.2.3. Packages hosted on github.com
239: 21.3. The configure phase
240: 21.3.1. Shared libraries - libtool
241: 21.3.2. Using libtool on GNU packages that already support libtool
242: 21.3.3. GNU Autoconf/Automake
1.223 nia 243: 21.3.4. Meson / ninja
1.154 rillig 244: 21.4. Programming languages
245: 21.4.1. C, C++, and Fortran
246: 21.4.2. Java
1.205 wiz 247: 21.4.3. Go
1.223 nia 248: 21.4.4. Rust
249: 21.4.5. Packages containing Perl scripts
250: 21.4.6. Packages containing shell scripts
251: 21.4.7. Other programming languages
1.154 rillig 252: 21.5. The build phase
253: 21.5.1. Compiling C and C++ code conditionally
254: 21.5.2. How to handle compiler bugs
1.172 rillig 255: 21.5.3. No such file or directory
256: 21.5.4. Undefined reference to "..."
257: 21.5.5. Running out of memory
1.154 rillig 258: 21.6. The install phase
259: 21.6.1. Creating needed directories
260: 21.6.2. Where to install documentation
261: 21.6.3. Installing highscore files
262: 21.6.4. Adding DESTDIR support to packages
263: 21.6.5. Packages with hardcoded paths to other interpreters
1.203 nia 264: 21.6.6. Packages installing Perl modules
1.154 rillig 265: 21.6.7. Packages installing info files
266: 21.6.8. Packages installing man pages
1.203 nia 267: 21.6.9. Packages installing X11 fonts
268: 21.6.10. Packages installing SGML or XML data
269: 21.6.11. Packages installing extensions to the MIME database
270: 21.6.12. Packages using intltool
271: 21.6.13. Packages installing startup scripts
272: 21.6.14. Packages installing TeX modules
273: 21.6.15. Packages supporting running binaries in emulation
274: 21.6.16. Packages installing hicolor icons
275: 21.6.17. Packages installing desktop files
1.154 rillig 276: 21.7. Marking packages as having problems
1.184 rillig 277: 22. GNOME packaging and porting
278: 22.1. Meta packages
279: 22.2. Packaging a GNOME application
280: 22.3. Updating GNOME to a newer version
281: 22.4. Patching guidelines
1.154 rillig 282: 23. Submitting and Committing
283: 23.1. Submitting binary packages
284: 23.2. Submitting source packages (for non-NetBSD-developers)
285: 23.3. General notes when adding, updating, or removing packages
286: 23.4. Commit Messages
287: 23.5. Committing: Adding a package to CVS
288: 23.6. Updating a package to a newer version
289: 23.7. Renaming a package in pkgsrc
290: 23.8. Moving a package in pkgsrc
291: 24. Frequently Asked Questions
1.1 dsieger 292: III. The pkgsrc infrastructure internals
1.184 rillig 293: 25. Design of the pkgsrc infrastructure
294: 25.1. The meaning of variable definitions
295: 25.2. Avoiding problems before they arise
296: 25.3. Variable evaluation
297: 25.3.1. At load time
298: 25.3.2. At runtime
299: 25.4. How can variables be specified?
300: 25.5. Designing interfaces for Makefile fragments
301: 25.5.1. Procedures with parameters
302: 25.5.2. Actions taken on behalf of parameters
303: 25.6. The order in which files are loaded
304: 25.6.1. The order in bsd.prefs.mk
305: 25.6.2. The order in bsd.pkg.mk
306: 26. Regression tests
307: 26.1. Running the regression tests
308: 26.2. Adding a new regression test
309: 26.2.1. Overridable functions
310: 26.2.2. Helper functions
311: 27. Porting pkgsrc
312: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 313: A. A simple example package: bison
314: A.1. files
315: A.1.1. Makefile
316: A.1.2. DESCR
317: A.1.3. PLIST
318: A.1.4. Checking a package with pkglint
319: A.2. Steps for building, installing, packaging
1.207 leot 320: B. Security hardening
321: B.1. Mechanisms
322: B.1.1. Enabled by default
323: B.1.2. Not enabled by default
324: B.2. Caveats
325: B.2.1. Problems with PKGSRC_MKPIE
326: B.2.2. Problems with PKGSRC_USE_FORTIFY
327: B.2.3. Problems with PKGSRC_USE_RELRO
328: B.2.4. Problems with PKGSRC_USE_SSP
329: B.3. Auditing the system
330: B.3.1. Checking for PIE
331: B.3.2. Checking for partial RELRO
332: B.3.3. Checking for full RELRO
333: B.3.4. Checking for SSP
334: C. Build logs
335: C.1. Building figlet
336: C.2. Packaging figlet
337: D. Directory layout of the pkgsrc FTP server
338: D.1. distfiles: The distributed source files
339: D.2. misc: Miscellaneous things
340: D.3. packages: Binary packages
341: D.4. reports: Bulk build reports
342: D.5. current, stable, pkgsrc-20xxQy: source packages
343: E. Help topics
344: F. Editing guidelines for the pkgsrc guide
345: F.1. Make targets
346: F.2. Procedure
1.1 dsieger 347:
348: List of Tables
349:
350: 1.1. Platforms supported by pkgsrc
1.184 rillig 351: 12.1. Patching examples
352: 22.1. PLIST handling for GNOME packages
1.1 dsieger 353:
354: Chapter 1. What is pkgsrc?
355:
356: Table of Contents
357:
358: 1.1. Introduction
359: 1.1.1. Why pkgsrc?
360: 1.1.2. Supported platforms
361: 1.2. Overview
362: 1.3. Terminology
363: 1.3.1. Roles involved in pkgsrc
364: 1.4. Typography
365:
366: 1.1. Introduction
367:
368: There is a lot of software freely available for Unix-based systems, which is
369: usually available in form of the source code. Before such software can be used,
370: it needs to be configured to the local system, compiled and installed, and this
371: is exactly what The NetBSD Packages Collection (pkgsrc) does. pkgsrc also has
372: some basic commands to handle binary packages, so that not every user has to
373: build the packages for himself, which is a time-costly task.
374:
375: pkgsrc currently contains several thousand packages, including:
376:
1.104 sevan 377: * www/apache24 - The Apache web server
1.1 dsieger 378:
379: * www/firefox - The Firefox web browser
380:
381: * meta-pkgs/gnome - The GNOME Desktop Environment
382:
1.102 ryoon 383: * meta-pkgs/kde4 - The K Desktop Environment
1.1 dsieger 384:
1.108 rillig 385: ? just to name a few.
1.1 dsieger 386:
387: pkgsrc has built-in support for handling varying dependencies, such as pthreads
388: and X11, and extended features such as IPv6 support on a range of platforms.
389:
390: 1.1.1. Why pkgsrc?
391:
392: pkgsrc provides the following key features:
393:
394: * Easy building of software from source as well as the creation and
395: installation of binary packages. The source and latest patches are
396: retrieved from a master or mirror download site, checksum verified, then
397: built on your system. Support for binary-only distributions is available
398: for both native platforms and NetBSD emulated platforms.
399:
400: * All packages are installed in a consistent directory tree, including
401: binaries, libraries, man pages and other documentation.
402:
1.104 sevan 403: * Tracking of package dependencies automatically, including when performing
404: updates, to ensure required packages are installed. The configuration files
405: of various packages are handled automatically during updates, so local
406: changes are preserved.
1.1 dsieger 407:
408: * Like NetBSD, pkgsrc is designed with portability in mind and consists of
409: highly portable code. This allows the greatest speed of development when
1.26 spz 410: porting to a new platform. This portability also ensures that pkgsrc is
1.1 dsieger 411: consistent across all platforms.
412:
413: * The installation prefix, acceptable software licenses, international
414: encryption requirements and build-time options for a large number of
415: packages are all set in a simple, central configuration file.
416:
417: * The entire source (not including the distribution files) is freely
418: available under a BSD license, so you may extend and adapt pkgsrc to your
419: needs. Support for local packages and patches is available right out of the
420: box, so you can configure it specifically for your environment.
421:
422: The following principles are basic to pkgsrc:
423:
1.198 leot 424: * "It should only work if it's right." -- That means, if a package contains
1.1 dsieger 425: bugs, it's better to find them and to complain about them rather than to
426: just install the package and hope that it works. There are numerous checks
1.175 gutterid 427: in pkgsrc that try to find such bugs: static analysis tools (pkgtools/
1.1 dsieger 428: pkglint), build-time checks (portability of shell scripts), and
429: post-installation checks (installed files, references to shared libraries,
430: script interpreters).
431:
1.198 leot 432: * "If it works, it should work everywhere" -- Like NetBSD has been ported to
1.1 dsieger 433: many hardware architectures, pkgsrc has been ported to many operating
434: systems. Care is taken that packages behave the same on all platforms.
435:
436: 1.1.2. Supported platforms
437:
438: pkgsrc consists of both a source distribution and a binary distribution for
439: these operating systems. After retrieving the required source or binaries, you
440: can be up and running with pkgsrc in just minutes!
441:
442: pkgsrc was derived from FreeBSD's ports system, and initially developed for
443: NetBSD only. Since then, pkgsrc has grown a lot, and now supports the following
444: platforms:
445:
446: Table 1.1. Platforms supported by pkgsrc
447:
1.92 sevan 448: +-----------------------------------------------------------------------------+
1.229 gutterid 449: | Platform | Date Support | Notes |
450: | | Added | |
451: |-------------------------------------+---------------+-----------------------|
452: |NetBSD | Aug 1997 | |
453: |-------------------------------------+---------------+-----------------------|
454: |Solaris | Mar 1999 |README.Solaris |
455: |-------------------------------------+---------------+-----------------------|
456: |Linux | Jun 1999 |README.Linux |
457: |-------------------------------------+---------------+-----------------------|
458: |Darwin / Mac OS X / OS X / macOS | Oct 2001 |README.macOS |
459: |-------------------------------------+---------------+-----------------------|
460: |FreeBSD | Nov 2002 |README.FreeBSD |
461: |-------------------------------------+---------------+-----------------------|
462: |OpenBSD | Nov 2002 |README.OpenBSD |
463: |-------------------------------------+---------------+-----------------------|
464: |IRIX | Dec 2002 |README.IRIX |
465: |-------------------------------------+---------------+-----------------------|
466: |BSD/OS | Dec 2003 | |
467: |-------------------------------------+---------------+-----------------------|
468: |AIX | Dec 2003 |README.AIX |
469: |-------------------------------------+---------------+-----------------------|
470: |Interix (Microsoft Windows Services | Mar 2004 |README.Interix |
471: |for Unix) | | |
472: |-------------------------------------+---------------+-----------------------|
473: |DragonFlyBSD | Oct 2004 | |
474: |-------------------------------------+---------------+-----------------------|
475: |OSF/1 | Nov 2004 |README.OSF1 |
476: |-------------------------------------+---------------+-----------------------|
477: |HP-UX | Apr 2007 |README.HPUX |
478: |-------------------------------------+---------------+-----------------------|
479: |Haiku | Sep 2010 |README.Haiku |
480: |-------------------------------------+---------------+-----------------------|
481: |MirBSD | Jan 2011 | |
482: |-------------------------------------+---------------+-----------------------|
483: |Minix3 | Nov 2011 |README.Minix3 |
484: |-------------------------------------+---------------+-----------------------|
485: |Cygwin | Mar 2013 |README.Cygwin |
486: |-------------------------------------+---------------+-----------------------|
487: |GNU/kFreeBSD | Jul 2013 |README.GNUkFreeBSD |
488: |-------------------------------------+---------------+-----------------------|
489: |Bitrig | Jun 2014 |Removed from pkgsrc Sep|
490: | | |2022 |
1.92 sevan 491: +-----------------------------------------------------------------------------+
1.1 dsieger 492:
493:
494: 1.2. Overview
495:
496: This document is divided into three parts. The first, The pkgsrc user's guide,
497: describes how one can use one of the packages in the Package Collection, either
498: by installing a precompiled binary package, or by building one's own copy using
499: the NetBSD package system. The second part, The pkgsrc developer's guide,
500: explains how to prepare a package so it can be easily built by other NetBSD
501: users without knowing about the package's building details. The third part, The
502: pkgsrc infrastructure internals is intended for those who want to understand
503: how pkgsrc is implemented.
504:
505: This document is available in various formats: HTML, PDF, PS, TXT.
506:
507: 1.3. Terminology
508:
509: There has been a lot of talk about "ports", "packages", etc. so far. Here is a
510: description of all the terminology used within this document.
511:
512: Package
513:
514: A set of files and building instructions that describe what's necessary to
515: build a certain piece of software using pkgsrc. Packages are traditionally
1.123 wiz 516: stored under /usr/pkgsrc, but may be stored in any location, referred to as
517: PKGSRCDIR.
1.1 dsieger 518:
519: The NetBSD package system
520:
521: This is the former name of "pkgsrc". It is part of the NetBSD operating
522: system and can be bootstrapped to run on non-NetBSD operating systems as
523: well. It handles building (compiling), installing, and removing of
524: packages.
525:
526: Distfile
527:
528: This term describes the file or files that are provided by the author of
529: the piece of software to distribute his work. All the changes necessary to
530: build on NetBSD are reflected in the corresponding package. Usually the
531: distfile is in the form of a compressed tar-archive, but other types are
532: possible, too. Distfiles are usually stored below /usr/pkgsrc/distfiles.
533:
534: Port
535:
536: This is the term used by FreeBSD and OpenBSD people for what we call a
537: package. In NetBSD terminology, "port" refers to a different architecture.
538:
539: Precompiled/binary package
540:
541: A set of binaries built with pkgsrc from a distfile and stuffed together in
542: a single .tgz file so it can be installed on machines of the same machine
543: architecture without the need to recompile. Packages are usually generated
544: in /usr/pkgsrc/packages; there is also an archive on ftp.NetBSD.org.
545:
546: Sometimes, this is referred to by the term "package" too, especially in the
547: context of precompiled packages.
548:
549: Program
550:
551: The piece of software to be installed which will be constructed from all
552: the files in the distfile by the actions defined in the corresponding
553: package.
554:
555: 1.3.1. Roles involved in pkgsrc
556:
557: pkgsrc users
558:
559: The pkgsrc users are people who use the packages provided by pkgsrc.
560: Typically they are system administrators. The people using the software
561: that is inside the packages (maybe called "end users") are not covered by
562: the pkgsrc guide.
563:
564: There are two kinds of pkgsrc users: Some only want to install pre-built
565: binary packages. Others build the pkgsrc packages from source, either for
566: installing them directly or for building binary packages themselves. For
567: pkgsrc users Part I, "The pkgsrc user's guide" should provide all necessary
568: documentation.
569:
570: package maintainers
571:
572: A package maintainer creates packages as described in Part II, "The pkgsrc
573: developer's guide".
574:
575: infrastructure developers
576:
577: These people are involved in all those files that live in the mk/ directory
578: and below. Only these people should need to read through Part III, "The
579: pkgsrc infrastructure internals", though others might be curious, too.
580:
581: 1.4. Typography
582:
583: When giving examples for commands, shell prompts are used to show if the
584: command should/can be issued as root, or if "normal" user privileges are
1.115 sevan 585: sufficient. We use a # for root's shell prompt, a % for users' shell prompt,
1.229 gutterid 586: assuming they use the C-shell or tcsh and a $ for Bourne shell and derivatives.
1.1 dsieger 587:
588: Part I. The pkgsrc user's guide
589:
590: Table of Contents
591:
1.154 rillig 592: 2. Getting help
593: 3. Where to get pkgsrc and how to keep it up-to-date
594: 3.1. Getting pkgsrc for the first time
595: 3.1.1. As tar archive
596: 3.1.2. Via anonymous CVS
597: 3.2. Keeping pkgsrc up-to-date
598: 3.2.1. Via tar files
599: 3.2.2. Via CVS
600: 4. Using pkgsrc on systems other than NetBSD
601: 4.1. Binary distribution
602: 4.2. Bootstrapping pkgsrc
603: 5. Using pkgsrc
604: 5.1. Using binary packages
605: 5.1.1. Finding binary packages
606: 5.1.2. Installing binary packages
1.202 nia 607: 5.1.3. Updating packages
608: 5.1.4. Deinstalling packages
609: 5.1.5. Getting information about installed packages
610: 5.1.6. Checking for security vulnerabilities in installed packages
611: 5.1.7. Finding if newer versions of your installed packages are in
1.232 gutterid 612: pkgsrc
1.202 nia 613: 5.1.8. Other administrative functions
1.154 rillig 614: 5.2. Building packages from source
615: 5.2.1. Requirements
616: 5.2.2. Fetching distfiles
617: 5.2.3. How to build and install
618: 6. Configuring pkgsrc
619: 6.1. General configuration
620: 6.2. Variables affecting the build process
1.241 rillig 621: 6.3. Preferences for native or pkgsrc software
622: 6.4. Variables affecting the installation process
623: 6.5. Selecting and configuring the compiler
624: 6.5.1. Selecting the compiler
625: 6.5.2. Additional flags to the compiler (CFLAGS)
626: 6.5.3. Additional flags to the linker (LDFLAGS)
627: 6.6. Developer/advanced settings
628: 6.7. Selecting Build Options
1.154 rillig 629: 7. Creating binary packages
630: 7.1. Building a single binary package
631: 7.2. Settings for creation of binary packages
632: 8. Creating binary packages for everything in pkgsrc (bulk builds)
633: 8.1. Preparations
1.180 rillig 634: 8.2. Running a bulk build
1.154 rillig 635: 8.2.1. Configuration
636: 8.3. Requirements of a full bulk build
1.178 rillig 637: 8.4. Bulk build variants
1.179 rillig 638: 8.4.1. Detect unknown configure options
639: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 640: 8.4.3. Force compiler options only in the build phase
641: 8.4.4. Use custom directories
642: 8.4.5. Turn warnings into errors
643: 8.4.6. Reject packages for which pkglint reports errors
644: 8.4.7. Reject packages that contain forbidden strings
645: 8.4.8. Reject packages whose self-test fails
646: 8.4.9. Reject packages that use undefined shell variables
647: 8.4.10. Turn off verbose logging
1.178 rillig 648: 8.5. Creating a multiple CD-ROM packages collection
649: 8.5.1. Example of cdpack
1.154 rillig 650: 9. Directory layout of the installed files
651: 9.1. File system layout in ${LOCALBASE}
652: 9.2. File system layout in ${VARBASE}
653: 10. Frequently Asked Questions
654: 10.1. Are there any mailing lists for pkg-related discussion?
655: 10.2. Utilities for package management (pkgtools)
656: 10.3. How to use pkgsrc as non-root
657: 10.4. How to resume transfers when fetching distfiles?
658: 10.5. How can I install/use modular X.org from pkgsrc?
659: 10.6. How to fetch files from behind a firewall
660: 10.7. How to fetch files from HTTPS sites
661: 10.8. How do I tell make fetch to do passive FTP?
662: 10.9. How to fetch all distfiles at once
663: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
664: 10.11. What does "Could not find bsd.own.mk" mean?
1.221 nia 665: 10.12. Using 'sudo' or `priv` with pkgsrc
1.154 rillig 666: 10.13. How do I change the location of configuration files?
667: 10.14. Automated security checks
668: 10.15. Why do some packages ignore my CFLAGS?
669: 10.16. A package does not build. What shall I do?
670: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.232 gutterid 671: conflicts" mean?
1.1 dsieger 672:
1.154 rillig 673: Chapter 2. Getting help
674:
675: To get help when using pkgsrc, the definitive source is this document, the
676: pkgsrc guide. If you don't find anything here, there are alternatives:
677:
678: * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
679: Run bmake help topic=? to get help for any topic, such as a variable name
680: like BUILD_DEFS, a make target like do-build, a missing C or C++ function
681: like strcasecmp or any other topic.
682:
1.207 leot 683: The available help topics are listed in Appendix E, Help topics.
1.154 rillig 684:
1.163 rillig 685: * To see the value of a single variable, run bmake show-var VARNAME=X.
686:
687: * To see the values of the most common variables, run bmake show-all. These
688: variables are grouped by topic. To see the variables for a single topic,
689: run bmake show-all-topic, for example bmake show-all-fetch.
690:
1.154 rillig 691: * The pkgsrc-users mailing list, to which you can subscribe and then ask your
692: questions.
693:
694: * The #pkgsrc IRC channel, which is accessible via a web browser or by using
695: a specialized chat program such as XChat. Pick any user name and join the
696: channel #pkgsrc.
697:
698: Chapter 3. Where to get pkgsrc and how to keep it up-to-date
1.1 dsieger 699:
700: Table of Contents
701:
1.154 rillig 702: 3.1. Getting pkgsrc for the first time
703: 3.1.1. As tar archive
704: 3.1.2. Via anonymous CVS
705: 3.2. Keeping pkgsrc up-to-date
706: 3.2.1. Via tar files
707: 3.2.2. Via CVS
1.1 dsieger 708:
709: Before you download and extract the files, you need to decide where you want to
710: extract them. When using pkgsrc as root user, pkgsrc is usually installed in /
711: usr/pkgsrc. You are though free to install the sources and binary packages
712: wherever you want in your filesystem, provided that the pathname does not
713: contain white-space or other characters that are interpreted specially by the
714: shell and some other programs. A safe bet is to use only letters, digits,
715: underscores and dashes.
716:
1.154 rillig 717: 3.1. Getting pkgsrc for the first time
1.1 dsieger 718:
1.25 wiz 719: Before you download any pkgsrc files, you should decide whether you want the
1.1 dsieger 720: current branch or the stable branch. The latter is forked on a quarterly basis
721: from the current branch and only gets modified for security updates. The names
722: of the stable branches are built from the year and the quarter, for example
1.246 leot 723: 2023Q3.
1.1 dsieger 724:
725: The second step is to decide how you want to download pkgsrc. You can get it as
1.24 wiz 726: a tar file or via CVS. Both ways are described here.
1.1 dsieger 727:
1.52 asau 728: Note that tar archive contains CVS working copy. Thus you can switch to using
729: CVS at any later time.
1.1 dsieger 730:
1.154 rillig 731: 3.1.1. As tar archive
1.52 asau 732:
1.151 sevan 733: The primary download location for all pkgsrc files is https://cdn.NetBSD.org/
734: pub/pkgsrc/ or ftp://ftp.NetBSD.org/pub/pkgsrc/ (it points to the same
735: location). There are a number of subdirectories for different purposes, which
1.207 leot 736: are described in detail in Appendix D, Directory layout of the pkgsrc FTP
1.151 sevan 737: server.
1.1 dsieger 738:
1.52 asau 739: The tar archive for the current branch is in the directory current and is
1.118 sevan 740: called pkgsrc.tar.gz. It is autogenerated weekly.
1.52 asau 741:
742: To save download time we provide bzip2- and xz-compressed archives which are
743: published at pkgsrc.tar.bz2 and pkgsrc.tar.xz respectively.
744:
745: You can fetch the same files using FTP.
1.1 dsieger 746:
1.246 leot 747: The tar file for the stable branch 2023Q3 is in the directory pkgsrc-2023Q3 and
1.59 jnemeth 748: is also called pkgsrc.tar.gz.
1.1 dsieger 749:
1.136 leot 750: To download the latest pkgsrc stable tarball, run:
1.12 weinem 751:
1.246 leot 752: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2023Q3/pkgsrc.tar.gz
1.12 weinem 753:
1.78 snj 754: If you prefer, you can also fetch it using "wget", "curl", or your web browser.
1.52 asau 755:
1.12 weinem 756: Then, extract it with:
757:
1.78 snj 758: $ tar -xzf pkgsrc.tar.gz -C /usr
1.12 weinem 759:
760: This will create the directory pkgsrc/ in /usr/ and all the package source will
761: be stored under /usr/pkgsrc/.
762:
763: To download pkgsrc-current, run:
764:
765: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz
1.1 dsieger 766:
1.154 rillig 767: 3.1.2. Via anonymous CVS
1.1 dsieger 768:
1.24 wiz 769: To fetch a specific pkgsrc stable branch, run:
1.1 dsieger 770:
1.246 leot 771: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2023Q3 -P pkgsrc
1.13 weinem 772:
1.24 wiz 773: This will create the directory pkgsrc/ in your /usr/ directory and all the
774: package source will be stored under /usr/pkgsrc/.
775:
776: To fetch the pkgsrc current branch, run:
1.1 dsieger 777:
1.40 wiz 778: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 779:
1.30 dholland 780: Refer to the list of available mirrors to choose a faster CVS mirror, if
781: needed.
1.1 dsieger 782:
1.24 wiz 783: If you get error messages from rsh, you need to set CVS_RSH variable. E.g.:
1.1 dsieger 784:
1.40 wiz 785: $ cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 786:
1.24 wiz 787: Refer to documentation on your command shell how to set CVS_RSH=ssh
788: permanently. For Bourne shells, you can set it in your .profile or better
789: globally in /etc/profile:
790:
791: # set CVS remote shell command
792: CVS_RSH=ssh
793: export CVS_RSH
1.12 weinem 794:
1.13 weinem 795: By default, CVS doesn't do things like most people would expect it to do. But
796: there is a way to convince CVS, by creating a file called .cvsrc in your home
1.12 weinem 797: directory and saving the following lines to it. This file will save you lots of
798: headache and some bug reports, so we strongly recommend it. You can find an
799: explanation of this file in the CVS documentation.
1.2 rillig 800:
801: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 802: cvs -q
1.2 rillig 803: checkout -P
1.4 rillig 804: update -dP
805: diff -upN
1.2 rillig 806: rdiff -u
1.24 wiz 807: release -d
1.1 dsieger 808:
1.154 rillig 809: 3.2. Keeping pkgsrc up-to-date
1.1 dsieger 810:
811: The preferred way to keep pkgsrc up-to-date is via CVS (which also works if you
812: have first installed it via a tar file). It saves bandwidth and hard disk
813: activity, compared to downloading the tar file again.
814:
1.154 rillig 815: 3.2.1. Via tar files
1.1 dsieger 816:
817: Warning
818:
819: When updating from a tar file, you first need to completely remove the old
820: pkgsrc directory. Otherwise those files that have been removed from pkgsrc in
821: the mean time will not be removed on your local disk, resulting in
822: inconsistencies. When removing the old files, any changes that you have done to
823: the pkgsrc files will be lost after updating. Therefore updating via CVS is
824: strongly recommended.
825:
826: Note that by default the distfiles and the binary packages are saved in the
827: pkgsrc tree, so don't forget to rescue them before updating. You can also
1.78 snj 828: configure pkgsrc to store distfiles and packages in directories outside the
1.154 rillig 829: pkgsrc tree by setting the DISTDIR and PACKAGES variables. See Chapter 6,
1.78 snj 830: Configuring pkgsrc for the details.
1.1 dsieger 831:
832: To update pkgsrc from a tar file, download the tar file as explained above.
833: Then, make sure that you have not made any changes to the files in the pkgsrc
834: directory. Remove the pkgsrc directory and extract the new tar file. Done.
835:
1.154 rillig 836: 3.2.2. Via CVS
1.1 dsieger 837:
1.26 spz 838: To update pkgsrc via CVS, change to the pkgsrc directory and run cvs:
1.12 weinem 839:
1.26 spz 840: $ cd /usr/pkgsrc && cvs update -dP
841:
842: If you get error messages from rsh, you need to set CVS_RSH variable as
843: described above. E.g.:
844:
845: $ cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP
1.1 dsieger 846:
1.154 rillig 847: 3.2.2.1. Switching between different pkgsrc branches
1.1 dsieger 848:
849: When updating pkgsrc, the CVS program keeps track of the branch you selected.
850: But if you, for whatever reason, want to switch from the stable branch to the
851: current one, you can do it by adding the option "-A" after the "update"
1.25 wiz 852: keyword. To switch from the current branch back to the stable branch, add the "
1.246 leot 853: -rpkgsrc-2023Q3" option.
1.1 dsieger 854:
1.154 rillig 855: 3.2.2.2. What happens to my changes when updating?
1.1 dsieger 856:
857: When you update pkgsrc, the CVS program will only touch those files that are
858: registered in the CVS repository. That means that any packages that you created
859: on your own will stay unmodified. If you change files that are managed by CVS,
860: later updates will try to merge your changes with those that have been done by
861: others. See the CVS manual, chapter "update" for details.
862:
1.154 rillig 863: Chapter 4. Using pkgsrc on systems other than NetBSD
1.1 dsieger 864:
865: Table of Contents
866:
1.154 rillig 867: 4.1. Binary distribution
868: 4.2. Bootstrapping pkgsrc
1.1 dsieger 869:
1.154 rillig 870: 4.1. Binary distribution
1.1 dsieger 871:
1.154 rillig 872: See Section 5.1, "Using binary packages".
1.1 dsieger 873:
1.154 rillig 874: 4.2. Bootstrapping pkgsrc
1.1 dsieger 875:
1.44 asau 876: pkgsrc can be bootstrapped for use in two different modes: privileged and
877: unprivileged one. In unprivileged mode in contrast to privileged one all
1.45 asau 878: programs are installed under one particular user and cannot utilise privileged
1.44 asau 879: operations (packages don't create special users and all special file
880: permissions like setuid are ignored).
881:
1.1 dsieger 882: Installing the bootstrap kit from source should be as simple as:
883:
1.60 asau 884: # env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 885: # cd pkgsrc/bootstrap
886: # ./bootstrap
887:
888:
1.44 asau 889: To bootstrap in unprivileged mode pass "--unprivileged" flag to bootstrap
890:
891: By default, in privileged mode pkgsrc uses /usr/pkg for prefix where programs
1.118 sevan 892: will be installed in, and /usr/pkg/pkgdb for the package database directory
893: where pkgsrc will do its internal bookkeeping, /var is used as varbase, where
1.44 asau 894: packages install their persistent data. In unprivileged mode pkgsrc uses ~/pkg
1.118 sevan 895: for prefix, ~/pkg/pkgdb for the package database, and ~/pkg/var for varbase.
1.44 asau 896:
897: You can change default layout using command-line arguments. Run "./bootstrap
898: --help" to get details.
1.1 dsieger 899:
900: Note
901:
902: The bootstrap installs a bmake tool. Use this bmake when building via pkgsrc.
903: For examples in this guide, use bmake instead of "make".
904:
1.44 asau 905: Note
906:
907: It is possible to bootstrap multiple instances of pkgsrc using non-intersecting
908: directories. Use bmake corresponding to the installation you're working with to
909: build and install packages.
910:
1.154 rillig 911: Chapter 5. Using pkgsrc
1.1 dsieger 912:
913: Table of Contents
914:
1.154 rillig 915: 5.1. Using binary packages
916: 5.1.1. Finding binary packages
917: 5.1.2. Installing binary packages
1.202 nia 918: 5.1.3. Updating packages
919: 5.1.4. Deinstalling packages
920: 5.1.5. Getting information about installed packages
921: 5.1.6. Checking for security vulnerabilities in installed packages
922: 5.1.7. Finding if newer versions of your installed packages are in pkgsrc
923: 5.1.8. Other administrative functions
1.154 rillig 924: 5.2. Building packages from source
925: 5.2.1. Requirements
926: 5.2.2. Fetching distfiles
927: 5.2.3. How to build and install
1.1 dsieger 928:
929: Basically, there are two ways of using pkgsrc. The first is to only install the
930: package tools and to use binary packages that someone else has prepared. This
931: is the "pkg" in pkgsrc. The second way is to install the "src" of pkgsrc, too.
932: Then you are able to build your own packages, and you can still use binary
933: packages from someone else.
934:
1.154 rillig 935: 5.1. Using binary packages
1.1 dsieger 936:
1.151 sevan 937: On the cdn.NetBSD.org site and mirrors, there are collections of binary
1.9 rillig 938: packages, ready to be installed. These binary packages have been built using
939: the default settings for the directories, that is:
940:
941: * /usr/pkg for LOCALBASE, where most of the files are installed,
942:
943: * /usr/pkg/etc for configuration files,
944:
945: * /var for VARBASE, where those files are installed that may change after
946: installation.
947:
948: If you cannot use these directories for whatever reasons (maybe because you're
949: not root), you cannot use these binary packages, but have to build the packages
1.154 rillig 950: yourself, which is explained in Section 4.2, "Bootstrapping pkgsrc".
1.1 dsieger 951:
1.154 rillig 952: 5.1.1. Finding binary packages
1.1 dsieger 953:
1.5 weinem 954: To install binary packages, you first need to know from where to get them. The
1.202 nia 955: first place where you should look is on the main pkgsrc CDN in the directory /
956: pub/pkgsrc/packages.
1.5 weinem 957:
958: This directory contains binary packages for multiple platforms. First, select
1.226 gutterid 959: your operating system. Then, select your hardware architecture, and in the
960: third step, the OS version and the "version" of pkgsrc.
1.9 rillig 961:
1.226 gutterid 962: In this directory, you may find a file called bootstrap.tar.gz which contains
1.9 rillig 963: the package management tools. If the file is missing, it is likely that your
964: operating system already provides those tools. Download the file and extract it
965: in the / directory. It will create the directories /usr/pkg (containing the
1.118 sevan 966: tools for managing binary packages and the database of installed packages).
1.1 dsieger 967:
1.154 rillig 968: 5.1.2. Installing binary packages
1.1 dsieger 969:
1.85 wiz 970: In the directory from the last section, there is a subdirectory called All/,
1.9 rillig 971: which contains all the binary packages that are available for the platform,
1.202 nia 972: excluding those that may not be distributed via HTTP or FTP.
1.9 rillig 973:
974: To install packages directly from an FTP or HTTP server, run the following
975: commands in a Bourne-compatible shell (be sure to su to root first):
976:
1.202 nia 977: # PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"
978: # PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"
1.169 rillig 979: # PKG_PATH="$PKG_PATH/OPSYS/ARCH/VERSIONS/All/"
1.9 rillig 980: # export PATH PKG_PATH
1.202 nia 981: # pkg_add pkgin
1.9 rillig 982:
983: Instead of URLs, you can also use local paths, for example if you are
984: installing from a set of CDROMs, DVDs or an NFS-mounted repository. If you want
985: to install packages from multiple sources, you can separate them by a semicolon
986: in PKG_PATH.
987:
988: After these preparations, installing a package is very easy:
989:
1.202 nia 990: # pkgin search nginx
991: nginx-1.19.6 Lightweight HTTP server and mail proxy server
992: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
993: # pkgin install zsh nginx-1.19.6 vim
1.1 dsieger 994:
1.202 nia 995: Note that pkgin is a user-friendly frontend to the pkg_* tools.
1.1 dsieger 996:
1.202 nia 997: Any prerequisite packages needed to run the package in question will be
998: installed, too, assuming they are present in the repository.
1.1 dsieger 999:
1000: After you've installed packages, be sure to have /usr/pkg/bin and /usr/pkg/sbin
1001: in your PATH so you can actually start the just installed program.
1002:
1.202 nia 1003: 5.1.3. Updating packages
1.1 dsieger 1004:
1.202 nia 1005: To update binary packages, it is recommended that you use pkgin upgrade. This
1006: will compare the remote package repository to your locally installed packages
1007: and safely replace any older packages.
1.1 dsieger 1008:
1.202 nia 1009: Note that pkgsrc is released as quarterly branches. If you are updating to a
1010: newer quarterly branch of pkgsrc, you may need to adjust the repository in /usr
1011: /pkg/etc/pkgin/repositories.conf.
1.1 dsieger 1012:
1.202 nia 1013: 5.1.4. Deinstalling packages
1.1 dsieger 1014:
1.202 nia 1015: To deinstall a package, it does not matter whether it was installed from source
1016: code or from a binary package. Neither the pkgin or the pkg_delete command need
1017: to know.
1.1 dsieger 1018:
1.202 nia 1019: To delete a package, you can just run pkgin remove package-name. The package
1020: name can be given with or without version number.
1.1 dsieger 1021:
1.202 nia 1022: 5.1.5. Getting information about installed packages
1.1 dsieger 1023:
1024: The pkg_info shows information about installed packages or binary package
1.202 nia 1025: files. As with other management tools, it works with packages installed from
1026: source or binaries.
1.1 dsieger 1027:
1.202 nia 1028: 5.1.6. Checking for security vulnerabilities in installed packages
1.1 dsieger 1029:
1.202 nia 1030: The pkgsrc Security Team and Packages Groups maintain a list of known
1.164 leot 1031: vulnerabilities to packages which are (or have been) included in pkgsrc. The
1.202 nia 1032: list is available from the NetBSD CDN at https://cdn.NetBSD.org/pub/NetBSD/
1.179 rillig 1033: packages/vulns/pkg-vulnerabilities.
1.1 dsieger 1034:
1.202 nia 1035: Please note that not every "vulnerability" with a CVE assignment is exploitable
1036: in every configuration. Some bugs are marked as active simply because an fix
1037: was not marked as such. Operating system specific hardening and mitigation
1038: features may also reduce the impact of bugs.
1039:
1.23 jakllsch 1040: Through pkg_admin fetch-pkg-vulnerabilities, this list can be downloaded
1041: automatically, and a security audit of all packages installed on a system can
1042: take place.
1043:
1044: There are two components to auditing. The first step, pkg_admin
1045: fetch-pkg-vulnerabilities, is for downloading the list of vulnerabilities from
1046: the NetBSD FTP site. The second step, pkg_admin audit, checks to see if any of
1047: your installed packages are vulnerable. If a package is vulnerable, you will
1048: see output similar to the following:
1.1 dsieger 1049:
1050: Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1051: https://www.samba.org/samba/whatsnew/macroexploit.html
1.1 dsieger 1052:
1.23 jakllsch 1053: You may wish to have the vulnerabilities file downloaded daily so that it
1054: remains current. This may be done by adding an appropriate entry to the root
1055: users crontab(5) entry. For example the entry
1056:
1.121 sevan 1057: # Download vulnerabilities file
1.118 sevan 1058: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1059: # Audit the installed packages and email results to root
1060: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1061: root >/dev/null 2>&1
1.118 sevan 1062:
1063:
1064: will update the vulnerability list every day at 3AM, followed by an audit at
1065: 3:09AM. The result of the audit are then emailed to root. On NetBSD this may be
1066: accomplished instead by adding the following line to /etc/daily.conf:
1067:
1068: fetch_pkg_vulnerabilities=YES
1069:
1.23 jakllsch 1070:
1.118 sevan 1071: to fetch the vulnerability list from the daily security script. The system is
1072: set to audit the packages by default but can be set explicitly, if desired (not
1.123 wiz 1073: required), by adding the following line to /etc/security.conf:
1.23 jakllsch 1074:
1.118 sevan 1075: check_pkg_vulnerabilities=YES
1.23 jakllsch 1076:
1077:
1.118 sevan 1078: see daily.conf(5) and security.conf(5) for more details.
1.1 dsieger 1079:
1.202 nia 1080: 5.1.7. Finding if newer versions of your installed packages are in pkgsrc
1.1 dsieger 1081:
1.12 weinem 1082: Install pkgtools/lintpkgsrc and run lintpkgsrc with the "-i" argument to check
1.202 nia 1083: if any packages are stale, e.g.
1.1 dsieger 1084:
1085: % lintpkgsrc -i
1086: ...
1087: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1088:
1089:
1.202 nia 1090: 5.1.8. Other administrative functions
1.1 dsieger 1091:
1092: The pkg_admin executes various administrative functions on the package system.
1093:
1.154 rillig 1094: 5.2. Building packages from source
1.1 dsieger 1095:
1096: After obtaining pkgsrc, the pkgsrc directory now contains a set of packages,
1.25 wiz 1097: organized into categories. You can browse the online index of packages, or run
1.1 dsieger 1098: make readme from the pkgsrc directory to build local README.html files for all
1099: packages, viewable with any web browser such as www/lynx or www/firefox.
1100:
1101: The default prefix for installed packages is /usr/pkg. If you wish to change
1102: this, you should do so by setting LOCALBASE in mk.conf. You should not try to
1103: use multiple different LOCALBASE definitions on the same system (inside a
1104: chroot is an exception).
1105:
1106: The rest of this chapter assumes that the package is already in pkgsrc. If it
1107: is not, see Part II, "The pkgsrc developer's guide" for instructions how to
1108: create your own packages.
1109:
1.154 rillig 1110: 5.2.1. Requirements
1.1 dsieger 1111:
1112: To build packages from source, you need a working C compiler. On NetBSD, you
1113: need to install the "comp" and the "text" distribution sets. If you want to
1114: build X11-related packages, the "xbase" and "xcomp" distribution sets are
1115: required, too.
1116:
1.154 rillig 1117: 5.2.2. Fetching distfiles
1.1 dsieger 1118:
1119: The first step for building a package is downloading the distfiles (i.e. the
1120: unmodified source). If they have not yet been downloaded, pkgsrc will fetch
1121: them automatically.
1122:
1123: If you have all files that you need in the distfiles directory, you don't need
1124: to connect. If the distfiles are on CD-ROM, you can mount the CD-ROM on /cdrom
1125: and add:
1126:
1127: DISTDIR=/cdrom/pkgsrc/distfiles
1128:
1129: to your mk.conf.
1130:
1131: By default a list of distribution sites will be randomly intermixed to prevent
1132: huge load on servers which holding popular packages (for example,
1133: SourceForge.net mirrors). Thus, every time when you need to fetch yet another
1134: distfile all the mirrors will be tried in new (random) order. You can turn this
1135: feature off by setting MASTER_SORT_RANDOM=NO (for PKG_DEVELOPERs it's already
1136: disabled).
1137:
1138: You can overwrite some of the major distribution sites to fit to sites that are
1139: close to your own. By setting one or two variables you can modify the order in
1140: which the master sites are accessed. MASTER_SORT contains a whitespace
1141: delimited list of domain suffixes. MASTER_SORT_REGEX is even more flexible, it
1142: contains a whitespace delimited list of regular expressions. It has higher
1143: priority than MASTER_SORT. Have a look at pkgsrc/mk/defaults/mk.conf to find
1144: some examples. This may save some of your bandwidth and time.
1145:
1146: You can change these settings either in your shell's environment, or, if you
1.4 rillig 1147: want to keep the settings, by editing the mk.conf file, and adding the
1.1 dsieger 1148: definitions there.
1149:
1.132 wiz 1150: If a package depends on many other packages (such as meta-pkgs/kde4), the build
1.1 dsieger 1151: process may alternate between periods of downloading source, and compiling. To
1152: ensure you have all the source downloaded initially you can run the command:
1153:
1154: % make fetch-list | sh
1155:
1156: which will output and run a set of shell commands to fetch the necessary files
1157: into the distfiles directory. You can also choose to download the files
1158: manually.
1159:
1.154 rillig 1160: 5.2.3. How to build and install
1.1 dsieger 1161:
1162: Once the software has downloaded, any patches will be applied, then it will be
1163: compiled for you. This may take some time depending on your computer, and how
1164: many other packages the software depends on and their compile time.
1165:
1166: Note
1167:
1168: If using bootstrap or pkgsrc on a non-NetBSD system, use the pkgsrc bmake
1169: command instead of "make" in the examples in this guide.
1170:
1171: For example, type
1172:
1173: % cd misc/figlet
1174: % make
1175:
1176:
1177: at the shell prompt to build the various components of the package.
1178:
1179: The next stage is to actually install the newly compiled program onto your
1180: system. Do this by entering:
1181:
1182: % make install
1183:
1184:
1185: while you are still in the directory for whatever package you are installing.
1186:
1187: Installing the package on your system may require you to be root. However,
1188: pkgsrc has a just-in-time-su feature, which allows you to only become root for
1189: the actual installation step.
1190:
1191: That's it, the software should now be installed and setup for use. You can now
1192: enter:
1193:
1194: % make clean
1195:
1196:
1197: to remove the compiled files in the work directory, as you shouldn't need them
1198: any more. If other packages were also added to your system (dependencies) to
1199: allow your program to compile, you can tidy these up also with the command:
1200:
1201: % make clean-depends
1202:
1203:
1204: Taking the figlet utility as an example, we can install it on our system by
1.207 leot 1205: building as shown in Appendix C, Build logs.
1.1 dsieger 1206:
1207: The program is installed under the default root of the packages tree - /usr/
1208: pkg. Should this not conform to your tastes, set the LOCALBASE variable in your
1209: environment, and it will use that value as the root of your packages tree. So,
1210: to use /usr/local, set LOCALBASE=/usr/local in your environment. Please note
1211: that you should use a directory which is dedicated to packages and not shared
1212: with other programs (i.e., do not try and use LOCALBASE=/usr). Also, you should
1213: not try to add any of your own files or directories (such as src/, obj/, or
1214: pkgsrc/) below the LOCALBASE tree. This is to prevent possible conflicts
1215: between programs and other files installed by the package system and whatever
1216: else may have been installed there.
1217:
1.4 rillig 1218: Some packages look in mk.conf to alter some configuration options at build
1.1 dsieger 1219: time. Have a look at pkgsrc/mk/defaults/mk.conf to get an overview of what will
1220: be set there by default. Environment variables such as LOCALBASE can be set in
1.4 rillig 1221: mk.conf to save having to remember to set them each time you want to use
1.1 dsieger 1222: pkgsrc.
1223:
1224: Occasionally, people want to "look under the covers" to see what is going on
1225: when a package is building or being installed. This may be for debugging
1226: purposes, or out of simple curiosity. A number of utility values have been
1227: added to help with this.
1228:
1229: 1. If you invoke the make(1) command with PKG_DEBUG_LEVEL=2, then a huge
1230: amount of information will be displayed. For example,
1231:
1232: make patch PKG_DEBUG_LEVEL=2
1233:
1.25 wiz 1234: will show all the commands that are invoked, up to and including the "patch
1235: " stage.
1.1 dsieger 1236:
1237: 2. If you want to know the value of a certain make(1) definition, then the
1238: VARNAME definition should be used, in conjunction with the show-var target.
1239: e.g. to show the expansion of the make(1) variable LOCALBASE:
1240:
1241: % make show-var VARNAME=LOCALBASE
1242: /usr/pkg
1243: %
1244:
1245:
1246: If you want to install a binary package that you've either created yourself
1247: (see next section), that you put into pkgsrc/packages manually or that is
1248: located on a remote FTP server, you can use the "bin-install" target. This
1249: target will install a binary package - if available - via pkg_add(1), else do a
1250: make package. The list of remote FTP sites searched is kept in the variable
1251: BINPKG_SITES, which defaults to ftp.NetBSD.org. Any flags that should be added
1252: to pkg_add(1) can be put into BIN_INSTALL_FLAGS. See pkgsrc/mk/defaults/mk.conf
1253: for more details.
1254:
1255: A final word of warning: If you set up a system that has a non-standard setting
1256: for LOCALBASE, be sure to set that before any packages are installed, as you
1257: cannot use several directories for the same purpose. Doing so will result in
1258: pkgsrc not being able to properly detect your installed packages, and fail
1259: miserably. Note also that precompiled binary packages are usually built with
1260: the default LOCALBASE of /usr/pkg, and that you should not install any if you
1261: use a non-standard LOCALBASE.
1262:
1.154 rillig 1263: Chapter 6. Configuring pkgsrc
1.1 dsieger 1264:
1265: Table of Contents
1266:
1.154 rillig 1267: 6.1. General configuration
1268: 6.2. Variables affecting the build process
1.241 rillig 1269: 6.3. Preferences for native or pkgsrc software
1270: 6.4. Variables affecting the installation process
1271: 6.5. Selecting and configuring the compiler
1272: 6.5.1. Selecting the compiler
1273: 6.5.2. Additional flags to the compiler (CFLAGS)
1274: 6.5.3. Additional flags to the linker (LDFLAGS)
1275: 6.6. Developer/advanced settings
1276: 6.7. Selecting Build Options
1.1 dsieger 1277:
1278: The whole pkgsrc system is configured in a single file, usually called mk.conf.
1279: In which directory pkgsrc looks for that file depends on the installation. On
1280: NetBSD, when you use make(1) from the base system, it is in the directory /etc
1281: /. In all other cases the default location is ${PREFIX}/etc/, depending on
1282: where you told the bootstrap program to install the binary packages.
1283:
1284: The format of the configuration file is that of the usual BSD-style Makefiles.
1285: The whole pkgsrc configuration is done by setting variables in this file. Note
1286: that you can define all kinds of variables, and no special error checking (for
1.112 rillig 1287: example for spelling mistakes) takes place.
1.1 dsieger 1288:
1.154 rillig 1289: 6.1. General configuration
1.1 dsieger 1290:
1.112 rillig 1291: The following variables apply to all pkgsrc packages. A complete list of the
1292: variables that can be configured by the user is available in mk/defaults/
1293: mk.conf, together with some comments that describe each variable's intent.
1.1 dsieger 1294:
1295: * LOCALBASE: Where packages will be installed. The default is /usr/pkg. Do
1296: not mix binary packages with different LOCALBASEs!
1297:
1298: * CROSSBASE: Where "cross" category packages will be installed. The default
1299: is ${LOCALBASE}/cross.
1300:
1.84 wiz 1301: * X11BASE: Where X11 is installed on the system. The default is /usr/X11R7.
1.1 dsieger 1302:
1303: * DISTDIR: Where to store the downloaded copies of the original source
1304: distributions used for building pkgsrc packages. The default is $
1305: {PKGSRCDIR}/distfiles.
1306:
1307: * PKG_DBDIR: Where the database about installed packages is stored. The
1.118 sevan 1308: default is /usr/pkg/pkgdb.
1.1 dsieger 1309:
1310: * MASTER_SITE_OVERRIDE: If set, override the packages' MASTER_SITES with this
1311: value.
1312:
1313: * MASTER_SITE_BACKUP: Backup location(s) for distribution files and patch
1314: files if not found locally or in ${MASTER_SITES} or ${PATCH_SITES}
1.118 sevan 1315: respectively. The defaults is ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/$
1.1 dsieger 1316: {DIST_SUBDIR}/.
1317:
1318: * BINPKG_SITES: List of sites carrying binary pkgs. rel and arch are replaced
1319: with OS release ("2.0", etc.) and architecture ("mipsel", etc.).
1320:
1.23 jakllsch 1321: * ACCEPTABLE_LICENSES: List of acceptable licenses. License names are
1322: case-sensitive. Whenever you try to build a package whose license is not in
1323: this list, you will get an error message. If the license condition is
1324: simple enough, the error message will include specific instructions on how
1325: to change this variable.
1.1 dsieger 1326:
1.154 rillig 1327: 6.2. Variables affecting the build process
1.1 dsieger 1328:
1329: * PACKAGES: The top level directory for the binary packages. The default is $
1330: {PKGSRCDIR}/packages.
1331:
1332: * WRKOBJDIR: The top level directory where, if defined, the separate working
1333: directories will get created, and symbolically linked to from ${WRKDIR}
1334: (see below). This is useful for building packages on several architectures,
1335: then ${PKGSRCDIR} can be NFS-mounted while ${WRKOBJDIR} is local to every
1336: architecture. (It should be noted that PKGSRCDIR should not be set by the
1.198 leot 1337: user -- it is an internal definition which refers to the root of the pkgsrc
1.1 dsieger 1338: tree. It is possible to have many pkgsrc tree instances.)
1339:
1340: * LOCALPATCHES: Directory for local patches that aren't part of pkgsrc. See
1.184 rillig 1341: Section 12.3, "patches/*" for more information.
1.1 dsieger 1342:
1343: * PKGMAKECONF: Location of the mk.conf file used by a package's BSD-style
1344: Makefile. If this is not set, MAKECONF is set to /dev/null to avoid picking
1345: up settings used by builds in /usr/src.
1346:
1.241 rillig 1347: 6.3. Preferences for native or pkgsrc software
1348:
1349: Whenever a package depends on a package that has a builtin.mk file, the
1350: dependent package can either use the built-in (native) version from the base
1351: system or the pkgsrc-provided version. This only affects dependencies, so it is
1352: still possible to build the pkgsrc package devel/pcre++ even when other
1353: packages depend on the native pcre++ version instead.
1354:
1355: To force using the pkgsrc-provided version for a particular package, define "
1356: PREFER_PKGSRC = package-ID" in mk.conf. To force using the native package,
1357: define "PREFER_NATIVE = package-ID". In both cases, the package-ID is the one
1358: from the buildlink3.mk of the package. In most cases, this ID is the same as
1359: the directory name of the package, but for example, devel/pcre++ has the
1360: package ID "pcrexx".
1361:
1362: For the packages that are not listed by their package ID, pkgsrc uses the
1363: pkgsrc-provided version if PREFER_PKGSRC contains the word "yes". Otherwise, if
1364: PREFER_NATIVE contains the word "yes", pkgsrc uses the native version. For
1365: example, to require using the pkgsrc-provided versions for all but the most
1366: basic bits on a NetBSD system, you can set:
1367:
1368: PREFER_PKGSRC= yes
1369: PREFER_NATIVE= getopt skey tcp_wrappers
1370:
1371: A package must have a builtin.mk file to be listed in PREFER_NATIVE, otherwise
1372: it is simply ignored in that list.
1373:
1374: PREFER_PKGSRC and PREFER_NATIVE should be set during bootstrap to ensure that
1375: the bootstrap process does not use inapropriate native tools as dependencies
1376: for core packages.
1377:
1378: # ./bootstrap --prefer-pkgsrc yes --prefer-native openssl
1379:
1380: Switching between settings globally at a later date can introduce complications
1381: with dependency resolution. This is caused by packages built with the opposite
1382: preference being installed alongside each other. Hence, when changing any of
1383: these variables after bootstrap, you need to rebuild all packages depending on
1384: those whose preference has been changed. This is not trivial and should be
1385: avoided.
1386:
1387: When using pkgsrc on Linux systems, there is high risk of "leakage", where
1388: programs installed by pkgsrc may inadvertently use a command or library not
1389: installed by pkgsrc, e.g. those installed by yum or apt. Such foreign
1390: dependencies may be installed, removed, or upgraded to a version incompatible
1391: with the pkgsrc package at any time, causing pkgsrc packages to subsequently
1392: malfunction. Pkgsrc cannot prevent this, as it has no control over other
1393: package managers. Another potential problem is that under Redhat Enterprise and
1394: related Linux systems, yum packages are only patched and never upgraded, so
1395: eventually they may become too outdated for use by pkgsrc. Even intentionally
1396: using foreign dependencies, not considered leakage, can lead to these problems,
1397: so it is generally discouraged. In order to minimize such problems,
1398: PREFER_PKGSRC defaults to "yes" on Linux systems. This ensures that pkgsrc is
1399: aware of any changes to dependency packages and can rebuild or upgrade the
1400: entire dependency tree as needed. This default can be overridden by setting
1401: --prefer-pkgsrc to a list of packages and --prefer-native to "yes".
1402:
1403: 6.4. Variables affecting the installation process
1.1 dsieger 1404:
1.198 leot 1405: * PKGSRC_KEEP_BIN_PKGS: By default, binary packages of built packages are
1.150 leot 1406: preserved in ${PACKAGES}/All. Setting this variable to "no" prevents this.
1.1 dsieger 1407:
1.107 jnemeth 1408: Packages have to support installation into a subdirectory of WRKDIR. This
1409: allows a package to be built, before the actual filesystem is touched. DESTDIR
1410: support exists in two variations:
1.4 rillig 1411:
1412: * Basic DESTDIR support means that the package installation and packaging is
1413: still run as root.
1414:
1415: * Full DESTDIR support can run the complete build, installation and packaging
1416: as normal user. Root privileges are only needed to add packages.
1417:
1418: With basic DESTDIR support, make clean needs to be run as root.
1419:
1.17 imil 1420: Considering the foo/bar package, DESTDIR full support can be tested using the
1421: following commands
1422:
1423: $ id
1424: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1425: $ mkdir $HOME/packages
1426: $ cd $PKGSRCDIR/foo/bar
1427:
1428: Verify DESTDIR full support, no root privileges should be needed
1429:
1.66 asau 1430: $ make stage-install
1.17 imil 1431:
1432: Create a package without root privileges
1433:
1.66 asau 1434: $ make PACKAGES=$HOME/packages package
1.17 imil 1435:
1436: For the following command, you must be able to gain root privileges using su(1)
1437:
1.66 asau 1438: $ make PACKAGES=$HOME/packages install
1.17 imil 1439:
1440: Then, as a simple user
1441:
1442: $ make clean
1443:
1.241 rillig 1444: 6.5. Selecting and configuring the compiler
1.4 rillig 1445:
1.241 rillig 1446: 6.5.1. Selecting the compiler
1.1 dsieger 1447:
1448: By default, pkgsrc will use GCC to build packages. This may be overridden by
1449: setting the following variables in /etc/mk.conf:
1450:
1451: PKGSRC_COMPILER:
1452:
1453: This is a list of values specifying the chain of compilers to invoke when
1454: building packages. Valid values are:
1455:
1.232 gutterid 1456: o ccc: Compaq C Compilers (Tru64)
1.66 asau 1457:
1.232 gutterid 1458: o ccache: compiler cache (chainable)
1.66 asau 1459:
1.232 gutterid 1460: o clang: Clang C and Objective-C compiler
1.66 asau 1461:
1.232 gutterid 1462: o distcc: distributed C/C++ (chainable)
1.1 dsieger 1463:
1.232 gutterid 1464: o f2c: Fortran 77 to C compiler (chainable)
1.66 asau 1465:
1.232 gutterid 1466: o icc: Intel C++ Compiler (Linux)
1.66 asau 1467:
1.232 gutterid 1468: o ido: SGI IRIS Development Option cc (IRIX 5)
1.1 dsieger 1469:
1.232 gutterid 1470: o gcc: GNU C/C++ Compiler
1.1 dsieger 1471:
1.232 gutterid 1472: o hp: HP-UX C/aC++ compilers
1.66 asau 1473:
1.232 gutterid 1474: o mipspro: Silicon Graphics, Inc. MIPSpro (n32/n64)
1.1 dsieger 1475:
1.232 gutterid 1476: o mipspro-ucode: Silicon Graphics, Inc. MIPSpro (o32)
1.1 dsieger 1477:
1.232 gutterid 1478: o sunpro: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio
1.1 dsieger 1479:
1.232 gutterid 1480: o xlc: IBM's XL C/C++ compiler suite
1.66 asau 1481:
1.1 dsieger 1482: The default is "gcc". You can use ccache and/or distcc with an appropriate
1483: PKGSRC_COMPILER setting, e.g. "ccache gcc". This variable should always be
1484: terminated with a value for a real compiler. Note that only one real
1485: compiler should be listed (e.g. "sunpro gcc" is not allowed).
1486:
1487: GCC_REQD:
1488:
1489: This specifies the minimum version of GCC to use when building packages. If
1490: the system GCC doesn't satisfy this requirement, then pkgsrc will build and
1491: install one of the GCC packages to use instead.
1492:
1.153 leot 1493: PYTHON_VERSION_DEFAULT:
1.114 maya 1494:
1495: Specifies which version of python to use when several options are
1496: available.
1497:
1498: PKGSRC_FORTRAN:
1499:
1.176 gutterid 1500: Specifies the Fortran compiler to use. The default is gfortran.
1.114 maya 1501:
1502: GFORTRAN_VERSION:
1503:
1504: If PKGSRC_FORTRAN= gfortran is used, this option specifies which version to
1505: use.
1506:
1.241 rillig 1507: 6.5.2. Additional flags to the compiler (CFLAGS)
1.1 dsieger 1508:
1509: If you wish to set the CFLAGS variable, please make sure to use the += operator
1510: instead of the = operator:
1511:
1512: CFLAGS+= -your -flags
1513:
1514: Using CFLAGS= (i.e. without the "+") may lead to problems with packages that
1.16 jnemeth 1515: need to add their own flags. You may want to take a look at the devel/cpuflags
1.24 wiz 1516: package if you're interested in optimization specifically for the current CPU.
1.1 dsieger 1517:
1.241 rillig 1518: 6.5.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 1519:
1520: If you want to pass flags to the linker, both in the configure step and the
1521: build step, you can do this in two ways. Either set LDFLAGS or LIBS. The
1522: difference between the two is that LIBS will be appended to the command line,
1523: while LDFLAGS come earlier. LDFLAGS is pre-loaded with rpath settings for ELF
1524: machines depending on the setting of USE_IMAKE or the inclusion of mk/
1525: x11.buildlink3.mk. As with CFLAGS, if you do not wish to override these
1526: settings, use the += operator:
1527:
1528: LDFLAGS+= -your -linkerflags
1529:
1.241 rillig 1530: 6.6. Developer/advanced settings
1.1 dsieger 1531:
1532: * PKG_DEVELOPER: Run some sanity checks that package developers want:
1533:
1.42 asau 1534: + make sure patches apply with zero fuzz
1.1 dsieger 1535:
1.42 asau 1536: + run check-shlibs to see that all binaries will find their shared libs.
1.1 dsieger 1537:
1.232 gutterid 1538: * CHECK_FILES_STRICT: Also check VARBASE and PKG_SYSCONFDIR values in PLIST
1539: entries.
1540:
1.1 dsieger 1541: * PKG_DEBUG_LEVEL: The level of debugging output which is displayed whilst
1542: making and installing the package. The default value for this is 0, which
1543: will not display the commands as they are executed (normal, default, quiet
1544: operation); the value 1 will display all shell commands before their
1545: invocation, and the value 2 will display both the shell commands before
1.112 rillig 1546: their invocation, as well as their actual execution progress with set -x.
1.1 dsieger 1547:
1.241 rillig 1548: 6.7. Selecting Build Options
1.1 dsieger 1549:
1550: Some packages have build time options, usually to select between different
1551: dependencies, enable optional support for big dependencies or enable
1552: experimental features.
1553:
1554: To see which options, if any, a package supports, and which options are
1555: mutually exclusive, run make show-options, for example:
1556:
1557: The following options are supported by this package:
1558: ssl Enable SSL support.
1559: Exactly one of the following gecko options is required:
1560: firefox Use firefox as gecko rendering engine.
1561: mozilla Use mozilla as gecko rendering engine.
1562: At most one of the following database options may be selected:
1563: mysql Enable support for MySQL database.
1564: pgsql Enable support for PostgreSQL database.
1565:
1566: These options are enabled by default: firefox
1567: These options are currently enabled: mozilla ssl
1568:
1.4 rillig 1569: The following variables can be defined in mk.conf to select which options to
1570: enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
1.1 dsieger 1571: disable options for all packages that support them, and PKG_OPTIONS.pkgbase,
1572: which can be used to select or disable options specifically for package pkgbase
1573: . Options listed in these variables are selected, options preceded by "-" are
1574: disabled. A few examples:
1575:
1.4 rillig 1576: $ grep "PKG.*OPTION" mk.conf
1.1 dsieger 1577: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1578: PKG_OPTIONS.kdebase= debug -sasl
1579: PKG_OPTIONS.apache= suexec
1580:
1.11 rillig 1581: It is important to note that options that were specifically suggested by the
1.19 snj 1582: package maintainer must be explicitly removed if you do not wish to include the
1583: option. If you are unsure you can view the current state with make show-options
1584: .
1.11 rillig 1585:
1.1 dsieger 1586: The following settings are consulted in the order given, and the last setting
1587: that selects or disables an option is used:
1588:
1589: 1. the default options as suggested by the package maintainer
1590:
1591: 2. the options implied by the settings of legacy variables (see below)
1592:
1593: 3. PKG_DEFAULT_OPTIONS
1594:
1595: 4. PKG_OPTIONS.pkgbase
1596:
1597: For groups of mutually exclusive options, the last option selected is used, all
1598: others are automatically disabled. If an option of the group is explicitly
1599: disabled, the previously selected option, if any, is used. It is an error if no
1600: option from a required group of options is selected, and building the package
1601: will fail.
1602:
1603: Before the options framework was introduced, build options were selected by
1.4 rillig 1604: setting a variable (often named USE_FOO) in mk.conf for each option. To ease
1605: transition to the options framework for the user, these legacy variables are
1606: converted to the appropriate options setting (PKG_OPTIONS.pkgbase)
1607: automatically. A warning is issued to prompt the user to update mk.conf to use
1608: the options framework directly. Support for the legacy variables will be
1.1 dsieger 1609: removed eventually.
1610:
1.154 rillig 1611: Chapter 7. Creating binary packages
1.1 dsieger 1612:
1613: Table of Contents
1614:
1.154 rillig 1615: 7.1. Building a single binary package
1616: 7.2. Settings for creation of binary packages
1.1 dsieger 1617:
1.154 rillig 1618: 7.1. Building a single binary package
1.1 dsieger 1619:
1620: Once you have built and installed a package, you can create a binary package
1621: which can be installed on another system with pkg_add(1). This saves having to
1622: build the same package on a group of hosts and wasting CPU time. It also
1623: provides a simple means for others to install your package, should you
1624: distribute it.
1625:
1626: To create a binary package, change into the appropriate directory in pkgsrc,
1627: and run make package:
1628:
1.112 rillig 1629: $ cd misc/figlet
1630: $ make package
1.1 dsieger 1631:
1.242 gutterid 1632: This will build your package (if not already done) and package it into a binary
1633: package. You can then use the pkg_* tools to manipulate it. Binary packages are
1634: created in PACKAGES, which defaults to /usr/pkgsrc/packages, in the form of a
1635: compressed tar file. See Section C.2, "Packaging figlet" for a continuation of
1636: the above misc/figlet example.
1.1 dsieger 1637:
1.154 rillig 1638: See Chapter 23, Submitting and Committing for information on how to submit such
1.1 dsieger 1639: a binary package.
1640:
1.154 rillig 1641: 7.2. Settings for creation of binary packages
1.1 dsieger 1642:
1.184 rillig 1643: See Section 13.17, "Other helpful targets".
1.6 rillig 1644:
1.154 rillig 1645: Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6 rillig 1646:
1647: Table of Contents
1648:
1.154 rillig 1649: 8.1. Preparations
1.180 rillig 1650: 8.2. Running a bulk build
1.154 rillig 1651: 8.2.1. Configuration
1652: 8.3. Requirements of a full bulk build
1.178 rillig 1653: 8.4. Bulk build variants
1.179 rillig 1654: 8.4.1. Detect unknown configure options
1655: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 1656: 8.4.3. Force compiler options only in the build phase
1657: 8.4.4. Use custom directories
1658: 8.4.5. Turn warnings into errors
1659: 8.4.6. Reject packages for which pkglint reports errors
1660: 8.4.7. Reject packages that contain forbidden strings
1661: 8.4.8. Reject packages whose self-test fails
1662: 8.4.9. Reject packages that use undefined shell variables
1663: 8.4.10. Turn off verbose logging
1.178 rillig 1664: 8.5. Creating a multiple CD-ROM packages collection
1665: 8.5.1. Example of cdpack
1.6 rillig 1666:
1.175 gutterid 1667: For a number of reasons, you may want to build binary packages for a large
1668: selected set of packages in pkgsrc, or even for all pkgsrc packages. For
1.71 wiz 1669: instance, when you have multiple machines that should run the same software, it
1670: is wasted time if they all build their packages themselves from source. Or you
1671: may want to build a list of packages you want and check them before deploying
1.175 gutterid 1672: onto production systems. There is a way of getting a set of binary packages:
1673: the bulk build system, or pbulk ("p" stands for "parallel"). This chapter
1674: describes how to set it up.
1.71 wiz 1675:
1.154 rillig 1676: 8.1. Preparations
1.71 wiz 1677:
1678: First of all, you have to decide whether you build all packages or a limited
1679: set of them. Full bulk builds usually consume a lot more resources, both space
1.175 gutterid 1680: and time, than builds for some practical sets of packages. A number of
1681: particularly heavy packages exist that are not actually interesting to a wide
1682: audience. (The approximate resource consumption for a full bulk build is given
1683: in section Section 8.3, "Requirements of a full bulk build".) For limited bulk
1684: builds you need to make a list of packages you want to build. Note that all
1685: their dependencies will be built, so you don't need to track them manually.
1.71 wiz 1686:
1687: During bulk builds various packages are installed and deinstalled in /usr/pkg
1688: (or whatever LOCALBASE is), so make sure that you don't need any package during
1.112 rillig 1689: the builds. Essentially, you should provide a fresh system, either a chroot
1.71 wiz 1690: environment or something even more restrictive, depending on what the operating
1691: system provides, or dedicate the whole physical machine. As a useful side
1692: effect this makes sure that bulk builds cannot break anything in your system.
1693: There have been numerous cases where certain packages tried to install files
1694: outside the LOCALBASE or wanted to edit some files in /etc.
1.6 rillig 1695:
1.180 rillig 1696: 8.2. Running a bulk build
1.6 rillig 1697:
1.180 rillig 1698: Running a bulk build works roughly as follows:
1.15 rillig 1699:
1700: * First, build the pbulk infrastructure in a fresh pkgsrc location.
1701:
1702: * Then, build each of the packages from a clean installation directory using
1703: the infrastructure.
1704:
1.154 rillig 1705: 8.2.1. Configuration
1.6 rillig 1706:
1.112 rillig 1707: To simplify configuration, we provide the helper script mk/pbulk/pbulk.sh.
1.6 rillig 1708:
1.68 asau 1709: In order to use it, prepare a clear system (real one, chroot environment, jail,
1710: zone, virtual machine). Configure network access to fetch distribution files.
1.112 rillig 1711: Create a user with name "pbulk".
1.68 asau 1712:
1713: Fetch and extract pkgsrc. Use a command like one of these:
1714:
1.151 sevan 1715: # (cd /usr && ftp -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1716: # (cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1.72 wiz 1717: # (cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)
1.68 asau 1718:
1719: Or any other way that fits (e.g., curl, wget).
1720:
1721: Deploy and configure pbulk tools, e.g.:
1722:
1.118 sevan 1723: # sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)
1.68 asau 1724: # sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment
1725: # sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build
1726:
1727: Note
1728:
1729: mk.conf.frag is a fragment of mk.conf that contains settings you want to apply
1730: to packages you build. For instance,
1731:
1.112 rillig 1732: PKG_DEVELOPER= yes # perform more checks
1733: X11_TYPE= modular # use pkgsrc X11
1734: SKIP_LICENSE_CHECK= yes # accept all licences (useful
1735: # when building all packages)
1.68 asau 1736:
1737: If configured for limited list, replace the list in /usr/pbulk/etc/pbulk.list
1.112 rillig 1738: with your list of packages, one per line without empty lines or comments. E.g.:
1.68 asau 1739:
1740: www/firefox
1741: mail/thunderbird
1742: misc/libreoffice4
1743:
1.69 asau 1744: At this point you can also review configuration in /usr/pbulk/etc and make
1745: final amendments, if wanted.
1746:
1.68 asau 1747: Start it:
1748:
1749: # /usr/pbulk/bin/bulkbuild
1750:
1751: After it finishes, you'll have /mnt filled with distribution files, binary
1752: packages, and reports, plain text summary in /mnt/bulklog/meta/report.txt
1753:
1754: Note
1755:
1756: The pbulk.sh script does not cover all possible use cases. While being ready to
1757: run, it serves as a good starting point to understand and build more complex
1758: setups. The script is kept small enough for better understanding.
1759:
1760: Note
1761:
1762: The pbulk.sh script supports running unprivileged bulk build and helps
1.205 wiz 1763: configuring distributed bulk builds. Distributed bulk builds support either
1764: building in worker chroots (each node is a path to a different chroot) that
1765: replicate the target system, including the pbulk prefix, or remote machines
1766: (each node is an IP address that must be accessible over SSH without a
1767: password).
1.15 rillig 1768:
1.154 rillig 1769: 8.3. Requirements of a full bulk build
1.71 wiz 1770:
1771: A complete bulk build requires lots of disk space. Some of the disk space can
1772: be read-only, some other must be writable. Some can be on remote filesystems
1773: (such as NFS) and some should be local. Some can be temporary filesystems,
1774: others must survive a sudden reboot.
1775:
1.205 wiz 1776: * 70 GB for the distfiles (read-write, remote, temporary)
1.71 wiz 1777:
1.205 wiz 1778: * 60 GB for the binary packages (read-write, remote, permanent)
1.71 wiz 1779:
1780: * 1 GB for the pkgsrc tree (read-only, remote, permanent)
1781:
1782: * 5 GB for LOCALBASE (read-write, local, temporary)
1783:
1784: * 10 GB for the log files (read-write, remote, permanent)
1785:
1786: * 5 GB for temporary files (read-write, local, temporary)
1787:
1.178 rillig 1788: 8.4. Bulk build variants
1789:
1790: To ensure that pkgsrc packages work in different configurations, it makes sense
1791: to run non-default bulk builds from time to time. This section lists some ideas
1792: for bulk builds that intentionally let packages fail if they don't follow the
1793: pkgsrc style.
1794:
1.179 rillig 1795: 8.4.1. Detect unknown configure options
1.178 rillig 1796:
1797: Add the following line to mk.conf.
1798:
1799: GNU_CONFIGURE_STRICT= yes
1800:
1801: When a package fails this additional check, the most common cause is that the
1802: configure option was valid for an older version of the package but does not
1803: apply anymore. In that case, just remove it.
1804:
1.179 rillig 1805: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.178 rillig 1806:
1807: The job of a compiler is not restricted to producing executable code, most
1.179 rillig 1808: compilers also detect typical programming mistakes. The pkgsrc compiler
1809: wrappers make it easy to force compiler options when the package is built. This
1810: can be used to find typical bugs across all packages that are in pkgsrc. By
1811: reporting these bugs upstream, the packages will be more reliable with the next
1812: updates.
1.178 rillig 1813:
1.179 rillig 1814: Add some of the following lines to mk.conf:
1.178 rillig 1815:
1816: CFLAGS+= -Werror=char-subscripts
1.179 rillig 1817: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 1818:
1.179 rillig 1819: When a package fails to build using these stricter compiler options, document
1820: the circumstances in which the compiler produced the error message. This
1821: includes:
1.178 rillig 1822:
1823: * The platform (MACHINE_PLATFORM)
1824:
1825: * The source file
1826:
1827: * An excerpt of the code. GCC and Clang already do this as part of the
1828: diagnostic.
1829:
1.179 rillig 1830: * The exact error message from the compiler.
1.178 rillig 1831:
1.179 rillig 1832: If a package produces these error messages, but the package is fine, record
1833: this in your local mk.conf, like this, to skip this check in the next builds:
1.178 rillig 1834:
1.179 rillig 1835: .if ${PKGPATH} == category/package
1.178 rillig 1836: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
1837: # error message
1838: # code
1.179 rillig 1839: # Reason why the code does not need to be fixed.
1.178 rillig 1840: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 1841: .endif
1.178 rillig 1842:
1843: If the error messages from the compiler are valid and the code needs to be
1.179 rillig 1844: fixed, prepare a local patch (see LOCALPATCHES) and report the bug to the
1845: upstream authors of the package, providing them with the information you
1846: collected above.
1.178 rillig 1847:
1.179 rillig 1848: Patches that are not essential for the package to work should only be reported
1849: upstream but not committed to pkgsrc, to make future updates easier.
1850:
1.181 rillig 1851: 8.4.3. Force compiler options only in the build phase
1852:
1853: When adding custom compiler flags via CFLAGS, these apply to all phases of the
1854: package build process. Especially in the configure phase, adding -Werror leads
1855: to wrong decisions. The GNU configure scripts feed many small test programs to
1856: the C compiler to see whether certain headers are available, functions are
1857: defined in a library and programs can be run. In many cases these programs
1858: would not survive a strict compiler run with -Wall -Wextra -Werror.
1859:
1860: The pkgsrc infrastructure is flexible enough to support compiler options being
1861: added between the configure and build phases. It's a little more complicated
1862: than the other examples in this section but still easy enough.
1863:
1864: The basic idea is to use the pkgsrc compiler wrapper to inject the desired
1865: compiler options. The compiler wrapper's original task is to hide unwanted
1866: directories of include files and to normalize compiler options. It does this by
1867: wrapping the compiler command and rewriting the command line. To see this in
1868: action, run bmake patch in a package directory and examine the work/.cwrappers/
1869: config directory. It contains individual configurations for the C compiler and
1870: the related tools. The plan is to find a hook between the configure and build
1871: phases, and to modify these configuration files at that point.
1872:
1873: To find this hook, have a look at mk/build/build.mk, which contains among
1874: others the pre-build-checks-hook. The word checks doesn't quite fit, but the
1875: pre-build-hook sounds good enough.
1876:
1877: The code to be included in mk.conf is:
1878:
1879: # Just a few example options.
1880: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
1881:
1882: .if ${BUILD_ONLY_CFLAGS:U:M*}
1883: pre-build-checks-hook: add-build-only-cflags
1884:
1885: add-build-only-cflags: .PHONY
1886: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
1887: ${TEST} ! -f ${.TARGET} || exit 0; \
1888: for flag in ${BUILD_ONLY_CFLAGS}; do \
1889: ${ECHO} "append=$$flag" >> cc; \
1890: done; \
1891: > ${.TARGET}
1892: .endif
1893:
1894: (When editing the mk.conf, make sure that the commands of the
1895: add-build-only-cflags target are indented with a tab, not with spaces.)
1896:
1897: The condition in the .if statement contains the :U modifier to prevent parse
1898: errors if the variable should be undefined, possibly because it is only defined
1899: for a subset of the packages. The :M* modifier ensures that there is at least
1900: one compiler option, to prevent a syntax error in the shell parser.
1901:
1902: The code around the ${.TARGET} variable ensures that the additional compiler
1903: options are only appended once, even if bmake build is run multiple times. To
1904: do this, it creates a marker file.
1905:
1906: To verify that this setup works, run bmake configure in a package directory. Up
1907: to now, everything works as usual. Examine the directory work/.cwrappers/config
1908: to see that the compiler options from BUILD_ONLY_CFLAGS are not yet added to
1909: the file cc. Examine the tail of the work/.work.log file to see that the normal
1910: compiler options are used.
1911:
1912: Now run bmake build. This will append the options to the file cc and will
1913: create the marker file in the same directory. After that, the build starts as
1914: usual, but with the added compiler options. Examine the tail of the file work
1915: /.work.log to see that the lines starting with [*] don't contain the compiler
1916: options, but the corresponding lines starting with <.> do end with these
1917: options.
1918:
1919: Building packages using this setup variant and fixing the resulting bugs is the
1920: same as in Section 8.4.2, "Detect classes of bugs by forcing compiler warnings"
1921: .
1922:
1923: 8.4.4. Use custom directories
1.178 rillig 1924:
1925: Some directories like PREFIX, VARBASE, PKG_SYSCONFDIR, PKGMANDIR, PKG_INFODIR
1926: can be configured in pkgsrc. Set these to arbitrary paths during bootstrap or
1927: afterwards in mk.conf.
1928:
1929: PREFIX= /a-random-uuid
1930: PKG_SYSCONFDIR= /a-random-uuid
1931: VARBASE= /a-random-uuid
1932: PKGMANDIR= a-random-uuid
1933: PKG_INFODIR= a-random-uuid
1934:
1.181 rillig 1935: 8.4.5. Turn warnings into errors
1.178 rillig 1936:
1937: When building a package, warnings are typically ignored since they just flow by
1938: and do not cause the build to fail immediately. To find these warnings,
1939: redefine them to errors in mk.conf.
1940:
1941: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
1942: WARNING_MSG= ${FAIL_MSG} "(was warning)"
1943:
1944: (There are many more classes of warnings in pkgsrc, and most of them can be
1945: redefined with a simple definition like above.
1946:
1.179 rillig 1947: If a package suggests to add USE_TOOLS+=perl to the package Makefile, research
1.178 rillig 1948: whether the package actually needs Perl. If it does, add USE_TOOLS+=perl to the
1949: package Makefile, and if it doesn't, add TOOLS_BROKEN+=perl.
1950:
1.181 rillig 1951: 8.4.6. Reject packages for which pkglint reports errors
1.178 rillig 1952:
1953: Using pkglint as part of the regular build process is mostly a waste of time.
1954: If you want to fix some of the warnings, just run pkglint recursively on the
1955: whole pkgsrc tree. This will take a few minutes (up to 10), which is much
1956: faster than a complete bulk build.
1957:
1.181 rillig 1958: 8.4.7. Reject packages that contain forbidden strings
1.178 rillig 1959:
1960: To ensure that the binary packages don't contain references to the build
1961: directory, there is already CHECK_WRKREF. If that variable includes the item
1962: extra, it is possible to define additional patterns that must not appear in any
1963: installed file. This is specified in mk.conf.
1964:
1965: CHECK_WRKREF= extra
1966: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
1967: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
1968: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
1969:
1970: The above patterns will probably generate many false positives, therefore the
1971: results need to be taken with a grain of salt.
1972:
1.181 rillig 1973: 8.4.8. Reject packages whose self-test fails
1.178 rillig 1974:
1975: To run the test suites that come with each package, add this line to mk.conf.
1976:
1977: PKGSRC_RUN_TEST= yes
1978:
1979: Be prepared that even the most basic packages fail this test. When doing a bulk
1980: build with this, it will often abort in the early phase where the packages are
1981: scanned for their dependencies since there are cyclic dependencies. There is
1982: still a lot to do in this area.
1983:
1.181 rillig 1984: 8.4.9. Reject packages that use undefined shell variables
1.178 rillig 1985:
1986: To catch typos in the shell snippets from the Makefile fragments, add the -u
1987: flag to most of the commands by adding this line to mk.conf.
1988:
1989: RUN= @set -eu;
1990:
1.181 rillig 1991: After that, ensure that none of the bulk build log files (even those for
1992: successfully built packages) contains the string parameter not set or whatever
1993: error message the command sh -ceu '$undefined' outputs.
1994:
1.178 rillig 1995: See mk/misc/common.mk for the existing definition.
1996:
1.181 rillig 1997: 8.4.10. Turn off verbose logging
1.178 rillig 1998:
1999: The build logs of a package are often quite long. This allows error messages or
2000: other interesting details to hide between the noise. To make the actual error
2001: message stand out more, add these lines to mk.conf.
2002:
2003: GNU_CONFIGURE_QUIET= yes
2004: MAKE_FLAGS+= -s
2005:
2006: The -s option works for both GNU Make and BSD Make. On exotic platforms with
2007: their own make, it may be a little different.
2008:
2009: 8.5. Creating a multiple CD-ROM packages collection
1.1 dsieger 2010:
2011: After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set
2012: of the resulting binary packages to assist in installing packages on other
2013: machines. The pkgtools/cdpack package provides a simple tool for creating the
2014: ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a way that
2015: keeps all the dependencies for a given package on the same CD as that package.
2016:
1.178 rillig 2017: 8.5.1. Example of cdpack
1.1 dsieger 2018:
2019: Complete documentation for cdpack is found in the cdpack(1) man page. The
2020: following short example assumes that the binary packages are left in /usr/
2021: pkgsrc/packages/All and that sufficient disk space exists in /u2 to hold the
2022: ISO 9660 images.
2023:
2024: # mkdir /u2/images
2025: # pkg_add /usr/pkgsrc/packages/All/cdpack
2026: # cdpack /usr/pkgsrc/packages/All /u2/images
2027:
2028:
2029: If you wish to include a common set of files (COPYRIGHT, README, etc.) on each
2030: CD in the collection, then you need to create a directory which contains these
1.175 gutterid 2031: files, e.g.:
1.1 dsieger 2032:
2033: # mkdir /tmp/common
2034: # echo "This is a README" > /tmp/common/README
2035: # echo "Another file" > /tmp/common/COPYING
2036: # mkdir /tmp/common/bin
2037: # echo "#!/bin/sh" > /tmp/common/bin/myscript
2038: # echo "echo Hello world" >> /tmp/common/bin/myscript
2039: # chmod 755 /tmp/common/bin/myscript
2040:
2041:
2042: Now create the images:
2043:
2044: # cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images
2045:
2046: Each image will contain README, COPYING, and bin/myscript in their root
2047: directories.
2048:
1.154 rillig 2049: Chapter 9. Directory layout of the installed files
1.1 dsieger 2050:
2051: Table of Contents
2052:
1.154 rillig 2053: 9.1. File system layout in ${LOCALBASE}
2054: 9.2. File system layout in ${VARBASE}
1.1 dsieger 2055:
2056: The files that are installed by pkgsrc are organized in a way that is similar
2057: to what you find in the /usr directory of the base system. But some details are
2058: different. This is because pkgsrc initially came from FreeBSD and had adopted
2059: its file system hierarchy. Later it was largely influenced by NetBSD. But no
2060: matter which operating system you are using pkgsrc with, you can expect the
2061: same layout for pkgsrc.
2062:
2063: There are mainly four root directories for pkgsrc, which are all configurable
2064: in the bootstrap/bootstrap script. When pkgsrc has been installed as root, the
2065: default locations are:
2066:
2067: LOCALBASE= /usr/pkg
2068: PKG_SYSCONFBASE= /usr/pkg/etc
2069: VARBASE= /var
1.119 sevan 2070: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2071:
2072: In unprivileged mode (when pkgsrc has been installed as any other user), the
2073: default locations are:
2074:
2075: LOCALBASE= ${HOME}/pkg
2076: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2077: VARBASE= ${HOME}/pkg/var
1.119 sevan 2078: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2079:
2080: What these four directories are for, and what they look like is explained
2081: below.
2082:
1.25 wiz 2083: * LOCALBASE corresponds to the /usr directory in the base system. It is the "
2084: main" directory where the files are installed and contains the well-known
1.1 dsieger 2085: subdirectories like bin, include, lib, share and sbin.
2086:
2087: * VARBASE corresponds to /var in the base system. Some programs (especially
2088: games, network daemons) need write access to it during normal operation.
2089:
2090: * PKG_SYSCONFDIR corresponds to /etc in the base system. It contains
2091: configuration files of the packages, as well as pkgsrc's mk.conf itself.
2092:
1.154 rillig 2093: 9.1. File system layout in ${LOCALBASE}
1.1 dsieger 2094:
2095: The following directories exist in a typical pkgsrc installation in $
2096: {LOCALBASE}.
2097:
2098: bin
2099:
2100: Contains executable programs that are intended to be directly used by the
2101: end user.
2102:
2103: emul
2104:
2105: Contains files for the emulation layers of various other operating systems,
2106: especially for NetBSD.
2107:
2108: etc (the usual location of ${PKG_SYSCONFDIR})
2109:
2110: Contains the configuration files.
2111:
2112: include
2113:
2114: Contains headers for the C and C++ programming languages.
2115:
2116: info
2117:
2118: Contains GNU info files of various packages.
2119:
2120: lib
2121:
2122: Contains shared and static libraries.
2123:
2124: libdata
2125:
2126: Contains data files that don't change after installation. Other data files
2127: belong into ${VARBASE}.
2128:
2129: libexec
2130:
2131: Contains programs that are not intended to be used by end users, such as
2132: helper programs or network daemons.
2133:
2134: libexec/cgi-bin
2135:
2136: Contains programs that are intended to be executed as CGI scripts by a web
2137: server.
2138:
2139: man (the usual value of ${PKGMANDIR})
2140:
2141: Contains brief documentation in form of manual pages.
2142:
2143: sbin
2144:
2145: Contains programs that are intended to be used only by the super-user.
2146:
2147: share
2148:
2149: Contains platform-independent data files that don't change after
2150: installation.
2151:
2152: share/doc
2153:
2154: Contains documentation files provided by the packages.
2155:
2156: share/examples
2157:
2158: Contains example files provided by the packages. Among others, the original
2159: configuration files are saved here and copied to ${PKG_SYSCONFDIR} during
2160: installation.
2161:
2162: share/examples/rc.d
2163:
2164: Contains the original files for rc.d scripts.
2165:
2166: var (the usual location of ${VARBASE})
2167:
2168: Contains files that may be modified after installation.
2169:
1.154 rillig 2170: 9.2. File system layout in ${VARBASE}
1.1 dsieger 2171:
2172: db/pkg (the usual location of ${PKG_DBDIR})
2173:
2174: Contains information about the currently installed packages.
2175:
2176: games
2177:
2178: Contains highscore files.
2179:
2180: log
2181:
2182: Contains log files.
2183:
2184: run
2185:
2186: Contains informational files about daemons that are currently running.
2187:
1.154 rillig 2188: Chapter 10. Frequently Asked Questions
1.1 dsieger 2189:
2190: Table of Contents
2191:
1.154 rillig 2192: 10.1. Are there any mailing lists for pkg-related discussion?
2193: 10.2. Utilities for package management (pkgtools)
2194: 10.3. How to use pkgsrc as non-root
2195: 10.4. How to resume transfers when fetching distfiles?
2196: 10.5. How can I install/use modular X.org from pkgsrc?
2197: 10.6. How to fetch files from behind a firewall
2198: 10.7. How to fetch files from HTTPS sites
2199: 10.8. How do I tell make fetch to do passive FTP?
2200: 10.9. How to fetch all distfiles at once
2201: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
2202: 10.11. What does "Could not find bsd.own.mk" mean?
1.221 nia 2203: 10.12. Using 'sudo' or `priv` with pkgsrc
1.154 rillig 2204: 10.13. How do I change the location of configuration files?
2205: 10.14. Automated security checks
2206: 10.15. Why do some packages ignore my CFLAGS?
2207: 10.16. A package does not build. What shall I do?
2208: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.232 gutterid 2209: conflicts" mean?
1.1 dsieger 2210:
2211: This section contains hints, tips & tricks on special things in pkgsrc that we
2212: didn't find a better place for in the previous chapters, and it contains items
2213: for both pkgsrc users and developers.
2214:
1.154 rillig 2215: 10.1. Are there any mailing lists for pkg-related discussion?
1.1 dsieger 2216:
2217: The following mailing lists may be of interest to pkgsrc users:
2218:
2219: * pkgsrc-users: This is a general purpose list for most issues regarding
2220: pkgsrc, regardless of platform, e.g. soliciting user help for pkgsrc
2221: configuration, unexpected build failures, using particular packages,
2222: upgrading pkgsrc installations, questions regarding the pkgsrc release
2223: branches, etc. General announcements or proposals for changes that impact
2224: the pkgsrc user community, e.g. major infrastructure changes, new features,
2225: package removals, etc., may also be posted.
2226:
2227: * pkgsrc-bulk: A list where the results of pkgsrc bulk builds are sent and
2228: discussed.
2229:
2230: * pkgsrc-changes: This list is for those who are interested in getting a
2231: commit message for every change committed to pkgsrc. It is also available
2232: in digest form, meaning one daily message containing all commit messages
2233: for changes to the package source tree in that 24 hour period.
2234:
2235: To subscribe, do:
2236:
2237: % echo subscribe listname | mail majordomo@NetBSD.org
2238:
1.174 leot 2239: Archives for all these mailing lists are available from https://
1.1 dsieger 2240: mail-index.NetBSD.org/.
2241:
1.154 rillig 2242: 10.2. Utilities for package management (pkgtools)
1.1 dsieger 2243:
2244: The directory pkgsrc/pkgtools contains a number of useful utilities for both
2245: users and developers of pkgsrc. This section attempts only to make the reader
1.121 sevan 2246: aware of some of the utilities and when they might be useful, and not to
2247: duplicate the documentation that comes with each package.
1.1 dsieger 2248:
2249: Utilities used by pkgsrc (automatically installed when needed):
2250:
2251: * pkgtools/x11-links: Symlinks for use by buildlink.
2252:
2253: OS tool augmentation (automatically installed when needed):
2254:
1.121 sevan 2255: * pkgtools/digest: Calculates various kinds of checksums (including SHA3).
1.1 dsieger 2256:
2257: * pkgtools/libnbcompat: Compatibility library for pkgsrc tools.
2258:
2259: * pkgtools/mtree: Installed on non-BSD systems due to lack of native mtree.
2260:
2261: * pkgtools/pkg_install: Up-to-date replacement for /usr/sbin/pkg_install, or
2262: for use on operating systems where pkg_install is not present.
2263:
2264: Utilities used by pkgsrc (not automatically installed):
2265:
2266: * pkgtools/pkg_tarup: Create a binary package from an already-installed
2267: package. Used by make replace to save the old package.
2268:
2269: * pkgtools/dfdisk: Adds extra functionality to pkgsrc, allowing it to fetch
2270: distfiles from multiple locations. It currently supports the following
2271: methods: multiple CD-ROMs and network FTP/HTTP connections.
2272:
2273: * devel/cpuflags: Determine the best compiler flags to optimise code for your
1.24 wiz 2274: current CPU and compiler.
1.1 dsieger 2275:
2276: Utilities for keeping track of installed packages, being up to date, etc:
2277:
1.65 wiz 2278: * pkgtools/pkgin: A package update tool similar to apt(1). Download, install,
2279: and upgrade binary packages easily.
2280:
1.1 dsieger 2281: * pkgtools/pkg_chk: Reports on packages whose installed versions do not match
2282: the latest pkgsrc entries.
2283:
2284: * pkgtools/pkgdep: Makes dependency graphs of packages, to aid in choosing a
2285: strategy for updating.
2286:
2287: * pkgtools/pkgdepgraph: Makes graphs from the output of pkgtools/pkgdep (uses
2288: graphviz).
2289:
1.12 weinem 2290: * pkgtools/pkglint: The pkglint(1) program checks a pkgsrc entry for errors.
2291:
2292: * pkgtools/lintpkgsrc: The lintpkgsrc(1) program does various checks on the
2293: complete pkgsrc system.
1.1 dsieger 2294:
2295: * pkgtools/pkgsurvey: Report what packages you have installed.
2296:
2297: Utilities for people maintaining or creating individual packages:
2298:
2299: * pkgtools/pkgdiff: Automate making and maintaining patches for a package
2300: (includes pkgdiff, pkgvi, mkpatches, etc.).
2301:
1.65 wiz 2302: * pkgtools/url2pkg: Aids in converting to pkgsrc.
1.1 dsieger 2303:
2304: Utilities for people maintaining pkgsrc (or: more obscure pkg utilities)
2305:
2306: * pkgtools/pkg_comp: Build packages in a chrooted area.
2307:
2308: * pkgtools/libkver: Spoof kernel version for chrooted cross builds.
2309:
1.154 rillig 2310: 10.3. How to use pkgsrc as non-root
1.1 dsieger 2311:
1.108 rillig 2312: To install packages from source as a non-root user, download pkgsrc as
1.154 rillig 2313: described in Chapter 3, Where to get pkgsrc and how to keep it up-to-date, cd
1.108 rillig 2314: into that directory and run the command ./bootstrap/bootstrap --unprivileged.
2315:
2316: This will install the binary part of pkgsrc to ~/pkg and put the pkgsrc
2317: configuration mk.conf into ~/pkg/etc.
2318:
2319: For more details, see mk/unprivileged.mk.
1.1 dsieger 2320:
1.154 rillig 2321: 10.4. How to resume transfers when fetching distfiles?
1.1 dsieger 2322:
2323: By default, resuming transfers in pkgsrc is disabled, but you can enable this
1.4 rillig 2324: feature by adding the option PKG_RESUME_TRANSFERS=YES into mk.conf. If, during
2325: a fetch step, an incomplete distfile is found, pkgsrc will try to resume it.
1.1 dsieger 2326:
1.61 wiz 2327: You can also use a different program than the platform default program by
2328: changing the FETCH_USING variable. You can specify the program by using of ftp,
2329: fetch, wget or curl. Alternatively, fetching can be disabled by using the value
2330: manual. A value of custom disables the system defaults and dependency tracking
2331: for the fetch program. In that case you have to provide FETCH_CMD,
2332: FETCH_BEFORE_ARGS, FETCH_RESUME_ARGS, FETCH_OUTPUT_ARGS, FETCH_AFTER_ARGS.
1.1 dsieger 2333:
1.16 jnemeth 2334: For example, if you want to use wget to download, you'll have to use something
2335: like:
1.1 dsieger 2336:
1.16 jnemeth 2337: FETCH_USING= wget
1.1 dsieger 2338:
1.154 rillig 2339: 10.5. How can I install/use modular X.org from pkgsrc?
1.1 dsieger 2340:
1.4 rillig 2341: If you want to use modular X.org from pkgsrc instead of your system's own X11
2342: (/usr/X11R6, /usr/openwin, ...) you will have to add the following line into
1.1 dsieger 2343: mk.conf:
2344:
1.4 rillig 2345: X11_TYPE=modular
1.1 dsieger 2346:
1.154 rillig 2347: 10.6. How to fetch files from behind a firewall
1.1 dsieger 2348:
2349: If you are sitting behind a firewall which does not allow direct connections to
2350: Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This
2351: is done using an environment variable in the form of a URL, e.g. in Amdahl, the
2352: machine "orpheus.amdahl.com" is one of the firewalls, and it uses port 80 as
2353: the proxy port number. So the proxy environment variables are:
2354:
2355: ftp_proxy=ftp://orpheus.amdahl.com:80/
2356: http_proxy=http://orpheus.amdahl.com:80/
2357:
1.154 rillig 2358: 10.7. How to fetch files from HTTPS sites
1.65 wiz 2359:
2360: Some fetch tools are not prepared to support HTTPS by default (for example, the
2361: one in NetBSD 6.0), or the one installed by the pkgsrc bootstrap (to avoid an
2362: openssl dependency that low in the dependency graph).
2363:
2364: Usually you won't notice, because distribution files are mirrored weekly to "
2365: ftp.NetBSD.org", but that might not be often enough if you are following
2366: pkgsrc-current. In that case, set FETCH_USING in your mk.conf file to "curl" or
2367: "wget", which are both compiled with HTTPS support by default. Of course, these
2368: tools need to be installed before you can use them this way.
2369:
1.154 rillig 2370: 10.8. How do I tell make fetch to do passive FTP?
1.1 dsieger 2371:
2372: This depends on which utility is used to retrieve distfiles. From bsd.pkg.mk,
2373: FETCH_CMD is assigned the first available command from the following list:
2374:
2375: * ${LOCALBASE}/bin/ftp
2376:
2377: * /usr/bin/ftp
2378:
2379: On a default NetBSD installation, this will be /usr/bin/ftp, which
2380: automatically tries passive connections first, and falls back to active
2381: connections if the server refuses to do passive. For the other tools, add the
1.4 rillig 2382: following to your mk.conf file: PASSIVE_FETCH=1.
1.1 dsieger 2383:
2384: Having that option present will prevent /usr/bin/ftp from falling back to
2385: active transfers.
2386:
1.154 rillig 2387: 10.9. How to fetch all distfiles at once
1.1 dsieger 2388:
2389: You would like to download all the distfiles in a single batch from work or
2390: university, where you can't run a make fetch. There is an archive of distfiles
2391: on ftp.NetBSD.org, but downloading the entire directory may not be appropriate.
2392:
2393: The answer here is to do a make fetch-list in /usr/pkgsrc or one of its
2394: subdirectories, carry the resulting list to your machine at work/school and use
2395: it there. If you don't have a NetBSD-compatible ftp(1) (like tnftp) at work,
2396: don't forget to set FETCH_CMD to something that fetches a URL:
2397:
2398: At home:
2399:
2400: % cd /usr/pkgsrc
2401: % make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh
2402: % scp /tmp/fetch.sh work:/tmp
2403:
2404: At work:
2405:
2406: % sh /tmp/fetch.sh
2407:
2408: then tar up /tmp/distfiles and take it home.
2409:
2410: If you have a machine running NetBSD, and you want to get all distfiles (even
2411: ones that aren't for your machine architecture), you can do so by using the
2412: above-mentioned make fetch-list approach, or fetch the distfiles directly by
2413: running:
2414:
2415: % make mirror-distfiles
2416:
2417: If you even decide to ignore NO_{SRC,BIN}_ON_{FTP,CDROM}, then you can get
2418: everything by running:
2419:
2420: % make fetch NO_SKIP=yes
2421:
1.154 rillig 2422: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
1.1 dsieger 2423:
2424: When compiling the pkgtools/pkg_install package, you get the error from make
2425: that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates
2426: that you don't have installed the "text" set (nroff, ...) from the NetBSD base
2427: distribution on your machine. It is recommended to do that to format man pages.
2428:
2429: In the case of the pkgtools/pkg_install package, you can get away with setting
1.4 rillig 2430: NOMAN=YES either in the environment or in mk.conf.
1.1 dsieger 2431:
1.154 rillig 2432: 10.11. What does "Could not find bsd.own.mk" mean?
1.1 dsieger 2433:
2434: You didn't install the compiler set, comp.tgz, when you installed your NetBSD
2435: machine. Please get and install it, by extracting it in /:
2436:
2437: # cd /
2438: # tar --unlink -zxvpf .../comp.tgz
2439:
2440: comp.tgz is part of every NetBSD release. Get the one that corresponds to your
2441: release (determine via uname -r).
2442:
1.221 nia 2443: 10.12. Using 'sudo' or `priv` with pkgsrc
1.1 dsieger 2444:
2445: When installing packages as non-root user and using the just-in-time su(1)
2446: feature of pkgsrc, it can become annoying to type in the root password for each
2447: required package installed. To avoid this, the sudo package can be used, which
1.221 nia 2448: does password caching over a limited time. To use it, install sudo or priv
2449: (either as binary package, from security/priv, or security/sudo) and then put
2450: the following into your mk.conf, somewhere after the definition of the
2451: LOCALBASE variable:
1.1 dsieger 2452:
2453: .if exists(${LOCALBASE}/bin/sudo)
2454: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2455: .endif
2456:
1.154 rillig 2457: 10.13. How do I change the location of configuration files?
1.1 dsieger 2458:
2459: As the system administrator, you can choose where configuration files are
2460: installed. The default settings make all these files go into ${PREFIX}/etc or
2461: some of its subdirectories; this may be suboptimal depending on your
2462: expectations (e.g., a read-only, NFS-exported PREFIX with a need of per-machine
2463: configuration of the provided packages).
2464:
2465: In order to change the defaults, you can modify the PKG_SYSCONFBASE variable
1.4 rillig 2466: (in mk.conf) to point to your preferred configuration directory; some common
2467: examples include /etc or /etc/pkg.
1.1 dsieger 2468:
2469: Furthermore, you can change this value on a per-package basis by setting the
2470: PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. PKG_SYSCONFVAR's value usually
2471: matches the name of the package you would like to modify, that is, the contents
2472: of PKGBASE.
2473:
2474: Note that after changing these settings, you must rebuild and reinstall any
2475: affected packages.
2476:
1.154 rillig 2477: 10.14. Automated security checks
1.1 dsieger 2478:
2479: Please be aware that there can often be bugs in third-party software, and some
2480: of these bugs can leave a machine vulnerable to exploitation by attackers. In
2481: an effort to lessen the exposure, the NetBSD packages team maintains a database
2482: of known-exploits to packages which have at one time been included in pkgsrc.
2483: The database can be downloaded automatically, and a security audit of all
1.14 jmcneill 2484: packages installed on a system can take place. To do this, refer to the
2485: following two tools (installed as part of the pkgtools/pkg_install package):
1.1 dsieger 2486:
1.21 snj 2487: 1. pkg_admin fetch-pkg-vulnerabilities, an easy way to download a list of the
2488: security vulnerabilities information. This list is kept up to date by the
1.26 spz 2489: pkgsrc security team, and is distributed from the NetBSD ftp server:
1.1 dsieger 2490:
1.177 leot 2491: https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities
1.1 dsieger 2492:
1.21 snj 2493: 2. pkg_admin audit, an easy way to audit the current machine, checking each
1.24 wiz 2494: known vulnerability. If a vulnerable package is installed, it will be shown
2495: by output to stdout, including a description of the type of vulnerability,
2496: and a URL containing more information.
1.1 dsieger 2497:
1.202 nia 2498: Use of these tools is strongly recommended! See Section 5.1.6, "Checking for
1.121 sevan 2499: security vulnerabilities in installed packages" for instructions on how to
2500: automate checking and reporting.
2501:
2502: If this database is installed, pkgsrc builds will use it to perform a security
2503: check before building any package.
1.1 dsieger 2504:
1.154 rillig 2505: 10.15. Why do some packages ignore my CFLAGS?
1.1 dsieger 2506:
2507: When you add your own preferences to the CFLAGS variable in your mk.conf, these
2508: flags are passed in environment variables to the ./configure scripts and to
2509: make(1). Some package authors ignore the CFLAGS from the environment variable
2510: by overriding them in the Makefiles of their package.
2511:
2512: Currently there is no solution to this problem. If you really need the package
2513: to use your CFLAGS you should run make patch in the package directory and then
2514: inspect any Makefile and Makefile.in for whether they define CFLAGS explicitly.
2515: Usually you can remove these lines. But be aware that some "smart" programmers
2516: write so bad code that it only works for the specific combination of CFLAGS
2517: they have chosen.
2518:
1.172 rillig 2519: To find out where the CFLAGS are ignored, add the following lines to mk.conf:
2520:
2521: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
2522: CFLAGS+= -Dpkgsrc___CFLAGS
2523: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
2524:
2525: Then run bmake show-all-configure show-all-build to see whether the above flags
2526: are passed to the actual build commands in general.
2527:
2528: To find out whether the flags are passed to individual compiler commands, have
2529: a look at the file work/.work.log. In most cases, the flags from the original
2530: command lines (the lines starting with [*]) are passed unmodified to the actual
2531: compiler (the lines starting with <.>). If the flag is missing from the actual
2532: compiler command, it must have been removed by the pkgsrc compiler wrappers.
2533:
1.154 rillig 2534: 10.16. A package does not build. What shall I do?
1.1 dsieger 2535:
2536: 1. Make sure that your copy of pkgsrc is consistent. A case that occurs often
2537: is that people only update pkgsrc in parts, because of performance reasons.
2538: Since pkgsrc is one large system, not a collection of many small systems,
2539: there are sometimes changes that only work when the whole pkgsrc tree is
2540: updated.
2541:
1.25 wiz 2542: 2. Make sure that you don't have any CVS conflicts. Search for "<<<<<<" or "
2543: >>>>>>" in all your pkgsrc files.
1.1 dsieger 2544:
1.25 wiz 2545: 3. Make sure that you don't have old copies of the packages extracted. Run
1.1 dsieger 2546: make clean clean-depends to verify this.
2547:
1.108 rillig 2548: 4. If you are a package developer who wants to invest some work, have a look
1.154 rillig 2549: at Chapter 21, Making your package work.
1.108 rillig 2550:
2551: 5. If the problem still exists, write a mail to the pkgsrc-users mailing list.
1.1 dsieger 2552:
1.154 rillig 2553: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.1 dsieger 2554: conflicts" mean?
2555:
2556: You have modified a file from pkgsrc, and someone else has modified that same
2557: file afterwards in the CVS repository. Both changes are in the same region of
2558: the file, so when you updated pkgsrc, the cvs command marked the conflicting
2559: changes in the file. Because of these markers, the file is no longer a valid
2560: Makefile.
2561:
2562: Have a look at that file, and if you don't need your local changes anymore, you
2563: can remove that file and run cvs -q update -dP in that directory to download
2564: the current version.
2565:
2566: Part II. The pkgsrc developer's guide
2567:
2568: This part of the book deals with creating and modifying packages. It starts
2569: with a "HOWTO"-like guide on creating a new package. The remaining chapters are
2570: more like a reference manual for pkgsrc.
2571:
2572: Table of Contents
2573:
1.154 rillig 2574: 11. Getting help
1.184 rillig 2575: 12. Package components - files, directories and contents
2576: 12.1. Makefile
2577: 12.2. distinfo
2578: 12.3. patches/*
2579: 12.3.1. Structure of a single patch file
2580: 12.3.2. Creating patch files
2581: 12.3.3. Sources where the patch files come from
2582: 12.3.4. Patching guidelines
2583: 12.3.5. Feedback to the author
2584: 12.4. Other mandatory files
2585: 12.5. Optional files
2586: 12.5.1. Files affecting the binary package
2587: 12.5.2. Files affecting the build process
2588: 12.5.3. Files affecting nothing at all
2589: 12.6. work*
2590: 12.7. files/*
2591: 13. The build process
2592: 13.1. Introduction
2593: 13.2. Program location
2594: 13.3. Directories used during the build process
2595: 13.4. Running a phase
2596: 13.5. The fetch phase
2597: 13.5.1. What to fetch and where to get it from
2598: 13.5.2. How are the files fetched?
2599: 13.6. The checksum phase
2600: 13.7. The extract phase
2601: 13.8. The patch phase
2602: 13.9. The tools phase
2603: 13.10. The wrapper phase
2604: 13.11. The configure phase
2605: 13.12. The build phase
2606: 13.13. The test phase
2607: 13.14. The install phase
2608: 13.15. The package phase
2609: 13.16. Cleaning up
2610: 13.17. Other helpful targets
2611: 14. Creating a new pkgsrc package from scratch
2612: 14.1. Common types of packages
1.219 nia 2613: 14.1.1. Python modules and programs
2614: 14.1.2. R packages
2615: 14.1.3. TeXlive packages
1.184 rillig 2616: 14.2. Examples
2617: 14.2.1. How the www/nvu package came into pkgsrc
2618: 15. Programming in Makefiles
2619: 15.1. Caveats
2620: 15.2. Makefile variables
2621: 15.2.1. Naming conventions
2622: 15.3. Code snippets
2623: 15.3.1. Adding things to a list
2624: 15.3.2. Echoing a string exactly as-is
2625: 15.3.3. Passing CFLAGS to GNU configure scripts
2626: 15.3.4. Handling possibly empty variables
1.229 gutterid 2627: 15.3.5. Testing yes/no variables in conditions
1.184 rillig 2628: 16. Options handling
2629: 16.1. Global default options
2630: 16.2. Converting packages to use bsd.options.mk
2631: 16.3. Option Names
2632: 16.4. Determining the options of dependencies
2633: 17. Tools needed for building or running
2634: 17.1. Tools for pkgsrc builds
2635: 17.2. Tools needed by packages
2636: 17.3. Tools provided by platforms
2637: 18. Buildlink methodology
2638: 18.1. Converting packages to use buildlink3
2639: 18.2. Writing buildlink3.mk files
2640: 18.2.1. Anatomy of a buildlink3.mk file
2641: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.
1.232 gutterid 2642: pkg in buildlink3.mk files
1.184 rillig 2643: 18.3. Writing builtin.mk files
2644: 18.3.1. Anatomy of a builtin.mk file
2645: 19. PLIST issues
2646: 19.1. RCS ID
2647: 19.2. Semi-automatic PLIST generation
2648: 19.3. Tweaking output of make print-PLIST
2649: 19.4. Variable substitution in PLIST
2650: 19.5. Man page compression
2651: 19.6. Changing PLIST source with PLIST_SRC
2652: 19.7. Platform-specific and differing PLISTs
2653: 19.8. Build-specific PLISTs
2654: 19.9. Sharing directories between packages
2655: 20. The pkginstall framework
2656: 20.1. Files and directories outside the installation prefix
2657: 20.1.1. Directory manipulation
2658: 20.1.2. File manipulation
2659: 20.2. Configuration files
2660: 20.2.1. How PKG_SYSCONFDIR is set
2661: 20.2.2. Telling the software where configuration files are
1.239 dholland 2662: 20.2.3. Patching installation
2663: 20.2.4. Declaring configuration files
2664: 20.2.5. Disabling handling of configuration files
1.184 rillig 2665: 20.3. System startup scripts
2666: 20.3.1. Disabling handling of system startup scripts
2667: 20.4. System users and groups
2668: 20.5. System shells
2669: 20.5.1. Disabling shell registration
2670: 20.6. Fonts
2671: 20.6.1. Disabling automatic update of the fonts databases
1.154 rillig 2672: 21. Making your package work
2673: 21.1. General operation
2674: 21.1.1. How to pull in user-settable variables from mk.conf
2675: 21.1.2. User interaction
2676: 21.1.3. Handling licenses
2677: 21.1.4. Restricted packages
2678: 21.1.5. Handling dependencies
2679: 21.1.6. Handling conflicts with other packages
2680: 21.1.7. Packages that cannot or should not be built
2681: 21.1.8. Packages which should not be deleted, once installed
2682: 21.1.9. Handling packages with security problems
2683: 21.1.10. How to handle incrementing versions when fixing an existing
1.232 gutterid 2684: package
1.154 rillig 2685: 21.1.11. Substituting variable text in the package files (the SUBST
1.232 gutterid 2686: framework)
1.154 rillig 2687: 21.2. The fetch phase
2688: 21.2.1. Packages whose distfiles aren't available for plain downloading
2689: 21.2.2. How to handle modified distfiles with the 'old' name
2690: 21.2.3. Packages hosted on github.com
2691: 21.3. The configure phase
2692: 21.3.1. Shared libraries - libtool
2693: 21.3.2. Using libtool on GNU packages that already support libtool
2694: 21.3.3. GNU Autoconf/Automake
1.223 nia 2695: 21.3.4. Meson / ninja
1.154 rillig 2696: 21.4. Programming languages
2697: 21.4.1. C, C++, and Fortran
2698: 21.4.2. Java
1.205 wiz 2699: 21.4.3. Go
1.223 nia 2700: 21.4.4. Rust
2701: 21.4.5. Packages containing Perl scripts
2702: 21.4.6. Packages containing shell scripts
2703: 21.4.7. Other programming languages
1.154 rillig 2704: 21.5. The build phase
2705: 21.5.1. Compiling C and C++ code conditionally
2706: 21.5.2. How to handle compiler bugs
1.172 rillig 2707: 21.5.3. No such file or directory
2708: 21.5.4. Undefined reference to "..."
2709: 21.5.5. Running out of memory
1.154 rillig 2710: 21.6. The install phase
2711: 21.6.1. Creating needed directories
2712: 21.6.2. Where to install documentation
2713: 21.6.3. Installing highscore files
2714: 21.6.4. Adding DESTDIR support to packages
2715: 21.6.5. Packages with hardcoded paths to other interpreters
1.203 nia 2716: 21.6.6. Packages installing Perl modules
1.154 rillig 2717: 21.6.7. Packages installing info files
2718: 21.6.8. Packages installing man pages
1.203 nia 2719: 21.6.9. Packages installing X11 fonts
2720: 21.6.10. Packages installing SGML or XML data
2721: 21.6.11. Packages installing extensions to the MIME database
2722: 21.6.12. Packages using intltool
2723: 21.6.13. Packages installing startup scripts
2724: 21.6.14. Packages installing TeX modules
2725: 21.6.15. Packages supporting running binaries in emulation
2726: 21.6.16. Packages installing hicolor icons
2727: 21.6.17. Packages installing desktop files
1.154 rillig 2728: 21.7. Marking packages as having problems
1.184 rillig 2729: 22. GNOME packaging and porting
2730: 22.1. Meta packages
2731: 22.2. Packaging a GNOME application
2732: 22.3. Updating GNOME to a newer version
2733: 22.4. Patching guidelines
1.154 rillig 2734: 23. Submitting and Committing
2735: 23.1. Submitting binary packages
2736: 23.2. Submitting source packages (for non-NetBSD-developers)
2737: 23.3. General notes when adding, updating, or removing packages
2738: 23.4. Commit Messages
2739: 23.5. Committing: Adding a package to CVS
2740: 23.6. Updating a package to a newer version
2741: 23.7. Renaming a package in pkgsrc
2742: 23.8. Moving a package in pkgsrc
2743: 24. Frequently Asked Questions
2744:
2745: Chapter 11. Getting help
2746:
2747: To get help when developing pkgsrc, the definitive source is this document, the
2748: pkgsrc guide. If you don't find anything here, there are alternatives:
2749:
2750: * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
2751: Run bmake help topic=? to get help for any topic, such as a variable name
2752: like BUILD_DEFS, a make target like do-build, a missing C or C++ function
2753: like strcasecmp or any other topic.
2754:
1.207 leot 2755: The available help topics are listed in Appendix E, Help topics.
1.154 rillig 2756:
1.163 rillig 2757: * To see the value of a single variable, run bmake show-var VARNAME=X.
2758:
2759: * To see the values of the most common variables, run bmake show-all. These
2760: variables are grouped by topic. To see the variables for a single topic,
2761: run bmake show-all-topic, for example bmake show-all-fetch.
2762:
1.154 rillig 2763: * The tech-pkg mailing list, to which you can subscribe and then ask your
2764: questions.
2765:
2766: * The #pkgsrc IRC channel, which is accessible via a web browser or by using
2767: a specialized chat program such as XChat. Pick any user name and join the
2768: channel #pkgsrc.
1.1 dsieger 2769:
1.184 rillig 2770: Chapter 12. Package components - files, directories and contents
1.1 dsieger 2771:
2772: Table of Contents
2773:
1.184 rillig 2774: 12.1. Makefile
2775: 12.2. distinfo
2776: 12.3. patches/*
2777: 12.3.1. Structure of a single patch file
2778: 12.3.2. Creating patch files
2779: 12.3.3. Sources where the patch files come from
2780: 12.3.4. Patching guidelines
2781: 12.3.5. Feedback to the author
2782: 12.4. Other mandatory files
2783: 12.5. Optional files
2784: 12.5.1. Files affecting the binary package
2785: 12.5.2. Files affecting the build process
2786: 12.5.3. Files affecting nothing at all
2787: 12.6. work*
2788: 12.7. files/*
1.1 dsieger 2789:
1.184 rillig 2790: Whenever you're preparing a package, there are a number of files involved which
2791: are described in the following sections.
1.1 dsieger 2792:
1.184 rillig 2793: 12.1. Makefile
1.1 dsieger 2794:
1.184 rillig 2795: Building, installation and creation of a binary package are all controlled by
2796: the package's Makefile. The Makefile describes various things about a package,
2797: for example from where to get it, how to configure, build, and install it.
1.1 dsieger 2798:
1.184 rillig 2799: A package Makefile contains several sections that describe the package.
1.1 dsieger 2800:
1.184 rillig 2801: In the first section there are the following variables, which should appear
2802: exactly in the order given here. The order and grouping of the variables is
2803: mostly historical and has no further meaning.
1.1 dsieger 2804:
1.184 rillig 2805: * DISTNAME is the basename of the distribution file to be downloaded from the
2806: package's website.
1.1 dsieger 2807:
1.184 rillig 2808: * PKGNAME is the name of the package, as used by pkgsrc. You need to provide
2809: it if DISTNAME (which is the default) is not a good name for the package in
2810: pkgsrc or DISTNAME is not provided (no distribution file is required).
2811: Usually it is the pkgsrc directory name together with the version number.
2812: It must match the regular expression ^[A-Za-z0-9][A-Za-z0-9-_.+]*$, that
2813: is, it starts with a letter or digit, and contains only letters, digits,
1.204 nia 2814: dashes, underscores, dots and plus signs. New packages should have entirely
2815: lower-case names, with the exception of some that must follow pre-existing
2816: conventions (e.g. R packages begin with R-). You can use the :tl variable
2817: modifier to lower-case the package name.
1.26 spz 2818:
1.184 rillig 2819: * CATEGORIES is a list of categories which the package fits in. You can
2820: choose any of the top-level directories of pkgsrc for it.
1.1 dsieger 2821:
1.184 rillig 2822: Currently the following values are available for CATEGORIES. If more than
2823: one is used, they need to be separated by spaces:
1.1 dsieger 2824:
1.184 rillig 2825: archivers cross geography meta-pkgs security
2826: audio databases graphics misc shells
2827: benchmarks devel ham multimedia sysutils
2828: biology editors inputmethod net textproc
2829: cad emulators lang news time
2830: chat finance mail parallel wm
2831: comms fonts math pkgtools www
2832: converters games mbone print x11
1.1 dsieger 2833:
1.184 rillig 2834: * MASTER_SITES, DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES
2835: are discussed in detail in Section 13.5, "The fetch phase".
1.1 dsieger 2836:
1.184 rillig 2837: The second section contains information about separately downloaded patches, if
2838: any.
1.1 dsieger 2839:
1.184 rillig 2840: * PATCHFILES: Name(s) of additional files that contain distribution patches.
2841: There is no default. pkgsrc will look for them at PATCH_SITES. They will
2842: automatically be uncompressed before patching if the names end with .gz or
2843: .Z.
1.1 dsieger 2844:
1.184 rillig 2845: * PATCH_SITES: Primary location(s) for distribution patch files (see
2846: PATCHFILES above) if not found locally.
1.1 dsieger 2847:
1.184 rillig 2848: * PATCH_DIST_STRIP: an argument to patch(1) that sets the pathname strip
2849: count to help find the correct files to patch. It defaults to -p0.
1.1 dsieger 2850:
1.184 rillig 2851: The third section contains the following variables.
1.1 dsieger 2852:
1.184 rillig 2853: * MAINTAINER is the email address of the person who feels responsible for
2854: this package, and who is most likely to look at problems or questions
2855: regarding this package which have been reported with send-pr(1). Other
2856: developers may contact the MAINTAINER before making changes to the package,
2857: but are not required to do so. When packaging a new program, set MAINTAINER
2858: to yourself. If you really can't maintain the package for future updates,
2859: set it to <pkgsrc-users@NetBSD.org>.
1.1 dsieger 2860:
1.184 rillig 2861: * OWNER should be used instead of MAINTAINER when you do not want other
2862: developers to update or change the package without contacting you first. A
2863: package Makefile should contain one of MAINTAINER or OWNER, but not both.
1.1 dsieger 2864:
1.184 rillig 2865: * HOMEPAGE is a URL where users can find more information about the package.
1.1 dsieger 2866:
1.184 rillig 2867: * COMMENT is a one-line description of the package (should not include the
2868: package name).
1.1 dsieger 2869:
1.184 rillig 2870: * LICENSE indicates the license(s) applicable for the package. See
2871: Section 21.1.3, "Handling licenses" for further details.
1.1 dsieger 2872:
1.184 rillig 2873: Other variables that affect the build:
1.1 dsieger 2874:
1.184 rillig 2875: * WRKSRC: The directory where the interesting distribution files of the
2876: package are found. The default is ${WRKDIR}/${DISTNAME}, which works for
2877: most packages.
1.1 dsieger 2878:
1.184 rillig 2879: If a package doesn't create a subdirectory for itself (most GNU software
2880: does, for instance), but extracts itself in the current directory, you
2881: should set WRKSRC=${WRKDIR}.
1.1 dsieger 2882:
1.184 rillig 2883: If a package doesn't create a subdirectory with the name of DISTNAME but
2884: some different name, set WRKSRC to point to the proper name in ${WRKDIR},
2885: for example WRKSRC=${WRKDIR}/${DISTNAME}/unix. See lang/tcl and x11/tk for
2886: other examples.
1.17 imil 2887:
1.184 rillig 2888: The name of the working directory created by pkgsrc is taken from the
2889: WRKDIR_BASENAME variable. By default, its value is work. If you want to use
2890: the same pkgsrc tree for building different kinds of binary packages, you
2891: can change the variable according to your needs. Two other variables handle
2892: common cases of setting WRKDIR_BASENAME individually. If OBJHOSTNAME is
2893: defined in mk.conf, the first component of the host's name is attached to
2894: the directory name. If OBJMACHINE is defined, the platform name is
2895: attached, which might look like work.i386 or work.sparc.
1.17 imil 2896:
1.184 rillig 2897: Please pay attention to the following gotchas:
1.17 imil 2898:
1.184 rillig 2899: * Add MANCOMPRESSED if man pages are installed in compressed form by the
2900: package. For packages using BSD-style makefiles which honor MANZ, there is
2901: MANCOMPRESSED_IF_MANZ.
1.17 imil 2902:
1.184 rillig 2903: * Replace /usr/local with "${PREFIX}" in all files (see patches, below).
1.103 wiz 2904:
1.184 rillig 2905: * If the package installs any info files, see Section 21.6.7, "Packages
2906: installing info files".
1.103 wiz 2907:
1.184 rillig 2908: 12.2. distinfo
1.17 imil 2909:
1.184 rillig 2910: The distinfo file contains the message digest, or checksum, of each distfile
2911: needed for the package. This ensures that the distfiles retrieved from the
2912: Internet have not been corrupted during transfer or altered by a malign force
2913: to introduce a security hole. To provide maximum security, all distfiles are
1.243 gutterid 2914: protected using two different message digest algorithms (BLAKE2s and SHA512),
2915: as well as the file size.
1.17 imil 2916:
1.184 rillig 2917: The distinfo file also contains the checksums for all the patches found in the
2918: patches directory (see Section 12.3, "patches/*"). These checksums ensure that
2919: patches are only applied intentionally and that they don't accidentally change,
2920: e.g. when merging different changes together. They also make sure that new
2921: patches are actually added to CVS and old ones are removed. Too see whether the
2922: patches and the distinfo file match, run pkglint after changing the patches.
1.17 imil 2923:
1.184 rillig 2924: To regenerate the distinfo file, use the make distinfo command.
1.17 imil 2925:
1.184 rillig 2926: Some packages have different sets of distfiles depending on the platform, for
2927: example lang/openjdk8. These are kept in the same distinfo file and care should
2928: be taken when upgrading such a package to ensure distfile information is not
2929: lost.
1.17 imil 2930:
1.184 rillig 2931: 12.3. patches/*
1.63 wiz 2932:
1.184 rillig 2933: Some packages don't work out-of-the box on the various platforms that are
2934: supported by pkgsrc. These packages need to be patched to make them work. The
2935: patch files can be found in the patches/ directory.
1.17 imil 2936:
1.184 rillig 2937: In the patch phase, these patches are applied to the files in WRKSRC directory
2938: after extracting them, in alphabetic order.
1.160 brook 2939:
1.184 rillig 2940: 12.3.1. Structure of a single patch file
1.160 brook 2941:
1.184 rillig 2942: The patch-* files should be in diff -bu format, and apply without a fuzz to
2943: avoid problems. (To force patches to apply with fuzz you can set
2944: PATCH_FUZZ_FACTOR=-F2). Furthermore, each patch should contain only changes for
2945: a single file, and no file should be patched by more than one patch file. This
2946: helps to keep future modifications simple.
1.160 brook 2947:
1.184 rillig 2948: Each patch file is structured as follows: In the first line, there is the RCS
2949: Id of the patch itself. The second line should be empty for aesthetic reasons.
2950: After that, there should be a comment for each change that the patch does.
2951: There are a number of standard cases:
1.160 brook 2952:
1.184 rillig 2953: * Patches for commonly known vulnerabilities should mention the vulnerability
2954: ID (CAN, CVE).
1.160 brook 2955:
1.184 rillig 2956: * Patches that change source code should mention the platform and other
2957: environment (for example, the compiler) that the patch is needed for.
1.160 brook 2958:
1.184 rillig 2959: The patch should be commented so that any developer who knows the code of the
2960: application can make some use of the patch. Special care should be taken for
2961: the upstream developers, since we generally want that they accept our patches,
2962: so we have less work in the future.
1.160 brook 2963:
1.184 rillig 2964: 12.3.2. Creating patch files
1.160 brook 2965:
1.184 rillig 2966: One important thing to mention is to pay attention that no RCS IDs get stored
2967: in the patch files, as these will cause problems when later checked into the
2968: NetBSD CVS tree. Use the pkgdiff command from the pkgtools/pkgdiff package to
2969: avoid these problems.
1.160 brook 2970:
1.184 rillig 2971: For even more automation, we recommend using mkpatches from the same package to
1.222 gutterid 2972: make a whole set of patches. You just have to back up files before you edit
2973: them to filename.orig, e.g., with cp -p filename filename.orig or, easier, by
2974: using pkgvi again from the same package. If you upgrade a package this way, you
2975: can easily compare the new set of patches with the previously existing one with
1.184 rillig 2976: patchdiff. The files in patches are replaced by new files, so carefully check
2977: if you want to take all the changes.
1.160 brook 2978:
1.184 rillig 2979: When you have finished a package, remember to generate the checksums for the
2980: patch files by using the make makepatchsum command, see Section 12.2,
2981: "distinfo".
1.1 dsieger 2982:
1.184 rillig 2983: When adding a patch that corrects a problem in the distfile (rather than e.g.
2984: enforcing pkgsrc's view of where man pages should go), send the patch as a bug
2985: report to the maintainer. This benefits non-pkgsrc users of the package, and
2986: usually makes it possible to remove the patch in future version.
1.1 dsieger 2987:
1.184 rillig 2988: The file names of the patch files are usually of the form patch-
2989: path_to_file__with__underscores.c. Many packages still use the previous
2990: convention patch-[a-z][a-z], but new patches should be of the form containing
2991: the filename. mkpatches included in pkgtools/pkgdiff takes care of the name
2992: automatically.
1.1 dsieger 2993:
1.222 gutterid 2994: When updating pre-existing patch files, if a file uses the old patch-[a-z][a-z]
2995: convention, it's best not to change it to the new form, as that will just cause
2996: churn that makes it harder to track changes to patching over time. Similarly,
2997: if a patch now applies at different line offsets, but still applies cleanly
2998: as-is, there's no need to update it, as that also unnecessarily complicates the
2999: patch history.
3000:
1.184 rillig 3001: 12.3.3. Sources where the patch files come from
1.1 dsieger 3002:
1.184 rillig 3003: If you want to share patches between multiple packages in pkgsrc, e.g. because
3004: they use the same distfiles, set PATCHDIR to the path where the patch files can
3005: be found, e.g.:
1.1 dsieger 3006:
1.184 rillig 3007: PATCHDIR= ../../editors/xemacs/patches
1.1 dsieger 3008:
1.184 rillig 3009: Patch files that are distributed by the author or other maintainers can be
3010: listed in PATCHFILES.
1.1 dsieger 3011:
1.184 rillig 3012: If it is desired to store any patches that should not be committed into pkgsrc,
3013: they can be kept outside the pkgsrc tree in the $LOCALPATCHES directory. The
3014: directory tree there is expected to have the same "category/package" structure
3015: as pkgsrc, and patches are expected to be stored inside these dirs (also known
3016: as $LOCALPATCHES/$PKGPATH). For example, if you want to keep a private patch
3017: for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All
3018: files in the named directory are expected to be patch files, and they are
3019: applied after pkgsrc patches are applied.
1.1 dsieger 3020:
1.184 rillig 3021: 12.3.4. Patching guidelines
1.1 dsieger 3022:
1.184 rillig 3023: When fixing a portability issue in the code do not use preprocessor magic to
3024: check for the current operating system nor platform. Doing so hurts portability
3025: to other platforms because the OS-specific details are not abstracted
3026: appropriately.
1.1 dsieger 3027:
1.184 rillig 3028: The general rule to follow is: instead of checking for the operating system the
3029: application is being built on, check for the specific features you need. For
3030: example, instead of assuming that kqueue is available under NetBSD and using
3031: the __NetBSD__ macro to conditionalize kqueue support, add a check that detects
1.198 leot 3032: kqueue itself -- yes, this generally involves patching the configure script.
1.184 rillig 3033: There is absolutely nothing that prevents some OSes from adopting interfaces
3034: from other OSes (e.g. Linux implementing kqueue), something that the above
3035: checks cannot take into account.
1.1 dsieger 3036:
1.184 rillig 3037: Of course, checking for features generally involves more work on the
3038: developer's side, but the resulting changes are cleaner and there are chances
3039: they will work on many other platforms. Not to mention that there are higher
3040: chances of being later integrated into the mainstream sources. Remember: It
3041: doesn't work unless it is right!
1.1 dsieger 3042:
1.184 rillig 3043: Some typical examples:
1.121 sevan 3044:
1.184 rillig 3045: Table 12.1. Patching examples
1.1 dsieger 3046:
1.184 rillig 3047: +-------------------------------------------------------------------------------------------+
3048: | Where | Incorrect | Correct |
3049: |---------+--------------------------+------------------------------------------------------|
3050: | |case ${target_os} in | |
3051: |configure|netbsd*) have_kvm=yes ;; |AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)|
3052: |script |*) have_kvm=no ;; | |
3053: | |esac | |
3054: |---------+--------------------------+------------------------------------------------------|
3055: |C source |#if defined(__NetBSD__) |#if defined(HAVE_SYS_EVENT_H) |
3056: |file |# include <sys/event.h> |# include <sys/event.h> |
3057: | |#endif |#endif |
3058: |---------+--------------------------+------------------------------------------------------|
3059: | |int |int |
3060: | |monitor_file(...) |monitor_file(...) |
3061: | |{ |{ |
3062: | |#if defined(__NetBSD__) |#if defined(HAVE_KQUEUE) |
3063: |C source | int fd = kqueue();| int fd = kqueue(); |
3064: |file | ... | ... |
3065: | |#else |#else |
3066: | | ... | ... |
3067: | |#endif |#endif |
3068: | |} |} |
3069: +-------------------------------------------------------------------------------------------+
1.1 dsieger 3070:
3071:
1.184 rillig 3072: 12.3.5. Feedback to the author
1.1 dsieger 3073:
1.184 rillig 3074: Always, always, always feed back any portability fixes or improvements you do
3075: to a package to the mainstream developers. This is the only way to get their
3076: attention on portability issues and to ensure that future versions can be built
3077: out-of-the box on NetBSD. Furthermore, any user that gets newer distfiles will
3078: get the fixes straight from the packaged code.
1.1 dsieger 3079:
1.184 rillig 3080: This generally involves cleaning up the patches (because sometimes the patches
3081: that are added to pkgsrc are quick hacks), filing bug reports in the
3082: appropriate trackers for the projects and working with the mainstream authors
3083: to accept your changes. It is extremely important that you do it so that the
3084: packages in pkgsrc are kept simple and thus further changes can be done without
3085: much hassle.
1.1 dsieger 3086:
1.184 rillig 3087: When you have done this, please add a URL to the upstream bug report to the
3088: patch comment.
1.1 dsieger 3089:
1.184 rillig 3090: Support the idea of free software!
1.1 dsieger 3091:
1.184 rillig 3092: 12.4. Other mandatory files
1.1 dsieger 3093:
1.184 rillig 3094: DESCR
1.1 dsieger 3095:
1.184 rillig 3096: A multi-line description of the piece of software. This should include any
3097: credits where they are due. Please bear in mind that others do not share
3098: your sense of humour (or spelling idiosyncrasies), and that others will
3099: read everything that you write here.
1.1 dsieger 3100:
1.184 rillig 3101: PLIST
1.1 dsieger 3102:
1.184 rillig 3103: This file governs the files that are installed on your system: all the
3104: binaries, manual pages, etc. There are other directives which may be
3105: entered in this file, to control the creation and deletion of directories,
3106: and the location of inserted files. See Chapter 19, PLIST issues for more
3107: information.
1.1 dsieger 3108:
1.184 rillig 3109: 12.5. Optional files
1.1 dsieger 3110:
1.184 rillig 3111: 12.5.1. Files affecting the binary package
1.1 dsieger 3112:
1.184 rillig 3113: INSTALL
1.1 dsieger 3114:
1.184 rillig 3115: This shell script is invoked twice by pkg_add(1). First time after package
3116: extraction and before files are moved in place, the second time after the
3117: files to install are moved in place. This can be used to do any custom
3118: procedures not possible with @exec commands in PLIST. See pkg_add(1) and
3119: pkg_create(1) for more information. See also Section 20.1, "Files and
3120: directories outside the installation prefix". Please note that you can
3121: modify variables in it easily by using FILES_SUBST in the package's
3122: Makefile:
1.1 dsieger 3123:
1.184 rillig 3124: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3125:
1.184 rillig 3126: replaces "@SOMEVAR@" with "somevalue" in the INSTALL. By default,
3127: substitution is performed for PREFIX, LOCALBASE, X11BASE, VARBASE, and a
3128: few others, type make help topic=FILES_SUBST for a complete list.
1.1 dsieger 3129:
1.184 rillig 3130: DEINSTALL
1.1 dsieger 3131:
1.184 rillig 3132: This script is executed before and after any files are removed. It is this
3133: script's responsibility to clean up any additional messy details around the
3134: package's installation, since all pkg_delete knows is how to delete the
3135: files created in the original distribution. See pkg_delete(1) and
3136: pkg_create(1) for more information. The same methods to replace variables
3137: can be used as for the INSTALL file.
1.1 dsieger 3138:
1.184 rillig 3139: MESSAGE
1.1 dsieger 3140:
1.198 leot 3141: This file is displayed after installation of the package. While this was
3142: used often in the past, it has two problems: the display will be missed if
3143: many packages are intalled at once, and the person installing the package
3144: and the one using or configuring it may be different. It should therefore
3145: be used only in exceptional circumstances where lasting negative
3146: consequences would result from someone not reading it.
3147:
3148: MESSAGE should not be used for:
3149:
1.232 gutterid 3150: o exhortations to read the documentation
1.198 leot 3151:
1.232 gutterid 3152: o reminders to install rc.d files and set variables
1.198 leot 3153:
1.232 gutterid 3154: o anything that should be explained in the installation/configuration
1.198 leot 3155: documentation that should come with the package
3156:
3157: If the documentation provided by upstream needs enhancing, create e.g.
3158: files/README.pkgsrc and install it in the package's documentation
3159: directory.
3160:
3161: Note that MESSAGE is shown for all operating systems and all init systems.
3162: If a MESSAGE is necessary, it should be narrowed to only those operating
3163: systems and init systems to which it applies.
3164:
3165: Note that you can modify variables in it easily by using MESSAGE_SUBST in
3166: the package's Makefile:
1.1 dsieger 3167:
1.184 rillig 3168: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3169:
1.184 rillig 3170: replaces "${SOMEVAR}" with "somevalue" in MESSAGE. By default, substitution
3171: is performed for PKGNAME, PKGBASE, PREFIX, LOCALBASE, X11BASE,
3172: PKG_SYSCONFDIR, ROOT_GROUP, and ROOT_USER.
1.1 dsieger 3173:
1.184 rillig 3174: You can display a different or additional files by setting the MESSAGE_SRC
3175: variable. Its default is MESSAGE, if the file exists.
1.1 dsieger 3176:
1.184 rillig 3177: ALTERNATIVES
1.1 dsieger 3178:
1.184 rillig 3179: This file is used by the alternatives framework. It creates, configures,
3180: and destroys generic wrappers used to run programs with similar interfaces.
3181: See pkg_alternatives(8) from pkgtools/pkg_alternatives for more
3182: information.
1.1 dsieger 3183:
1.184 rillig 3184: Each line of the file contains two filenames, first the wrapper and then
3185: the alternative provided by the package. Both paths are relative to PREFIX.
1.1 dsieger 3186:
1.184 rillig 3187: 12.5.2. Files affecting the build process
1.1 dsieger 3188:
1.184 rillig 3189: Makefile.common
1.1 dsieger 3190:
1.184 rillig 3191: This file contains arbitrary things that could also go into a Makefile, but
3192: its purpose is to be used by more than one package. This file should only
3193: be used when the packages that will use the file are known in advance. For
3194: other purposes it is often better to write a *.mk file and give it a good
3195: name that describes what it does.
1.1 dsieger 3196:
1.184 rillig 3197: buildlink3.mk
1.1 dsieger 3198:
1.184 rillig 3199: This file contains the dependency information for the buildlink3 framework
3200: (see Chapter 18, Buildlink methodology).
1.1 dsieger 3201:
1.184 rillig 3202: hacks.mk
1.1 dsieger 3203:
1.184 rillig 3204: This file contains workarounds for compiler bugs and similar things. It is
3205: included automatically by the pkgsrc infrastructure, so you don't need an
3206: extra .include line for it.
1.1 dsieger 3207:
1.184 rillig 3208: options.mk
1.1 dsieger 3209:
1.184 rillig 3210: This file contains the code for the package-specific options (see
3211: Chapter 16, Options handling) that can be selected by the user. If a
3212: package has only one or two options, it is equally acceptable to put the
3213: code directly into the Makefile.
1.1 dsieger 3214:
1.184 rillig 3215: 12.5.3. Files affecting nothing at all
1.1 dsieger 3216:
1.184 rillig 3217: README*
1.1 dsieger 3218:
1.184 rillig 3219: These files do not take place in the creation of a package and thus are
3220: purely informative to the package developer.
1.1 dsieger 3221:
1.184 rillig 3222: TODO
1.1 dsieger 3223:
1.184 rillig 3224: This file contains things that need to be done to make the package even
3225: better.
1.1 dsieger 3226:
1.184 rillig 3227: 12.6. work*
1.1 dsieger 3228:
1.184 rillig 3229: When you type make, the distribution files are unpacked into the directory
3230: denoted by WRKDIR. It can be removed by running make clean. Besides the
3231: sources, this directory is also used to keep various timestamp files. The
3232: directory gets removed completely on clean. The default is ${.CURDIR}/work or $
3233: {.CURDIR}/work.${MACHINE_ARCH} if OBJMACHINE is set.
1.1 dsieger 3234:
1.184 rillig 3235: 12.7. files/*
1.80 wiz 3236:
1.184 rillig 3237: If you have any files that you wish to be placed in the package prior to
3238: configuration or building, you can place these files here and use a ${CP}
3239: command in the "post-extract" target to achieve this.
1.1 dsieger 3240:
1.184 rillig 3241: If you want to share files in this way with other packages, set the FILESDIR
3242: variable to point to the other package's files directory, e.g.:
1.1 dsieger 3243:
1.184 rillig 3244: FILESDIR= ../../editors/xemacs/files
1.14 jmcneill 3245:
1.184 rillig 3246: Chapter 13. The build process
1.1 dsieger 3247:
1.184 rillig 3248: Table of Contents
1.1 dsieger 3249:
1.184 rillig 3250: 13.1. Introduction
3251: 13.2. Program location
3252: 13.3. Directories used during the build process
3253: 13.4. Running a phase
3254: 13.5. The fetch phase
3255: 13.5.1. What to fetch and where to get it from
3256: 13.5.2. How are the files fetched?
3257: 13.6. The checksum phase
3258: 13.7. The extract phase
3259: 13.8. The patch phase
3260: 13.9. The tools phase
3261: 13.10. The wrapper phase
3262: 13.11. The configure phase
3263: 13.12. The build phase
3264: 13.13. The test phase
3265: 13.14. The install phase
3266: 13.15. The package phase
3267: 13.16. Cleaning up
3268: 13.17. Other helpful targets
1.1 dsieger 3269:
1.184 rillig 3270: 13.1. Introduction
1.122 leot 3271:
1.184 rillig 3272: This chapter gives a detailed description on how a package is built. Building a
3273: package is separated into different phases (for example fetch, build, install),
3274: all of which are described in the following sections. Each phase is split into
3275: so-called stages, which take the name of the containing phase, prefixed by one
3276: of pre-, do- or post-. (Examples are pre-configure, post-build.) Most of the
3277: actual work is done in the do-* stages.
1.1 dsieger 3278:
1.184 rillig 3279: Never override the regular targets (like fetch), if you have to, override the
3280: do-* ones instead.
1.1 dsieger 3281:
1.184 rillig 3282: The basic steps for building a program are always the same. First the program's
3283: source (distfile) must be brought to the local system and then extracted. After
3284: any pkgsrc-specific patches to compile properly are applied, the software can
3285: be configured, then built (usually by compiling), and finally the generated
3286: binaries, etc. can be put into place on the system.
1.1 dsieger 3287:
1.184 rillig 3288: To get more details about what is happening at each step, you can set the
3289: PKG_VERBOSE variable, or the PATCH_DEBUG variable if you are just interested in
3290: more details about the patch step.
1.1 dsieger 3291:
1.184 rillig 3292: 13.2. Program location
1.1 dsieger 3293:
1.184 rillig 3294: Before outlining the process performed by the NetBSD package system in the next
3295: section, here's a brief discussion on where programs are installed, and which
3296: variables influence this.
1.1 dsieger 3297:
1.184 rillig 3298: The automatic variable PREFIX indicates where all files of the final program
3299: shall be installed. It is usually set to LOCALBASE (/usr/pkg), or CROSSBASE for
3300: pkgs in the cross category. The value of PREFIX needs to be put into the
3301: various places in the program's source where paths to these files are encoded.
3302: See Section 12.3, "patches/*" and Section 21.3.1, "Shared libraries - libtool"
3303: for more details.
1.1 dsieger 3304:
1.184 rillig 3305: When choosing which of these variables to use, follow the following rules:
1.1 dsieger 3306:
1.184 rillig 3307: * PREFIX always points to the location where the current pkg will be
3308: installed. When referring to a pkg's own installation path, use "${PREFIX}"
3309: .
1.1 dsieger 3310:
1.223 nia 3311: * LOCALBASE is where all pkgs are installed. If you need to construct a -I or
3312: -L argument to the compiler to find includes and libraries installed by
3313: another pkg, use "${LOCALBASE}". The name LOCALBASE stems from FreeBSD,
3314: which installed all packages in /usr/local. As pkgsrc leaves /usr/local for
3315: the system administrator, this variable is a misnomer.
1.1 dsieger 3316:
1.184 rillig 3317: * X11BASE is where the actual X11 distribution (from xsrc, etc.) is
3318: installed. When looking for standard X11 includes (not those installed by a
3319: package), use "${X11BASE}".
1.1 dsieger 3320:
1.184 rillig 3321: * X11-based packages using imake must set USE_IMAKE to be installed correctly
3322: under LOCALBASE.
1.1 dsieger 3323:
1.184 rillig 3324: * Within ${PREFIX}, packages should install files according to hier(7), with
3325: the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/
3326: man.
1.1 dsieger 3327:
1.184 rillig 3328: 13.3. Directories used during the build process
1.2 rillig 3329:
1.184 rillig 3330: When building a package, various directories are used to store source files,
3331: temporary files, pkgsrc-internal files, and so on. These directories are
3332: explained here.
1.1 dsieger 3333:
1.184 rillig 3334: Some of the directory variables contain relative pathnames. There are two
3335: common base directories for these relative directories: PKGSRCDIR/PKGPATH is
3336: used for directories that are pkgsrc-specific. WRKSRC is used for directories
3337: inside the package itself.
1.1 dsieger 3338:
1.184 rillig 3339: PKGSRCDIR
1.1 dsieger 3340:
1.184 rillig 3341: This is an absolute pathname that points to the pkgsrc root directory.
3342: Generally, you don't need it.
1.1 dsieger 3343:
1.184 rillig 3344: PKGDIR
1.1 dsieger 3345:
1.184 rillig 3346: This is an absolute pathname that points to the current package.
1.1 dsieger 3347:
1.184 rillig 3348: PKGPATH
1.1 dsieger 3349:
1.184 rillig 3350: This is a pathname relative to PKGSRCDIR that points to the current
1.228 gutterid 3351: package. It is defined after including bsd.prefs.mk and can be used in
3352: makefile fragments that are used by several packages to distinguish between
3353: these packages. Other variables that would serve the same purpose are
3354: PKGBASE and PKGNAME, but these are only defined after including bsd.pkg.mk,
3355: which is too late.
3356:
3357: In mk.conf, the pkgsrc user can use PKGPATH to tweak variables like
3358: MAKE_JOBS and CFLAGS.
1.1 dsieger 3359:
1.184 rillig 3360: WRKDIR
1.1 dsieger 3361:
1.184 rillig 3362: This is an absolute pathname pointing to the directory where all work takes
3363: place. The distfiles are extracted to this directory. It also contains
3364: temporary directories and log files used by the various pkgsrc frameworks,
3365: like buildlink or the wrappers.
1.1 dsieger 3366:
1.184 rillig 3367: WRKSRC
1.1 dsieger 3368:
1.184 rillig 3369: This is an absolute pathname pointing to the directory where the distfiles
3370: are extracted. It is usually a direct subdirectory of WRKDIR, and often
3371: it's the only directory entry that isn't hidden. This variable may be
3372: changed by a package Makefile.
1.1 dsieger 3373:
1.184 rillig 3374: The CREATE_WRKDIR_SYMLINK definition takes either the value yes or no and
3375: defaults to no. It indicates whether a symbolic link to the WRKDIR is to be
3376: created in the pkgsrc entry's directory. If users would like to have their
3377: pkgsrc trees behave in a read-only manner, then the value of
3378: CREATE_WRKDIR_SYMLINK should be set to no.
1.1 dsieger 3379:
1.184 rillig 3380: 13.4. Running a phase
1.1 dsieger 3381:
1.184 rillig 3382: You can run a particular phase by typing make phase, where phase is the name of
3383: the phase. This will automatically run all phases that are required for this
3384: phase. The default phase is build, that is, when you run make without
3385: parameters in a package directory, the package will be built, but not
3386: installed.
1.1 dsieger 3387:
1.184 rillig 3388: 13.5. The fetch phase
1.1 dsieger 3389:
1.184 rillig 3390: The first step in building a package is to fetch the distribution files
3391: (distfiles) from the sites that are providing them. This is the task of the
3392: fetch phase.
1.25 wiz 3393:
1.184 rillig 3394: 13.5.1. What to fetch and where to get it from
1.1 dsieger 3395:
1.184 rillig 3396: In simple cases, MASTER_SITES defines all URLs from where the distfile, whose
3397: name is derived from the DISTNAME variable, is fetched. The more complicated
3398: cases are described below.
1.1 dsieger 3399:
1.184 rillig 3400: The variable DISTFILES specifies the list of distfiles that have to be fetched.
3401: Its value defaults to ${DEFAULT_DISTFILES} and its value is ${DISTNAME}$
3402: {EXTRACT_SUFX}, so that most packages don't need to define it at all.
3403: EXTRACT_SUFX is .tar.gz by default, but can be changed freely. Note that if
3404: your package requires additional distfiles to the default one, you cannot just
3405: append the additional filenames using the += operator, but you have write for
3406: example:
1.1 dsieger 3407:
1.184 rillig 3408: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 3409:
1.184 rillig 3410: Each distfile is fetched from a list of sites, usually MASTER_SITES. If the
3411: package has multiple DISTFILES or multiple PATCHFILES from different sites, you
3412: can set SITES.distfile to the list of URLs where the file distfile (including
3413: the suffix) can be found.
1.1 dsieger 3414:
1.184 rillig 3415: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
3416: DISTFILES+= foo-file.tar.gz
3417: SITES.foo-file.tar.gz= \
3418: https://www.somewhere.com/somehow/ \
3419: https://www.somewhereelse.com/mirror/somehow/
1.1 dsieger 3420:
1.184 rillig 3421: When actually fetching the distfiles, each item from MASTER_SITES or SITES.*
3422: gets the name of each distfile appended to it, without an intermediate slash.
3423: Therefore, all site values have to end with a slash or other separator
3424: character. This allows for example to set MASTER_SITES to a URL of a CGI script
3425: that gets the name of the distfile as a parameter. In this case, the definition
3426: would look like:
1.1 dsieger 3427:
1.184 rillig 3428: MASTER_SITES= https://www.example.com/download.cgi?file=
1.1 dsieger 3429:
1.184 rillig 3430: The exception to this rule are URLs starting with a dash. In that case the URL
3431: is taken as is, fetched and the result stored under the name of the distfile.
3432: You can use this style for the case when the download URL style does not match
3433: the above common case. For example, if permanent download URL is a redirector
3434: to the real download URL, or the download file name is offered by an HTTP
3435: Content-Disposition header. In the following example, foo-1.0.0.tar.gz will be
3436: created instead of the default v1.0.0.tar.gz.
1.1 dsieger 3437:
1.184 rillig 3438: DISTNAME= foo-1.0.0
3439: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
1.29 wiz 3440:
1.184 rillig 3441: There are some predefined values for MASTER_SITES, which can be used in
3442: packages. The names of the variables should speak for themselves.
1.29 wiz 3443:
1.225 gutterid 3444: MASTER_SITE_APACHE MASTER_SITE_BACKUP
3445: MASTER_SITE_CRATESIO MASTER_SITE_CYGWIN
3446: MASTER_SITE_DEBIAN MASTER_SITE_FREEBSD
3447: MASTER_SITE_FREEBSD_LOCAL MASTER_SITE_GENTOO
3448: MASTER_SITE_GITHUB MASTER_SITE_GITLAB
3449: MASTER_SITE_GNOME MASTER_SITE_GNU
3450: MASTER_SITE_GNUSTEP MASTER_SITE_HASKELL_HACKAGE
3451: MASTER_SITE_IFARCHIVE MASTER_SITE_KDE
3452: MASTER_SITE_MOZILLA MASTER_SITE_MOZILLA_ALL
3453: MASTER_SITE_MYSQL MASTER_SITE_NETLIB
3454: MASTER_SITE_OPENBSD MASTER_SITE_OPENOFFICE
3455: MASTER_SITE_OSDN MASTER_SITE_PERL_CPAN
3456: MASTER_SITE_PGSQL MASTER_SITE_PYPI
3457: MASTER_SITE_RUBYGEMS MASTER_SITE_R_CRAN
3458: MASTER_SITE_SOURCEFORGE MASTER_SITE_SUNSITE
3459: MASTER_SITE_SUSE MASTER_SITE_TEX_CTAN
3460: MASTER_SITE_XCONTRIB MASTER_SITE_XEMACS
3461: MASTER_SITE_XORG
1.1 dsieger 3462:
1.184 rillig 3463: Some explanations for the less self-explaining ones: MASTER_SITE_BACKUP
3464: contains backup sites for packages that are maintained in ftp://ftp.NetBSD.org/
3465: pub/pkgsrc/distfiles/${DIST_SUBDIR}. MASTER_SITE_LOCAL contains local package
3466: source distributions that are maintained in ftp://ftp.NetBSD.org/pub/pkgsrc/
3467: distfiles/LOCAL_PORTS/.
1.1 dsieger 3468:
1.184 rillig 3469: If you choose one of these predefined sites, you may want to specify a
3470: subdirectory of that site. Since these macros may expand to more than one
3471: actual site, you must use the following construct to specify a subdirectory:
1.1 dsieger 3472:
1.184 rillig 3473: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
3474: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 3475:
1.184 rillig 3476: Note the trailing slash after the subdirectory name.
1.1 dsieger 3477:
1.184 rillig 3478: 13.5.2. How are the files fetched?
1.1 dsieger 3479:
1.184 rillig 3480: The fetch phase makes sure that all the distfiles exist in a local directory
3481: (DISTDIR, which can be set by the pkgsrc user). If the files do not exist, they
3482: are fetched using commands of the form
1.1 dsieger 3483:
1.184 rillig 3484: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
1.1 dsieger 3485:
1.184 rillig 3486: where ${site} varies through several possibilities in turn: first,
3487: MASTER_SITE_OVERRIDE is tried, then the sites specified in either SITES.file if
3488: defined, else MASTER_SITES or PATCH_SITES, as applies, then finally the value
3489: of MASTER_SITE_BACKUP. The order of all except the first and the last can be
3490: optionally sorted by the user, via setting either MASTER_SORT_RANDOM, and
3491: MASTER_SORT_AWK or MASTER_SORT_REGEX.
1.1 dsieger 3492:
1.184 rillig 3493: The specific command and arguments used depend on the FETCH_USING parameter.
3494: The example above is for FETCH_USING=custom.
1.66 asau 3495:
1.184 rillig 3496: The distfiles mirror run by the NetBSD Foundation uses the mirror-distfiles
3497: target to mirror the distfiles, if they are freely distributable. Packages
3498: setting NO_SRC_ON_FTP (usually to "${RESTRICTED}") will not have their
3499: distfiles mirrored.
1.1 dsieger 3500:
1.184 rillig 3501: 13.6. The checksum phase
1.1 dsieger 3502:
1.184 rillig 3503: After the distfile(s) are fetched, their checksum is generated and compared
3504: with the checksums stored in the distinfo file. If the checksums don't match,
3505: the build is aborted. This is to ensure the same distfile is used for building,
3506: and that the distfile wasn't changed, e.g. by some malign force, deliberately
3507: changed distfiles on the master distribution site or network lossage.
1.1 dsieger 3508:
1.184 rillig 3509: 13.7. The extract phase
1.1 dsieger 3510:
1.184 rillig 3511: When the distfiles are present on the local system, they need to be extracted,
3512: as they usually come in the form of some compressed archive format.
1.1 dsieger 3513:
1.184 rillig 3514: By default, all DISTFILES are extracted. If you only need some of them, you can
3515: set the EXTRACT_ONLY variable to the list of those files.
1.1 dsieger 3516:
1.184 rillig 3517: Extracting the files is usually done by a little program, mk/extract/extract,
3518: which already knows how to extract various archive formats, so most likely you
3519: will not need to change anything here. But if you need, the following variables
3520: may help you:
1.1 dsieger 3521:
1.184 rillig 3522: EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}
1.1 dsieger 3523:
1.184 rillig 3524: Use these variables to override the default options for an extract command,
3525: which are defined in mk/extract/extract.
1.1 dsieger 3526:
1.184 rillig 3527: EXTRACT_USING
1.1 dsieger 3528:
1.184 rillig 3529: This variable can be set to bsdtar, gtar, nbtar (which is the default
3530: value), pax, or an absolute pathname pointing to the command with which tar
3531: archives should be extracted. It is preferred to choose bsdtar over gtar if
3532: NetBSD's pax-as-tar is not good enough.
1.1 dsieger 3533:
1.184 rillig 3534: If the extract program doesn't serve your needs, you can also override the
3535: EXTRACT_CMD variable, which holds the command used for extracting the files.
3536: This command is executed in the ${WRKSRC} directory. During execution of this
3537: command, the shell variable extract_file holds the absolute pathname of the
3538: file that is going to be extracted.
1.1 dsieger 3539:
1.184 rillig 3540: And if that still does not suffice, you can override the do-extract target in
3541: the package Makefile.
1.1 dsieger 3542:
1.184 rillig 3543: 13.8. The patch phase
1.1 dsieger 3544:
1.184 rillig 3545: After extraction, all the patches named by the PATCHFILES, those present in the
3546: patches subdirectory of the package as well as in $LOCALPATCHES/$PKGPATH (e.g.
3547: /usr/local/patches/graphics/png) are applied. Patchfiles ending in .Z or .gz
3548: are uncompressed before they are applied, files ending in .orig or .rej are
3549: ignored. Any special options to patch(1) can be handed in PATCH_DIST_ARGS. See
3550: Section 12.3, "patches/*" for more details.
1.1 dsieger 3551:
1.184 rillig 3552: By default patch(1) is given special arguments to make it fail if the expected
3553: text from the patch context is not found in the patched file. If that happens,
3554: fix the patch file by comparing it with the actual text in the file to be
3555: patched.
1.1 dsieger 3556:
1.184 rillig 3557: 13.9. The tools phase
1.1 dsieger 3558:
1.184 rillig 3559: This is covered in Chapter 17, Tools needed for building or running.
1.1 dsieger 3560:
1.184 rillig 3561: 13.10. The wrapper phase
1.1 dsieger 3562:
1.184 rillig 3563: This phase creates wrapper programs for the compilers and linkers. The
3564: following variables can be used to tweak the wrappers.
1.1 dsieger 3565:
1.184 rillig 3566: ECHO_WRAPPER_MSG
1.1 dsieger 3567:
1.184 rillig 3568: The command used to print progress messages. Does nothing by default. Set
3569: to ${ECHO} to see the progress messages.
1.1 dsieger 3570:
1.184 rillig 3571: WRAPPER_DEBUG
1.1 dsieger 3572:
1.184 rillig 3573: This variable can be set to yes (default) or no, depending on whether you
3574: want additional information in the wrapper log file.
1.1 dsieger 3575:
1.184 rillig 3576: WRAPPER_UPDATE_CACHE
1.1 dsieger 3577:
1.184 rillig 3578: This variable can be set to yes or no, depending on whether the wrapper
3579: should use its cache, which will improve the speed. The default value is
3580: yes, but is forced to no if the platform does not support it.
1.1 dsieger 3581:
1.184 rillig 3582: WRAPPER_REORDER_CMDS
1.1 dsieger 3583:
1.184 rillig 3584: A list of reordering commands. A reordering command has the form reorder:l:
3585: lib1:lib2. It ensures that that -llib1 occurs before -llib2.
1.1 dsieger 3586:
1.184 rillig 3587: 13.11. The configure phase
1.1 dsieger 3588:
1.184 rillig 3589: Most pieces of software need information on the header files, system calls, and
3590: library routines which are available on the platform they run on. The process
3591: of determining this information is known as configuration, and is usually
3592: automated. In most cases, a script is supplied with the distfiles, and its
3593: invocation results in generation of header files, Makefiles, etc.
1.1 dsieger 3594:
1.184 rillig 3595: If the package contains a configure script, this can be invoked by setting
3596: HAS_CONFIGURE to "yes". If the configure script is a GNU autoconf script, you
1.187 rillig 3597: should set GNU_CONFIGURE to "yes" instead.
1.1 dsieger 3598:
1.187 rillig 3599: In the do-configure stage, a rough equivalent of the following command is run.
3600: See mk/configure/configure.mk, target do-configure-script for the exact
3601: definition.
3602:
3603: .for dir in ${CONFIGURE_DIRS}
3604: cd ${WRKSRC} && cd ${dir} \
3605: && env ${CONFIGURE_ENV} \
3606: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 3607: .endfor
1.1 dsieger 3608:
1.184 rillig 3609: CONFIGURE_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In
3610: each of these directories, the configure script is run with the environment
3611: CONFIGURE_ENV and arguments CONFIGURE_ARGS. The variables CONFIGURE_ENV,
3612: CONFIGURE_SCRIPT (default: "./configure") and CONFIGURE_ARGS may all be changed
3613: by the package.
1.1 dsieger 3614:
1.184 rillig 3615: If the program uses the Perl way of configuration (mainly Perl modules, but not
3616: only), i.e. a file called Makefile.PL, it should include ../../lang/perl5/
3617: module.mk. To set any parameter for Makefile.PL use the MAKE_PARAMS variable
3618: (e.g., MAKE_PARAMS+=foo=bar
1.1 dsieger 3619:
1.184 rillig 3620: If the program uses an Imakefile for configuration, the appropriate steps can
3621: be invoked by setting USE_IMAKE to "yes". If you only need xmkmf, add it to
3622: USE_TOOLS. You can add variables to xmkmf's environment by adding them to the
3623: SCRIPTS_ENV variable.
1.1 dsieger 3624:
1.184 rillig 3625: If the program uses cmake for configuration, the appropriate steps can be
1.233 wiz 3626: invoked by including ../../devel/cmake/build.mk. You can add variables to
3627: cmake's environment by adding them to the CONFIGURE_ENV variable and arguments
3628: to cmake by adding them to the CMAKE_ARGS variable. If you want to add
3629: arguments only for particular stages, you can use the CMAKE_CONFIGURE_ARGS,
3630: CMAKE_BUILD_ARGS, and CMAKE_INSTALL_ARGS variables. You can set the
3631: CONFIGURE_DIRS variable to the directories in which CMake should be run,
3632: relative to WRKSRC. This defaults to to ".".
1.1 dsieger 3633:
1.184 rillig 3634: If there is no configure step at all, set NO_CONFIGURE to "yes".
1.1 dsieger 3635:
1.184 rillig 3636: 13.12. The build phase
1.1 dsieger 3637:
1.187 rillig 3638: For building a package, a rough equivalent of the following code is executed;
3639: see mk/build/build.mk, target do-build for the exact definition.
1.154 rillig 3640:
1.187 rillig 3641: .for dir in ${BUILD_DIRS}
3642: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 3643: && env ${MAKE_ENV} \
1.187 rillig 3644: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 3645: -f ${MAKE_FILE} \
3646: ${BUILD_TARGET}
3647: .endfor
1.1 dsieger 3648:
1.184 rillig 3649: BUILD_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In each of
3650: these directories, MAKE_PROGRAM is run with the environment MAKE_ENV and
3651: arguments BUILD_MAKE_FLAGS. The variables MAKE_ENV, BUILD_MAKE_FLAGS, MAKE_FILE
3652: and BUILD_TARGET may all be changed by the package.
1.1 dsieger 3653:
1.184 rillig 3654: The default value of MAKE_PROGRAM is "gmake" if USE_TOOLS contains "gmake", "
3655: make" otherwise. The default value of MAKE_FILE is "Makefile", and BUILD_TARGET
3656: defaults to "all".
1.1 dsieger 3657:
1.184 rillig 3658: If there is no build step at all, set NO_BUILD to "yes".
1.1 dsieger 3659:
1.184 rillig 3660: 13.13. The test phase
1.1 dsieger 3661:
1.184 rillig 3662: [TODO]
1.1 dsieger 3663:
1.184 rillig 3664: 13.14. The install phase
1.1 dsieger 3665:
1.184 rillig 3666: Once the build stage has completed, the final step is to install the software
3667: in public directories, so users can access the programs and files.
1.1 dsieger 3668:
1.187 rillig 3669: In the install phase, a rough equivalent of the following code is executed; see
3670: mk/install/install.mk, target do-install for the exact definition.
3671: Additionally, before and after this code, several consistency checks are run
3672: against the files-to-be-installed, see mk/check/*.mk for details.
3673:
3674: .for dir in ${INSTALL_DIRS}
3675: cd ${WRKSRC} && cd ${dir} \
3676: && env ${INSTALL_ENV} ${MAKE_ENV} \
3677: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
3678: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 3679: .endfor
1.1 dsieger 3680:
1.184 rillig 3681: The variable's meanings are analogous to the ones in the build phase.
3682: INSTALL_DIRS defaults to BUILD_DIRS. INSTALL_TARGET is "install" by default,
3683: plus "install.man" if USE_IMAKE is defined and NO_INSTALL_MANPAGES is not
3684: defined.
1.1 dsieger 3685:
1.184 rillig 3686: In the install phase, the following variables are useful. They are all
3687: variations of the install(1) command that have the owner, group and permissions
3688: preset. INSTALL is the plain install command. The specialized variants,
3689: together with their intended use, are:
1.1 dsieger 3690:
1.184 rillig 3691: INSTALL_PROGRAM_DIR
1.1 dsieger 3692:
1.184 rillig 3693: directories that contain binaries
1.1 dsieger 3694:
1.184 rillig 3695: INSTALL_SCRIPT_DIR
1.1 dsieger 3696:
1.184 rillig 3697: directories that contain scripts
1.1 dsieger 3698:
1.184 rillig 3699: INSTALL_LIB_DIR
1.1 dsieger 3700:
1.184 rillig 3701: directories that contain shared and static libraries
1.1 dsieger 3702:
1.184 rillig 3703: INSTALL_DATA_DIR
1.108 rillig 3704:
1.184 rillig 3705: directories that contain data files
1.108 rillig 3706:
1.184 rillig 3707: INSTALL_MAN_DIR
1.108 rillig 3708:
1.184 rillig 3709: directories that contain man pages
1.108 rillig 3710:
1.184 rillig 3711: INSTALL_GAME_DIR
1.108 rillig 3712:
1.184 rillig 3713: directories that contain data files for games
1.108 rillig 3714:
1.184 rillig 3715: INSTALL_PROGRAM
1.108 rillig 3716:
1.184 rillig 3717: binaries that can be stripped from debugging symbols
1.108 rillig 3718:
1.184 rillig 3719: INSTALL_SCRIPT
1.108 rillig 3720:
1.184 rillig 3721: binaries that cannot be stripped
1.108 rillig 3722:
1.184 rillig 3723: INSTALL_GAME
1.108 rillig 3724:
1.184 rillig 3725: game binaries
1.108 rillig 3726:
1.184 rillig 3727: INSTALL_LIB
1.108 rillig 3728:
1.184 rillig 3729: shared and static libraries
1.108 rillig 3730:
1.184 rillig 3731: INSTALL_DATA
1.108 rillig 3732:
1.184 rillig 3733: data files
1.1 dsieger 3734:
1.184 rillig 3735: INSTALL_GAME_DATA
1.1 dsieger 3736:
1.184 rillig 3737: data files for games
1.108 rillig 3738:
1.184 rillig 3739: INSTALL_MAN
1.108 rillig 3740:
1.184 rillig 3741: man pages
1.1 dsieger 3742:
1.184 rillig 3743: Some other variables are:
1.1 dsieger 3744:
1.184 rillig 3745: INSTALL_UNSTRIPPED
1.1 dsieger 3746:
1.184 rillig 3747: If set to yes, do not run strip(1) when installing binaries. Any debugging
3748: sections and symbols present in binaries will be preserved.
1.1 dsieger 3749:
1.184 rillig 3750: INSTALLATION_DIRS
1.1 dsieger 3751:
1.184 rillig 3752: A list of directories relative to PREFIX that are created by pkgsrc at the
3753: beginning of the install phase. The package is supposed to create all
3754: needed directories itself before installing files to it and list all other
3755: directories here.
1.1 dsieger 3756:
1.184 rillig 3757: In the rare cases that a package shouldn't install anything, set NO_INSTALL to
3758: "yes". This is mostly relevant for packages in the regress category.
1.1 dsieger 3759:
1.184 rillig 3760: 13.15. The package phase
1.121 sevan 3761:
1.184 rillig 3762: Once the install stage has completed, a binary package of the installed files
3763: can be built. These binary packages can be used for quick installation without
3764: previous compilation, e.g. by the make bin-install or by using pkg_add.
1.1 dsieger 3765:
1.184 rillig 3766: By default, the binary packages are created in ${PACKAGES}/All and symlinks are
3767: created in ${PACKAGES}/category, one for each category in the CATEGORIES
3768: variable. PACKAGES defaults to pkgsrc/packages.
1.1 dsieger 3769:
1.184 rillig 3770: 13.16. Cleaning up
1.1 dsieger 3771:
1.184 rillig 3772: Once you're finished with a package, you can clean the work directory by
3773: running make clean. If you want to clean the work directories of all
3774: dependencies too, use make clean-depends.
1.1 dsieger 3775:
1.184 rillig 3776: 13.17. Other helpful targets
1.1 dsieger 3777:
1.184 rillig 3778: pre/post-*
1.1 dsieger 3779:
1.184 rillig 3780: For any of the main targets described in the previous section (configure,
3781: build, install, etc.), two auxiliary targets exist with "pre-" and "post-"
3782: used as a prefix for the main target's name. These targets are invoked
3783: before and after the main target is called, allowing extra configuration or
3784: installation steps be performed from a package's Makefile, for example,
3785: which a program's configure script or install target omitted.
3786:
3787: About 5% of the pkgsrc packages define their custom post-extract target,
3788: another 5% define pre-configure, and 10% define post-install. The other pre
3789: /post-* targets are defined even less often.
1.1 dsieger 3790:
1.184 rillig 3791: do-*
1.182 leot 3792:
1.184 rillig 3793: Should one of the main targets do the wrong thing, and should there be no
3794: variable to fix this, you can redefine it with the do-* target. (Note that
3795: redefining the target itself instead of the do-* target is a bad idea, as
3796: the pre-* and post-* targets won't be called anymore, etc.)
1.1 dsieger 3797:
1.184 rillig 3798: About 15% of the pkgsrc packages override the default do-install, the other
3799: do-* targets are overridden even less often.
1.1 dsieger 3800:
1.184 rillig 3801: reinstall
1.1 dsieger 3802:
1.184 rillig 3803: If you did a make install and you noticed some file was not installed
3804: properly, you can repeat the installation with this target, which will
3805: ignore the "already installed" flag.
1.1 dsieger 3806:
1.184 rillig 3807: This is the default value of DEPENDS_TARGET except in the case of make
3808: update and make package, where the defaults are "package" and "update",
3809: respectively.
1.1 dsieger 3810:
1.184 rillig 3811: deinstall
1.1 dsieger 3812:
1.184 rillig 3813: This target does a pkg_delete(1) in the current directory, effectively
3814: de-installing the package. The following variables can be used to tune the
3815: behaviour:
1.1 dsieger 3816:
1.184 rillig 3817: PKG_VERBOSE
1.1 dsieger 3818:
1.184 rillig 3819: Add a "-v" to the pkg_delete(1) command.
1.1 dsieger 3820:
1.184 rillig 3821: DEINSTALLDEPENDS
1.1 dsieger 3822:
1.184 rillig 3823: Remove all packages that require (depend on) the given package. This
3824: can be used to remove any packages that may have been pulled in by a
3825: given package, e.g. if make deinstall DEINSTALLDEPENDS=1 is done in
3826: pkgsrc/x11/kde, this is likely to remove whole KDE. Works by adding "-R
3827: " to the pkg_delete(1) command line.
1.1 dsieger 3828:
1.184 rillig 3829: bin-install
1.1 dsieger 3830:
1.184 rillig 3831: Install a binary package from local disk and via FTP from a list of sites
3832: (see the BINPKG_SITES variable), and do a make package if no binary package
3833: is available anywhere. The arguments given to pkg_add can be set via
3834: BIN_INSTALL_FLAGS e.g., to do verbose operation, etc.
1.1 dsieger 3835:
1.184 rillig 3836: install-clean
1.1 dsieger 3837:
1.184 rillig 3838: This target removes the state files for the "install" and later phases so
3839: that the "install" target may be re-invoked. This can be used after editing
3840: the PLIST to install the package without rebuilding it.
1.1 dsieger 3841:
1.184 rillig 3842: build-clean
1.18 mishka 3843:
1.184 rillig 3844: This target removes the state files for the "build" and later phases so
3845: that the "build" target may be re-invoked.
1.18 mishka 3846:
1.184 rillig 3847: update
1.18 mishka 3848:
1.184 rillig 3849: This target causes the current package to be updated to the latest version.
3850: The package and all depending packages first get de-installed, then current
3851: versions of the corresponding packages get compiled and installed. This is
3852: similar to manually noting which packages are currently installed, then
3853: performing a series of make deinstall and make install (or whatever
3854: UPDATE_TARGET is set to) for these packages.
1.18 mishka 3855:
1.184 rillig 3856: You can use the "update" target to resume package updating in case a
3857: previous make update was interrupted for some reason. However, in this
3858: case, make sure you don't call make clean or otherwise remove the list of
3859: dependent packages in WRKDIR. Otherwise, you lose the ability to
3860: automatically update the current package along with the dependent packages
3861: you have installed.
1.121 sevan 3862:
1.184 rillig 3863: Resuming an interrupted make update will only work as long as the package
3864: tree remains unchanged. If the source code for one of the packages to be
3865: updated has been changed, resuming make update will most certainly fail!
1.1 dsieger 3866:
1.184 rillig 3867: The following variables can be used either on the command line or in
3868: mk.conf to alter the behaviour of make update:
1.1 dsieger 3869:
1.184 rillig 3870: UPDATE_TARGET
1.1 dsieger 3871:
1.184 rillig 3872: Install target to recursively use for the updated package and the
3873: dependent packages. Defaults to DEPENDS_TARGET if set, "install"
3874: otherwise for make update. Other good targets are "package" or "
3875: bin-install". Do not set this to "update" or you will get stuck in an
3876: endless loop!
1.1 dsieger 3877:
1.184 rillig 3878: NOCLEAN
1.1 dsieger 3879:
1.184 rillig 3880: Don't clean up after updating. Useful if you want to leave the work
3881: sources of the updated packages around for inspection or other
3882: purposes. Be sure you eventually clean up the source tree (see the "
3883: clean-update" target below) or you may run into troubles with old
3884: source code still lying around on your next make or make update.
1.1 dsieger 3885:
1.184 rillig 3886: REINSTALL
1.1 dsieger 3887:
1.184 rillig 3888: Deinstall each package before installing (making DEPENDS_TARGET). This
3889: may be necessary if the "clean-update" target (see below) was called
3890: after interrupting a running make update.
1.1 dsieger 3891:
1.184 rillig 3892: DEPENDS_TARGET
1.1 dsieger 3893:
1.184 rillig 3894: Allows you to disable recursion and hardcode the target for packages.
3895: The default is "update" for the update target, facilitating a recursive
3896: update of prerequisite packages. Only set DEPENDS_TARGET if you want to
3897: disable recursive updates. Use UPDATE_TARGET instead to just set a
3898: specific target for each package to be installed during make update
3899: (see above).
1.1 dsieger 3900:
1.184 rillig 3901: clean-update
1.1 dsieger 3902:
1.184 rillig 3903: Clean the source tree for all packages that would get updated if make
3904: update was called from the current directory. This target should not be
3905: used if the current package (or any of its depending packages) have already
3906: been de-installed (e.g., after calling make update) or you may lose some
3907: packages you intended to update. As a rule of thumb: only use this target
3908: before the first time you run make update and only if you have a dirty
3909: package tree (e.g., if you used NOCLEAN).
1.86 wiz 3910:
1.184 rillig 3911: If you are unsure about whether your tree is clean, you can either perform
3912: a make clean at the top of the tree, or use the following sequence of
3913: commands from the directory of the package you want to update (before
3914: running make update for the first time, otherwise you lose all the packages
3915: you wanted to update!):
1.86 wiz 3916:
1.184 rillig 3917: # make clean-update
3918: # make clean CLEANDEPENDS=YES
3919: # make update
1.86 wiz 3920:
3921:
1.184 rillig 3922: The following variables can be used either on the command line or in
3923: mk.conf to alter the behaviour of make clean-update:
1.86 wiz 3924:
1.184 rillig 3925: CLEAR_DIRLIST
1.86 wiz 3926:
1.184 rillig 3927: After make clean, do not reconstruct the list of directories to update
3928: for this package. Only use this if make update successfully installed
3929: all packages you wanted to update. Normally, this is done automatically
3930: on make update, but may have been suppressed by the NOCLEAN variable
3931: (see above).
1.1 dsieger 3932:
1.184 rillig 3933: replace
1.1 dsieger 3934:
1.184 rillig 3935: Update the installation of the current package. This differs from update in
3936: that it does not replace dependent packages. You will need to install
3937: pkgtools/pkg_tarup for this target to work.
1.1 dsieger 3938:
1.184 rillig 3939: Be careful when using this target! There are no guarantees that dependent
3940: packages will still work, in particular they will most certainly break if
3941: you make replace a library package whose shared library major version
3942: changed between your installed version and the new one. For this reason,
3943: this target is not officially supported and only recommended for advanced
3944: users.
1.1 dsieger 3945:
1.184 rillig 3946: info
1.1 dsieger 3947:
1.184 rillig 3948: This target invokes pkg_info(1) for the current package. You can use this
3949: to check which version of a package is installed.
1.86 wiz 3950:
1.184 rillig 3951: index
1.1 dsieger 3952:
1.184 rillig 3953: This is a top-level command, i.e. it should be used in the pkgsrc
3954: directory. It creates a database of all packages in the local pkgsrc tree,
3955: including dependencies, comment, maintainer, and some other useful
3956: information. Individual entries are created by running make describe in the
3957: packages' directories. This index file is saved as pkgsrc/INDEX. It can be
3958: displayed in verbose format by running make print-index. You can search in
3959: it with make search key=something. You can extract a list of all packages
3960: that depend on a particular one by running make show-deps PKG=somepackage.
1.1 dsieger 3961:
1.184 rillig 3962: Running this command takes a very long time, some hours even on fast
3963: machines!
1.1 dsieger 3964:
1.184 rillig 3965: readme
1.1 dsieger 3966:
1.199 nia 3967: This target generates a index.html file, which can be viewed using a
1.184 rillig 3968: browser such as www/firefox or www/links. The generated files contain
3969: references to any packages which are in the PACKAGES directory on the local
3970: host. The generated files can be made to refer to URLs based on
3971: FTP_PKG_URL_HOST and FTP_PKG_URL_DIR. For example, if I wanted to generate
1.199 nia 3972: index.html files which pointed to binary packages on the local machine, in
1.184 rillig 3973: the directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
3974: FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
3975: subdirectories will be searched for all the binary packages.
1.1 dsieger 3976:
1.184 rillig 3977: The target can be run at the toplevel or in category directories, in which
3978: case it descends recursively.
1.1 dsieger 3979:
1.184 rillig 3980: readme-all
1.1 dsieger 3981:
1.184 rillig 3982: This is a top-level command, run it in pkgsrc. Use this target to create a
3983: file README-all.html which contains a list of all packages currently
3984: available in the NetBSD Packages Collection, together with the category
3985: they belong to and a short description. This file is compiled from the
1.199 nia 3986: pkgsrc/*/index.html files, so be sure to run this after a make readme.
1.1 dsieger 3987:
1.184 rillig 3988: cdrom-readme
1.1 dsieger 3989:
1.184 rillig 3990: This is very much the same as the "readme" target (see above), but is to be
3991: used when generating a pkgsrc tree to be written to a CD-ROM. This target
1.199 nia 3992: also produces index.html files, and can be made to refer to URLs based on
1.184 rillig 3993: CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
1.1 dsieger 3994:
1.184 rillig 3995: show-distfiles
1.1 dsieger 3996:
1.184 rillig 3997: This target shows which distfiles and patchfiles are needed to build the
3998: package (ALLFILES, which contains all DISTFILES and PATCHFILES, but not
3999: patches/*).
1.1 dsieger 4000:
1.184 rillig 4001: show-downlevel
1.1 dsieger 4002:
1.184 rillig 4003: This target shows nothing if the package is not installed. If a version of
4004: this package is installed, but is not the version provided in this version
4005: of pkgsrc, then a warning message is displayed. This target can be used to
4006: show which of your installed packages are downlevel, and so the old
4007: versions can be deleted, and the current ones added.
1.1 dsieger 4008:
1.184 rillig 4009: show-pkgsrc-dir
1.1 dsieger 4010:
1.184 rillig 4011: This target shows the directory in the pkgsrc hierarchy from which the
4012: package can be built and installed. This may not be the same directory as
4013: the one from which the package was installed. This target is intended to be
4014: used by people who may wish to upgrade many packages on a single host, and
4015: can be invoked from the top-level pkgsrc Makefile by using the "
4016: show-host-specific-pkgs" target.
1.1 dsieger 4017:
1.184 rillig 4018: show-installed-depends
1.1 dsieger 4019:
1.184 rillig 4020: This target shows which installed packages match the current package's
4021: DEPENDS. Useful if out of date dependencies are causing build problems.
1.1 dsieger 4022:
1.184 rillig 4023: print-build-depends-list
1.1 dsieger 4024:
1.184 rillig 4025: This target shows the list of packages that the current package depends on
4026: for building.
1.1 dsieger 4027:
1.184 rillig 4028: print-run-depends-list
1.1 dsieger 4029:
1.184 rillig 4030: This target shows the list of packages that the current package depends on
4031: for running.
1.1 dsieger 4032:
1.184 rillig 4033: check-shlibs
1.1 dsieger 4034:
1.184 rillig 4035: After a package is installed, check all its binaries and (on ELF platforms)
4036: shared libraries to see if they find the shared libs they need. Run by
4037: default if PKG_DEVELOPER is set in mk.conf.
1.1 dsieger 4038:
1.184 rillig 4039: print-PLIST
1.1 dsieger 4040:
1.184 rillig 4041: After a "make install" from a new or upgraded pkg, this prints out an
4042: attempt to generate a new PLIST from a find -newer work/.extract_done. An
4043: attempt is made to care for shared libs etc., but it is strongly
4044: recommended to review the result before putting it into PLIST. On upgrades,
4045: it's useful to diff the output of this command against an already existing
4046: PLIST file.
1.1 dsieger 4047:
1.184 rillig 4048: If the package installs files via tar(1) or other methods that don't update
4049: file access times, be sure to add these files manually to your PLIST, as
4050: the "find -newer" command used by this target won't catch them!
1.56 ryoon 4051:
1.184 rillig 4052: See Section 19.3, "Tweaking output of make print-PLIST" for more
4053: information on this target.
1.1 dsieger 4054:
1.184 rillig 4055: Chapter 14. Creating a new pkgsrc package from scratch
1.1 dsieger 4056:
1.184 rillig 4057: Table of Contents
1.1 dsieger 4058:
1.184 rillig 4059: 14.1. Common types of packages
1.219 nia 4060: 14.1.1. Python modules and programs
4061: 14.1.2. R packages
4062: 14.1.3. TeXlive packages
1.184 rillig 4063: 14.2. Examples
4064: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 4065:
1.184 rillig 4066: When you find a package that is not yet in pkgsrc, you most likely have a URL
4067: from where you can download the source code. Starting with this URL, creating a
4068: package involves only a few steps.
1.1 dsieger 4069:
1.184 rillig 4070: 1. In your mk.conf, set PKG_DEVELOPER=yes to enable the basic quality checks.
1.1 dsieger 4071:
1.184 rillig 4072: 2. Install the package meta-pkgs/pkg_developer, which among others will
4073: install the utilities url2pkg, pkglint, pkgvi and mkpatches:
1.1 dsieger 4074:
1.184 rillig 4075: $ cd /usr/pkgsrc
4076: $ (cd meta-pkgs/pkg_developer && bmake update)
1.1 dsieger 4077:
1.184 rillig 4078: 3. Choose one of the top-level directories as the category in which you want
4079: to place your package. You can also create a directory of your own (maybe
1.219 nia 4080: called local). Change into that category directory:
1.1 dsieger 4081:
1.219 nia 4082: $ cd category
1.1 dsieger 4083:
1.219 nia 4084: 4. Run the program url2pkg, passing as argument the URL of the distribution
4085: file (in most cases a .tar.gz file). This will download the distribution
4086: file and create the necessary files of the package, based on what's in the
4087: distribution file:
1.1 dsieger 4088:
1.184 rillig 4089: $ url2pkg https://www.example.org/packages/package-1.0.tar.gz
1.1 dsieger 4090:
1.184 rillig 4091: 5. Examine the extracted files to determine the dependencies of your package.
4092: Ideally, this is mentioned in some README file, but things may differ. For
4093: each of these dependencies, look where it exists in pkgsrc, and if there is
4094: a file called buildlink3.mk in that directory, add a line to your package
4095: Makefile which includes that file just before the last line. If the
4096: buildlink3.mk file does not exist, it must be created first. The
4097: buildlink3.mk file makes sure that the package's include files and
4098: libraries are provided.
1.1 dsieger 4099:
1.219 nia 4100: If you just need binaries from a dependent package, add a DEPENDS line to
4101: the Makefile, which specifies the version of the dependency and where it
4102: can be found in pkgsrc. This line should be placed in the third paragraph.
4103: If the dependency is only needed for building the package, but not when
4104: using it, use TOOL_DEPENDS or BUILD_DEPENDS instead of DEPENDS. The
4105: difference between TOOL_DEPENDS and BUILD_DEPENDS occurs when
4106: cross-compiling: TOOL_DEPENDS are native packages, i.e. packages for the
4107: platform where the package is built; BUILD_DEPENDS are target packages,
4108: i.e. packages for the platform for which the package is built. There is
4109: also TEST_DEPENDS, which specifies a dependency used only for testing the
4110: resulting package built, using the upstream project's included test suite,
4111: on the native platform. Your package may then look like this:
1.1 dsieger 4112:
1.184 rillig 4113: [...]
1.1 dsieger 4114:
1.184 rillig 4115: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
4116: DEPENDS+= screen-[0-9]*:../../misc/screen
4117: DEPENDS+= screen>=4.0:../../misc/screen
1.1 dsieger 4118:
1.184 rillig 4119: [...]
1.1 dsieger 4120:
1.184 rillig 4121: .include "../../category/package/buildlink3.mk"
4122: .include "../../devel/glib2/buildlink3.mk"
4123: .include "../../mk/bsd.pkg.mk"
1.1 dsieger 4124:
1.184 rillig 4125: 6. Run pkglint to see what things still need to be done to make your package a
4126: "good" one. If you don't know what pkglint's warnings want to tell you, try
4127: pkglint --explain or pkglint -e, which outputs additional explanations.
1.1 dsieger 4128:
1.184 rillig 4129: 7. In many cases the package is not yet ready to build. You can find
4130: instructions for the most common cases in the next section, Section 14.1,
4131: "Common types of packages". After you have followed the instructions over
4132: there, you can hopefully continue here.
1.1 dsieger 4133:
1.184 rillig 4134: 8. Run bmake clean to clean the working directory from the extracted files.
1.219 nia 4135: Besides these files, a lot of cache files and other system information have
4136: been saved in the working directory, which may have become outdated after
4137: you edited the Makefile.
1.1 dsieger 4138:
1.184 rillig 4139: 9. Now, run bmake to build the package. For the various things that can go
4140: wrong in this phase, consult Chapter 21, Making your package work.
1.1 dsieger 4141:
1.184 rillig 4142: If the extracted files from the package need to be fixed, run multiple
4143: rounds of these commands:
1.1 dsieger 4144:
1.219 nia 4145: $ bmake
1.184 rillig 4146: $ pkgvi ${WRKSRC}/some/file/that/does/not/compile
4147: $ mkpatches
1.219 nia 4148: $ bmake mps
4149: $ bmake clean
1.1 dsieger 4150:
1.184 rillig 4151: 10. When the package builds fine, the next step is to install the package. Run
4152: bmake install and hope that everything works.
1.1 dsieger 4153:
1.184 rillig 4154: 11. Up to now, the file PLIST, which contains a list of the files that are
4155: installed by the package, is nearly empty. Run bmake print-PLIST >PLIST to
4156: generate a probably correct list. Check the file using your preferred text
4157: editor to see if the list of files looks plausible.
1.1 dsieger 4158:
1.184 rillig 4159: 12. Run pkglint again to see if the generated PLIST contains garbage or not.
1.1 dsieger 4160:
1.184 rillig 4161: 13. When you ran bmake install, the package had been registered in the database
4162: of installed files, but with an empty list of files. To fix this, run bmake
4163: deinstall and bmake install again. Now the package is registered with the
4164: list of files from PLIST.
1.48 wiz 4165:
1.219 nia 4166: 14. Run bmake clean update to run everything from above again in a single step,
1.184 rillig 4167: making sure that the PLIST is correct and the whole package is created as
4168: intended.
1.48 wiz 4169:
1.219 nia 4170: 15. Run pkglint to see if there's anything left to do.
1.48 wiz 4171:
1.219 nia 4172: 16. Commit the package to pkgsrc-wip or main pkgsrc; see Chapter 23, Submitting
1.184 rillig 4173: and Committing.
1.50 wiz 4174:
1.184 rillig 4175: 14.1. Common types of packages
1.1 dsieger 4176:
1.219 nia 4177: 14.1.1. Python modules and programs
1.1 dsieger 4178:
1.184 rillig 4179: Python modules and programs packages are easily created using a set of
4180: predefined variables.
1.1 dsieger 4181:
1.184 rillig 4182: If some Python versions are not supported by the software, set the
4183: PYTHON_VERSIONS_INCOMPATIBLE variable to the Python versions that are not
4184: supported, e.g.
1.1 dsieger 4185:
1.184 rillig 4186: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.1 dsieger 4187:
1.184 rillig 4188: If the packaged software is a Python module, include one of ../../lang/python/
1.248 ! wiz 4189: wheel.mk.
1.1 dsieger 4190:
1.248 ! wiz 4191: The package directory should be called "py-software" and PKGNAME should be set
! 4192: to "${PYPKGPREFIX}-${DISTNAME}", e.g.
1.1 dsieger 4193:
1.184 rillig 4194: DISTNAME= foopymodule-1.2.10
4195: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
1.1 dsieger 4196:
1.226 gutterid 4197: For software in PyPi, the name should match what PyPi specifies for "pip
4198: install software".
4199:
1.184 rillig 4200: If it is an application, include "../../lang/python/application.mk". In order
4201: to correctly set the path to the Python interpreter, use the REPLACE_PYTHON
4202: variable and set it to the list of files (paths relative to WRKSRC) that must
4203: be corrected. For example:
1.1 dsieger 4204:
1.184 rillig 4205: REPLACE_PYTHON= *.py
1.1 dsieger 4206:
1.184 rillig 4207: Some Python modules have separate distributions for Python-2.x and Python-3.x
4208: support. In pkgsrc this is handled by the versioned_dependencies.mk file. Set
4209: PYTHON_VERSIONED_DEPENDENCIES to the list of packages that should be depended
4210: upon and include "../../lang/python/versioned_dependencies.mk", then the pkgsrc
4211: infrastructure will depend on the appropriate package version. For example:
1.1 dsieger 4212:
1.184 rillig 4213: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.1 dsieger 4214:
1.184 rillig 4215: Look inside versioned_dependencies.mk for a list of supported packages.
1.1 dsieger 4216:
1.219 nia 4217: 14.1.2. R packages
1.1 dsieger 4218:
1.184 rillig 4219: Simple R packages from CRAN are handled automatically by R2pkg, which is
4220: available in pkgtools/R2pkg. Individual packages (and optionally their
4221: dependencies) may be created and updated. R packages generally follow the same
4222: form, and most of the relevant information needed is contained in a DESCRIPTION
4223: file as part of each R package on CRAN. Consequently, R2pkg downloads that
4224: information and creates or updates a package in the canonical form. The
4225: resulting package should be reviewed for correctness.
1.1 dsieger 4226:
1.219 nia 4227: 14.1.3. TeXlive packages
1.1 dsieger 4228:
1.184 rillig 4229: TeXlive packages from CTAN are handled automatically by texlive2pkg, which is
4230: available in pkgtools/texlive2pkg.
1.1 dsieger 4231:
1.184 rillig 4232: If the TeXlive package name is not known, it may be useful to search CTAN. A "
4233: Contained in" field on the package page typically identifies the basename of
4234: the package file in the TeXlive archive.
1.1 dsieger 4235:
1.184 rillig 4236: If the TeXlive package name is known, download the files from the TeXlive
4237: archive. For package foo, you will need to download foo.tar.xz. Most TeXlive
4238: packages also have associated documentation packages, so download
4239: foo.doc.tar.xz at the same time. These files should be placed in the
4240: appropriate category directory, which is often but not always print. Then run
4241: the following command in the category directory.
1.1 dsieger 4242:
1.184 rillig 4243: texlive2pkg foo.tar.xz foo.doc.tar.xz
1.1 dsieger 4244:
1.184 rillig 4245: This will create two packages, tex-foo and tex-foo-doc. Be sure to check that
4246: both packages are correct.
1.1 dsieger 4247:
1.184 rillig 4248: Finally, CTAN currently does not include version information in package
4249: filenames and changes their contents periodically when updates occur.
4250: Consequently, pkgsrc avoids downloading distfiles directly from CTAN and
4251: instead relies on the pkgsrc archives. For each new or updated TeXlive package,
4252: e.g., the main one and the corresponding documentation, upload the distfiles
4253: with the following command in each package directory.
1.1 dsieger 4254:
1.184 rillig 4255: make upload-distfiles
1.117 sevan 4256:
1.184 rillig 4257: 14.2. Examples
1.117 sevan 4258:
1.184 rillig 4259: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 4260:
1.184 rillig 4261: 14.2.1.1. The initial package
1.1 dsieger 4262:
1.184 rillig 4263: Looking at the file pkgsrc/doc/TODO, I saw that the "nvu" package has not yet
4264: been imported into pkgsrc. As the description says it has to do with the web,
4265: the obvious choice for the category is "www".
1.1 dsieger 4266:
1.184 rillig 4267: $ mkdir www/nvu
4268: $ cd www/nvu
1.1 dsieger 4269:
1.184 rillig 4270: The web site says that the sources are available as a tar file, so I fed that
4271: URL to the url2pkg program:
1.1 dsieger 4272:
1.184 rillig 4273: $ url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.1 dsieger 4274:
1.184 rillig 4275: My editor popped up, and I added a PKGNAME line below the DISTNAME line, as the
4276: package name should not have the word "sources" in it. I also filled in the
4277: MAINTAINER, HOMEPAGE and COMMENT fields. Then the package Makefile looked like
4278: that:
1.1 dsieger 4279:
1.184 rillig 4280: # $NetBSD $
4281: #
1.1 dsieger 4282:
1.184 rillig 4283: DISTNAME= nvu-1.0-sources
4284: PKGNAME= nvu-1.0
4285: CATEGORIES= www
4286: MASTER_SITES= http://cvs.nvu.com/download/
4287: EXTRACT_SUFX= .tar.bz2
1.1 dsieger 4288:
1.184 rillig 4289: MAINTAINER= rillig@NetBSD.org
4290: HOMEPAGE= http://cvs.nvu.com/
4291: COMMENT= Web Authoring System
1.1 dsieger 4292:
1.184 rillig 4293: # url2pkg-marker (please do not remove this line.)
4294: .include "../../mk/bsd.pkg.mk"
1.1 dsieger 4295:
1.184 rillig 4296: On the first line of output above, an artificial space has been added between
4297: NetBSD and $, this is a workaround to prevent CVS expanding to the filename of
4298: the guide.
1.1 dsieger 4299:
1.184 rillig 4300: Then, I quit the editor and watched pkgsrc downloading a large source archive:
1.1 dsieger 4301:
1.184 rillig 4302: url2pkg> Running "make makesum" ...
4303: => Required installed package digest>=20010302: digest-20060826 found
4304: => Fetching nvu-1.0-sources.tar.bz2
4305: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4306: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4307: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4308: url2pkg> Running "make extract" ...
4309: => Required installed package digest>=20010302: digest-20060826 found
4310: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4311: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4312: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4313: ===> Installing dependencies for nvu-1.0
4314: ===> Overriding tools for nvu-1.0
4315: ===> Extracting for nvu-1.0
4316: url2pkg> Adjusting the Makefile.
1.1 dsieger 4317:
1.184 rillig 4318: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.1 dsieger 4319:
1.184 rillig 4320: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.1 dsieger 4321:
1.184 rillig 4322: 14.2.1.2. Fixing all kinds of problems to make the package work
1.1 dsieger 4323:
1.184 rillig 4324: Now that the package has been extracted, let's see what's inside it. The
4325: package has a README.txt, but that only says something about mozilla, so it's
4326: probably useless for seeing what dependencies this package has. But since there
4327: is a GNU configure script in the package, let's hope that it will complain
4328: about everything it needs.
1.1 dsieger 4329:
1.184 rillig 4330: $ bmake
4331: => Required installed package digest>=20010302: digest-20060826 found
4332: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4333: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4334: ===> Patching for nvu-1.0
4335: ===> Creating toolchain wrappers for nvu-1.0
4336: ===> Configuring for nvu-1.0
4337: [...]
4338: configure: error: Perl 5.004 or higher is required.
4339: [...]
4340: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4341: [...]
1.1 dsieger 4342:
1.184 rillig 4343: That worked quite well. So I opened the package Makefile in my editor, and
4344: since it already has a USE_TOOLS line, I just appended "perl" to it. Since the
4345: dependencies of the package have changed now, and since a perl wrapper is
4346: automatically installed in the "tools" phase, I need to build the package from
4347: scratch.
1.1 dsieger 4348:
1.184 rillig 4349: $ bmake clean
4350: ===> Cleaning for nvu-1.0
4351: $ bmake
4352: [...]
4353: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4354: GNU Make. You will not be able to build Mozilla without GNU Make.
4355: [...]
1.1 dsieger 4356:
1.184 rillig 4357: So I added "gmake" to the USE_TOOLS line and tried again (from scratch).
1.1 dsieger 4358:
1.184 rillig 4359: [...]
4360: checking for GTK - version >= 1.2.0... no
4361: *** Could not run GTK test program, checking why...
4362: [...]
1.1 dsieger 4363:
1.184 rillig 4364: Now to the other dependencies. The first question is: Where is the GTK package
4365: hidden in pkgsrc?
1.1 dsieger 4366:
1.184 rillig 4367: $ echo ../../*/gtk*
4368: [many packages ...]
4369: $ echo ../../*/gtk
4370: ../../x11/gtk
4371: $ echo ../../*/gtk2
4372: ../../x11/gtk2
4373: $ echo ../../*/gtk2/bui*
4374: ../../x11/gtk2/buildlink3.mk
1.1 dsieger 4375:
1.184 rillig 4376: The first try was definitely too broad. The second one had exactly one result,
4377: which is very good. But there is one pitfall with GNOME packages. Before GNOME
4378: 2 had been released, there were already many GNOME 1 packages in pkgsrc. To be
4379: able to continue to use these packages, the GNOME 2 packages were imported as
4380: separate packages, and their names usually have a "2" appended. So I checked
4381: whether this was the case here, and indeed it was.
1.1 dsieger 4382:
1.184 rillig 4383: Since the GTK2 package has a buildlink3.mk file, adding the dependency is very
4384: easy. I just inserted an .include line before the last line of the package
4385: Makefile, so that it now looks like this:
1.1 dsieger 4386:
1.184 rillig 4387: [...]
4388: .include "../../x11/gtk2/buildlink3.mk"
4389: .include "../../mk/bsd.pkg.mk
1.1 dsieger 4390:
1.184 rillig 4391: After another bmake clean && bmake, the answer was:
1.108 rillig 4392:
1.184 rillig 4393: [...]
4394: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4395: checking for GTK - version >= 1.2.0... no
4396: *** Could not run GTK test program, checking why...
4397: *** The test program failed to compile or link. See the file config.log for the
4398: *** exact error that occured. This usually means GTK was incorrectly installed
4399: *** or that you have moved GTK since it was installed. In the latter case, you
4400: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4401: configure: error: Test for GTK failed.
4402: [...]
1.1 dsieger 4403:
1.184 rillig 4404: In this particular case, the assumption that "every package prefers GNOME 2"
4405: had been wrong. The first of the lines above told me that this package really
4406: wanted to have the GNOME 1 version of GTK. If the package had looked for GTK2,
4407: it would have looked for pkg-config instead of gtk-config. So I changed the x11
4408: /gtk2 to x11/gtk in the package Makefile, and tried again.
1.1 dsieger 4409:
1.184 rillig 4410: [...]
4411: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
4412: In file included from xpidl.c:42:
4413: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4414: In file included from xpidl.c:42:
4415: xpidl.h:132: error: parse error before "IDL_ns"
4416: [...]
1.1 dsieger 4417:
1.184 rillig 4418: The package still does not find all of its dependencies. Now the question is:
4419: Which package provides the libIDL/IDL.h header file?
1.1 dsieger 4420:
1.184 rillig 4421: $ echo ../../*/*idl*
4422: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4423: $ echo ../../*/*IDL*
4424: ../../net/libIDL
1.1 dsieger 4425:
1.184 rillig 4426: Let's take the one from the second try. So I included the ../../net/libIDL/
4427: buildlink3.mk file and tried again. But the error didn't change. After digging
4428: through some of the code, I concluded that the build process of the package was
4429: broken and couldn't have ever worked, but since the Mozilla source tree is
4430: quite large, I didn't want to fix it. So I added the following to the package
4431: Makefile and tried again:
1.1 dsieger 4432:
1.184 rillig 4433: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4434: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.1 dsieger 4435:
1.184 rillig 4436: The latter line is needed because the package expects the library libIDL.so,
4437: but only libIDL-2.so is available. So I told the compiler wrapper to rewrite
4438: that on the fly.
1.1 dsieger 4439:
1.184 rillig 4440: The next problem was related to a recent change of the FreeType interface. I
4441: looked up in www/seamonkey which patch files were relevant for this issue and
4442: copied them to the patches directory. Then I retried, fixed the patches so that
4443: they applied cleanly and retried again. This time, everything worked.
1.1 dsieger 4444:
1.184 rillig 4445: 14.2.1.3. Installing the package
1.1 dsieger 4446:
1.184 rillig 4447: $ bmake CHECK_FILES=no install
4448: [...]
4449: $ bmake print-PLIST >PLIST
4450: $ bmake deinstall
4451: $ bmake install
1.1 dsieger 4452:
1.184 rillig 4453: Chapter 15. Programming in Makefiles
1.1 dsieger 4454:
1.184 rillig 4455: Table of Contents
1.1 dsieger 4456:
1.184 rillig 4457: 15.1. Caveats
4458: 15.2. Makefile variables
4459: 15.2.1. Naming conventions
4460: 15.3. Code snippets
4461: 15.3.1. Adding things to a list
4462: 15.3.2. Echoing a string exactly as-is
4463: 15.3.3. Passing CFLAGS to GNU configure scripts
4464: 15.3.4. Handling possibly empty variables
1.229 gutterid 4465: 15.3.5. Testing yes/no variables in conditions
1.1 dsieger 4466:
1.184 rillig 4467: Pkgsrc consists of many Makefile fragments, each of which forms a well-defined
4468: part of the pkgsrc system. Using the make(1) system as a programming language
4469: for a big system like pkgsrc requires some discipline to keep the code correct
4470: and understandable.
1.1 dsieger 4471:
1.184 rillig 4472: The basic ingredients for Makefile programming are variables and shell
4473: commands. Among these shell commands may even be more complex ones like awk(1)
4474: programs. To make sure that every shell command runs as intended it is
4475: necessary to quote all variables correctly when they are used.
1.1 dsieger 4476:
1.184 rillig 4477: This chapter describes some patterns that appear quite often in Makefiles,
4478: including the pitfalls that come along with them.
1.1 dsieger 4479:
1.184 rillig 4480: 15.1. Caveats
1.1 dsieger 4481:
1.184 rillig 4482: * When you are creating a file as a target of a rule, always write the data
4483: to a temporary file first and finally rename that file. Otherwise there
4484: might occur an error in the middle of generating the file, and when the
4485: user runs make(1) for the second time, the file exists and will not be
4486: regenerated properly. Example:
1.1 dsieger 4487:
1.184 rillig 4488: wrong:
4489: @echo "line 1" > ${.TARGET}
4490: @echo "line 2" >> ${.TARGET}
4491: @false
1.1 dsieger 4492:
1.184 rillig 4493: correct:
4494: @echo "line 1" > ${.TARGET}.tmp
4495: @echo "line 2" >> ${.TARGET}.tmp
4496: @false
4497: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 4498:
1.184 rillig 4499: When you run make wrong twice, the file wrong will exist, although there
4500: was an error message in the first run. On the other hand, running make
4501: correct gives an error message twice, as expected.
1.1 dsieger 4502:
1.184 rillig 4503: You might remember that make(1) sometimes removes ${.TARGET} in case of
4504: error, but this only happens when it is interrupted, for example by
4505: pressing Ctrl+C. This does not happen when one of the commands fails (like
4506: false(1) above).
1.1 dsieger 4507:
1.184 rillig 4508: 15.2. Makefile variables
1.1 dsieger 4509:
1.184 rillig 4510: Makefile variables contain strings that can be processed using the five
4511: operators =, +=, ?=, := and !=, which are described in the make(1) man page.
1.1 dsieger 4512:
1.184 rillig 4513: When a variable's value is parsed from a Makefile, the hash character # and the
4514: backslash character \ are handled specially. If a backslash is the last
4515: character in a line, that backslash is removed from the line and the line
4516: continues with the next line of the file.
1.1 dsieger 4517:
1.184 rillig 4518: The # character starts a comment that reaches until the end of the line. To get
4519: an actual # character, such as in a URL, write \# instead.
1.1 dsieger 4520:
1.184 rillig 4521: The evaluation of variables either happens immediately or lazy. It happens
4522: immediately when the variable occurs on the right-hand side of the := or the !=
4523: operator, in a .if condition or a .for loop. In the other cases, it is
4524: evaluated lazily.
1.1 dsieger 4525:
1.184 rillig 4526: Some of the modifiers split the string into words and then operate on the
4527: words, others operate on the string as a whole. When a string is split into
4528: words, double quotes and single quotes are interpreted as delimiters, just like
4529: in sh(1).
1.1 dsieger 4530:
1.184 rillig 4531: 15.2.1. Naming conventions
1.1 dsieger 4532:
1.184 rillig 4533: * All variable names starting with an underscore are reserved for use by the
4534: pkgsrc infrastructure. They shall not be used by packages.
1.1 dsieger 4535:
1.184 rillig 4536: * In .for loops you should use lowercase variable names for the iteration
4537: variables.
1.1 dsieger 4538:
1.184 rillig 4539: * All list variables should have a plural name, such as PKG_OPTIONS or
4540: DISTFILES.
1.1 dsieger 4541:
1.184 rillig 4542: 15.3. Code snippets
1.1 dsieger 4543:
1.184 rillig 4544: 15.3.1. Adding things to a list
1.1 dsieger 4545:
1.184 rillig 4546: When adding a string that possibly contains whitespace or quotes to a list
4547: (example 1), it must be quoted using the :Q modifier.
1.1 dsieger 4548:
1.184 rillig 4549: When adding another list to a list (example 2), it must not be quoted, since
4550: its elements are already quoted.
1.1 dsieger 4551:
1.184 rillig 4552: STRING= foo * bar `date`
4553: LIST= # empty
4554: ANOTHER_LIST= a=b c=d
1.1 dsieger 4555:
1.184 rillig 4556: LIST+= ${STRING:Q} # 1
4557: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4558:
1.184 rillig 4559: 15.3.2. Echoing a string exactly as-is
1.1 dsieger 4560:
1.184 rillig 4561: Echoing a string containing special characters needs special work.
1.1 dsieger 4562:
1.184 rillig 4563: STRING= foo bar < > * `date` $$HOME ' "
4564: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4565:
1.184 rillig 4566: all:
4567: echo ${STRING} # 1
4568: echo ${STRING:Q} # 2
4569: printf '%s\n' ${STRING:Q}'' # 3
4570: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 4571:
1.184 rillig 4572: Example 1 leads to a syntax error in the shell, as the characters are just
4573: copied.
1.1 dsieger 4574:
1.184 rillig 4575: Example 2 quotes the string so that the shell interprets it correctly. But the
4576: echo command may additionally interpret strings with a leading dash or those
4577: containing backslashes.
1.1 dsieger 4578:
1.184 rillig 4579: Example 3 can handle arbitrary strings, since printf(1) only interprets the
4580: format string, but not the next argument. The trailing single quotes handle the
4581: case when the string is empty. In that case, the :Q modifier would result in an
4582: empty string too, which would then be skipped by the shell. For printf(1) this
4583: doesn't make a difference, but other programs may care.
1.1 dsieger 4584:
1.184 rillig 4585: In example 4, the EXAMPLE_ENV does not need to be quoted because the quoting
4586: has already been done when adding elements to the list.
1.1 dsieger 4587:
1.184 rillig 4588: 15.3.3. Passing CFLAGS to GNU configure scripts
1.1 dsieger 4589:
1.184 rillig 4590: When passing CFLAGS or similar variables to a GNU-style configure script
4591: (especially those that call other configure scripts), it must not have leading
4592: or trailing whitespace, since otherwise the configure script gets confused. To
4593: trim leading and trailing whitespace, use the :M modifier, as in the following
4594: example:
1.1 dsieger 4595:
1.184 rillig 4596: CPPFLAGS= # empty
4597: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
4598: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 4599:
1.184 rillig 4600: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 4601:
1.184 rillig 4602: all:
4603: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4604: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4605:
1.184 rillig 4606: In this example, CPPFLAGS has both leading and trailing whitespace because the
4607: += operator always adds a space.
1.1 dsieger 4608:
1.184 rillig 4609: 15.3.4. Handling possibly empty variables
1.1 dsieger 4610:
1.184 rillig 4611: When a possibly empty variable is used in a shell program, it may lead to a
4612: syntax error.
1.1 dsieger 4613:
1.184 rillig 4614: EGFILES= # empty
1.1 dsieger 4615:
1.184 rillig 4616: install-examples: # produces a syntax error in the shell
4617: for egfile in ${EGFILES}; do \
4618: echo "Installing $$egfile"; \
4619: done
1.1 dsieger 4620:
1.184 rillig 4621: The shell only sees the text for egfile in ; do, since ${EGFILES} is replaced
4622: with an empty string by make(1). To fix this syntax error, use one of the
4623: snippets below.
1.1 dsieger 4624:
1.229 gutterid 4625: EGFILES= # empty
1.1 dsieger 4626:
1.184 rillig 4627: install-examples:
4628: for egfile in ${EGFILES} ""; do \
4629: [ -n "$$egfile" ] || continue; \
4630: echo "Installing $$egfile"; \
4631: done
1.1 dsieger 4632:
1.184 rillig 4633: In this case, an empty string is appended to the iteration list (to prevent the
4634: syntax error) and filtered out later.
1.1 dsieger 4635:
1.184 rillig 4636: EGFILES= # empty
1.1 dsieger 4637:
1.184 rillig 4638: install-examples:
4639: .for egfile in ${EGFILES}
4640: echo "Installing ${egfile}"
4641: .endfor
1.1 dsieger 4642:
1.184 rillig 4643: If one of the filenames contains special characters, it should be enclosed in
4644: single or double quotes.
1.1 dsieger 4645:
1.184 rillig 4646: To have a shell command test whether a make variable is empty, use the
4647: following code: ${TEST} -z ${POSSIBLY_EMPTY:Q}"".
1.1 dsieger 4648:
1.229 gutterid 4649: 15.3.5. Testing yes/no variables in conditions
4650:
4651: When a variable can have the values yes or no, use the following pattern to
4652: test the variable:
4653:
4654: .if ${VAR:U:tl} == "yes"
4655: # do something
4656: .endif
4657:
4658: The :U modifier is only necessary if the variable can be undefined. If the
4659: variable is guaranteed to be defined, the :U can be omitted.
4660:
4661: The :tl modifier converts the variable value to lowercase, allowing for the
4662: values yes, Yes, YES.
4663:
1.184 rillig 4664: Chapter 16. Options handling
1.1 dsieger 4665:
4666: Table of Contents
4667:
1.184 rillig 4668: 16.1. Global default options
4669: 16.2. Converting packages to use bsd.options.mk
4670: 16.3. Option Names
4671: 16.4. Determining the options of dependencies
1.1 dsieger 4672:
4673: Many packages have the ability to be built to support different sets of
4674: features. bsd.options.mk is a framework in pkgsrc that provides generic
4675: handling of those options that determine different ways in which the packages
4676: can be built. It's possible for the user to specify exactly which sets of
4677: options will be built into a package or to allow a set of global default
4678: options apply.
4679:
1.7 rillig 4680: There are two broad classes of behaviors that one might want to control via
4681: options. One is whether some particular feature is enabled in a program that
4682: will be built anyway, often by including or not including a dependency on some
4683: other package. The other is whether or not an additional program will be built
4684: as part of the package. Generally, it is better to make a split package for
4685: such additional programs instead of using options, because it enables binary
4686: packages to be built which can then be added separately. For example, the foo
4687: package might have minimal dependencies (those packages without which foo
4688: doesn't make sense), and then the foo-gfoo package might include the GTK
4689: frontend program gfoo. This is better than including a gtk option to foo that
4690: adds gfoo, because either that option is default, in which case binary users
4691: can't get foo without gfoo, or not default, in which case they can't get gfoo.
4692: With split packages, they can install foo without having GTK, and later decide
4693: to install gfoo (pulling in GTK at that time). This is an advantage to source
4694: users too, avoiding the need for rebuilds.
4695:
4696: Plugins with widely varying dependencies should usually be split instead of
4697: options.
4698:
4699: It is often more work to maintain split packages, especially if the upstream
4700: package does not support this. The decision of split vs. option should be made
4701: based on the likelihood that users will want or object to the various pieces,
4702: the size of the dependencies that are included, and the amount of work.
4703:
4704: A further consideration is licensing. Non-free parts, or parts that depend on
4705: non-free dependencies (especially plugins) should almost always be split if
4706: feasible.
4707:
1.184 rillig 4708: 16.1. Global default options
1.1 dsieger 4709:
4710: Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of
4711: the options that should be built into every package if that option is
1.4 rillig 4712: supported. This variable should be set in mk.conf.
1.1 dsieger 4713:
1.184 rillig 4714: 16.2. Converting packages to use bsd.options.mk
1.1 dsieger 4715:
4716: The following example shows how bsd.options.mk should be used by the
4717: hypothetical ``wibble'' package, either in the package Makefile, or in a file,
4718: e.g. options.mk, that is included by the main package Makefile.
4719:
4720: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
4721: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
4722: PKG_OPTIONS_OPTIONAL_GROUPS= database
4723: PKG_OPTIONS_GROUP.database= mysql pgsql
4724: PKG_SUGGESTED_OPTIONS= wibble-foo
4725: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
4726: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
4727:
4728: .include "../../mk/bsd.prefs.mk"
4729:
4730: # this package was previously named wibble2
4731: .if defined(PKG_OPTIONS.wibble2)
4732: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
4733: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
4734: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
4735: .endif
4736:
4737: .include "../../mk/bsd.options.mk"
4738:
4739: # Package-specific option-handling
4740:
4741: ###
4742: ### FOO support
4743: ###
4744: .if !empty(PKG_OPTIONS:Mwibble-foo)
4745: CONFIGURE_ARGS+= --enable-foo
4746: .endif
4747:
4748: ###
4749: ### LDAP support
4750: ###
4751: .if !empty(PKG_OPTIONS:Mldap)
4752: . include "../../databases/openldap-client/buildlink3.mk"
4753: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
4754: .endif
4755:
4756: ###
4757: ### database support
4758: ###
4759: .if !empty(PKG_OPTIONS:Mmysql)
4760: . include "../../mk/mysql.buildlink3.mk"
4761: .endif
4762: .if !empty(PKG_OPTIONS:Mpgsql)
4763: . include "../../mk/pgsql.buildlink3.mk"
4764: .endif
4765:
4766: The first section contains the information about which build options are
4767: supported by the package, and any default options settings if needed.
4768:
4769: 1. PKG_OPTIONS_VAR is the name of the make(1) variable that the user can set
4770: to override the default options. It should be set to PKG_OPTIONS.pkgbase.
4771: Do not set it to PKG_OPTIONS.${PKGBASE}, since PKGBASE is not defined at
4772: the point where the options are processed.
4773:
4774: 2. PKG_SUPPORTED_OPTIONS is a list of build options supported by the package.
4775:
4776: 3. PKG_OPTIONS_OPTIONAL_GROUPS is a list of names of groups of mutually
4777: exclusive options. The options in each group are listed in
4778: PKG_OPTIONS_GROUP.groupname. The most specific setting of any option from
4779: the group takes precedence over all other options in the group. Options
4780: from the groups will be automatically added to PKG_SUPPORTED_OPTIONS.
4781:
4782: 4. PKG_OPTIONS_REQUIRED_GROUPS is like PKG_OPTIONS_OPTIONAL_GROUPS, but
4783: building the packages will fail if no option from the group is selected.
4784:
4785: 5. PKG_OPTIONS_NONEMPTY_SETS is a list of names of sets of options. At least
4786: one option from each set must be selected. The options in each set are
4787: listed in PKG_OPTIONS_SET.setname. Options from the sets will be
4788: automatically added to PKG_SUPPORTED_OPTIONS. Building the package will
4789: fail if no option from the set is selected.
4790:
4791: 6. PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
4792: default.
4793:
4794: 7. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE:option" pairs that map
1.4 rillig 4795: legacy mk.conf variables to their option counterparts. Pairs should be
1.1 dsieger 4796: added with "+=" to keep the listing of global legacy variables. A warning
4797: will be issued if the user uses a legacy variable.
4798:
4799: 8. PKG_OPTIONS_LEGACY_OPTS is a list of "old-option:new-option" pairs that map
4800: options that have been renamed to their new counterparts. Pairs should be
4801: added with "+=" to keep the listing of global legacy options. A warning
4802: will be issued if the user uses a legacy option.
4803:
4804: 9. PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
4805: used. This can be used for cases that neither PKG_OPTIONS_LEGACY_VARS nor
4806: PKG_OPTIONS_LEGACY_OPTS can handle, e. g. when PKG_OPTIONS_VAR is renamed.
4807:
4808: 10. PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
4809: variables or options used, and what to use instead.
4810:
4811: A package should never modify PKG_DEFAULT_OPTIONS or the variable named in
4812: PKG_OPTIONS_VAR. These are strictly user-settable. To suggest a default set of
4813: options, use PKG_SUGGESTED_OPTIONS.
4814:
4815: PKG_OPTIONS_VAR must be defined before including bsd.options.mk. If none of
4816: PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and
4817: PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform-specific
4818: options if none of them is supported on the current platform), PKG_OPTIONS is
4819: set to the empty list and the package is otherwise treated as not using the
4820: options framework.
4821:
4822: After the inclusion of bsd.options.mk, the variable PKG_OPTIONS contains the
4823: list of selected build options, properly filtered to remove unsupported and
4824: duplicate options.
4825:
4826: The remaining sections contain the logic that is specific to each option. The
4827: correct way to check for an option is to check whether it is listed in
4828: PKG_OPTIONS:
4829:
4830: .if !empty(PKG_OPTIONS:Moption)
4831:
1.184 rillig 4832: 16.3. Option Names
1.1 dsieger 4833:
4834: Options that enable similar features in different packages (like optional
4835: support for a library) should use a common name in all packages that support it
4836: (like the name of the library). If another package already has an option with
4837: the same meaning, use the same name.
4838:
4839: Options that enable features specific to one package, where it's unlikely that
4840: another (unrelated) package has the same (or a similar) optional feature,
4841: should use a name prefixed with pkgname-.
4842:
4843: If a group of related packages share an optional feature specific to that
4844: group, prefix it with the name of the "main" package (e. g.
4845: djbware-errno-hack).
4846:
4847: For new options, add a line to mk/defaults/options.description. Lines have two
4848: fields, separated by tab. The first field is the option name, the second its
4849: description. The description should be a whole sentence (starting with an
4850: uppercase letter and ending with a period) that describes what enabling the
4851: option does. E. g. "Enable ispell support." The file is sorted by option names.
4852:
1.184 rillig 4853: 16.4. Determining the options of dependencies
1.7 rillig 4854:
4855: When writing buildlink3.mk files, it is often necessary to list different
4856: dependencies based on the options with which the package was built. For
4857: querying these options, the file pkgsrc/mk/pkg-build-options.mk should be used.
4858: A typical example looks like this:
4859:
4860: pkgbase := libpurple
4861: .include "../../mk/pkg-build-options.mk"
4862:
4863: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
4864: ...
4865: .endif
4866:
4867: Including pkg-build-options.mk here will set the variable
4868: PKG_BUILD_OPTIONS.libpurple to the build options of the libpurple package,
4869: which can then be queried like PKG_OPTIONS in the options.mk file. See the file
4870: pkg-build-options.mk for more details.
4871:
1.184 rillig 4872: Chapter 17. Tools needed for building or running
4873:
4874: Table of Contents
4875:
4876: 17.1. Tools for pkgsrc builds
4877: 17.2. Tools needed by packages
4878: 17.3. Tools provided by platforms
4879:
4880: The USE_TOOLS definition is used both internally by pkgsrc and also for
4881: individual packages to define what commands are needed for building a package
4882: (like TOOL_DEPENDS) or for later run-time of an installed packaged (such as
4883: DEPENDS). If the native system provides an adequate tool, then in many cases, a
4884: pkgsrc package will not be used.
4885:
4886: When building a package, the replacement tools are made available in a
4887: directory (as symlinks or wrapper scripts) that is early in the executable
4888: search path. Just like the buildlink system, this helps with consistent builds.
4889:
4890: A tool may be needed to help build a specific package. For example, perl, GNU
4891: make (gmake) or yacc may be needed.
4892:
4893: Also a tool may be needed, for example, because the native system's supplied
4894: tool may be inefficient for building a package with pkgsrc. For example, a
4895: package may need GNU awk, bison (instead of yacc) or a better sed.
4896:
4897: The tools used by a package can be listed by running make show-tools.
4898:
4899: 17.1. Tools for pkgsrc builds
4900:
4901: The default set of tools used by pkgsrc is defined in bsd.pkg.mk. This includes
4902: standard Unix tools, such as: cat, awk, chmod, test, and so on. These can be
4903: seen by running: make show-var VARNAME=USE_TOOLS.
4904:
4905: If a package needs a specific program to build then the USE_TOOLS variable can
4906: be used to define the tools needed.
4907:
4908: 17.2. Tools needed by packages
4909:
4910: In the following examples, the :run means that it is needed at run-time (and
4911: becomes a DEPENDS). The default is a build dependency which can be set with
4912: :build. (So in this example, it is the same as gmake:build and
4913: pkg-config:build.)
4914:
4915: USE_TOOLS+= gmake perl:run pkg-config
4916:
4917: When using the tools framework, a TOOLS_PATH.foo variable is defined which
4918: contains the full path to the appropriate tool. For example, TOOLS_PATH.bash
4919: could be "/bin/bash" on Linux systems.
4920:
4921: If you always need a pkgsrc version of the tool at run-time, then just use
4922: DEPENDS instead.
4923:
4924: 17.3. Tools provided by platforms
4925:
4926: When improving or porting pkgsrc to a new platform, have a look at (or create)
4927: the corresponding platform specific make file fragment under pkgsrc/mk/tools/
4928: tools.${OPSYS}.mk which defines the name of the common tools. For example:
4929:
4930: .if exists(/usr/bin/bzcat)
4931: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
4932: .elif exists(/usr/bin/bzip2)
4933: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
4934: .endif
4935:
4936: TOOLS_PLATFORM.true?= true # shell builtin
4937:
4938: Chapter 18. Buildlink methodology
1.1 dsieger 4939:
4940: Table of Contents
4941:
1.184 rillig 4942: 18.1. Converting packages to use buildlink3
4943: 18.2. Writing buildlink3.mk files
4944: 18.2.1. Anatomy of a buildlink3.mk file
4945: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
1.232 gutterid 4946: buildlink3.mk files
1.184 rillig 4947: 18.3. Writing builtin.mk files
4948: 18.3.1. Anatomy of a builtin.mk file
4949:
4950: Buildlink is a framework in pkgsrc that controls what headers and libraries are
4951: seen by a package's configure and build processes. This is implemented in a two
4952: step process:
4953:
4954: 1. Symlink headers and libraries for dependencies into BUILDLINK_DIR, which by
4955: default is a subdirectory of WRKDIR.
4956:
4957: 2. Create wrapper scripts that are used in place of the normal compiler tools
4958: that translate -I${LOCALBASE}/include and -L${LOCALBASE}/lib into
4959: references to BUILDLINK_DIR. The wrapper scripts also make native compiler
4960: on some operating systems look like GCC, so that packages that expect GCC
4961: won't require modifications to build with those native compilers.
4962:
4963: This normalizes the environment in which a package is built so that the package
4964: may be built consistently despite what other software may be installed. Please
4965: note that the normal system header and library paths, e.g. /usr/include, /usr/
4966: lib, etc., are always searched -- buildlink3 is designed to insulate the
4967: package build from non-system-supplied software.
4968:
4969: 18.1. Converting packages to use buildlink3
1.1 dsieger 4970:
1.184 rillig 4971: The process of converting packages to use the buildlink3 framework ("bl3ifying"
4972: ) is fairly straightforward. The things to keep in mind are:
1.1 dsieger 4973:
1.184 rillig 4974: 1. Ensure that the build always calls the wrapper scripts instead of the
4975: actual toolchain. Some packages are tricky, and the only way to know for
4976: sure is the check ${WRKDIR}/.work.log to see if the wrappers are being
4977: invoked.
1.1 dsieger 4978:
1.184 rillig 4979: 2. Don't override PREFIX from within the package Makefile, e.g. Java VMs,
4980: standalone shells, etc., because the code to symlink files into $
4981: {BUILDLINK_DIR} looks for files relative to "pkg_info -qp pkgname".
1.1 dsieger 4982:
1.184 rillig 4983: 3. Remember that only the buildlink3.mk files that you list in a package's
4984: Makefile are added as dependencies for that package.
1.1 dsieger 4985:
1.184 rillig 4986: If a dependency on a particular package is required for its libraries and
4987: headers, then we replace:
1.1 dsieger 4988:
1.184 rillig 4989: DEPENDS+= foo>=1.1.0:../../category/foo
1.1 dsieger 4990:
1.184 rillig 4991: with
1.1 dsieger 4992:
1.184 rillig 4993: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 4994:
1.184 rillig 4995: The buildlink3.mk files usually define the required dependencies. If you need a
4996: newer version of the dependency when using buildlink3.mk files, then you can
4997: define it in your Makefile; for example:
1.1 dsieger 4998:
1.184 rillig 4999: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5000: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 5001:
1.184 rillig 5002: There are several buildlink3.mk files in pkgsrc/mk that handle special package
5003: issues:
1.1 dsieger 5004:
1.184 rillig 5005: * bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB
5006: implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT.
1.1 dsieger 5007:
1.184 rillig 5008: * curses.buildlink3.mk: If the system comes with neither Curses nor NCurses,
5009: this will take care to install the devel/ncurses package.
1.1 dsieger 5010:
1.184 rillig 5011: * krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding
5012: a dependency on Heimdal or MIT-krb5 for packages that require a Kerberos 5
5013: implementation.
1.1 dsieger 5014:
1.184 rillig 5015: * motif.buildlink3.mk checks for a system-provided Motif installation or adds
5016: a dependency on x11/lesstif or x11/motif. The user can set MOTIF_TYPE to "
5017: dt", "lesstif" or "motif" to choose which Motif version will be used.
1.1 dsieger 5018:
1.184 rillig 5019: * readline.buildlink3.mk checks for a system-provided GNU readline or
5020: editline (libedit) installation, or adds a dependency on devel/readline,
5021: devel/editline. The user can set READLINE_DEFAULT to choose readline
5022: implementation. If your package really needs GNU readline library, its
5023: Makefile should include devel/readline/buildlink3.mk instead of
5024: readline.buildlink3.mk.
1.1 dsieger 5025:
1.184 rillig 5026: * oss.buildlink3.mk defines several variables that may be used by packages
5027: that use the Open Sound System (OSS) API.
1.1 dsieger 5028:
1.184 rillig 5029: * pgsql.buildlink3.mk will accept any of the Postgres versions in the
5030: variable PGSQL_VERSIONS_ACCEPTED and default to the version
5031: PGSQL_VERSION_DEFAULT. See the file for more information.
1.1 dsieger 5032:
1.184 rillig 5033: * pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native
5034: pthreads or adds a dependency on devel/pth as needed.
1.1 dsieger 5035:
1.184 rillig 5036: * xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena
5037: widgets library.
1.1 dsieger 5038:
1.184 rillig 5039: The comments in those buildlink3.mk files provide a more complete description
5040: of how to use them properly.
1.1 dsieger 5041:
1.184 rillig 5042: 18.2. Writing buildlink3.mk files
1.1 dsieger 5043:
1.184 rillig 5044: A package's buildlink3.mk file is included by Makefiles to indicate the need to
5045: compile and link against header files and libraries provided by the package. A
5046: buildlink3.mk file should always provide enough information to add the correct
5047: type of dependency relationship and include any other buildlink3.mk files that
5048: it needs to find headers and libraries that it needs in turn.
1.1 dsieger 5049:
1.184 rillig 5050: To generate an initial buildlink3.mk file for further editing, Rene Hexel's
5051: pkgtools/createbuildlink package is highly recommended. For most packages, the
5052: following command will generate a good starting point for buildlink3.mk files:
1.1 dsieger 5053:
1.184 rillig 5054: % cd pkgsrc/category/pkgdir
5055: % createbuildlink >buildlink3.mk
1.1 dsieger 5056:
5057:
1.184 rillig 5058: 18.2.1. Anatomy of a buildlink3.mk file
1.1 dsieger 5059:
1.184 rillig 5060: The following real-life example buildlink3.mk is taken from pkgsrc/graphics/
5061: tiff:
1.14 jmcneill 5062:
1.184 rillig 5063: BUILDLINK_TREE+= tiff
1.1 dsieger 5064:
1.184 rillig 5065: .if !defined(TIFF_BUILDLINK3_MK)
5066: TIFF_BUILDLINK3_MK:=
1.1 dsieger 5067:
1.184 rillig 5068: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5069: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5070: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 5071:
1.184 rillig 5072: .include "../../devel/zlib/buildlink3.mk"
5073: .include "../../graphics/jpeg/buildlink3.mk"
5074: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 5075:
1.184 rillig 5076: BUILDLINK_TREE+= -tiff
1.1 dsieger 5077:
1.184 rillig 5078: The header and footer manipulate BUILDLINK_TREE, which is common across all
5079: buildlink3.mk files and is used to track the dependency tree.
1.1 dsieger 5080:
1.184 rillig 5081: The main section is protected from multiple inclusion and controls how the
5082: dependency on pkg is added. Several important variables are set in the section:
1.1 dsieger 5083:
1.185 wiz 5084: * BUILDLINK_API_DEPENDS.pkg is the dependency version recorded in the
1.184 rillig 5085: installed package; this should always be set using += to ensure that we're
5086: appending to any pre-existing list of values. This variable should be set
1.185 wiz 5087: to the last version of the package that had an backwards-incompatible API
1.184 rillig 5088: change.
1.1 dsieger 5089:
1.184 rillig 5090: * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory.
1.1 dsieger 5091:
1.184 rillig 5092: * BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use
1.236 gutterid 5093: BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency
5094: is selected by setting BUILDLINK_DEPMETHOD.pkg to "build". By default, the
5095: full dependency is used.
1.1 dsieger 5096:
1.184 rillig 5097: * BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS.pkg (not shown above) are lists
5098: of subdirectories of ${BUILDLINK_PREFIX.pkg} to add to the header and
5099: library search paths. These default to "include" and "lib" respectively.
1.1 dsieger 5100:
1.184 rillig 5101: * BUILDLINK_CPPFLAGS.pkg (not shown above) is the list of preprocessor flags
5102: to add to CPPFLAGS, which are passed on to the configure and build phases.
5103: The "-I" option should be avoided and instead be handled using
5104: BUILDLINK_INCDIRS.pkg as above.
1.66 asau 5105:
1.184 rillig 5106: The following variables are all optionally defined within this second section
5107: (protected against multiple inclusion) and control which package files are
5108: symlinked into ${BUILDLINK_DIR} and how their names are transformed during the
5109: symlinking:
1.23 jakllsch 5110:
1.184 rillig 5111: * BUILDLINK_FILES.pkg (not shown above) is a shell glob pattern relative to $
5112: {BUILDLINK_PREFIX.pkg} to be symlinked into ${BUILDLINK_DIR}, e.g. include/
5113: *.h.
1.1 dsieger 5114:
1.184 rillig 5115: * BUILDLINK_FILES_CMD.pkg (not shown above) is a shell pipeline that outputs
5116: to stdout a list of files relative to ${BUILDLINK_PREFIX.pkg}. The
5117: resulting files are to be symlinked into ${BUILDLINK_DIR}. By default, this
5118: takes the +CONTENTS of a pkg and filters it through $
5119: {BUILDLINK_CONTENTS_FILTER.pkg}.
1.1 dsieger 5120:
1.184 rillig 5121: * BUILDLINK_CONTENTS_FILTER.pkg (not shown above) is a filter command that
5122: filters +CONTENTS input into a list of files relative to $
5123: {BUILDLINK_PREFIX.pkg} on stdout. By default, BUILDLINK_CONTENTS_FILTER.pkg
5124: outputs the contents of the include and lib directories in the package
5125: +CONTENTS.
1.1 dsieger 5126:
1.184 rillig 5127: * BUILDLINK_FNAME_TRANSFORM.pkg (not shown above) is a list of sed arguments
5128: used to transform the name of the source filename into a destination
5129: filename, e.g. -e "s|/curses.h|/ncurses.h|g".
1.1 dsieger 5130:
1.184 rillig 5131: This section can additionally include any buildlink3.mk needed for pkg's
5132: library dependencies. Including these buildlink3.mk files means that the
5133: headers and libraries for these dependencies are also symlinked into $
5134: {BUILDLINK_DIR} whenever the pkg buildlink3.mk file is included. Dependencies
5135: are only added for directly include buildlink3.mk files.
1.1 dsieger 5136:
1.184 rillig 5137: When providing a buildlink3.mk and including other buildlink3.mk files in it,
5138: please only add necessary ones, i.e., those whose libraries or header files are
5139: automatically exposed when the package is use.
1.1 dsieger 5140:
1.184 rillig 5141: In particular, if only an executable (bin/foo) is linked against a library,
5142: that library does not need to be propagated in the buildlink3.mk file.
1.1 dsieger 5143:
1.184 rillig 5144: The following steps should help you decide if a buildlink3.mk file needs to be
5145: included:
1.1 dsieger 5146:
1.184 rillig 5147: * Look at the installed header files: What headers do they include? The
5148: packages providing these files must be buildlinked.
1.1 dsieger 5149:
1.184 rillig 5150: * Run ldd on all installed libraries and look against what other libraries
5151: they link. Some of the packages providing these probably need to be
5152: buildlinked; however, it's not automatic, since e.g. GTK on some systems
5153: pulls in the X libraries, so they will show up in the ldd output, while on
5154: others (like OS X) it won't. ldd output can thus only be used as a hint.
1.1 dsieger 5155:
1.184 rillig 5156: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
5157: buildlink3.mk files
1.16 jnemeth 5158:
1.185 wiz 5159: Both variables set lower bounds for a version of this package. The two
5160: variables differ in that one describes source compatibility (API) and the other
5161: binary compatibility (ABI). The difference is that a change in the API breaks
5162: compilation of programs while changes in the ABI stop compiled programs from
5163: running.
5164:
5165: The BUILDLINK_API_DEPENDS.pkg variable in a buildlink3.mk should be changed
5166: very rarely. (One possible scenario: If all packages using this package need a
5167: higher version than defined in the buildlink3.mk, BUILDLINK_API_DEPENDS.pkg
5168: could be updated to that higher version.)
5169:
5170: On the other hand, changes to BUILDLINK_ABI_DEPENDS.pkg are more common. The
5171: variable will need to be updated every time the major version of one of its
5172: shared libraries is changed, or any other change where a binary built against
5173: the previous version of the package will not run against the new version any
5174: longer.
5175:
5176: In such a case, the package's BUILDLINK_ABI_DEPENDS.pkg must be increased to
5177: require the new package version. Then the PKGREVISION of all packages foo that
5178: depend on this package need to be increased, and if they have buildlink3.mk
5179: files, BUILDLINK_ABI_DEPENDS.foo in their buildlink3.mk files must be increased
5180: to the new version as well. This is required so that a package will pull in the
5181: versions of the packages that use the new ABI and that the packages'
5182: PKGREVISIONs uniquely identify the packages built against the new ABI. The
5183: pkgtools/revbump package can help with these updates.
1.1 dsieger 5184:
1.184 rillig 5185: See Section 21.1.5, "Handling dependencies" for more information about
1.185 wiz 5186: dependencies on other packages, including the BUILDLINK_API_DEPENDS
5187: definitions.
1.1 dsieger 5188:
1.184 rillig 5189: Please take careful consideration before adjusting BUILDLINK_API_DEPENDS.pkg or
1.185 wiz 5190: BUILDLINK_ABI_DEPENDS.pkg in a buildlink3.mk file as we don't want to cause
5191: unneeded package deletions and rebuilds. In many cases, new versions of
5192: packages work just fine with older dependencies.
1.1 dsieger 5193:
1.211 gutterid 5194: Also, it is not needed to set BUILDLINK_ABI_DEPENDS.pkg when it is identical to
1.184 rillig 5195: BUILDLINK_API_DEPENDS.pkg.
1.1 dsieger 5196:
1.211 gutterid 5197: Note there is also the distinction that users are able to disable enforcement
5198: of ABI dependencies using the USE_ABI_DEPENDS variable, but there is no
5199: equivalent option for API dependencies.
5200:
1.184 rillig 5201: 18.3. Writing builtin.mk files
1.1 dsieger 5202:
1.184 rillig 5203: Some packages in pkgsrc install headers and libraries that coincide with
5204: headers and libraries present in the base system. Aside from a buildlink3.mk
5205: file, these packages should also include a builtin.mk file that includes the
5206: necessary checks to decide whether using the built-in software or the pkgsrc
5207: software is appropriate.
1.1 dsieger 5208:
1.184 rillig 5209: The only requirements of a builtin.mk file for pkg are:
1.1 dsieger 5210:
1.184 rillig 5211: 1. It should set USE_BUILTIN.pkg to either "yes" or "no" after it is included.
1.1 dsieger 5212:
1.184 rillig 5213: 2. It should not override any USE_BUILTIN.pkg which is already set before the
5214: builtin.mk file is included.
1.1 dsieger 5215:
1.184 rillig 5216: 3. It should be written to allow multiple inclusion. This is very important
5217: and takes careful attention to Makefile coding.
1.1 dsieger 5218:
1.184 rillig 5219: 18.3.1. Anatomy of a builtin.mk file
1.1 dsieger 5220:
1.184 rillig 5221: The following is the recommended template for builtin.mk files:
1.1 dsieger 5222:
1.184 rillig 5223: .if !defined(IS_BUILTIN.foo)
5224: #
5225: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5226: # genuinely exists in the system or not.
5227: #
5228: IS_BUILTIN.foo?= no
1.1 dsieger 5229:
1.184 rillig 5230: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5231: # version can be determined.
5232: #
5233: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5234: BUILTIN_PKG.foo?= foo-1.0
5235: . endif
5236: .endif # IS_BUILTIN.foo
1.1 dsieger 5237:
1.184 rillig 5238: .if !defined(USE_BUILTIN.foo)
5239: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5240: . if defined(BUILTIN_PKG.foo)
5241: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5242: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5243: USE_BUILTIN.foo!= \
5244: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5245: && ${ECHO} "yes" || ${ECHO} "no"
5246: . endif
5247: . endfor
5248: . endif
5249: .endif # USE_BUILTIN.foo
1.1 dsieger 5250:
1.184 rillig 5251: CHECK_BUILTIN.foo?= no
5252: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5253: #
5254: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5255: # "yes" or "no".
5256: #
5257: .endif # CHECK_BUILTIN.foo
1.1 dsieger 5258:
1.184 rillig 5259: The first section sets IS_BUILTIN.pkg depending on if pkg really exists in the
5260: base system. This should not be a base system software with similar
5261: functionality to pkg; it should only be "yes" if the actual package is included
5262: as part of the base system. This variable is only used internally within the
5263: builtin.mk file.
1.1 dsieger 5264:
1.184 rillig 5265: The second section sets BUILTIN_PKG.pkg to the version of pkg in the base
5266: system if it exists (if IS_BUILTIN.pkg is "yes"). This variable is only used
5267: internally within the builtin.mk file.
1.1 dsieger 5268:
1.184 rillig 5269: The third section sets USE_BUILTIN.pkg and is required in all builtin.mk files.
5270: The code in this section must make the determination whether the built-in
5271: software is adequate to satisfy the dependencies listed in
5272: BUILDLINK_API_DEPENDS.pkg. This is typically done by comparing BUILTIN_PKG.pkg
5273: against each of the dependencies in BUILDLINK_API_DEPENDS.pkg. USE_BUILTIN.pkg
5274: must be set to the correct value by the end of the builtin.mk file. Note that
5275: USE_BUILTIN.pkg may be "yes" even if IS_BUILTIN.pkg is "no" because we may make
5276: the determination that the built-in version of the software is similar enough
5277: to be used as a replacement.
1.1 dsieger 5278:
1.184 rillig 5279: The last section is guarded by CHECK_BUILTIN.pkg, and includes code that uses
5280: the value of USE_BUILTIN.pkg set in the previous section. This typically
5281: includes, e.g., adding additional dependency restrictions and listing
5282: additional files to symlink into ${BUILDLINK_DIR} (via BUILDLINK_FILES.pkg).
1.1 dsieger 5283:
1.184 rillig 5284: Chapter 19. PLIST issues
1.1 dsieger 5285:
1.184 rillig 5286: Table of Contents
1.1 dsieger 5287:
1.184 rillig 5288: 19.1. RCS ID
5289: 19.2. Semi-automatic PLIST generation
5290: 19.3. Tweaking output of make print-PLIST
5291: 19.4. Variable substitution in PLIST
5292: 19.5. Man page compression
5293: 19.6. Changing PLIST source with PLIST_SRC
5294: 19.7. Platform-specific and differing PLISTs
5295: 19.8. Build-specific PLISTs
5296: 19.9. Sharing directories between packages
1.1 dsieger 5297:
1.184 rillig 5298: The PLIST file contains a package's "packing list", i.e. a list of files that
5299: belong to the package (relative to the ${PREFIX} directory it's been installed
5300: in) plus some additional statements - see the pkg_create(1) man page for a full
5301: list. This chapter addresses some issues that need attention when dealing with
5302: the PLIST file (or files, see below!).
1.1 dsieger 5303:
1.184 rillig 5304: 19.1. RCS ID
1.1 dsieger 5305:
1.184 rillig 5306: Be sure to add a RCS ID line as the first thing in any PLIST file you write:
1.1 dsieger 5307:
1.184 rillig 5308: @comment $NetBSD $
1.1 dsieger 5309:
1.184 rillig 5310: An artificial space has been added between NetBSD and $, this is a workaround
5311: here to prevent CVS expanding to the filename of the guide. When adding the RCS
5312: ID the space should be omitted.
1.38 wiz 5313:
1.184 rillig 5314: 19.2. Semi-automatic PLIST generation
1.1 dsieger 5315:
1.184 rillig 5316: You can use the make print-PLIST command to output a PLIST that matches any new
5317: files since the package was extracted. See Section 13.17, "Other helpful
5318: targets" for more information on this target.
1.11 rillig 5319:
1.184 rillig 5320: 19.3. Tweaking output of make print-PLIST
1.1 dsieger 5321:
1.184 rillig 5322: The PRINT_PLIST_AWK variable takes a set of AWK patterns and actions that are
5323: used to filter the output of print-PLIST. You can append any chunk of AWK
5324: scripting you like to it, but be careful with quoting.
1.1 dsieger 5325:
1.184 rillig 5326: For example, to get all files inside the libdata/foo directory removed from the
5327: resulting PLIST:
1.1 dsieger 5328:
1.184 rillig 5329: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 5330:
1.185 wiz 5331: The PRINT_PLIST_AWK transformations are evaluated after the file list and
5332: directory list are sorted. EARLY_PRINT_PLIST_AWK is like PRINT_PLIST_AWK except
5333: it operates before the file list and directory list are sorted.
5334:
1.184 rillig 5335: 19.4. Variable substitution in PLIST
1.1 dsieger 5336:
1.184 rillig 5337: A number of variables are substituted automatically in PLISTs when a package is
5338: installed on a system. This includes the following variables:
1.1 dsieger 5339:
1.184 rillig 5340: ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
1.1 dsieger 5341:
1.184 rillig 5342: Some packages like emacs and perl embed information about which
5343: architecture they were built on into the pathnames where they install their
5344: files. To handle this case, PLIST will be preprocessed before actually
5345: used, and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p
5346: gives. The same is done if the string ${MACHINE_GNU_ARCH} is embedded in
5347: PLIST somewhere - use this on packages that have GNU autoconf-created
5348: configure scripts.
1.1 dsieger 5349:
1.184 rillig 5350: Legacy note
1.1 dsieger 5351:
1.184 rillig 5352: There used to be a symbol "$ARCH" that was replaced by the output of uname
5353: -m, but that's no longer supported and has been removed.
1.1 dsieger 5354:
1.184 rillig 5355: ${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}
1.1 dsieger 5356:
1.184 rillig 5357: Some packages want to embed the OS name and version into some paths. To do
5358: this, use these variables in the PLIST:
1.1 dsieger 5359:
1.232 gutterid 5360: o ${OPSYS} - output of "uname -s"
1.1 dsieger 5361:
1.232 gutterid 5362: o ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
1.1 dsieger 5363:
1.232 gutterid 5364: o ${OS_VERSION} - "uname -r"
1.1 dsieger 5365:
1.184 rillig 5366: For a list of values which are replaced by default, the output of make help
5367: topic=PLIST_SUBST as well as searching the pkgsrc/mk directory with grep for
5368: PLIST_SUBST should help.
1.1 dsieger 5369:
1.184 rillig 5370: If you want to change other variables not listed above, you can add variables
5371: and their expansions to this variable in the following way, similar to
5372: MESSAGE_SUBST (see Section 12.5, "Optional files"):
1.1 dsieger 5373:
1.184 rillig 5374: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 5375:
1.184 rillig 5376: This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue".
1.1 dsieger 5377:
1.184 rillig 5378: The PLIST_VARS variable can be used to simplify the common case of
5379: conditionally including some PLIST entries. It can be done by adding
5380: PLIST_VARS+=foo and setting the corresponding PLIST.foo variable to yes if the
5381: entry should be included. This will substitute "${PLIST.foo}" in the PLIST with
5382: either """" or ""@comment "". For example, in Makefile:
1.1 dsieger 5383:
1.184 rillig 5384: PLIST_VARS+= foo
5385: .if condition
5386: PLIST.foo= yes
5387: .else
1.1 dsieger 5388:
1.184 rillig 5389: And then in PLIST:
1.1 dsieger 5390:
1.184 rillig 5391: @comment $NetBSD $
5392: bin/bar
5393: man/man1/bar.1
5394: ${PLIST.foo}bin/foo
5395: ${PLIST.foo}man/man1/foo.1
5396: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 5397:
1.184 rillig 5398: An artificial space has been added between NetBSD and $, this is a workaround
5399: here to prevent CVS expanding to the filename of the guide. When adding the RCS
1.195 gutterid 5400: ID the space should be omitted.
1.1 dsieger 5401:
1.184 rillig 5402: 19.5. Man page compression
1.1 dsieger 5403:
1.184 rillig 5404: Man pages should be installed in compressed form if MANZ is set (in
5405: bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the
5406: suffix ".gz" is appended/removed automatically for man pages according to MANZ
5407: and MANCOMPRESSED being set or not, see above for details. This modification of
5408: the PLIST file is done on a copy of it, not PLIST itself.
1.100 leot 5409:
1.184 rillig 5410: 19.6. Changing PLIST source with PLIST_SRC
1.100 leot 5411:
1.184 rillig 5412: To use one or more files as source for the PLIST used in generating the binary
5413: package, set the variable PLIST_SRC to the names of that file(s). The files are
5414: later concatenated using cat(1), and the order of things is important. The
5415: default for PLIST_SRC is ${PKGDIR}/PLIST.
1.1 dsieger 5416:
1.184 rillig 5417: 19.7. Platform-specific and differing PLISTs
1.1 dsieger 5418:
1.184 rillig 5419: Some packages decide to install a different set of files based on the operating
5420: system being used. These differences can be automatically handled by using the
5421: following files:
1.1 dsieger 5422:
1.184 rillig 5423: * PLIST.common
1.1 dsieger 5424:
1.184 rillig 5425: * PLIST.${OPSYS}
1.1 dsieger 5426:
1.184 rillig 5427: * PLIST.${MACHINE_ARCH}
1.1 dsieger 5428:
1.184 rillig 5429: * PLIST.${OPSYS}-${MACHINE_ARCH}
1.1 dsieger 5430:
1.184 rillig 5431: * PLIST.common_end
1.1 dsieger 5432:
1.184 rillig 5433: 19.8. Build-specific PLISTs
1.1 dsieger 5434:
1.184 rillig 5435: Some packages decide to generate hard-to-guess file names during installation
5436: that are hard to wire down.
1.1 dsieger 5437:
1.184 rillig 5438: In such cases, you can set the GENERATE_PLIST variable to shell code terminated
5439: (with a semicolon) that will output PLIST entries which will be appended to the
5440: PLIST
1.1 dsieger 5441:
1.184 rillig 5442: You can find one example in editors/xemacs:
1.1 dsieger 5443:
1.184 rillig 5444: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
1.1 dsieger 5445:
1.184 rillig 5446: which will append something like bin/xemacs-21.4.23-54e8ea71.dmp to the PLIST.
1.1 dsieger 5447:
1.184 rillig 5448: 19.9. Sharing directories between packages
1.1 dsieger 5449:
1.184 rillig 5450: A "shared directory" is a directory where multiple (and unrelated) packages
5451: install files. These directories were problematic because you had to add
5452: special tricks in the PLIST to conditionally remove them, or have some
5453: centralized package handle them.
1.106 tnn 5454:
1.184 rillig 5455: In pkgsrc, it is now easy: Each package should create directories and install
5456: files as needed; pkg_delete will remove any directories left empty after
5457: uninstalling a package.
1.106 tnn 5458:
1.184 rillig 5459: If a package needs an empty directory to work, create the directory during
5460: installation as usual, and also add an entry to the PLIST:
1.1 dsieger 5461:
1.184 rillig 5462: @pkgdir path/to/empty/directory
1.1 dsieger 5463:
1.184 rillig 5464: or take a look at MAKE_DIRS and OWN_DIRS.
1.1 dsieger 5465:
1.184 rillig 5466: Chapter 20. The pkginstall framework
1.1 dsieger 5467:
1.184 rillig 5468: Table of Contents
1.1 dsieger 5469:
1.184 rillig 5470: 20.1. Files and directories outside the installation prefix
5471: 20.1.1. Directory manipulation
5472: 20.1.2. File manipulation
5473: 20.2. Configuration files
5474: 20.2.1. How PKG_SYSCONFDIR is set
5475: 20.2.2. Telling the software where configuration files are
1.239 dholland 5476: 20.2.3. Patching installation
5477: 20.2.4. Declaring configuration files
5478: 20.2.5. Disabling handling of configuration files
1.184 rillig 5479: 20.3. System startup scripts
5480: 20.3.1. Disabling handling of system startup scripts
5481: 20.4. System users and groups
5482: 20.5. System shells
5483: 20.5.1. Disabling shell registration
5484: 20.6. Fonts
5485: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 5486:
1.184 rillig 5487: This chapter describes the framework known as pkginstall, whose key features
5488: are:
1.1 dsieger 5489:
1.184 rillig 5490: * Generic installation and manipulation of directories and files outside the
5491: pkgsrc-handled tree, LOCALBASE.
1.1 dsieger 5492:
1.184 rillig 5493: * Automatic handling of configuration files during installation, provided
5494: that packages are correctly designed.
1.1 dsieger 5495:
1.184 rillig 5496: * Generation and installation of system startup scripts.
1.1 dsieger 5497:
1.184 rillig 5498: * Registration of system users and groups.
1.1 dsieger 5499:
1.184 rillig 5500: * Registration of system shells.
1.1 dsieger 5501:
1.184 rillig 5502: * Automatic updating of fonts databases.
1.1 dsieger 5503:
1.184 rillig 5504: The following sections inspect each of the above points in detail.
1.1 dsieger 5505:
1.184 rillig 5506: You may be thinking that many of the things described here could be easily done
5507: with simple code in the package's post-installation target (post-install). This
5508: is incorrect, as the code in them is only executed when building from source.
5509: Machines using binary packages could not benefit from it at all (as the code
5510: itself could be unavailable). Therefore, the only way to achieve any of the
5511: items described above is by means of the installation scripts, which are
5512: automatically generated by pkginstall.
1.1 dsieger 5513:
1.184 rillig 5514: 20.1. Files and directories outside the installation prefix
1.95 wiz 5515:
1.184 rillig 5516: As you already know, the PLIST file holds a list of files and directories that
5517: belong to a package. The names used in it are relative to the installation
5518: prefix (${PREFIX}), which means that it cannot register files outside this
5519: directory (absolute path names are not allowed). Despite this restriction, some
5520: packages need to install files outside this location; e.g., under ${VARBASE} or
5521: ${PKG_SYSCONFDIR}. The only way to achieve this is to create such files during
5522: installation time by using installation scripts.
1.95 wiz 5523:
1.184 rillig 5524: The generic installation scripts are shell scripts that can contain arbitrary
5525: code. The list of scripts to execute is taken from the INSTALL_FILE variable,
5526: which defaults to INSTALL. A similar variable exists for package removal
5527: (DEINSTALL_FILE, whose default is DEINSTALL). These scripts can run arbitrary
5528: commands, so they have the potential to create and manage files anywhere in the
5529: file system.
1.95 wiz 5530:
1.184 rillig 5531: Using these general installation files is not recommended, but may be needed in
5532: some special cases. One reason for avoiding them is that the user has to trust
5533: the packager that there is no unwanted or simply erroneous code included in the
5534: installation script. Also, previously there were many similar scripts for the
5535: same functionality, and fixing a common error involved finding and changing all
5536: of them.
1.95 wiz 5537:
1.184 rillig 5538: The pkginstall framework offers another, standardized way. It provides generic
5539: scripts to abstract the manipulation of such files and directories based on
5540: variables set in the package's Makefile. The rest of this section describes
5541: these variables.
1.1 dsieger 5542:
1.184 rillig 5543: 20.1.1. Directory manipulation
1.1 dsieger 5544:
1.184 rillig 5545: The following variables can be set to request the creation of directories
5546: anywhere in the file system:
1.1 dsieger 5547:
1.184 rillig 5548: * MAKE_DIRS and OWN_DIRS contain a list of directories that should be created
5549: and should attempt to be destroyed by the installation scripts. The
5550: difference between the two is that the latter prompts the administrator to
5551: remove any directories that may be left after deinstallation (because they
5552: were not empty), while the former does not. Example:
1.1 dsieger 5553:
1.184 rillig 5554: MAKE_DIRS+= ${VARBASE}/foo/private
1.1 dsieger 5555:
1.184 rillig 5556: * MAKE_DIRS_PERMS and OWN_DIRS_PERMS contain a list of tuples describing
5557: which directories should be created and should attempt to be destroyed by
5558: the installation scripts. Each tuple holds the following values, separated
5559: by spaces: the directory name, its owner, its group and its numerical mode.
5560: For example:
1.1 dsieger 5561:
1.184 rillig 5562: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5563: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5564:
1.184 rillig 5565: The difference between the two is exactly the same as their non-PERMS
5566: counterparts.
1.1 dsieger 5567:
1.184 rillig 5568: 20.1.2. File manipulation
1.1 dsieger 5569:
1.184 rillig 5570: Creating non-empty files outside the installation prefix is tricky because the
5571: PLIST forces all files to be inside it. To overcome this problem, the only
1.239 dholland 5572: solution is to extract the file in a known place (i.e., inside the installation
5573: prefix) and copy it to the appropriate location during installation (done by
5574: the installation scripts generated by pkginstall). We will call the former the
5575: reference file in the following paragraphs, which describe the variables that
5576: can be used to automatically and consistently handle files outside the
5577: installation prefix:
5578:
5579: * REQD_FILES is a list of pairs of reference and target files. At
5580: installation time, the reference file is copied to the target if and only
5581: if the latter does not exist. Upon deinstallation, the reference file is
1.184 rillig 5582: removed provided that it was not modified by the installation.
1.1 dsieger 5583:
1.239 dholland 5584: * REQD_FILES_PERMS contains tuples describing reference files and targets,
5585: including owner, group, and numeric permissions that should be set. For
5586: example:
1.1 dsieger 5587:
1.184 rillig 5588: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5589: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5590:
1.239 dholland 5591: * CONF_FILES and CONF_FILES_PERMS have the same syntax as REQD_FILES and
5592: REQD_FILES_PERMS respectively. The difference is that these variables are
5593: specifically intended for handling configuration files, for which
5594: additional conventions and constraints apply. See Section 20.2,
5595: "Configuration files" for further discussion. Note in particular that while
5596: handling of configuration files can be disabled by the user (see
5597: Section 20.2.5, "Disabling handling of configuration files"), this setting
5598: does not affect REQD_FILES and REQD_FILES_PERMS.
5599:
5600: To install an empty file, one can use these macros and /dev/null as the
5601: reference file.
1.1 dsieger 5602:
1.184 rillig 5603: 20.2. Configuration files
1.1 dsieger 5604:
1.239 dholland 5605: There are two principles that govern the handling of configuration files in
5606: pkgsrc: first, the user's configuration must not be lost or overwritten by
5607: upgrades or reinstallations; and second, the default configuration should
5608: always be available for reference. To that end, pkgsrc has a framework
5609: specifically for handling configuration files. In general, configuration files
5610: are installed into ${PREFIX}/share/examples, and copied from there to the
5611: pertinent etc directory as a separate step and only as needed.
5612:
5613: To make this work, there are three things that need to happen, any of which may
5614: require patching. First, the package must be told to read its configuration
5615: from the correct place at runtime; this place is ${PKG_SYSCONFDIR} (or possibly
5616: a subdirectory of it) which is often but not always ${PREFIX}/etc. Second, the
5617: package must be taught to install its default configuration files in ${PREFIX}/
5618: share/examples/${PKGBASE}; this is the point at which patching often becomes
5619: required because it is not the same place as the runtime location. Third, the
5620: configuration files need to be declared in the package makefile; this is the
5621: easy part.
5622:
5623: With those elements in place, the right things will happen: the package install
5624: phase and resulting binary package will not touch ${PKG_SYSCONFDIR}, and the
5625: default configuration will be copied into place by the pkgsrc framework only if
5626: not already present. Similarly, upon deinstall the configuration will not be
5627: removed if it has been modified. (This means that in the case of reinstallation
5628: and upgrades, unmodified configuration files are updated but modifications are
5629: never discarded.)
5630:
5631: The following sections describe how to make these things happen and document
5632: other relevant knobs available in the pkgsrc infrastructure.
1.1 dsieger 5633:
1.184 rillig 5634: 20.2.1. How PKG_SYSCONFDIR is set
1.1 dsieger 5635:
1.184 rillig 5636: As said before, the PKG_SYSCONFDIR variable specifies where configuration files
5637: shall be installed. Its contents are set based upon the following variables:
1.1 dsieger 5638:
1.184 rillig 5639: * PKG_SYSCONFBASE: The configuration's root directory. Defaults to ${PREFIX}/
1.239 dholland 5640: etc although it may be overridden by the user to point to their preferred
1.184 rillig 5641: location (e.g., /etc, /etc/pkg, etc.). Packages must not use it directly.
1.1 dsieger 5642:
1.184 rillig 5643: * PKG_SYSCONFSUBDIR: A subdirectory of PKG_SYSCONFBASE under which the
5644: configuration files for the package being built shall be installed. The
5645: definition of this variable only makes sense in the package's Makefile
5646: (i.e., it is not user-customizable).
1.1 dsieger 5647:
1.184 rillig 5648: As an example, consider the Apache package, www/apache24, which places its
5649: configuration files under the httpd/ subdirectory of PKG_SYSCONFBASE. This
5650: should be set in the package Makefile.
1.1 dsieger 5651:
1.184 rillig 5652: * PKG_SYSCONFVAR: Specifies the name of the variable that holds this
5653: package's configuration directory (if different from PKG_SYSCONFBASE). It
5654: defaults to PKGBASE's value, and is always prefixed with PKG_SYSCONFDIR.
1.1 dsieger 5655:
1.184 rillig 5656: * PKG_SYSCONFDIR.${PKG_SYSCONFVAR}: Holds the directory where the
5657: configuration files for the package identified by PKG_SYSCONFVAR's shall be
5658: placed.
1.1 dsieger 5659:
1.184 rillig 5660: Based on the above variables, pkginstall determines the value of
1.239 dholland 5661: PKG_SYSCONFDIR, which is the only variable that may be used within a package to
1.184 rillig 5662: refer to its configuration directory. The algorithm used to set its value is
5663: basically the following:
1.1 dsieger 5664:
1.184 rillig 5665: 1. If PKG_SYSCONFDIR.${PKG_SYSCONFVAR} is set, its value is used.
1.1 dsieger 5666:
1.184 rillig 5667: 2. If the previous variable is not defined but PKG_SYSCONFSUBDIR is set in the
5668: package's Makefile, the resulting value is ${PKG_SYSCONFBASE}/$
5669: {PKG_SYSCONFSUBDIR}.
1.1 dsieger 5670:
1.184 rillig 5671: 3. Otherwise, it is set to ${PKG_SYSCONFBASE}.
1.1 dsieger 5672:
1.184 rillig 5673: It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to
1.239 dholland 5674: OWN_DIRS. This causes it to be automatically created if needed. See
5675: Section 20.1.1, "Directory manipulation" for further details. This does not
5676: apply to subdirectories of ${PKG_SYSCONFDIR}; they must be manually created
5677: with OWN_DIRS or MAKE_DIRS.
1.1 dsieger 5678:
1.184 rillig 5679: 20.2.2. Telling the software where configuration files are
1.1 dsieger 5680:
1.184 rillig 5681: Given that pkgsrc (and users!) expect configuration files to be in a known
1.239 dholland 5682: place, you need to teach each package where to install its files. In some cases
5683: you will have to patch the package Makefiles to achieve it. If you are lucky,
5684: though, it may be as easy as passing an extra flag to the configuration script.
5685: This is the case for packages using GNU autoconf:
1.1 dsieger 5686:
1.184 rillig 5687: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 5688:
1.184 rillig 5689: Note that this specifies where the package has to look for its configuration
1.239 dholland 5690: files, not where they will be installed. Fortunately, there is a different way
1.240 gutterid 5691: to specify the latter, as seen in the next section, although the combination is
5692: rather confusing at first glance.
1.1 dsieger 5693:
1.239 dholland 5694: 20.2.3. Patching installation
1.1 dsieger 5695:
1.239 dholland 5696: As discussed above, packages themselves must not touch the contents of $
1.184 rillig 5697: {PKG_SYSCONFDIR} directly. Bad news is that many software installation scripts
5698: will, out of the box, mess with the contents of that directory. So what is the
5699: correct procedure to fix this issue?
1.1 dsieger 5700:
1.184 rillig 5701: You must teach the package (usually by manually patching it) to install any
5702: configuration files under the examples hierarchy, share/examples/${PKGBASE}/.
5703: This way, the PLIST registers them and the administrator always has the
5704: original copies available.
1.1 dsieger 5705:
1.239 dholland 5706: It turns out that for packages using GNU autoconf it is possible to create the
5707: desired effect by setting sysconfdir on the make command line at install time.
5708: Consider this example taken from mail/mutt:
5709:
5710: EGDIR= ${PREFIX}/share/examples/mutt
5711: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
5712:
5713: Note that the EGDIR variable, though commonly used for this purpose, is local
5714: to that package and has no meaning outside it.
1.1 dsieger 5715:
1.239 dholland 5716: 20.2.4. Declaring configuration files
1.1 dsieger 5717:
1.239 dholland 5718: Once the required configuration files are in place (i.e., under the examples
5719: hierarchy), the pkginstall framework can use them as reference copies during
5720: the package installation to update what is in ${PKG_SYSCONFDIR}. To achieve
5721: this, the variables CONF_FILES and CONF_FILES_PERMS are used. Check out
5722: Section 20.1.2, "File manipulation" for further information about their syntax
5723: and their purpose. Here is an example, taken from the mail/mutt package:
5724:
5725: EGDIR= ${PREFIX}/share/examples/mutt
5726: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5727:
5728: Note that (as in the previous section's example) the EGDIR variable is specific
5729: to the package and has no meaning outside it.
5730:
5731: For reference, the complete example from Mutt is as follows:
5732:
5733: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5734: EGDIR= ${PREFIX}/share/examples/mutt
5735: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5736: INSTALLATION_DIRS+= ${EGDIR}
5737: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.1 dsieger 5738:
1.239 dholland 5739: 20.2.5. Disabling handling of configuration files
1.1 dsieger 5740:
1.184 rillig 5741: The automatic copying of config files can be toggled by setting the environment
5742: variable PKG_CONFIG prior to package installation.
1.1 dsieger 5743:
1.184 rillig 5744: 20.3. System startup scripts
1.1 dsieger 5745:
1.184 rillig 5746: System startup scripts are special files because they must be installed in a
5747: place known by the underlying OS, usually outside the installation prefix.
5748: Therefore, the same rules described in Section 20.1, "Files and directories
5749: outside the installation prefix" apply, and the same solutions can be used.
5750: However, pkginstall provides a special mechanism to handle these files.
1.1 dsieger 5751:
1.184 rillig 5752: In order to provide system startup scripts, the package has to:
1.1 dsieger 5753:
1.184 rillig 5754: 1. Store the script inside ${FILESDIR}, with the .sh suffix appended.
1.223 nia 5755: Considering the print/cups-base package as an example, it has a cupsd.sh in
5756: its files directory.
1.95 wiz 5757:
1.184 rillig 5758: 2. Tell pkginstall to handle it, appending the name of the script, without its
5759: extension, to the RCD_SCRIPTS variable. Continuing the previous example:
1.95 wiz 5760:
1.184 rillig 5761: RCD_SCRIPTS+= cupsd
1.95 wiz 5762:
1.184 rillig 5763: Once this is done, pkginstall will do the following steps for each script in an
5764: automated fashion:
1.95 wiz 5765:
1.184 rillig 5766: 1. Process the file found in the files directory applying all the
5767: substitutions described in the FILES_SUBST variable.
1.1 dsieger 5768:
1.184 rillig 5769: 2. Copy the script from the files directory to the examples hierarchy, $
1.239 dholland 5770: {PREFIX}/share/examples/rc.d/. Note that this reference file must be
1.184 rillig 5771: explicitly registered in the PLIST.
1.1 dsieger 5772:
1.184 rillig 5773: 3. Add code to the installation scripts to copy the startup script from the
5774: examples hierarchy into the system-wide startup scripts directory.
1.1 dsieger 5775:
1.184 rillig 5776: 20.3.1. Disabling handling of system startup scripts
1.1 dsieger 5777:
1.184 rillig 5778: The automatic copying of config files can be toggled by setting the environment
5779: variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts
5780: will be always copied inside the examples hierarchy, ${PREFIX}/share/examples/
5781: rc.d/, no matter what the value of this variable is.
1.1 dsieger 5782:
1.184 rillig 5783: 20.4. System users and groups
1.1 dsieger 5784:
1.184 rillig 5785: If a package needs to create special users and/or groups during installation,
5786: it can do so by using the pkginstall framework.
1.1 dsieger 5787:
1.184 rillig 5788: Users can be created by adding entries to the PKG_USERS variable. Each entry
5789: has the following syntax:
1.1 dsieger 5790:
1.184 rillig 5791: user:group
1.1 dsieger 5792:
1.184 rillig 5793: Further specification of user details may be done by setting per-user
5794: variables. PKG_UID.user is the numeric UID for the user. PKG_GECOS.user is the
5795: user's description or comment. PKG_HOME.user is the user's home directory, and
5796: defaults to /nonexistent if not specified. PKG_SHELL.user is the user's shell,
5797: and defaults to /sbin/nologin if not specified.
1.1 dsieger 5798:
1.184 rillig 5799: Similarly, groups can be created by adding entries to the PKG_GROUPS variable,
5800: whose syntax is:
1.1 dsieger 5801:
1.184 rillig 5802: group
1.1 dsieger 5803:
1.184 rillig 5804: The numeric GID of the group may be set by defining PKG_GID.group.
1.1 dsieger 5805:
1.184 rillig 5806: If a package needs to create the users and groups at an earlier stage, then it
5807: can set USERGROUP_PHASE to either configure,build, or pre-install to indicate
5808: the phase before which the users and groups are created. In this case, the
5809: numeric UIDs and GIDs of the created users and groups are automatically
5810: hardcoded into the final installation scripts.
1.1 dsieger 5811:
1.184 rillig 5812: 20.5. System shells
1.1 dsieger 5813:
1.184 rillig 5814: Packages that install system shells should register them in the shell database,
5815: /etc/shells, to make things easier to the administrator. This must be done from
5816: the installation scripts to keep binary packages working on any system.
5817: pkginstall provides an easy way to accomplish this task.
1.1 dsieger 5818:
1.184 rillig 5819: When a package provides a shell interpreter, it has to set the PKG_SHELL
5820: variable to its absolute file name. This will add some hooks to the
5821: installation scripts to handle it. Consider the following example, taken from
5822: shells/zsh:
1.1 dsieger 5823:
1.184 rillig 5824: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 dsieger 5825:
1.184 rillig 5826: 20.5.1. Disabling shell registration
1.1 dsieger 5827:
1.184 rillig 5828: The automatic registration of shell interpreters can be disabled by the
5829: administrator by setting the PKG_REGISTER_SHELLS environment variable to NO.
1.1 dsieger 5830:
1.184 rillig 5831: 20.6. Fonts
1.1 dsieger 5832:
1.184 rillig 5833: Packages that install X11 fonts should update the database files that index the
5834: fonts within each fonts directory. This can easily be accomplished within the
5835: pkginstall framework.
1.1 dsieger 5836:
1.184 rillig 5837: When a package installs X11 fonts, it must list the directories in which fonts
5838: are installed in the FONTS_DIRS.type variables, where type can be one of "ttf",
5839: "type1" or "x11". This will add hooks to the installation scripts to run the
5840: appropriate commands to update the fonts database files within each of those
5841: directories. For convenience, if the directory path is relative, it is taken to
5842: be relative to the package's installation prefix. Consider the following
5843: example, taken from fonts/dbz-ttf:
1.1 dsieger 5844:
1.184 rillig 5845: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5846:
1.184 rillig 5847: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 5848:
1.184 rillig 5849: The automatic update of fonts databases can be disabled by the administrator by
5850: setting the PKG_UPDATE_FONTS_DB environment variable to NO.
1.1 dsieger 5851:
1.154 rillig 5852: Chapter 21. Making your package work
1.1 dsieger 5853:
5854: Table of Contents
5855:
1.154 rillig 5856: 21.1. General operation
5857: 21.1.1. How to pull in user-settable variables from mk.conf
5858: 21.1.2. User interaction
5859: 21.1.3. Handling licenses
5860: 21.1.4. Restricted packages
5861: 21.1.5. Handling dependencies
5862: 21.1.6. Handling conflicts with other packages
5863: 21.1.7. Packages that cannot or should not be built
5864: 21.1.8. Packages which should not be deleted, once installed
5865: 21.1.9. Handling packages with security problems
5866: 21.1.10. How to handle incrementing versions when fixing an existing
1.232 gutterid 5867: package
1.154 rillig 5868: 21.1.11. Substituting variable text in the package files (the SUBST
1.232 gutterid 5869: framework)
1.154 rillig 5870: 21.2. The fetch phase
5871: 21.2.1. Packages whose distfiles aren't available for plain downloading
5872: 21.2.2. How to handle modified distfiles with the 'old' name
5873: 21.2.3. Packages hosted on github.com
5874: 21.3. The configure phase
5875: 21.3.1. Shared libraries - libtool
5876: 21.3.2. Using libtool on GNU packages that already support libtool
5877: 21.3.3. GNU Autoconf/Automake
1.223 nia 5878: 21.3.4. Meson / ninja
1.154 rillig 5879: 21.4. Programming languages
5880: 21.4.1. C, C++, and Fortran
5881: 21.4.2. Java
1.205 wiz 5882: 21.4.3. Go
1.223 nia 5883: 21.4.4. Rust
5884: 21.4.5. Packages containing Perl scripts
5885: 21.4.6. Packages containing shell scripts
5886: 21.4.7. Other programming languages
1.154 rillig 5887: 21.5. The build phase
5888: 21.5.1. Compiling C and C++ code conditionally
5889: 21.5.2. How to handle compiler bugs
1.172 rillig 5890: 21.5.3. No such file or directory
5891: 21.5.4. Undefined reference to "..."
5892: 21.5.5. Running out of memory
1.154 rillig 5893: 21.6. The install phase
5894: 21.6.1. Creating needed directories
5895: 21.6.2. Where to install documentation
5896: 21.6.3. Installing highscore files
5897: 21.6.4. Adding DESTDIR support to packages
5898: 21.6.5. Packages with hardcoded paths to other interpreters
1.203 nia 5899: 21.6.6. Packages installing Perl modules
1.154 rillig 5900: 21.6.7. Packages installing info files
5901: 21.6.8. Packages installing man pages
1.203 nia 5902: 21.6.9. Packages installing X11 fonts
5903: 21.6.10. Packages installing SGML or XML data
5904: 21.6.11. Packages installing extensions to the MIME database
5905: 21.6.12. Packages using intltool
5906: 21.6.13. Packages installing startup scripts
5907: 21.6.14. Packages installing TeX modules
5908: 21.6.15. Packages supporting running binaries in emulation
5909: 21.6.16. Packages installing hicolor icons
5910: 21.6.17. Packages installing desktop files
1.154 rillig 5911: 21.7. Marking packages as having problems
1.1 dsieger 5912:
1.154 rillig 5913: 21.1. General operation
1.1 dsieger 5914:
5915: One appealing feature of pkgsrc is that it runs on many different platforms. As
5916: a result, it is important to ensure, where possible, that packages in pkgsrc
5917: are portable. This chapter mentions some particular details you should pay
5918: attention to while working on pkgsrc.
5919:
1.154 rillig 5920: 21.1.1. How to pull in user-settable variables from mk.conf
1.1 dsieger 5921:
5922: The pkgsrc user can configure pkgsrc by overriding several variables in the
1.4 rillig 5923: file pointed to by MAKECONF, which is mk.conf by default. When you want to use
5924: those variables in the preprocessor directives of make(1) (for example .if or
5925: .for), you need to include the file ../../mk/bsd.prefs.mk before, which in turn
5926: loads the user preferences.
1.1 dsieger 5927:
5928: But note that some variables may not be completely defined after ../../mk/
5929: bsd.prefs.mk has been included, as they may contain references to variables
1.108 rillig 5930: that are not yet defined. In shell commands (the lines in Makefile that are
5931: indented with a tab) this is no problem, since variables are only expanded when
5932: they are used. But in the preprocessor directives mentioned above and in
5933: dependency lines (of the form target: dependencies) the variables are expanded
5934: at load time.
1.1 dsieger 5935:
5936: Note
5937:
1.108 rillig 5938: To check whether a variable can be used at load time, run pkglint -Wall on your
5939: package.
1.1 dsieger 5940:
1.154 rillig 5941: 21.1.2. User interaction
1.1 dsieger 5942:
5943: Occasionally, packages require interaction from the user, and this can be in a
5944: number of ways:
5945:
5946: * When fetching the distfiles, some packages require user interaction such as
5947: entering username/password or accepting a license on a web page.
5948:
5949: * When extracting the distfiles, some packages may ask for passwords.
5950:
5951: * help to configure the package before it is built
5952:
5953: * help during the build process
5954:
5955: * help during the installation of a package
5956:
1.108 rillig 5957: A package can set the INTERACTIVE_STAGE variable to define which stages need
5958: interaction. This should be done in the package's Makefile, e.g.:
1.1 dsieger 5959:
5960: INTERACTIVE_STAGE= configure install
5961:
5962: The user can then decide to skip this package by setting the BATCH variable.
1.108 rillig 5963: Packages that require interaction are also excluded from bulk builds.
1.1 dsieger 5964:
1.154 rillig 5965: 21.1.3. Handling licenses
1.1 dsieger 5966:
5967: Authors of software can choose the licence under which software can be copied.
1.111 sevan 5968: The Free Software Foundation has declared some licenses "Free", and the Open
5969: Source Initiative has a definition of "Open Source".
5970:
5971: By default, pkgsrc allows packages with Free or Open Source licenses to be
5972: built. To allow packages with other licenses to be built as well, the pkgsrc
5973: user needs to add these licenses to the ACCEPTABLE_LICENSES variable in mk.conf
5974: . Note that this variable only affects which packages may be built, while the
5975: license terms often also restrict the actual use of the package and its
5976: redistribution.
1.1 dsieger 5977:
5978: One might want to only install packages with a BSD license, or the GPL, and not
1.20 jnemeth 5979: the other. The free licenses are added to the default ACCEPTABLE_LICENSES
1.111 sevan 5980: variable. The pkgsrc user can override the default by setting the
5981: ACCEPTABLE_LICENSES variable with "=" instead of "+=". The licenses accepted by
5982: default are defined in the DEFAULT_ACCEPTABLE_LICENSES variable in the file
5983: pkgsrc/mk/license.mk.
1.1 dsieger 5984:
5985: The license tag mechanism is intended to address copyright-related issues
5986: surrounding building, installing and using a package, and not to address
1.20 jnemeth 5987: redistribution issues (see RESTRICTED and NO_SRC_ON_FTP, etc.). Packages with
5988: redistribution restrictions should set these tags.
1.1 dsieger 5989:
5990: Denoting that a package may be copied according to a particular license is done
5991: by placing the license in pkgsrc/licenses and setting the LICENSE variable to a
5992: string identifying the license, e.g. in graphics/xv:
5993:
5994: LICENSE= xv-license
5995:
5996: When trying to build, the user will get a notice that the package is covered by
5997: a license which has not been placed in the ACCEPTABLE_LICENSES variable:
5998:
5999: % make
6000: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6001: ===> To view the license, enter "/usr/bin/make show-license".
6002: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6003: ===> ACCEPTABLE_LICENSES+=xv-license
6004: *** Error code 1
6005:
6006: The license can be viewed with make show-license, and if the user so chooses,
1.4 rillig 6007: the line printed above can be added to mk.conf to convey to pkgsrc that it
1.1 dsieger 6008: should not in the future fail because of that license:
6009:
6010: ACCEPTABLE_LICENSES+=xv-license
6011:
1.111 sevan 6012: The use of LICENSE=shareware, LICENSE=no-commercial-use, and similar language
6013: is deprecated because it does not crisply refer to a particular license text.
6014: Another problem with such usage is that it does not enable a user to tell
6015: pkgsrc to proceed for a single package without also telling pkgsrc to proceed
6016: for all packages with that tag.
6017:
1.154 rillig 6018: 21.1.3.1. Adding a package with a new license
1.1 dsieger 6019:
1.49 rodent 6020: When adding a package with a new license, the following steps are required:
6021:
1.111 sevan 6022: 1. Check whether the license qualifies as Free or Open Source by referencing
6023: Various Licenses and Comments about Them and Licenses by Name | Open Source
6024: Initiative. If this is the case, the filename in pkgsrc/licenses/ does not
6025: need the -license suffix, and the license name should be added to:
1.49 rodent 6026:
6027: + DEFAULT_ACCEPTABLE_LICENSES in pkgsrc/mk/license.mk
6028:
6029: + default_acceptable_licenses in pkgsrc/pkgtools/pkg_install/files/lib/
6030: license.c
6031:
6032: 2. The license text should be added to pkgsrc/licenses for displaying. A list
6033: of known licenses can be seen in this directory.
1.1 dsieger 6034:
1.154 rillig 6035: 21.1.3.2. Change to the license
1.1 dsieger 6036:
1.111 sevan 6037: When the license changes (in a way other than formatting), make sure that the
6038: new license has a different name (e.g., append the version number if it exists,
6039: or the date). Just because a user told pkgsrc to build programs under a
6040: previous version of a license does not mean that pkgsrc should build programs
6041: under the new licenses. The higher-level point is that pkgsrc does not evaluate
6042: licenses for reasonableness; the only test is a mechanistic test of whether a
6043: particular text has been approved by either of two bodies (FSF or OSI).
1.1 dsieger 6044:
1.154 rillig 6045: 21.1.4. Restricted packages
1.1 dsieger 6046:
1.111 sevan 6047: Some licenses restrict how software may be re-distributed. By declaring the
6048: restrictions, package tools can automatically refrain from e.g. placing binary
6049: packages on FTP sites.
6050:
6051: There are four possible restrictions, which are the cross product of sources
6052: (distfiles) and binaries not being placed on FTP sites and CD-ROMs. Because
6053: this is rarely the exact language in any license, and because non-Free licenses
6054: tend to be different from each other, pkgsrc adopts a definition of FTP and
6055: CD-ROM. "FTP" means making the source or binary file available over the
6056: Internet at no charge. "CD-ROM" means making the source or binary available on
6057: some kind of media, together with other source and binary packages, which is
6058: sold for a distribution charge.
1.1 dsieger 6059:
6060: In order to encode these restrictions, the package system defines five make
6061: variables that can be set to note these restrictions:
6062:
6063: * RESTRICTED
6064:
6065: This variable should be set whenever a restriction exists (regardless of
6066: its kind). Set this variable to a string containing the reason for the
6067: restriction. It should be understood that those wanting to understand the
6068: restriction will have to read the license, and perhaps seek advice of
6069: counsel.
6070:
6071: * NO_BIN_ON_CDROM
6072:
6073: Binaries may not be placed on CD-ROM containing other binary packages, for
6074: which a distribution charge may be made. In this case, set this variable to
6075: ${RESTRICTED}.
6076:
6077: * NO_BIN_ON_FTP
6078:
6079: Binaries may not made available on the Internet without charge. In this
6080: case, set this variable to ${RESTRICTED}. If this variable is set, binary
6081: packages will not be included on ftp.NetBSD.org.
6082:
6083: * NO_SRC_ON_CDROM
6084:
6085: Distfiles may not be placed on CD-ROM, together with other distfiles, for
6086: which a fee may be charged. In this case, set this variable to $
6087: {RESTRICTED}.
6088:
6089: * NO_SRC_ON_FTP
6090:
6091: Distfiles may not made available via FTP at no charge. In this case, set
6092: this variable to ${RESTRICTED}. If this variable is set, the distfile(s)
6093: will not be mirrored on ftp.NetBSD.org.
6094:
1.111 sevan 6095: Please note that packages will be removed from pkgsrc when the distfiles are
1.33 wiz 6096: not distributable and cannot be obtained for a period of one full quarter
1.111 sevan 6097: branch. Packages with manual/interactive fetch must have a maintainer and it is
6098: his/her responsibility to ensure this.
1.33 wiz 6099:
1.154 rillig 6100: 21.1.5. Handling dependencies
1.1 dsieger 6101:
1.175 gutterid 6102: Your package may depend on some other package being present, and there are
6103: various ways of expressing this dependency. pkgsrc supports the DEPENDS,
6104: BUILD_DEPENDS, TOOL_DEPENDS, and TEST_DEPENDS definitions, the USE_TOOLS
6105: definition, as well as dependencies via buildlink3.mk, which is the preferred
6106: way to handle dependencies, and which uses the variables named above. See
1.184 rillig 6107: Chapter 18, Buildlink methodology for more information.
1.175 gutterid 6108:
6109: The basic difference is that the DEPENDS definition registers that
6110: pre-requisite in the binary package so it will be pulled in when the binary
6111: package is later installed, whilst the BUILD_DEPENDS, TOOL_DEPENDS, and
6112: TEST_DEPENDS definitions do not, marking a dependency that is only needed for
1.184 rillig 6113: building or testing the resulting package. See also Chapter 14, Creating a new
1.175 gutterid 6114: pkgsrc package from scratch for more information.
6115:
6116: This means that if you only need a package present whilst you are building or
6117: testing, it should be noted as a TOOL_DEPENDS, BUILD_DEPENDS, or TEST_DEPENDS.
6118: When cross-compiling, TOOL_DEPENDS are native packages, i.e. packages for the
6119: architecture where the package is built; BUILD_DEPENDS are target packages,
6120: i.e., packages for the architecture for which the package is built.
1.1 dsieger 6121:
1.175 gutterid 6122: The format for a DEPENDS, BUILD_DEPENDS, TOOL_DEPENDS, and TEST_DEPENDS
6123: definition is:
1.1 dsieger 6124:
6125: <pre-req-package-name>:../../<category>/<pre-req-package>
6126:
6127: Please note that the "pre-req-package-name" may include any of the wildcard
6128: version numbers recognized by pkg_info(1).
6129:
1.55 wiz 6130: 1. If your package needs another package's binaries or libraries to build and
1.1 dsieger 6131: run, and if that package has a buildlink3.mk file available, use it:
6132:
6133: .include "../../graphics/jpeg/buildlink3.mk"
6134:
1.55 wiz 6135: 2. If your package needs another package's binaries or libraries only for
6136: building, and if that package has a buildlink3.mk file available, use it:
6137:
6138: .include "../../graphics/jpeg/buildlink3.mk"
6139:
6140: but set BUILDLINK_DEPMETHOD.jpeg?=build to make it a build dependency only.
6141: This case is rather rare.
6142:
6143: 3. If your package needs binaries from another package to build, use the
1.156 leot 6144: TOOL_DEPENDS definition:
6145:
6146: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.1 dsieger 6147:
1.156 leot 6148: 4. If your package needs static libraries to link against, header files to
6149: include, etc. from another package to build, use the BUILD_DEPENDS
6150: definition.
1.1 dsieger 6151:
1.156 leot 6152: 5. If your package needs a library with which to link and there is no
1.26 spz 6153: buildlink3.mk file available, create one. Using DEPENDS won't be sufficient
6154: because the include files and libraries will be hidden from the compiler.
1.1 dsieger 6155:
1.156 leot 6156: 6. If your package needs some executable to be able to run correctly and if
1.26 spz 6157: there's no buildlink3.mk file, this is specified using the DEPENDS
6158: variable. The print/lyx package needs to be able to execute the latex
1.129 wiz 6159: binary from the tex-latex-bin package when it runs, and that is specified:
1.1 dsieger 6160:
1.129 wiz 6161: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.1 dsieger 6162:
1.175 gutterid 6163: 7. If your package includes a test suite that has extra dependencies only
6164: required for this purpose (frequently this can be run as a "make test"
6165: target), use the TEST_DEPENDS variable.
6166:
6167: 8. You can use wildcards in package dependencies. Note that such wildcard
1.26 spz 6168: dependencies are retained when creating binary packages. The dependency is
6169: checked when installing the binary package and any package which matches
6170: the pattern will be used. Wildcard dependencies should be used with care.
1.1 dsieger 6171:
6172: The "-[0-9]*" should be used instead of "-*" to avoid potentially ambiguous
6173: matches such as "tk-postgresql" matching a "tk-*" DEPENDS.
6174:
6175: Wildcards can also be used to specify that a package will only build
6176: against a certain minimum version of a pre-requisite:
6177:
1.26 spz 6178: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 6179:
1.26 spz 6180: This means that the package will build using version 6.0 of ImageMagick or
6181: newer. Such a dependency may be warranted if, for example, the command line
6182: options of an executable have changed.
6183:
1.183 wiz 6184: If you need to depend on minimum versions of libraries, set
6185: BUILDLINK_API_DEPENDS.pkg to the appropriate pattern before including its
6186: buildlink3.mk file, e.g.
6187:
6188: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
6189: .include "../../graphics/jpeg/buildlink3.mk"
1.1 dsieger 6190:
6191: For security fixes, please update the package vulnerabilities file. See
1.154 rillig 6192: Section 21.1.9, "Handling packages with security problems" for more
1.1 dsieger 6193: information.
6194:
6195: If your package needs files from another package to build, add the relevant
6196: distribution files to DISTFILES, so they will be extracted automatically. See
6197: the print/ghostscript package for an example. (It relies on the jpeg sources
6198: being present in source form during the build.)
6199:
1.154 rillig 6200: 21.1.6. Handling conflicts with other packages
1.1 dsieger 6201:
1.226 gutterid 6202: Your package may conflict with other packages users might already have
6203: installed on their system, e.g., if your package installs the same set of files
1.227 wiz 6204: as another package in the pkgsrc tree.
1.1 dsieger 6205:
1.142 leot 6206: For example, x11/libXaw3d and x11/Xaw-Xpm install the same shared library, thus
6207: you set in pkgsrc/x11/libXaw3d/Makefile:
1.1 dsieger 6208:
1.142 leot 6209: CONFLICTS= Xaw-Xpm-[0-9]*
1.1 dsieger 6210:
1.142 leot 6211: and in pkgsrc/x11/Xaw-Xpm/Makefile:
1.1 dsieger 6212:
1.142 leot 6213: CONFLICTS= libXaw3d-[0-9]*
1.1 dsieger 6214:
1.142 leot 6215: pkg_add(1) is able to detect attempts to install packages that conflict with
6216: existing packages and abort. However, in many situations this is too late in
6217: the process. Binary package managers will not know about the conflict until
6218: they attempt to install the package after already downloading it and all its
6219: dependencies. Users may also waste time building a package and its dependencies
6220: only to find out at the end that it conflicts with another package they have
6221: installed.
6222:
6223: To avoid these issues CONFLICTS entries should be added in all cases where it
6224: is known that packages conflict with each other. These CONFLICTS entries are
6225: exported in pkg_summary(5) files and consumed by binary package managers to
6226: inform users that packages cannot be installed onto the target system.
1.1 dsieger 6227:
1.154 rillig 6228: 21.1.7. Packages that cannot or should not be built
1.1 dsieger 6229:
6230: There are several reasons why a package might be instructed to not build under
6231: certain circumstances. If the package builds and runs on most platforms, the
1.83 dholland 6232: exceptions should be noted with BROKEN_ON_PLATFORM. If the package builds and
6233: runs on a small handful of platforms, set BROKEN_EXCEPT_ON_PLATFORM instead.
6234: Both BROKEN_ON_PLATFORM and BROKEN_EXCEPT_ON_PLATFORM are OS triples
6235: (OS-version-platform) that can use glob-style wildcards.
6236:
1.114 maya 6237: If a package is not appropriate for some platforms (as opposed to merely
1.83 dholland 6238: broken), a different set of variables should be used as this affects failure
6239: reporting and statistics. If the package is appropriate for most platforms, the
6240: exceptions should be noted with NOT_FOR_PLATFORM. If the package is appropriate
6241: for only a small handful of platforms (often exactly one), set
6242: ONLY_FOR_PLATFORM instead. Both ONLY_FOR_PLATFORM and NOT_FOR_PLATFORM are OS
6243: triples (OS-version-platform) that can use glob-style wildcards.
1.1 dsieger 6244:
6245: Some packages are tightly bound to a specific version of an operating system,
6246: e.g. LKMs or sysutils/lsof. Such binary packages are not backwards compatible
6247: with other versions of the OS, and should be uploaded to a version specific
6248: directory on the FTP server. Mark these packages by setting OSVERSION_SPECIFIC
6249: to "yes". This variable is not currently used by any of the package system
6250: internals, but may be used in the future.
6251:
6252: If the package should be skipped (for example, because it provides
6253: functionality already provided by the system), set PKG_SKIP_REASON to a
6254: descriptive message. If the package should fail because some preconditions are
6255: not met, set PKG_FAIL_REASON to a descriptive message.
6256:
1.154 rillig 6257: 21.1.8. Packages which should not be deleted, once installed
1.1 dsieger 6258:
6259: To ensure that a package may not be deleted, once it has been installed, the
6260: PKG_PRESERVE definition should be set in the package Makefile. This will be
1.25 wiz 6261: carried into any binary package that is made from this pkgsrc entry. A "
6262: preserved" package will not be deleted using pkg_delete(1) unless the "-f"
1.1 dsieger 6263: option is used.
6264:
1.154 rillig 6265: 21.1.9. Handling packages with security problems
1.1 dsieger 6266:
1.247 wiz 6267: When a vulnerability is found, this should be noted in pkgsrc/doc/
6268: pkg-vulnerabilities. Entries in that file consist of three parts:
1.205 wiz 6269:
6270: * package version pattern
6271:
6272: * type of vulnerability (please cut'n'paste an existing one where possible)
6273:
6274: * URL providing additional information about the issue
6275:
6276: For the package version pattern please always use `<' to mark an upper bound
6277: (not `<='!). This will avoid possible problems due unrelated PKGREVISION bumps
6278: not related to security fixes. Lower bounds can be added too, using '>' or '>=
1.206 wiz 6279: '. For example, "foo>=1<1.2" would mark versions 1.0 (included) to 1.2
1.205 wiz 6280: (excluded) of "foo" as affected by the security issue.
6281:
6282: Entries should always be added at the bottom of the file.
6283:
6284: When fixing packages, please modify the upper bound of the corresponding entry.
6285: To continue the previous example, if a fix was backported to version 1.1nb2,
1.206 wiz 6286: change the previous pattern to "foo>=1<1.1nb2".
1.205 wiz 6287:
6288: To locally test a package version pattern against a PKGNAME you can use the
6289: pkg_admin pmatch command.
6290:
6291: The URL should be as permanent as possible and provide as much information
6292: about the issue as possible. CVE entries are preferred.
6293:
6294: After committing that file, ask pkgsrc-security@NetBSD.org to update the file
6295: on ftp.NetBSD.org.
1.1 dsieger 6296:
6297: After fixing the vulnerability by a patch, its PKGREVISION should be increased
6298: (this is of course not necessary if the problem is fixed by using a newer
1.32 wiz 6299: release of the software), and the pattern in the pkg-vulnerabilities file must
6300: be updated.
1.1 dsieger 6301:
6302: Also, if the fix should be applied to the stable pkgsrc branch, be sure to
6303: submit a pullup request!
6304:
6305: Binary packages already on ftp.NetBSD.org will be handled semi-automatically by
6306: a weekly cron job.
6307:
1.205 wiz 6308: In case a security issue is disputed, please contact
6309: pkgsrc-security@NetBSD.org.
6310:
1.154 rillig 6311: 21.1.10. How to handle incrementing versions when fixing an existing package
1.1 dsieger 6312:
6313: When making fixes to an existing package it can be useful to change the version
6314: number in PKGNAME. To avoid conflicting with future versions by the original
6315: author, a "nb1", "nb2", ... suffix can be used on package versions by setting
6316: PKGREVISION=1 (2, ...). The "nb" is treated like a "." by the package tools.
6317: e.g.
6318:
6319: DISTNAME= foo-17.42
6320: PKGREVISION= 9
6321:
6322: will result in a PKGNAME of "foo-17.42nb9". If you want to use the original
6323: value of PKGNAME without the "nbX" suffix, e.g. for setting DIST_SUBDIR, use
6324: PKGNAME_NOREV.
6325:
6326: When a new release of the package is released, the PKGREVISION should be
6327: removed, e.g. on a new minor release of the above package, things should be
6328: like:
6329:
6330: DISTNAME= foo-17.43
6331:
6332: PKGREVISION should be incremented for any non-trivial change in the resulting
6333: binary package. Without a PKGREVISION bump, someone with the previous version
6334: installed has no way of knowing that their package is out of date. Thus,
6335: changes without increasing PKGREVISION are essentially labeled "this is so
6336: trivial that no reasonable person would want to upgrade", and this is the rough
6337: test for when increasing PKGREVISION is appropriate. Examples of changes that
6338: do not merit increasing PKGREVISION are:
6339:
1.14 jmcneill 6340: * Changing HOMEPAGE, MAINTAINER, OWNER, or comments in Makefile.
1.1 dsieger 6341:
6342: * Changing build variables if the resulting binary package is the same.
6343:
6344: * Changing DESCR.
6345:
6346: * Adding PKG_OPTIONS if the default options don't change.
6347:
6348: Examples of changes that do merit an increase to PKGREVISION include:
6349:
6350: * Security fixes
6351:
6352: * Changes or additions to a patch file
6353:
6354: * Changes to the PLIST
6355:
1.12 weinem 6356: * A dependency is changed or renamed.
6357:
1.1 dsieger 6358: PKGREVISION must also be incremented when dependencies have ABI changes.
6359:
1.154 rillig 6360: 21.1.11. Substituting variable text in the package files (the SUBST framework)
1.1 dsieger 6361:
1.180 rillig 6362: When you want to replace the same text in multiple files, or multiple times in
6363: the same file, it is cumbersome to maintain a patch file for this. This is
6364: where the SUBST framework steps in. It provides an easy-to-use interface for
6365: replacing text in files. It just needs the following information:
1.172 rillig 6366:
1.180 rillig 6367: * In which phase of the package build cycle should the replacement happen?
1.172 rillig 6368:
1.180 rillig 6369: * In which files should the replacement happen?
1.172 rillig 6370:
6371: * Which text should be replaced with what?
6372:
1.180 rillig 6373: This information is encoded in a block of SUBST variables. A minimal example
6374: is:
6375:
6376: SUBST_CLASSES+= paths
6377: SUBST_STAGE.paths= pre-configure
6378: SUBST_FILES.paths= src/*.c
6379: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
6380:
6381: Translated into English, it means: In the pre-configure stage (that is, after
6382: applying the patches from the patches/ directory and before running the
6383: configure script and the portability check), replace the text /usr/local with
6384: the content of the variable PREFIX.
6385:
6386: Each SUBST block starts by appending an identifier to SUBST_CLASSES (note the +
6387: =). This identifier can be chosen freely by the package. If there should ever
6388: be duplicate identifiers, the pkgsrc infrastructure will catch this and fail
6389: early, so don't worry about name collisions.
6390:
6391: Except for SUBST_CLASSES, all variables in a SUBST block are parameterized
6392: using this identifier. In the remainder of this section, these parameterized
6393: variables are written as SUBST_STAGE.*.
6394:
6395: SUBST_CLASSES+= paths
6396: SUBST_STAGE.paths= pre-configure
6397: SUBST_MESSAGE.paths= Fixing absolute paths.
6398: SUBST_FILES.paths= src/*.c
6399: SUBST_FILES.paths+= scripts/*.sh
6400: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
6401: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
6402: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
6403:
6404: To get a complete picture about the SUBST substitutions, run bmake
6405: show-all-subst. If something doesn't work as expected, run pkglint on the
6406: package, which detects several typical mistakes surrounding the SUBST blocks.
6407: For any questions that might remain after this, have a look at mk/subst.mk.
6408:
6409: 21.1.11.1. Choosing the time where the substitutions happen
6410:
6411: The SUBST_STAGE.* is one of {pre,do,post}-
6412: {extract,patch,configure,build,test,install}. Of these, pre-configure is used
6413: most often, by far. The most popular stages are, in chronological order:
6414:
6415: post-extract
6416:
6417: The substitutions are applied immediately after the distfiles are
6418: extracted. Running bmake extract on the package will leave no traces of the
6419: original files.
6420:
6421: When the substitution applies to files for which there is also a patch in
6422: the patches/ directory, this means that the patches will be computed based
6423: on the result of the substitution. When these patches are sent to the
6424: upstream maintainer later, to be fixed in the upstream package, these
6425: patches may no longer match what the upstream author is used to. Because of
6426: this, pre-configure is often a better choice.
6427:
6428: pre-configure
6429:
6430: The substitutions are applied after the patches from the patches/
6431: directory. This makes it possible to run bmake patch on the package, after
6432: which the patches can be edited using the tools pkgvi and mkpatches from
6433: the pkgtools/pkgdiff package.
6434:
6435: When updating the patches, it is helpful to explicitly separate the bmake
6436: patch from the bmake configure, and to only edit the patches between these
6437: commands. Otherwise the substitutions from the SUBST block will end up in
6438: the patch file. When this happens in really obvious ways, pkglint will
6439: complain about patches that contain a hard-coded /usr/pkg instead of the
6440: correct and intended @PREFIX@, but it can only detect these really obvious
6441: cases.
6442:
6443: do-configure
6444:
6445: This stage should only be used if the package defines a pre-configure
6446: action itself, and the substitution must happen after that. Typical
6447: examples are packages that use the pre-configure stage to regenerate the
6448: GNU configure script from configure.ac.
6449:
6450: post-configure
6451:
6452: This stage is used to fix up any mistakes by the configure stage.
6453:
6454: pre-build
6455:
6456: This stage should only be used for substitutions that are clearly related
6457: to building the package, not for fixing the configuration. Substitutions
6458: for pathnames (such as replacing /usr/local with ${PREFIX}) or user names
6459: (such as replacing @MY_USER@ with the actual username) belong in
6460: pre-configure or post-configure instead.
6461:
6462: post-build
6463:
6464: Just as with pre-build, this stage should only be used for substitutions
6465: that are clearly related to building the package, not for fixing the
6466: configuration. Substitutions for pathnames (such as replacing /usr/local
6467: with ${PREFIX}) or user names (such as replacing @MY_USER@ with the actual
6468: username) belong in pre-configure or post-configure instead.
6469:
6470: A typical use is to update pkg-config files to include the rpath compiler
6471: options.
6472:
6473: pre-install
6474:
6475: In general, the install phase should be as simple as possible. As with the
6476: pre-build and post-build stages, it should not be used to fix pathnames or
6477: user names, these belong in pre-configure instead. There are only few
6478: legitimate use cases for applying substitutions in this stage.
6479:
1.181 rillig 6480: 21.1.11.2. Choosing the files where the substitutions happen
1.180 rillig 6481:
6482: The SUBST_FILES.* variable contains a list of filename patterns. These patterns
6483: are relative to WRKSRC since that is where most substitutions happen. A typical
6484: example is:
6485:
6486: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
6487:
6488: The above patterns, especially the last, are quite broad. The SUBST
6489: implementation checks that each filename pattern that is mentioned here has an
6490: effect. For example, if none of the */*/Makefile files contains the patterns to
6491: be found and substituted, that filename pattern is redundant and should be left
1.181 rillig 6492: out. By default, the SUBST framework will complain with an error message. If
6493: the text to be substituted occurs in some of the files from a single pattern,
6494: but not in all of them, that is totally ok, and the SUBST framework will only
6495: print an INFO message for those files.
1.180 rillig 6496:
6497: If there is a good reason for having redundant filename patterns, set
1.181 rillig 6498: SUBST_NOOP_OK.* to yes.
1.180 rillig 6499:
6500: Another popular way of choosing the files for the substitutions is via a shell
6501: command, like this:
6502:
1.181 rillig 6503: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 6504: SUBST_FILES.path= ${C_FILES_CMD:sh}
6505:
6506: The variable name C_FILES_CMD in this example is freely chosen and independent
6507: of the SUBST framework.
6508:
6509: In this variant, the SUBST_FILES.* variable lists each file individually.
6510: Thereby chances are higher that there are filename patterns in which no
6511: substitution happens. Since the SUBST framework cannot know whether the
6512: filename patterns in SUBST_FILES.* have been explicitly listed in the Makefile
6513: (where any redundant filename pattern would be suspicious) or been generated by
6514: a shell command (in which redundant filename patterns are more likely and to be
6515: expected), it will complain about these redundant filename patterns. Therefore,
6516: SUBST blocks that use a shell command to generate the list of filename patterns
6517: often need to set SUBST_NOOP_OK.* to yes.
6518:
6519: 21.1.11.3. Choosing what to substitute
6520:
6521: In most cases, the substitutions are given using one or more sed(1) commands,
6522: like this:
6523:
6524: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
6525:
6526: Each of the sed commands needs to be preceded by the -e option and should be
6527: specified on a line of its own, to avoid hiding short sed commands at the end
6528: of a line.
6529:
6530: Since the sed commands often contain shell metacharacters as the separator (the
6531: | in the above example), it is common to enclose them in single quotes.
6532:
6533: A common substitution is to replace placeholders of the form @VARNAME@ with
6534: their pkgsrc counterpart variable ${VARNAME}. A typical example is:
6535:
6536: SUBST_VARS.path= PREFIX
6537:
1.181 rillig 6538: This type of substitutions is typically done by the GNU configure scripts
6539: during the do-configure stage, but in some cases these need to be overridden.
6540: The same pattern is also used when a package defines patches that replace
6541: previously hard-coded paths like /usr/local with a @PREFIX@ placeholder first,
6542: which then gets substituted by the actual ${PREFIX} in the pre-configure stage.
6543: In many of these cases, it works equally well to just use the SUBST framework
6544: to directly replace /usr/local with ${PREFIX}, thereby omitting the
6545: intermediate patch file.
1.180 rillig 6546:
6547: If the above is not flexible enough, it is possible to not use sed at all for
6548: the substitution but to specify an entirely different command, like this:
6549:
6550: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
1.1 dsieger 6551:
1.180 rillig 6552: This is used for the few remaining packages in which the distributed files use
6553: Windows-style line endings that need to be converted to UNIX-style line
6554: endings.
1.1 dsieger 6555:
1.180 rillig 6556: 21.1.11.4. Other SUBST variables
1.172 rillig 6557:
1.180 rillig 6558: When a SUBST block is applied during a package build, a message is logged. The
6559: default message is fine for most purposes but can be overridden by setting
6560: SUBST_MESSAGE.* to an individual message.
1.1 dsieger 6561:
1.154 rillig 6562: 21.2. The fetch phase
1.1 dsieger 6563:
1.154 rillig 6564: 21.2.1. Packages whose distfiles aren't available for plain downloading
1.1 dsieger 6565:
6566: If you need to download from a dynamic URL you can set DYNAMIC_MASTER_SITES and
6567: a make fetch will call files/getsite.sh with the name of each file to download
6568: as an argument, expecting it to output the URL of the directory from which to
6569: download it. graphics/ns-cult3d is an example of this usage.
6570:
6571: If the download can't be automated, because the user must submit personal
6572: information to apply for a password, or must pay for the source, or whatever,
6573: you can set FETCH_MESSAGE to a list of lines that are displayed to the user
6574: before aborting the build. Example:
6575:
6576: FETCH_MESSAGE= "Please download the files"
6577: FETCH_MESSAGE+= " "${DISTFILES:Q}
6578: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
6579:
1.154 rillig 6580: 21.2.2. How to handle modified distfiles with the 'old' name
1.1 dsieger 6581:
6582: Sometimes authors of a software package make some modifications after the
6583: software was released, and they put up a new distfile without changing the
6584: package's version number. If a package is already in pkgsrc at that time, the
6585: checksum will no longer match. The contents of the new distfile should be
6586: compared against the old one before changing anything, to make sure the
6587: distfile was really updated on purpose, and that no trojan horse or so crept
6588: in. Please mention that the distfiles were compared and what was found in your
1.54 rodent 6589: commit message.
6590:
6591: Then, the correct way to work around this is to set DIST_SUBDIR to a unique
1.109 wiz 6592: directory name, usually based on PKGNAME_NOREV (but take care with python or
6593: ruby packages, where PKGNAME includes a variable prefix). All DISTFILES and
6594: PATCHFILES for this package will be put in that subdirectory of the local
1.154 rillig 6595: distfiles directory. (See Section 21.1.10, "How to handle incrementing versions
1.109 wiz 6596: when fixing an existing package" for more details.) In case this happens more
6597: often, PKGNAME can be used (thus including the nbX suffix) or a date stamp can
6598: be appended, like ${PKGNAME_NOREV}-YYYYMMDD.
1.54 rodent 6599:
6600: DIST_SUBDIR is also used when a distfile's name does not contain a version and
6601: the distfile is apt to change. In cases where the likelihood of this is very
6602: small, DIST_SUBDIR might not be required. Additionally, DIST_SUBDIR must not be
6603: removed unless the distfile name changes, even if a package is being moved or
6604: renamed.
6605:
6606: Do not forget regenerating the distinfo file after that, since it contains the
6607: DIST_SUBDIR path in the filenames. Also, increase the PKGREVISION if the
6608: installed package is different. Furthermore, a mail to the package's authors
6609: seems appropriate telling them that changing distfiles after releases without
6610: changing the file names is not good practice.
1.1 dsieger 6611:
1.154 rillig 6612: 21.2.3. Packages hosted on github.com
1.88 tnn 6613:
1.90 tnn 6614: Helper methods exist for packages hosted on github.com which will often have
6615: distfile names that clash with other packages, for example 1.0.tar.gz. Use one
6616: of the three recipes from below:
1.88 tnn 6617:
1.154 rillig 6618: 21.2.3.1. Fetch based on a tagged release
1.88 tnn 6619:
1.189 bacon 6620: If your distfile URL looks similar to https://github.com/username/example/
6621: archive/v1.0.zip, then you are packaging a tagged release.
1.88 tnn 6622:
1.189 bacon 6623: DISTNAME= example-1.0
1.90 tnn 6624: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 6625: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 6626: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 6627: EXTRACT_SUFX= .zip
6628:
1.230 gutterid 6629: Here, DISTNAME combined with use of GITHUB_TAG leads the file fetching
6630: infrastructure to save the resulting file locally as example-1.0.zip.
6631:
1.189 bacon 6632: 21.2.3.2. Fetch based on a specific commit before the first release
6633:
6634: If your distfile looks similar to https://github.com/username/example/archive/
6635: 988881adc9fc3655077dc2d4d757d480b5ea0e11 and is from a commit before the first
6636: release, then set the package version to 0.0.0.N, where N is the number of
6637: commits to the repository, and set GITHUB_TAG to the commit hash. This will
6638: (almost) ensure that the first tagged release will have a version greater than
6639: this one so that package upgrades will function properly.
6640:
6641: DISTNAME= example-0.0.0.347
6642: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6643: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
6644: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
6645:
6646: 21.2.3.3. Fetch based on a specific commit after a release
1.88 tnn 6647:
1.189 bacon 6648: If your distfile looks similar to https://github.com/username/example/archive/
6649: 988881adc9fc3655077dc2d4d757d480b5ea0e11 and is from a commit after a release,
6650: then include the last release version and the commit count since that release
6651: in the package version and set GITHUB_TAG to the commit hash. The latest
6652: release and commit count are shown in the output of "git describe --tags":
6653:
6654: # git clone https://github.com/username/example
6655: # cd example
6656: # git describe --tags
6657: 1.2.3-5-g988881a
1.88 tnn 6658:
1.189 bacon 6659: DISTNAME= example-1.2.3.5
6660: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6661: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 6662: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.88 tnn 6663:
1.189 bacon 6664: 21.2.3.4. Fetch based on release
1.88 tnn 6665:
1.189 bacon 6666: If your distfile URL looks similar to https://github.com/username/example/
6667: releases/download/rel-1.6/offensive-1.6.zip, then you are packaging a release.
1.88 tnn 6668:
1.90 tnn 6669: DISTNAME= offensive-1.6
1.88 tnn 6670: PKGNAME= ${DISTNAME:S/offensive/proper/}
1.90 tnn 6671: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 6672: GITHUB_PROJECT= example
1.90 tnn 6673: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
6674: EXTRACT_SUFX= .zip
1.88 tnn 6675:
1.154 rillig 6676: 21.3. The configure phase
1.1 dsieger 6677:
1.154 rillig 6678: 21.3.1. Shared libraries - libtool
1.1 dsieger 6679:
6680: pkgsrc supports many different machines, with different object formats like
6681: a.out and ELF, and varying abilities to do shared library and dynamic loading
6682: at all. To accompany this, varying commands and options have to be passed to
6683: the compiler, linker, etc. to get the Right Thing, which can be pretty annoying
6684: especially if you don't have all the machines at your hand to test things. The
6685: devel/libtool pkg can help here, as it just "knows" how to build both static
6686: and dynamic libraries from a set of source files, thus being
6687: platform-independent.
6688:
6689: Here's how to use libtool in a package in seven simple steps:
6690:
6691: 1. Add USE_LIBTOOL=yes to the package Makefile.
6692:
6693: 2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of "$
6694: {CC}". You could even add it to the definition of CC, if only libraries are
6695: being built in a given Makefile. This one command will build both PIC and
6696: non-PIC library objects, so you need not have separate shared and
6697: non-shared library rules.
6698:
6699: 3. For the linking of the library, remove any "ar", "ranlib", and "ld
6700: -Bshareable" commands, and instead use:
6701:
6702: ${LIBTOOL} --mode=link \
6703: ${CC} -o ${.TARGET:.a=.la} \
6704: ${OBJS:.o=.lo} \
6705: -rpath ${PREFIX}/lib \
6706: -version-info major:minor
6707:
6708: Note that the library is changed to have a .la extension, and the objects
6709: are changed to have a .lo extension. Change OBJS as necessary. This
6710: automatically creates all of the .a, .so.major.minor, and ELF symlinks (if
6711: necessary) in the build directory. Be sure to include "-version-info",
6712: especially when major and minor are zero, as libtool will otherwise strip
6713: off the shared library version.
6714:
6715: From the libtool manual:
6716:
6717: So, libtool library versions are described by three integers:
6718:
6719: CURRENT
6720: The most recent interface number that this library implements.
6721:
6722: REVISION
6723: The implementation number of the CURRENT interface.
6724:
6725: AGE
6726: The difference between the newest and oldest interfaces that
6727: this library implements. In other words, the library implements
6728: all the interface numbers in the range from number `CURRENT -
6729: AGE' to `CURRENT'.
6730:
6731: If two libraries have identical CURRENT and AGE numbers, then the
6732: dynamic linker chooses the library with the greater REVISION number.
6733:
6734: The "-release" option will produce different results for a.out and ELF
1.25 wiz 6735: (excluding symlinks) in only one case. An ELF library of the form "
6736: libfoo-release.so.x.y" will have a symlink of "libfoo.so.x.y" on an a.out
1.1 dsieger 6737: platform. This is handled automatically.
6738:
6739: The "-rpath argument" is the install directory of the library being built.
6740:
6741: In the PLIST, include only the .la file, the other files will be added
6742: automatically.
6743:
6744: 4. When linking shared object (.so) files, i.e. files that are loaded via
6745: dlopen(3), NOT shared libraries, use "-module -avoid-version" to prevent
6746: them getting version tacked on.
6747:
6748: The PLIST file gets the foo.so entry.
6749:
6750: 5. When linking programs that depend on these libraries before they are
6751: installed, preface the cc(1) or ld(1) line with "${LIBTOOL} --mode=link",
6752: and it will find the correct libraries (static or shared), but please be
6753: aware that libtool will not allow you to specify a relative path in -L
6754: (such as "-L../somelib"), because it expects you to change that argument to
6755: be the .la file. e.g.
6756:
6757: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
6758:
6759: should be changed to:
6760:
6761: ${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
6762:
6763: and it will do the right thing with the libraries.
6764:
6765: 6. When installing libraries, preface the install(1) or cp(1) command with "$
6766: {LIBTOOL} --mode=install", and change the library name to .la. e.g.
6767:
1.23 jakllsch 6768: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 6769:
6770: This will install the static .a, shared library, any needed symlinks, and
6771: run ldconfig(8).
6772:
6773: 7. In your PLIST, include only the .la file (this is a change from previous
6774: behaviour).
6775:
1.154 rillig 6776: 21.3.2. Using libtool on GNU packages that already support libtool
1.1 dsieger 6777:
6778: Add USE_LIBTOOL=yes to the package Makefile. This will override the package's
6779: own libtool in most cases. For older libtool using packages, libtool is made by
6780: ltconfig script during the do-configure step; you can check the libtool script
6781: location by doing make configure; find work*/ -name libtool.
6782:
6783: LIBTOOL_OVERRIDE specifies which libtool scripts, relative to WRKSRC, to
6784: override. By default, it is set to "libtool */libtool */*/libtool". If this
6785: does not match the location of the package's libtool script(s), set it as
6786: appropriate.
6787:
6788: If you do not need *.a static libraries built and installed, then use
6789: SHLIBTOOL_OVERRIDE instead.
6790:
6791: If your package makes use of the platform-independent library for loading
6792: dynamic shared objects, that comes with libtool (libltdl), you should include
6793: devel/libltdl/buildlink3.mk.
6794:
6795: Some packages use libtool incorrectly so that the package may not work or build
6796: in some circumstances. Some of the more common errors are:
6797:
6798: * The inclusion of a shared object (-module) as a dependent library in an
6799: executable or library. This in itself isn't a problem if one of two things
6800: has been done:
6801:
6802: 1. The shared object is named correctly, i.e. libfoo.la, not foo.la
6803:
6804: 2. The -dlopen option is used when linking an executable.
6805:
6806: * The use of libltdl without the correct calls to initialisation routines.
6807: The function lt_dlinit() should be called and the macro
6808: LTDL_SET_PRELOADED_SYMBOLS included in executables.
6809:
1.154 rillig 6810: 21.3.3. GNU Autoconf/Automake
1.1 dsieger 6811:
6812: If a package needs GNU autoconf or automake to be executed to regenerate the
1.223 nia 6813: configure script and Makefile.in makefile templates from configure.ac and
6814: Makefile.am, then they should be executed in a pre-configure target:
1.1 dsieger 6815:
1.223 nia 6816: USE_TOOLS+= autoconf automake autoreconf
6817: GNU_CONFIGURE= yes
1.1 dsieger 6818: ...
6819:
6820: pre-configure:
1.223 nia 6821: set -e; cd ${WRKSRC} && autoreconf -fi
1.1 dsieger 6822: ...
6823:
1.223 nia 6824: Packages which use GNU Automake will sometimes require GNU Make (gmake in
6825: USE_TOOLS), but not always. Note that autoreconf only needs to be executed if
6826: configure.ac or Makefiles are modified, or configure is not present.
1.1 dsieger 6827:
6828: There are times when the configure process makes additional changes to the
6829: generated files, which then causes the build process to try to re-execute the
6830: automake sequence. This is prevented by touching various files in the configure
6831: stage. If this causes problems with your package you can set AUTOMAKE_OVERRIDE=
6832: NO in the package Makefile.
6833:
1.223 nia 6834: 21.3.4. Meson / ninja
6835:
6836: Packages using Meson to configure need to include:
6837:
6838: .include "../../devel/meson/build.mk"
6839:
6840: In nearly all cases (any program with dependencies), pkg-config needs to be
6841: added to USE_TOOLS. If the package installs translation files for non-English
6842: languages, also add msgfmt and xgettext:
6843:
6844: USE_TOOLS+= pkg-config msgfmt xgettext
6845:
6846: If any options need to be passed to Meson, use MESON_ARGS instead of
6847: CONFIGURE_ARGS:
6848:
6849: MESON_ARGS+= -Dx11=false
6850:
1.154 rillig 6851: 21.4. Programming languages
1.1 dsieger 6852:
1.154 rillig 6853: 21.4.1. C, C++, and Fortran
1.1 dsieger 6854:
1.244 gutterid 6855: Compilers for the C and C++ languages come with the NetBSD base system. By
1.223 nia 6856: default, pkgsrc assumes that a package is written in C and will hide all other
6857: compilers (via the wrapper framework, see Chapter 18, Buildlink methodology).
1.1 dsieger 6858:
1.243 gutterid 6859: To declare which languages should be made available through pkgsrc's compiler
6860: wrappers, use the USE_LANGUAGES variable. Allowed values currently are:
1.212 wiz 6861:
1.244 gutterid 6862: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.212 wiz 6863:
6864: (and any combination). The default is "c". Packages using GNU configure
6865: scripts, even if written in C++, usually need a C compiler for the configure
1.244 gutterid 6866: phase.
1.243 gutterid 6867:
6868: To declare which features a package requies from the compiler, set either
6869: USE_CC_FEATURES or USE_CXX_FEATURES. Allowed values for USE_CC_FEATURES are
6870: currently:
6871:
6872: c11, c99, has_include
6873:
6874: Allowed values for USE_CXX_FEATURES are currently:
6875:
6876: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
6877: charconv, parallelism_ts, unique_ptr, put_time,
6878: is_trivially_copy_constructible
1.1 dsieger 6879:
1.244 gutterid 6880: Language variants like gnu99 and c++11 can be specified in FORCE_C_STD and
6881: FORCE_CXX_STD if the package does not explicitly set -std=... when compiling
6882: (i.e. the package assumes the compiler defaults to C++11 or some other
6883: standard). This is a common bug in upstream build systems.
6884:
6885: Allowed values for FORCE_C_STD are currently:
6886:
6887: c90, c99, c11, gnu90, gnu99, gnu11
6888:
6889: Allowed values for FORCE_CXX_STD are currently:
6890:
6891: c++03, c++11, c++14, c++17, c++20,
6892: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
6893:
1.154 rillig 6894: 21.4.2. Java
1.1 dsieger 6895:
6896: If a program is written in Java, use the Java framework in pkgsrc. The package
6897: must include ../../mk/java-vm.mk. This Makefile fragment provides the following
6898: variables:
6899:
6900: * USE_JAVA defines if a build dependency on the JDK is added. If USE_JAVA is
6901: set to "run", then there is only a runtime dependency on the JDK. The
6902: default is "yes", which also adds a build dependency on the JDK.
6903:
6904: * Set USE_JAVA2 to declare that a package needs a Java2 implementation. The
6905: supported values are "yes", "1.4", and "1.5". "yes" accepts any Java2
6906: implementation, "1.4" insists on versions 1.4 or above, and "1.5" only
6907: accepts versions 1.5 or above. This variable is not set by default.
6908:
1.25 wiz 6909: * PKG_JAVA_HOME is automatically set to the runtime location of the used Java
6910: implementation dependency. It may be used to set JAVA_HOME to a good value
6911: if the program needs this variable to be defined.
6912:
1.205 wiz 6913: 21.4.3. Go
6914:
6915: If a program is written in Go and has any dependencies on other Go modules,
6916: have the package include ../../lang/go/go-module.mk.
6917:
6918: 1. Generate a list of those dependencies with make clean && make patch && make
6919: show-go-modules > go-modules.mk.
6920:
1.223 nia 6921: 2. Prepend .include "go-modules.mk" to any other .includes.
6922:
6923: 3. Incorporate these modules in distinfo with make makesum.
1.205 wiz 6924:
1.223 nia 6925: 21.4.4. Rust
1.205 wiz 6926:
1.223 nia 6927: If a program is written in Rust and uses Cargo to build, have the package
6928: include ../../lang/rust/cargo.mk.
1.205 wiz 6929:
1.223 nia 6930: 1. Generate a list of those dependencies with make CARGO_ARGS="build
6931: --release" build && make print-cargo-depends > cargo-depends.mk.
1.205 wiz 6932:
1.223 nia 6933: 2. Prepend .include "cargo-depends.mk" to any other .includes.
1.205 wiz 6934:
6935: 3. Incorporate these modules in distinfo with make makesum.
6936:
1.223 nia 6937: 21.4.5. Packages containing Perl scripts
1.1 dsieger 6938:
1.203 nia 6939: If your package contains interpreted Perl scripts, add "perl" to the USE_TOOLS
1.1 dsieger 6940: variable and set REPLACE_PERL to ensure that the proper interpreter path is
6941: set. REPLACE_PERL should contain a list of scripts, relative to WRKSRC, that
1.74 wiz 6942: you want adjusted. Every occurrence of */bin/perl in a she-bang line will be
1.210 gutterid 6943: replaced with the full path to the Perl executable.
1.1 dsieger 6944:
1.210 gutterid 6945: If a particular version of Perl is needed, set the PERL5_REQD variable to the
1.1 dsieger 6946: version number. The default is "5.0".
6947:
1.203 nia 6948: See Section 21.6.6, "Packages installing Perl modules" for information about
1.210 gutterid 6949: handling Perl modules.
6950:
6951: There is also the REPLACE_PERL6 variable for the language now known as Raku.
1.1 dsieger 6952:
1.223 nia 6953: 21.4.6. Packages containing shell scripts
1.41 wiz 6954:
6955: REPLACE_SH, REPLACE_BASH, REPLACE_CSH, and REPLACE_KSH can be used to replace
1.225 gutterid 6956: shell she-bangs in files. Please use the appropriate one, preferring REPLACE_SH
6957: when this shell is sufficient. Each should contain a list of scripts, relative
6958: to WRKSRC, that you want adjusted. Every occurrence of the matching shell in a
6959: she-bang line will be replaced with the full path to the shell executable. When
6960: using REPLACE_BASH, don't forget to add bash to USE_TOOLS.
1.41 wiz 6961:
1.223 nia 6962: 21.4.7. Other programming languages
1.1 dsieger 6963:
1.210 gutterid 6964: There are further similar REPLACE variables available, e.g., REPLACE_AWK for
6965: packages containing awk scripts, and REPLACE_R for R. These two, like the
1.211 gutterid 6966: others noted above, have their actions defined centrally in mk/configure/
6967: replace-interpreter.mk. Other languages define the actions of these variables
6968: within their own dedicated part of the tree, e.g., REPLACE_PHP is actioned in
1.245 gutterid 6969: lang/php/replace.mk, and REPLACE_PYTHON is actioned in lang/python/
1.211 gutterid 6970: application.mk. For other languages, consult the mk files found within their
1.216 gutterid 6971: specific directories (the naming convention varies), or check the list found in
6972: Appendix E, Help topics.
1.210 gutterid 6973:
6974: Currently, special handling for other languages varies in pkgsrc. If a compiler
6975: package provides a buildlink3.mk file, include that, otherwise just add a
6976: (build) dependency on the appropriate compiler package.
1.1 dsieger 6977:
1.154 rillig 6978: 21.5. The build phase
1.1 dsieger 6979:
6980: The most common failures when building a package are that some platforms do not
6981: provide certain header files, functions or libraries, or they provide the
6982: functions in a library that the original package author didn't know. To work
6983: around this, you can rewrite the source code in most cases so that it does not
6984: use the missing functions or provides a replacement function.
6985:
1.154 rillig 6986: 21.5.1. Compiling C and C++ code conditionally
1.1 dsieger 6987:
6988: If a package already comes with a GNU configure script, the preferred way to
6989: fix the build failure is to change the configure script, not the code. In the
6990: other cases, you can utilize the C preprocessor, which defines certain macros
6991: depending on the operating system and hardware architecture it compiles for.
6992: These macros can be queried using for example #if defined(__i386). Almost every
6993: operating system, hardware architecture and compiler has its own macro. For
6994: example, if the macros __GNUC__, __i386__ and __NetBSD__ are all defined, you
6995: know that you are using NetBSD on an i386 compatible CPU, and your compiler is
6996: GCC.
6997:
6998: The list of the following macros for hardware and operating system depends on
6999: the compiler that is used. For example, if you want to conditionally compile
7000: code on Solaris, don't use __sun__, as the SunPro compiler does not define it.
7001: Use __sun instead.
7002:
1.154 rillig 7003: 21.5.1.1. C preprocessor macros to identify the operating system
1.1 dsieger 7004:
1.223 nia 7005: To distinguish between specific NetBSD versions, you should use the following
7006: code.
7007:
7008: #ifdef __NetBSD__
7009: #include <sys/param.h>
7010: #if __NetBSD_Prereq__(9,99,17)
7011: /* use a newer feature */
7012: #else
7013: /* older code */
7014: #endif
7015: #endif
7016:
7017: #ifndef _WIN32
7018: /* Unix-like specific code */
7019: #endif
7020:
1.1 dsieger 7021: To distinguish between 4.4 BSD-derived systems and the rest of the world, you
7022: should use the following code.
7023:
7024: #include <sys/param.h>
7025: #if (defined(BSD) && BSD >= 199306)
7026: /* BSD-specific code goes here */
7027: #else
7028: /* non-BSD-specific code goes here */
7029: #endif
7030:
1.223 nia 7031: You can also test for the following macros:
1.1 dsieger 7032:
1.46 obache 7033: Cygwin __CYGWIN__
7034: DragonFly __DragonFly__
1.1 dsieger 7035: FreeBSD __FreeBSD__
1.46 obache 7036: Haiku __HAIKU__
1.1 dsieger 7037: Interix __INTERIX
7038: IRIX __sgi (TODO: get a definite source for this)
1.223 nia 7039: Linux __linux
1.83 dholland 7040: Mac OS X __APPLE__
1.46 obache 7041: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7042: Minix3 __minix
1.1 dsieger 7043: NetBSD __NetBSD__
7044: OpenBSD __OpenBSD__
7045: Solaris sun, __sun
7046:
1.154 rillig 7047: 21.5.1.2. C preprocessor macros to identify the hardware architecture
1.1 dsieger 7048:
7049: i386 i386, __i386, __i386__
1.223 nia 7050: x86-64 __amd64__, __x86_64__
7051: ARM __arm__
1.1 dsieger 7052: MIPS __mips
7053: SPARC sparc, __sparc
1.223 nia 7054: PowerPC __powerpc
1.1 dsieger 7055:
1.154 rillig 7056: 21.5.1.3. C preprocessor macros to identify the compiler
1.1 dsieger 7057:
7058: GCC __GNUC__ (major version), __GNUC_MINOR__
7059: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7060: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7061: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7062:
1.154 rillig 7063: 21.5.2. How to handle compiler bugs
1.1 dsieger 7064:
7065: Some source files trigger bugs in the compiler, based on combinations of
7066: compiler version and architecture and almost always relation to optimisation
7067: being enabled. Common symptoms are gcc internal errors or never finishing
7068: compiling a file.
7069:
7070: Typically, a workaround involves testing the MACHINE_ARCH and compiler version,
1.87 tnn 7071: disabling optimisation for that combination of file, MACHINE_ARCH and compiler.
7072:
7073: This used to be a big problem in the past, but is rarely needed now as compiler
7074: technology has matured. If you still need to add a compiler specific
7075: workaround, please do so in the file hacks.mk and describe the symptom and
7076: compiler version as detailed as possible.
1.1 dsieger 7077:
1.172 rillig 7078: 21.5.3. No such file or directory
7079:
7080: Compilation sometimes fails with an error message like this:
7081:
7082: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
7083: fatal error: pango/pango.h: No such file or directory
7084:
7085: The proper way to fix this problem depends on the type of the header, which is
7086: described in the following sections.
7087:
7088: 21.5.3.1. Headers from other packages
7089:
7090: If the header name looks like it comes from a different package, that other
7091: package should be included via the buildlink3 framework.
7092:
7093: First, look whether the header is somewhere in the buildlink3 directory below
7094: WRKDIR. In the above case of the missing Pango header:
7095:
7096: $ find work/.buildlink/ -print | grep -F pango/pango.h
7097:
7098: In the case of Pango, the output is:
7099:
7100: work/.buildlink/include/pango-1.0/pango/pango.h
7101:
7102: If the pango/pango.h file were placed directly in the .buildlink directory, it
7103: would have been found automatically. There is an extra pango-1.0 path component
7104: though, which means that the compiler command line must contain an option of
7105: the form -I${BUILDLINK3_PREFIX.pango}/include/pango-1.0. In most cases this
7106: option is generated by the configure script, which can be examined using:
7107:
7108: $ $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
7109: -I/usr/pkg/include/pango-1.0
7110: -I/usr/pkg/include/pango-1.0
7111: -I/usr/pkg/include/pango-1.0
7112: -I/usr/pkg/include/pango-1.0
7113: -I/usr/pkg/include/pango-1.0
7114:
7115: This looks good. These options are transformed by the buildlink wrapper to
7116: refer to the correct path inside work/.buildlink.
7117:
7118: Since the compilation fails though, examine the compiler command lines in work
7119: /.work.log to see whether the -I option is included in the particular command
7120: line.
7121:
7122: To further analyze the situation, run bmake build-env, which sets up an
7123: interactive, realistic environment including all the pkgsrc wrapper commands
7124: and environment variables. From there, try to compile some simple example
7125: programs that use the header.
7126:
7127: 21.5.3.2. Headers generated during the build
7128:
7129: If the name of the header seems to come from the package itself, and if the
7130: build is run with parallel jobs, the package may have some undeclared
7131: dependencies between the .c and the .h files, and a C file is compiled before
7132: its required header is generated.
7133:
7134: To see whether the build runs with parallel jobs, run bmake show-all-build |
7135: grep JOBS. Its output looks like this:
7136:
7137: usr MAKE_JOBS= 7
7138: pkg MAKE_JOBS_SAFE # undefined
7139: def _MAKE_JOBS_N= 7
7140:
7141: In this case the pkgsrc user has asked pkgsrc to build packages with 7 jobs in
7142: parallel (MAKE_JOBS). The package could have disabled parallel builds by
7143: setting MAKE_JOBS_SAFE to no, but in this case it hasn't.
7144:
7145: To see whether the build failure is caused by parallel builds, first save the
7146: exact error message and a bit of context, maybe you need it later for reporting
7147: a bug. Next, run:
7148:
7149: MAKE_JOBS_SAFE=no bmake clean build
7150:
7151: If that succeeds, file a bug report against the pkgsrc package, including the
7152: exact error message and the contents of your mk.conf file.
7153:
1.173 rillig 7154: 21.5.3.3. Symlinks
7155:
7156: Pkgsrc does not work reliably if any of LOCALBASE, VARBASE or WRKDIR contains a
7157: symlink. Since 2019Q2, the pkgsrc bootstrap program prevents installing pkgsrc
7158: in symlink-based directories. Existing pkgsrc installations are not checked for
7159: symlinks though.
7160:
7161: The "No such file or directory" error messages are a typical symptom of
7162: symlinks, and it's quite difficult to find out that this is the actual cause.
7163:
7164: 21.5.3.4. Stale working directories
7165:
7166: When building a hierarchy of packages, it may happen that one package is built
7167: and then pkgsrc is updated. This situation can provoke various hard to diagnose
7168: build errors. To clean up the situation:
7169:
1.223 nia 7170: $ (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.173 rillig 7171:
1.223 nia 7172: (The only purpose of the bsd.pkg.mk is to prevent running this command in the
7173: wrong directory.)
1.173 rillig 7174:
7175: If you have set WRKOBJDIR in mk.conf, remove that directory as well.
7176:
7177: 21.5.3.5. Other possible reasons
7178:
7179: On platforms other than BSD, third-party packages are installed in /usr/
7180: include, together with the base system. This means that pkgsrc cannot
7181: distinguish between headers provided by the base system (which it needs) and
7182: headers from third-party packages (which are often included in pkgsrc as well).
7183: This can lead to subtle version mismatches.
7184:
7185: In pkgsrc installations that have been active for several years, it may happen
7186: that some files are manually deleted. To exclude this unlikely reason, run
7187: pkg_admin check.
7188:
7189: It may help to run pkg_admin rebuild-tree to check/fix dependencies.
7190:
7191: If all of the above doesn't help, see Chapter 2, Getting help for contact
7192: information. Be prepared to describe what you have tried so far and what any
7193: error messages were.
7194:
1.172 rillig 7195: 21.5.4. Undefined reference to "..."
1.1 dsieger 7196:
7197: This error message often means that a package did not link to a shared library
7198: it needs. The following functions are known to cause this error message over
7199: and over.
7200:
7201: +-----------------------------------------------------+
7202: | Function |Library |Affected platforms|
7203: |-------------------------+--------+------------------|
7204: |accept, bind, connect |-lsocket|Solaris |
7205: |-------------------------+--------+------------------|
7206: |crypt |-lcrypt |DragonFly, NetBSD |
7207: |-------------------------+--------+------------------|
7208: |dlopen, dlsym |-ldl |Linux |
7209: |-------------------------+--------+------------------|
7210: |gethost* |-lnsl |Solaris |
7211: |-------------------------+--------+------------------|
7212: |inet_aton |-lresolv|Solaris |
7213: |-------------------------+--------+------------------|
7214: |nanosleep, sem_*, timer_*|-lrt |Solaris |
7215: |-------------------------+--------+------------------|
7216: |openpty |-lutil |Linux |
7217: +-----------------------------------------------------+
7218:
1.223 nia 7219: To fix these linker errors, it is often sufficient to add LIBS.OperatingSystem+
7220: = -lfoo to the package Makefile and then run bmake clean; bmake.
1.1 dsieger 7221:
1.223 nia 7222: 21.5.4.1. The SunPro compiler and inline functions
1.1 dsieger 7223:
7224: When you are using the SunPro compiler, there is another possibility. That
7225: compiler cannot handle the following code:
7226:
7227: extern int extern_func(int);
7228:
7229: static inline int
7230: inline_func(int x)
7231: {
7232: return extern_func(x);
7233: }
7234:
7235: int main(void)
7236: {
7237: return 0;
7238: }
7239:
7240: It generates the code for inline_func even if that function is never used. This
7241: code then refers to extern_func, which can usually not be resolved. To solve
7242: this problem you can try to tell the package to disable inlining of functions.
7243:
1.228 gutterid 7244: 21.5.4.2. Missing atomic functions
7245:
7246: When building for older machine architectures (e.g., i386, PowerPC), builds may
7247: fail because the package expects modern 64-bit atomic functions which the
7248: underlying hardware either doesn't support, or will only support with specific
7249: compiler flags. This is generally handled via inclusion of mk/atomic64.mk.
7250:
1.172 rillig 7251: 21.5.5. Running out of memory
1.1 dsieger 7252:
7253: Sometimes packages fail to build because the compiler runs into an operating
7254: system specific soft limit. With the UNLIMIT_RESOURCES variable pkgsrc can be
1.223 nia 7255: told to unlimit the resources. The allowed values are any combination of "
7256: cputime", "datasize", "memorysize", "stacksize" and "virtualsize". Setting this
7257: variable is similar to running the shell builtin ulimit command to raise the
7258: maximum data segment size or maximum stack size of a process, respectively, to
7259: their hard limits.
1.1 dsieger 7260:
1.154 rillig 7261: 21.6. The install phase
1.1 dsieger 7262:
1.154 rillig 7263: 21.6.1. Creating needed directories
1.1 dsieger 7264:
7265: The BSD-compatible install supplied with some operating systems cannot create
7266: more than one directory at a time. As such, you should call ${INSTALL_*_DIR}
7267: like this:
7268:
7269: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7270: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
7271:
1.223 nia 7272: Instead of running the install commands directly, you can also append "dir1
7273: dir2" to the INSTALLATION_DIRS variable, which will automatically do the right
7274: thing.
1.1 dsieger 7275:
1.154 rillig 7276: 21.6.2. Where to install documentation
1.1 dsieger 7277:
7278: In general, documentation should be installed into ${PREFIX}/share/doc/$
1.223 nia 7279: {PKGBASE} or ${PREFIX}/share/doc/${PKGNAME_NOREV} (the latter includes the
7280: version number of the package).
1.1 dsieger 7281:
7282: Many modern packages using GNU autoconf allow to set the directory where HTML
7283: documentation is installed with the "--with-html-dir" option. Sometimes using
7284: this flag is needed because otherwise the documentation ends up in ${PREFIX}/
1.223 nia 7285: share/doc/html or other places. In pkgsrc, the HTML documentation should go
7286: into the package-specific directory, just like any other documentation.
1.1 dsieger 7287:
7288: An exception to the above is that library API documentation generated with the
7289: textproc/gtk-doc tools, for use by special browsers (devhelp) should be left at
7290: their default location, which is ${PREFIX}/share/gtk-doc. Such documentation
7291: can be recognized from files ending in .devhelp or .devhelp2. (It is also
7292: acceptable to install such files in ${PREFIX}/share/doc/${PKGBASE} or ${PREFIX}
7293: /share/doc/${PKGNAME}; the .devhelp* file must be directly in that directory
7294: then, no additional subdirectory level is allowed in this case. This is usually
7295: achieved by using "--with-html-dir=${PREFIX}/share/doc". ${PREFIX}/share/
7296: gtk-doc is preferred though.)
7297:
1.154 rillig 7298: 21.6.3. Installing highscore files
1.1 dsieger 7299:
7300: Certain packages, most of them in the games category, install a score file that
7301: allows all users on the system to record their highscores. In order for this to
7302: work, the binaries need to be installed setgid and the score files owned by the
1.36 wiz 7303: appropriate group and/or owner (traditionally the "games" user/group). Set
7304: USE_GAMESGROUP to yes to support this. The following variables, documented in
7305: more detail in mk/defaults/mk.conf, control this behaviour: GAMEDATAMODE,
1.100 leot 7306: GAMEDIRMODE, GAMES_GROUP, GAMEMODE, GAME_USER. Other useful variables are:
7307: GAMEDIR_PERMS, GAMEDATA_PERMS and SETGID_GAMES_PERMS.
7308:
7309: An example that illustrates some of the variables described above is games/
7310: moon-buggy. OWN_DIRS_PERMS is used to properly set directory permissions of the
7311: directory where the scorefile is saved, REQD_FILES_PERMS is used to create a
7312: dummy scorefile (mbscore) with the proper permissions and SPECIAL_PERMS is used
7313: to install setgid the game binary:
7314:
7315: USE_GAMESGROUP= yes
7316:
7317: BUILD_DEFS+= VARBASE
7318:
7319: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
7320: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
7321: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
7322:
7323: Various INSTALL_* variables are also available: INSTALL_GAME to install setgid
7324: game binaries, INSTALL_GAME_DIR to install game directories that are needed to
7325: be accessed by setgid games and INSTALL_GAME_DATA to install scorefiles.
1.1 dsieger 7326:
1.14 jmcneill 7327: A package should therefore never hard code file ownership or access permissions
1.100 leot 7328: but rely on *_PERMS as described above or alternatively on INSTALL_GAME,
7329: INSTALL_GAME_DATA and INSTALL_GAME_DIR to set these correctly.
1.1 dsieger 7330:
1.154 rillig 7331: 21.6.4. Adding DESTDIR support to packages
1.4 rillig 7332:
1.14 jmcneill 7333: DESTDIR support means that a package installs into a staging directory, not the
7334: final location of the files. Then a binary package is created which can be used
7335: for installation as usual. There are two ways: Either the package must install
1.25 wiz 7336: as root ("destdir") or the package can install as non-root user ("user-destdir"
7337: ).
1.14 jmcneill 7338:
1.113 leot 7339: * PKG_DESTDIR_SUPPORT has to be set to "destdir" or "user-destdir". By
7340: default PKG_DESTDIR_SUPPORT is set to "user-destdir" to help catching more
7341: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
7342: PKG_DESTDIR_SUPPORT needs to be set before the inclusion.
1.14 jmcneill 7343:
1.4 rillig 7344: * All installation operations have to be prefixed with ${DESTDIR}.
7345:
7346: * automake gets this DESTDIR mostly right automatically. Many manual rules
7347: and pre/post-install often are incorrect; fix them.
7348:
1.17 imil 7349: * If files are installed with special owner/group use SPECIAL_PERMS.
1.4 rillig 7350:
7351: * In general, packages should support UNPRIVILEGED to be able to use DESTDIR.
7352:
1.154 rillig 7353: 21.6.5. Packages with hardcoded paths to other interpreters
1.1 dsieger 7354:
7355: Your package may also contain scripts with hardcoded paths to other
1.203 nia 7356: interpreters besides (or as well as) Perl. To correct the full pathname to the
1.1 dsieger 7357: script interpreter, you need to set the following definitions in your Makefile
7358: (we shall use tclsh in this example):
7359:
7360: REPLACE_INTERPRETER+= tcl
7361: REPLACE.tcl.old= .*/bin/tclsh
7362: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
7363: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
7364: # relative to ${WRKSRC}, just as in REPLACE_PERL
7365:
1.203 nia 7366: 21.6.6. Packages installing Perl modules
1.1 dsieger 7367:
7368: Makefiles of packages providing perl5 modules should include the Makefile
7369: fragment ../../lang/perl5/module.mk. It provides a do-configure target for the
7370: standard perl configuration for such modules as well as various hooks to tune
7371: this configuration. See comments in this file for details.
7372:
7373: Perl5 modules will install into different places depending on the version of
7374: perl used during the build process. To address this, pkgsrc will append lines
7375: to the PLIST corresponding to the files listed in the installed .packlist file
7376: generated by most perl5 modules. This is invoked by defining PERL5_PACKLIST to
1.48 wiz 7377: a space-separated list of packlist files relative to PERL5_PACKLIST_DIR
7378: (PERL5_INSTALLVENDORARCH by default), e.g.:
1.1 dsieger 7379:
1.48 wiz 7380: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 7381:
1.48 wiz 7382: The perl5 config variables installarchlib, installscript, installvendorbin,
7383: installvendorscript, installvendorarch, installvendorlib, installvendorman1dir,
7384: and installvendorman3dir represent those locations in which components of perl5
7385: modules may be installed, provided as variable with uppercase and prefixed with
7386: PERL5_, e.g. PERL5_INSTALLARCHLIB and may be used by perl5 packages that don't
7387: have a packlist. These variables are also substituted for in the PLIST as
7388: uppercase prefixed with PERL5_SUB_.
1.1 dsieger 7389:
1.154 rillig 7390: 21.6.7. Packages installing info files
1.1 dsieger 7391:
7392: Some packages install info files or use the "makeinfo" or "install-info"
7393: commands. INFO_FILES should be defined in the package Makefile so that INSTALL
7394: and DEINSTALL scripts will be generated to handle registration of the info
7395: files in the Info directory file. The "install-info" command used for the info
7396: files registration is either provided by the system, or by a special purpose
7397: package automatically added as dependency if needed.
7398:
7399: PKGINFODIR is the directory under ${PREFIX} where info files are primarily
7400: located. PKGINFODIR defaults to "info" and can be overridden by the user.
7401:
7402: The info files for the package should be listed in the package PLIST; however
7403: any split info files need not be listed.
7404:
7405: A package which needs the "makeinfo" command at build time must add "makeinfo"
7406: to USE_TOOLS in its Makefile. If a minimum version of the "makeinfo" command is
7407: needed it should be noted with the TEXINFO_REQD variable in the package
7408: Makefile. By default, a minimum version of 3.12 is required. If the system does
7409: not provide a makeinfo command or if it does not match the required minimum, a
7410: build dependency on the devel/gtexinfo package will be added automatically.
7411:
7412: The build and installation process of the software provided by the package
7413: should not use the install-info command as the registration of info files is
1.25 wiz 7414: the task of the package INSTALL script, and it must use the appropriate
1.1 dsieger 7415: makeinfo command.
7416:
7417: To achieve this goal, the pkgsrc infrastructure creates overriding scripts for
7418: the install-info and makeinfo commands in a directory listed early in PATH.
7419:
7420: The script overriding install-info has no effect except the logging of a
7421: message. The script overriding makeinfo logs a message and according to the
7422: value of TEXINFO_REQD either runs the appropriate makeinfo command or exit on
7423: error.
7424:
1.154 rillig 7425: 21.6.8. Packages installing man pages
1.1 dsieger 7426:
7427: All packages that install manual pages should install them into the same
7428: directory, so that there is one common place to look for them. In pkgsrc, this
7429: place is ${PREFIX}/${PKGMANDIR}, and this expression should be used in
1.25 wiz 7430: packages. The default for PKGMANDIR is "man". Another often-used value is "
7431: share/man".
1.1 dsieger 7432:
7433: Note
7434:
7435: The support for a custom PKGMANDIR is far from complete.
7436:
7437: The PLIST files can just use man/ as the top level directory for the man page
7438: file entries, and the pkgsrc framework will convert as needed. In all other
7439: places, the correct PKGMANDIR must be used.
7440:
7441: Packages that are configured with GNU_CONFIGURE set as "yes", by default will
7442: use the ./configure --mandir switch to set where the man pages should be
7443: installed. The path is GNU_CONFIGURE_MANDIR which defaults to ${PREFIX}/$
7444: {PKGMANDIR}.
7445:
7446: Packages that use GNU_CONFIGURE but do not use --mandir, can set
7447: CONFIGURE_HAS_MANDIR to "no". Or if the ./configure script uses a non-standard
7448: use of --mandir, you can set GNU_CONFIGURE_MANDIR as needed.
7449:
1.184 rillig 7450: See Section 19.5, "Man page compression" for information on installation of
1.1 dsieger 7451: compressed manual pages.
7452:
1.203 nia 7453: 21.6.9. Packages installing X11 fonts
1.1 dsieger 7454:
7455: If a package installs font files, you will need to rebuild the fonts database
7456: in the directory where they get installed at installation and deinstallation
7457: time. This can be automatically done by using the pkginstall framework.
7458:
7459: You can list the directories where fonts are installed in the FONTS_DIRS.type
7460: variables, where type can be one of "ttf", "type1" or "x11". Also make sure
7461: that the database file fonts.dir is not listed in the PLIST.
7462:
7463: Note that you should not create new directories for fonts; instead use the
7464: standard ones to avoid that the user needs to manually configure his X server
7465: to find them.
7466:
1.203 nia 7467: 21.6.10. Packages installing SGML or XML data
1.1 dsieger 7468:
7469: If a package installs SGML or XML data files that need to be registered in
7470: system-wide catalogs (like DTDs, sub-catalogs, etc.), you need to take some
7471: extra steps:
7472:
7473: 1. Include ../../textproc/xmlcatmgr/catalogs.mk in your Makefile, which takes
7474: care of registering those files in system-wide catalogs at installation and
7475: deinstallation time.
7476:
7477: 2. Set SGML_CATALOGS to the full path of any SGML catalogs installed by the
7478: package.
7479:
7480: 3. Set XML_CATALOGS to the full path of any XML catalogs installed by the
7481: package.
7482:
7483: 4. Set SGML_ENTRIES to individual entries to be added to the SGML catalog.
7484: These come in groups of three strings; see xmlcatmgr(1) for more
7485: information (specifically, arguments recognized by the 'add' action). Note
7486: that you will normally not use this variable.
7487:
7488: 5. Set XML_ENTRIES to individual entries to be added to the XML catalog. These
7489: come in groups of three strings; see xmlcatmgr(1) for more information
7490: (specifically, arguments recognized by the 'add' action). Note that you
7491: will normally not use this variable.
7492:
1.203 nia 7493: 21.6.11. Packages installing extensions to the MIME database
1.1 dsieger 7494:
7495: If a package provides extensions to the MIME database by installing .xml files
7496: inside ${PREFIX}/share/mime/packages, you need to take some extra steps to
7497: ensure that the database is kept consistent with respect to these new files:
7498:
7499: 1. Include ../../databases/shared-mime-info/mimedb.mk (avoid using the
7500: buildlink3.mk file from this same directory, which is reserved for
7501: inclusion from other buildlink3.mk files). It takes care of rebuilding the
7502: MIME database at installation and deinstallation time, and disallows any
7503: access to it directly from the package.
7504:
1.25 wiz 7505: 2. Check the PLIST and remove any entries under the share/mime directory,
1.1 dsieger 7506: except for files saved under share/mime/packages. The former are handled
7507: automatically by the update-mime-database program, but the latter are
7508: package-dependent and must be removed by the package that installed them in
7509: the first place.
7510:
7511: 3. Remove any share/mime/* directories from the PLIST. They will be handled by
7512: the shared-mime-info package.
7513:
1.203 nia 7514: 21.6.12. Packages using intltool
1.1 dsieger 7515:
7516: If a package uses intltool during its build, add intltool to the USE_TOOLS,
7517: which forces it to use the intltool package provided by pkgsrc, instead of the
7518: one bundled with the distribution file.
7519:
7520: This tracks intltool's build-time dependencies and uses the latest available
7521: version; this way, the package benefits of any bug fixes that may have appeared
7522: since it was released.
7523:
1.203 nia 7524: 21.6.13. Packages installing startup scripts
1.1 dsieger 7525:
7526: If a package contains a rc.d script, it won't be copied into the startup
7527: directory by default, but you can enable it, by adding the option
1.4 rillig 7528: PKG_RCD_SCRIPTS=YES in mk.conf. This option will copy the scripts into /etc/
7529: rc.d when a package is installed, and it will automatically remove the scripts
7530: when the package is deinstalled.
1.1 dsieger 7531:
1.203 nia 7532: 21.6.14. Packages installing TeX modules
1.1 dsieger 7533:
7534: If a package installs TeX packages into the texmf tree, the ls-R database of
7535: the tree needs to be updated.
7536:
7537: Note
7538:
1.23 jakllsch 7539: Except the main TeX packages such as kpathsea, packages should install files
7540: into ${PREFIX}/share/texmf-dist, not ${PREFIX}/share/texmf.
1.1 dsieger 7541:
1.23 jakllsch 7542: 1. Include ../../print/kpathsea/texmf.mk. This takes care of rebuilding the
7543: ls-R database at installation and deinstallation time.
1.1 dsieger 7544:
1.23 jakllsch 7545: 2. If your package installs files into a texmf tree other than the one at $
7546: {PREFIX}/share/texmf-dist, set TEX_TEXMF_DIRS to the list of all texmf
7547: trees that need database update.
1.1 dsieger 7548:
7549: If your package also installs font map files that need to be registered
1.30 dholland 7550: using updmap, include ../../print/tex-tetex/map.mk and set TEX_MAP_FILES
7551: and/or TEX_MIXEDMAP_FILES to the list of all such font map files. Then
7552: updmap will be run automatically at installation/deinstallation to enable/
7553: disable font map files for TeX output drivers.
1.1 dsieger 7554:
7555: 3. Make sure that none of ls-R databases are included in PLIST, as they will
1.30 dholland 7556: be removed only by the kpathsea package.
1.1 dsieger 7557:
1.203 nia 7558: 21.6.15. Packages supporting running binaries in emulation
1.1 dsieger 7559:
7560: There are some packages that provide libraries and executables for running
7561: binaries from a one operating system on a different one (if the latter supports
7562: it). One example is running Linux binaries on NetBSD.
7563:
7564: The pkgtools/rpm2pkg helps in extracting and packaging Linux rpm packages.
7565:
7566: The CHECK_SHLIBS can be set to no to avoid the check-shlibs target, which tests
7567: if all libraries for each installed executable can be found by the dynamic
7568: linker. Since the standard dynamic linker is run, this fails for emulation
7569: packages, because the libraries used by the emulation are not in the standard
7570: directories.
7571:
1.203 nia 7572: 21.6.16. Packages installing hicolor icons
1.1 dsieger 7573:
7574: If a package installs images under the share/icons/hicolor and/or updates the
7575: share/icons/hicolor/icon-theme.cache database, you need to take some extra
7576: steps to make sure that the shared theme directory is handled appropriately and
7577: that the cache database is rebuilt:
7578:
7579: 1. Include ../../graphics/hicolor-icon-theme/buildlink3.mk.
7580:
7581: 2. Check the PLIST and remove the entry that refers to the theme cache.
7582:
7583: 3. Ensure that the PLIST does not remove the shared icon directories from the
7584: share/icons/hicolor hierarchy because they will be handled automatically.
7585:
7586: The best way to verify that the PLIST is correct with respect to the last two
7587: points is to regenerate it using make print-PLIST.
7588:
1.203 nia 7589: 21.6.17. Packages installing desktop files
1.1 dsieger 7590:
7591: If a package installs .desktop files under share/applications and these include
1.54 rodent 7592: MIME information (MimeType key), you need to take extra steps to ensure that
7593: they are registered into the MIME database:
1.1 dsieger 7594:
7595: 1. Include ../../sysutils/desktop-file-utils/desktopdb.mk.
7596:
7597: 2. Check the PLIST and remove the entry that refers to the share/applications/
7598: mimeinfo.cache file. It will be handled automatically.
7599:
7600: The best way to verify that the PLIST is correct with respect to the last point
7601: is to regenerate it using make print-PLIST.
7602:
1.154 rillig 7603: 21.7. Marking packages as having problems
1.1 dsieger 7604:
1.23 jakllsch 7605: In some cases one does not have the time to solve a problem immediately. In
7606: this case, one can plainly mark a package as broken. For this, one just sets
7607: the variable BROKEN to the reason why the package is broken (similar to the
1.162 rillig 7608: PKG_FAIL_REASON variable). A user trying to build the package will immediately
7609: be shown this message, and the build will not be even tried.
1.1 dsieger 7610:
1.23 jakllsch 7611: BROKEN packages are removed from pkgsrc in irregular intervals.
1.1 dsieger 7612:
1.184 rillig 7613: Chapter 22. GNOME packaging and porting
7614:
7615: Table of Contents
7616:
7617: 22.1. Meta packages
7618: 22.2. Packaging a GNOME application
7619: 22.3. Updating GNOME to a newer version
7620: 22.4. Patching guidelines
7621:
7622: Quoting GNOME's web site:
7623:
7624: The GNOME project provides two things: The GNOME desktop environment, an
7625: intuitive and attractive desktop for users, and the GNOME development
7626: platform, an extensive framework for building applications that integrate
7627: into the rest of the desktop.
7628:
7629: pkgsrc provides a seamless way to automatically build and install a complete
7630: GNOME environment under many different platforms. We can say with confidence
7631: that pkgsrc is one of the most advanced build and packaging systems for GNOME
7632: due to its included technologies buildlink3, the wrappers and tools framework
7633: and automatic configuration file management. Lots of efforts are put into
7634: achieving a completely clean deinstallation of installed software components.
7635:
7636: Given that pkgsrc is NetBSD's official packaging system, the above also means
7637: that great efforts are put into making GNOME work under this operating system.
7638:
7639: This chapter is aimed at pkgsrc developers and other people interested in
7640: helping our GNOME porting and packaging efforts. It provides instructions on
7641: how to manage the existing packages and some important information regarding
7642: their internals.
7643:
7644: 22.1. Meta packages
7645:
7646: pkgsrc includes three GNOME-related meta packages:
7647:
7648: * meta-pkgs/gnome-base: Provides the core GNOME desktop environment. It only
7649: includes the necessary bits to get it to boot correctly, although it may
7650: lack important functionality for daily operation. The idea behind this
7651: package is to let end users build their own configurations on top of this
7652: one, first installing this meta package to achieve a functional setup and
7653: then adding individual applications.
7654:
7655: * meta-pkgs/gnome: Provides a complete installation of the GNOME platform and
7656: desktop as defined by the GNOME project; this is based on the components
7657: distributed in the platform/x.y/x.y.z/sources and desktop/x.y/x.y.z/sources
7658: directories of the official FTP server. Developer-only tools found in those
7659: directories are not installed unless required by some other component to
7660: work properly. Similarly, packages from the bindings set (bindings/x.y/
7661: x.y.z/sources) are not pulled in unless required as a dependency for an
7662: end-user component. This package "extends" meta-pkgs/gnome-base.
7663:
7664: * meta-pkgs/gnome-devel: Installs all the tools required to build a GNOME
7665: component when fetched from the CVS repository. These are required to let
7666: the autogen.sh scripts work appropriately.
7667:
7668: In all these packages, the DEPENDS lines are sorted in a way that eases
7669: updates: a package may depend on other packages listed before it but not on any
7670: listed after it. It is very important to keep this order to ease updates so...
7671: do not change it to alphabetical sorting!
7672:
7673: 22.2. Packaging a GNOME application
7674:
7675: Almost all GNOME applications are written in C and use a common set of tools as
7676: their build system. Things get different with the new bindings to other
7677: languages (such as Python), but the following will give you a general idea on
7678: the minimum required tools:
7679:
7680: * Almost all GNOME applications use the GNU Autotools as their build system.
7681: As a general rule you will need to tell this to your package:
7682:
1.223 nia 7683: GNU_CONFIGURE= yes
7684: USE_LIBTOOL= yes
7685: USE_TOOLS+= gmake
1.184 rillig 7686:
7687: * If the package uses pkg-config to detect dependencies, add this tool to the
7688: list of required utilities:
7689:
1.223 nia 7690: USE_TOOLS+= pkg-config
1.184 rillig 7691:
7692: Also use pkgtools/verifypc at the end of the build process to ensure that
7693: you did not miss to specify any dependency in your package and that the
7694: version requirements are all correct.
7695:
7696: * If the package uses intltool, be sure to add intltool to the USE_TOOLS to
7697: handle dependencies and to force the package to use the latest available
7698: version.
7699:
7700: * If the package uses gtk-doc (a documentation generation utility), do not
7701: add a dependency on it. The tool is rather big and the distfile should come
7702: with pregenerated documentation anyway; if it does not, it is a bug that
7703: you ought to report. For such packages you should disable gtk-doc (unless
7704: it is the default):
7705:
1.223 nia 7706: CONFIGURE_ARGS+= --disable-gtk-doc
1.184 rillig 7707:
7708: The default location of installed HTML files (share/gtk-doc/<package-name>)
7709: is correct and should not be changed unless the package insists on
7710: installing them somewhere else. Otherwise programs as devhelp will not be
7711: able to open them. You can do that with an entry similar to:
1.1 dsieger 7712:
1.223 nia 7713: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.1 dsieger 7714:
1.184 rillig 7715: GNOME uses multiple shared directories and files under the installation prefix
7716: to maintain databases. In this context, shared means that those exact same
7717: directories and files are used among several different packages, leading to
7718: conflicts in the PLIST. pkgsrc currently includes functionality to handle the
7719: most common cases, so you have to forget about using @unexec ${RMDIR} lines in
7720: your file lists and omitting shared files from them. If you find yourself doing
7721: those, your package is most likely incorrect.
1.1 dsieger 7722:
1.184 rillig 7723: The following table lists the common situations that result in using shared
7724: directories or files. For each of them, the appropriate solution is given.
7725: After applying the solution be sure to regenerate the package's file list with
7726: make print-PLIST and ensure it is correct.
1.1 dsieger 7727:
1.184 rillig 7728: Table 22.1. PLIST handling for GNOME packages
1.1 dsieger 7729:
1.184 rillig 7730: +-----------------------------------------------------------------------------+
7731: | If the package... | Then... |
7732: |-------------------------------------------+---------------------------------|
1.203 nia 7733: |Installs icons under the share/icons/ |See Section 21.6.16, "Packages |
7734: |hicolor hierarchy or updates share/icons/ |installing hicolor icons". |
1.184 rillig 7735: |hicolor/icon-theme.cache. | |
7736: |-------------------------------------------+---------------------------------|
1.203 nia 7737: | |See Section 21.6.11, "Packages |
1.184 rillig 7738: |Installs files under share/mime/packages. |installing extensions to the MIME|
7739: | |database". |
7740: |-------------------------------------------+---------------------------------|
1.203 nia 7741: |Installs .desktop files under share/ |See Section 21.6.17, "Packages |
1.184 rillig 7742: |applications and these include MIME |installing desktop files". |
7743: |information. | |
7744: +-----------------------------------------------------------------------------+
1.1 dsieger 7745:
7746:
1.184 rillig 7747: 22.3. Updating GNOME to a newer version
1.1 dsieger 7748:
1.184 rillig 7749: When seeing GNOME as a whole, there are two kinds of updates:
1.1 dsieger 7750:
1.184 rillig 7751: Major update
1.1 dsieger 7752:
1.184 rillig 7753: Given that there is still a very long way for GNOME 3 (if it ever appears),
7754: we consider a major update one that goes from a 2.X version to a 2.Y one,
7755: where Y is even and greater than X. These are hard to achieve because they
7756: introduce lots of changes in the components' code and almost all GNOME
7757: distfiles are updated to newer versions. Some of them can even break API
7758: and ABI compatibility with the previous major version series. As a result,
7759: the update needs to be done all at once to minimize breakage.
1.1 dsieger 7760:
1.184 rillig 7761: A major update typically consists of around 80 package updates and the
7762: addition of some new ones.
1.1 dsieger 7763:
1.184 rillig 7764: Minor update
1.1 dsieger 7765:
1.184 rillig 7766: We consider a minor update one that goes from a 2.A.X version to a 2.A.Y
7767: one where Y is greater than X. These are easy to achieve because they do
7768: not update all GNOME components, can be done in an incremental way and do
7769: not break API nor ABI compatibility.
1.1 dsieger 7770:
1.184 rillig 7771: A minor update typically consists of around 50 package updates, although
7772: the numbers here may vary a lot.
1.1 dsieger 7773:
1.184 rillig 7774: In order to update the GNOME components in pkgsrc to a new stable release
7775: (either major or minor), the following steps should be followed:
1.1 dsieger 7776:
1.184 rillig 7777: 1. Get a list of all the tarballs that form the new release by using the
7778: following commands. These will leave the full list of the components'
7779: distfiles into the list.txt file:
1.1 dsieger 7780:
1.184 rillig 7781: % echo ls "*.tar.bz2" | \
7782: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
7783: awk '{ print $9 }' >list.txt
7784: % echo ls "*.tar.bz2" | \
7785: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
7786: awk '{ print $9 }' >>list.txt
1.1 dsieger 7787:
1.184 rillig 7788: 2. Open each meta package's Makefile and bump their version to the release you
7789: are updating them to. The three meta packages should be always consistent
7790: with versioning. Obviously remove any PKGREVISIONs that might be in them.
1.1 dsieger 7791:
1.184 rillig 7792: 3. For each meta package, update all its DEPENDS lines to match the latest
7793: versions as shown by the above commands. Do not list any newer version
7794: (even if found in the FTP) because the meta packages are supposed to list
7795: the exact versions that form a specific GNOME release. Exceptions are
7796: permitted here if a newer version solves a serious issue in the overall
7797: desktop experience; these typically come in the form of a revision bump in
7798: pkgsrc, not in newer versions from the developers.
1.1 dsieger 7799:
1.184 rillig 7800: Packages not listed in the list.txt file should be updated to the latest
7801: version available (if found in pkgsrc). This is the case, for example, of
7802: the dependencies on the GNU Autotools in the meta-pkgs/gnome-devel meta
7803: package.
1.1 dsieger 7804:
1.184 rillig 7805: 4. Generate a patch from the modified meta packages and extract the list of
7806: "new" lines. This will provide you an outline on what packages need to be
7807: updated in pkgsrc and in what order:
1.1 dsieger 7808:
1.184 rillig 7809: % cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt
1.1 dsieger 7810:
1.184 rillig 7811: 5. For major desktop updates it is recommended to zap all your installed
7812: packages and start over from scratch at this point.
1.1 dsieger 7813:
1.184 rillig 7814: 6. Now comes the longest step by far: iterate over the contents of todo.txt
7815: and update the packages listed in it in order. For major desktop updates
7816: none of these should be committed until the entire set is completed because
7817: there are chances of breaking not-yet-updated packages.
1.1 dsieger 7818:
1.184 rillig 7819: 7. Once the packages are up to date and working, commit them to the tree one
7820: by one with appropriate log messages. At the end, commit the three meta
7821: package updates and all the corresponding changes to the doc/CHANGES-<YEAR>
7822: and pkgsrc/doc/TODO files.
1.1 dsieger 7823:
1.184 rillig 7824: 22.4. Patching guidelines
1.1 dsieger 7825:
1.184 rillig 7826: GNOME is a very big component in pkgsrc which approaches 100 packages. Please,
7827: it is very important that you always, always, always feed back any portability
7828: fixes you do to a GNOME package to the mainstream developers (see
7829: Section 12.3.5, "Feedback to the author"). This is the only way to get their
7830: attention on portability issues and to ensure that future versions can be built
7831: out-of-the box on NetBSD. The less custom patches in pkgsrc, the easier further
7832: updates are. Those developers in charge of issuing major GNOME updates will be
7833: grateful if you do that.
1.1 dsieger 7834:
1.200 cirnatda 7835: The most common places to report bugs are the GNOME's GitLab and the
7836: freedesktop.org's GitLab. Not all components use these to track bugs, but most
7837: of them do. Do not be short on your reports: always provide detailed
1.184 rillig 7838: explanations of the current failure, how it can be improved to achieve maximum
1.200 cirnatda 7839: portability and, if at all possible, provide a patch against the main Git
7840: branch. The more verbose you are, the higher chances of your patch being
7841: accepted.
1.1 dsieger 7842:
1.184 rillig 7843: Also, please avoid using preprocessor magic to fix portability issues. While
7844: the FreeBSD GNOME people are doing a great job in porting GNOME to their
7845: operating system, the official GNOME sources are now plagued by conditionals
7846: that check for __FreeBSD__ and similar macros. This hurts portability. Please
7847: see our patching guidelines (Section 12.3.4, "Patching guidelines") for more
7848: details.
1.1 dsieger 7849:
1.154 rillig 7850: Chapter 23. Submitting and Committing
1.1 dsieger 7851:
7852: Table of Contents
7853:
1.154 rillig 7854: 23.1. Submitting binary packages
7855: 23.2. Submitting source packages (for non-NetBSD-developers)
7856: 23.3. General notes when adding, updating, or removing packages
7857: 23.4. Commit Messages
7858: 23.5. Committing: Adding a package to CVS
7859: 23.6. Updating a package to a newer version
7860: 23.7. Renaming a package in pkgsrc
7861: 23.8. Moving a package in pkgsrc
1.1 dsieger 7862:
1.154 rillig 7863: 23.1. Submitting binary packages
1.1 dsieger 7864:
7865: Our policy is that we accept binaries only from pkgsrc developers to guarantee
7866: that the packages don't contain any trojan horses etc. This is not to annoy
7867: anyone but rather to protect our users! You're still free to put up your
7868: home-made binary packages and tell the world where to get them. NetBSD
1.154 rillig 7869: developers doing bulk builds and wanting to upload them please see Chapter 8,
1.66 asau 7870: Creating binary packages for everything in pkgsrc (bulk builds).
1.1 dsieger 7871:
1.154 rillig 7872: 23.2. Submitting source packages (for non-NetBSD-developers)
1.1 dsieger 7873:
1.218 nia 7874: Firstly, you can import new packages into pkgsrc-wip ("pkgsrc work-in-progress"
7875: ); see the homepage at https://pkgsrc.org/wip/ for details.
7876:
7877: Next, check that your package is complete, compiles and runs well; see
1.184 rillig 7878: Chapter 14, Creating a new pkgsrc package from scratch and the rest of this
1.218 nia 7879: document. Run the pkgtools/pkglint tool and fix any errors that appear.
7880:
7881: Finally, send a report to the pkgsrc bug tracking system, either with the
7882: send-pr(1) command, or if you don't have that, go to the web page https://
7883: www.NetBSD.org/support/send-pr.html, which contains some instructions and a
7884: link to a form where you can submit packages. The sysutils/gtk-send-pr package
7885: is also available as a substitute for either of the above two tools.
1.1 dsieger 7886:
7887: In the form of the problem report, the category should be "pkg", the synopsis
7888: should include the package name and version number, and the description field
7889: should contain a short description of your package (contents of the COMMENT
1.218 nia 7890: variable or DESCR file are OK).
1.1 dsieger 7891:
1.154 rillig 7892: 23.3. General notes when adding, updating, or removing packages
1.1 dsieger 7893:
7894: Please note all package additions, updates, moves, and removals in pkgsrc/doc/
7895: CHANGES-YYYY. It's very important to keep this file up to date and conforming
7896: to the existing format, because it will be used by scripts to automatically
7897: update pages on www.NetBSD.org and other sites. Additionally, check the pkgsrc/
7898: doc/TODO file and remove the entry for the package you updated or removed, in
7899: case it was mentioned there.
7900:
7901: When the PKGREVISION of a package is bumped, the change should appear in pkgsrc
7902: /doc/CHANGES-YYYY if it is security related or otherwise relevant. Mass bumps
7903: that result from a dependency being updated should not be mentioned. In all
7904: other cases it's the developer's decision.
7905:
7906: There is a make target that helps in creating proper CHANGES-YYYY entries: make
7907: changes-entry. It uses the optional CTYPE and NETBSD_LOGIN_NAME variables. The
7908: general usage is to first make sure that your CHANGES-YYYY file is up-to-date
7909: (to avoid having to resolve conflicts later-on) and then to cd to the package
7910: directory. For package updates, make changes-entry is enough. For new packages,
7911: or package moves or removals, set the CTYPE variable on the command line to
1.4 rillig 7912: "Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in mk.conf if
1.23 jakllsch 7913: your local login name is not the same as your NetBSD login name. The target
7914: also automatically removes possibly existing entries for the package in the
7915: TODO file. Don't forget to commit the changes, e.g. by using make
1.66 asau 7916: commit-changes-entry! If you are not using a checkout directly from
1.23 jakllsch 7917: cvs.NetBSD.org, but e.g. a local copy of the repository, you can set
7918: USE_NETBSD_REPO=yes. This makes the cvs commands use the main repository.
1.1 dsieger 7919:
1.154 rillig 7920: 23.4. Commit Messages
1.130 wiz 7921:
7922: For several years, there have been mirrors of pkgsrc in fossil, git, and hg.
7923: Standard practise when using these tools is to make the first line of a commit
7924: message function as a summary that can be read without the rest, such as is
7925: commonly done with "git log --oneline". For this reason, we have the following
7926: guidelines for pkgsrc commit messages:
7927:
1.131 wiz 7928: * Start the commit message with a line that explains the big picture in 65
1.130 wiz 7929: characters or less. When a commit is for one package, include the name of
7930: the package. For updates, include the version to which it is updated.
7931:
7932: * Leave the next line empty.
7933:
7934: * Then come the details for the commit (changes in that package, reason for a
7935: change) and any relevant PRs. Wrap this section.
7936:
7937: Here is an example:
7938:
1.238 wiz 7939: libxslt: update to 1.0.30
1.130 wiz 7940:
1.238 wiz 7941: Changes since 1.0.29:
7942: ...
1.130 wiz 7943:
7944: Here is another example:
7945:
1.238 wiz 7946: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.130 wiz 7947:
1.238 wiz 7948: (rationale)
1.130 wiz 7949:
7950: Commit messages are final: no "cvs admin" is allowed on the pkgsrc repository
7951: to change commit messages.
7952:
1.154 rillig 7953: 23.5. Committing: Adding a package to CVS
1.1 dsieger 7954:
7955: This section is only of interest for pkgsrc developers with write access to the
1.34 wiz 7956: pkgsrc repository.
7957:
7958: When the package is finished, "cvs add" the files. Start by adding the
7959: directory and then files in the directory. Don't forget to add the new package
7960: to the category's Makefile. Make sure you don't forget any files; you can check
7961: by running "cvs status". An example:
7962:
7963: $ cd .../pkgsrc/category
7964: $ cvs add pkgname
7965: $ cd pkgname
7966: $ cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
7967: $ cvs add patches/p*
7968: $ cvs status | less
1.35 wiz 7969: $ cvs commit
1.34 wiz 7970: $ cd ..
1.236 gutterid 7971: $ vi Makefile # add SUBDIR+=pkgname line
1.35 wiz 7972: $ cvs commit Makefile
1.66 asau 7973: $ cd pkgname
1.73 jnemeth 7974: $ make CTYPE=Added commit-changes-entry
1.1 dsieger 7975:
7976: The commit message of the initial import should include part of the DESCR file,
7977: so people reading the mailing lists know what the package is/does.
7978:
1.34 wiz 7979: Also mention the new package in pkgsrc/doc/CHANGES-20xx.
7980:
7981: Previously, "cvs import" was suggested, but it was much easier to get wrong
7982: than "cvs add".
1.1 dsieger 7983:
1.154 rillig 7984: 23.6. Updating a package to a newer version
1.1 dsieger 7985:
7986: Please always put a concise, appropriate and relevant summary of the changes
7987: between old and new versions into the commit log when updating a package. There
7988: are various reasons for this:
7989:
7990: * A URL is volatile, and can change over time. It may go away completely or
7991: its information may be overwritten by newer information.
7992:
7993: * Having the change information between old and new versions in our CVS
7994: repository is very useful for people who use either cvs or anoncvs.
7995:
7996: * Having the change information between old and new versions in our CVS
7997: repository is very useful for people who read the pkgsrc-changes mailing
7998: list, so that they can make tactical decisions about when to upgrade the
7999: package.
8000:
8001: Please also recognize that, just because a new version of a package has been
8002: released, it should not automatically be upgraded in the CVS repository. We
8003: prefer to be conservative in the packages that are included in pkgsrc -
8004: development or beta packages are not really the best thing for most places in
8005: which pkgsrc is used. Please use your judgement about what should go into
8006: pkgsrc, and bear in mind that stability is to be preferred above new and
8007: possibly untested features.
8008:
1.154 rillig 8009: 23.7. Renaming a package in pkgsrc
1.21 snj 8010:
8011: Renaming packages is not recommended.
8012:
1.175 gutterid 8013: When renaming packages, be sure to fix any references to the old name in other
1.21 snj 8014: Makefiles, options, buildlink files, etc.
8015:
1.175 gutterid 8016: Also, when renaming a package, please add the package name and version pattern
1.167 leot 8017: (s) of the previous package to SUPERSEDES. This may be repeated for multiple
8018: renames. The new package would be an exact replacement. Example:
8019:
8020: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
8021: SUPERSEDES+= optcomp-[0-9]*
1.21 snj 8022:
8023: Note that "successor" in the CHANGES-YYYY file doesn't necessarily mean that it
8024: supersedes, as that successor may not be an exact replacement but is a
8025: suggestion for the replaced functionality.
8026:
1.154 rillig 8027: 23.8. Moving a package in pkgsrc
1.21 snj 8028:
8029: It is preferred that packages are not renamed or moved, but if needed please
8030: follow these steps.
1.1 dsieger 8031:
8032: 1. Make a copy of the directory somewhere else.
8033:
8034: 2. Remove all CVS dirs.
8035:
8036: Alternatively to the first two steps you can also do:
8037:
8038: % cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package
8039:
8040: and use that for further work.
8041:
1.25 wiz 8042: 3. Fix CATEGORIES and any DEPENDS paths that just did "../package" instead of
1.1 dsieger 8043: "../../category/package".
8044:
1.21 snj 8045: 4. In the modified package's Makefile, consider setting PREV_PKGPATH to the
8046: previous category/package pathname. The PREV_PKGPATH can be used by tools
8047: for doing an update using pkgsrc building; for example, it can search the
8048: pkg_summary(5) database for PREV_PKGPATH (if no SUPERSEDES) and then use
8049: the corresponding new PKGPATH for that moved package. Note that it may have
8050: multiple matches, so the tool should also check on the PKGBASE too. The
8051: PREV_PKGPATH probably has no value unless SUPERSEDES is not set, i.e.
8052: PKGBASE stays the same.
8053:
1.237 gutterid 8054: 5. cvs add the modified package in the new place.
1.1 dsieger 8055:
1.21 snj 8056: 6. Check if any package depends on it:
1.1 dsieger 8057:
8058: % cd /usr/pkgsrc
8059: % grep /package */*/Makefile* */*/buildlink*
8060:
1.21 snj 8061: 7. Fix paths in packages from step 5 to point to new location.
1.1 dsieger 8062:
1.21 snj 8063: 8. cvs rm (-f) the package at the old location.
1.1 dsieger 8064:
1.21 snj 8065: 9. Remove from oldcategory/Makefile.
1.1 dsieger 8066:
1.21 snj 8067: 10. Add to newcategory/Makefile.
1.1 dsieger 8068:
1.21 snj 8069: 11. Commit the changed and removed files:
1.1 dsieger 8070:
8071: % cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile
8072:
8073: (and any packages from step 5, of course).
8074:
1.154 rillig 8075: Chapter 24. Frequently Asked Questions
1.1 dsieger 8076:
8077: This section contains the answers to questions that may arise when you are
8078: writing a package. If you don't find your question answered here, first have a
8079: look in the other chapters, and if you still don't have the answer, ask on the
8080: pkgsrc-users mailing list.
8081:
1.154 rillig 8082: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
8083: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
8084: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
1.223 nia 8085: 24.4. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
8086: 24.5. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.232 gutterid 8087: the := inside it.
1.223 nia 8088: 24.6. Which mailing lists are there for package developers?
8089: 24.7. Where is the pkgsrc documentation?
8090: 24.8. I have a little time to kill. What shall I do?
1.1 dsieger 8091:
1.154 rillig 8092: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
1.1 dsieger 8093:
8094: MAKEFLAGS are the flags passed to the pkgsrc-internal invocations of make
1.223 nia 8095: (1).
8096:
8097: MAKE_FLAGS are the flags that are passed to the MAKE_PROGRAM when
8098: building the package.
8099:
8100: .MAKEFLAGS is an internal variable of bmake and should not be used by
8101: packages.
1.1 dsieger 8102:
1.154 rillig 8103: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
1.1 dsieger 8104:
8105: MAKE is the path to the make(1) program that is used in the pkgsrc
1.223 nia 8106: infrastructure.
8107:
8108: GMAKE is the path to GNU Make, but you need to say USE_TOOLS+=gmake to
8109: use that.
8110:
8111: MAKE_PROGRAM is the path to the Make program that is used for building
8112: the package.
1.1 dsieger 8113:
1.154 rillig 8114: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
1.1 dsieger 8115:
8116: CC is the path to the real C compiler, which can be configured by the
1.223 nia 8117: pkgsrc user.
1.1 dsieger 8118:
1.223 nia 8119: PKG_CC is the path to the compiler wrapper.
1.1 dsieger 8120:
1.223 nia 8121: PKGSRC_COMPILER is not a path to a compiler, but the type of compiler
8122: that should be used. See mk/compiler.mk for more information about the
8123: latter variable.
1.1 dsieger 8124:
1.223 nia 8125: 24.4. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
1.1 dsieger 8126:
1.25 wiz 8127: For optimization reasons, some variables are only available in the "
8128: wrapper" phase and later. To "simulate" the wrapper phase, append
1.1 dsieger 8129: PKG_PHASE=wrapper to the above command.
8130:
1.223 nia 8131: 24.5. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 8132: the := inside it.
8133:
1.223 nia 8134: The := is not an assignment operator, even though it may look like one.
1.108 rillig 8135: Instead, it is a degenerate form of ${LIST:old_string=new_string}, which
8136: is documented in the make(1) man page and which is commonly used in the
8137: form ${SRCS:.c=.o}. In the case of MASTER_SITE_*, old_string is the empty
8138: string and new_string is package/. That's where the : and the = fall
8139: together.
1.1 dsieger 8140:
1.223 nia 8141: 24.6. Which mailing lists are there for package developers?
1.1 dsieger 8142:
8143: tech-pkg
8144:
8145: This is a list for technical discussions related to pkgsrc
8146: development, e.g. soliciting feedback for changes to pkgsrc
8147: infrastructure, proposed new features, questions related to porting
8148: pkgsrc to a new platform, advice for maintaining a package, patches
8149: that affect many packages, help requests moved from pkgsrc-users when
8150: an infrastructure bug is found, etc.
8151:
8152: pkgsrc-bugs
8153:
8154: All bug reports in category "pkg" sent with send-pr(1) appear here.
8155: Please do not report your bugs here directly; use one of the other
8156: mailing lists.
8157:
1.223 nia 8158: 24.7. Where is the pkgsrc documentation?
1.1 dsieger 8159:
8160: There are many places where you can find documentation about pkgsrc:
8161:
8162: * The pkgsrc guide (this document) is a collection of chapters that
8163: explain large parts of pkgsrc, but some chapters tend to be outdated.
8164: Which ones they are is hard to say.
8165:
1.174 leot 8166: * On the mailing list archives (see https://mail-index.NetBSD.org/),
8167: you can find discussions about certain features, announcements of new
1.1 dsieger 8168: parts of the pkgsrc infrastructure and sometimes even announcements
8169: that a certain feature has been marked as obsolete. The benefit here
8170: is that each message has a date appended to it.
8171:
8172: * Many of the files in the mk/ directory start with a comment that
8173: describes the purpose of the file and how it can be used by the
8174: pkgsrc user and package authors. An easy way to find this
8175: documentation is to run bmake help.
8176:
8177: * The CVS log messages are a rich source of information, but they tend
8178: to be highly abbreviated, especially for actions that occur often.
8179: Some contain a detailed description of what has changed, but they are
8180: geared towards the other pkgsrc developers, not towards an average
8181: pkgsrc user. They also only document changes, so if you don't know
8182: what has been before, these messages may not be worth too much to
8183: you.
8184:
8185: * Some parts of pkgsrc are only "implicitly documented", that is the
8186: documentation exists only in the mind of the developer who wrote the
8187: code. To get this information, use the cvs annotate command to see
8188: who has written it and ask on the tech-pkg mailing list, so that
8189: others can find your questions later (see above). To be sure that the
8190: developer in charge reads the mail, you may CC him or her.
8191:
1.223 nia 8192: 24.8. I have a little time to kill. What shall I do?
1.1 dsieger 8193:
8194: This is not really an FAQ yet, but here's the answer anyway.
8195:
8196: * Run pkg_chk -N (from the pkgtools/pkg_chk package). It will tell you
8197: about newer versions of installed packages that are available, but
8198: not yet updated in pkgsrc.
8199:
1.198 leot 8200: * Browse pkgsrc/doc/TODO -- it contains a list of suggested new
8201: packages and a list of cleanups and enhancements for pkgsrc that
8202: would be nice to have.
1.1 dsieger 8203:
1.71 wiz 8204: * Review packages for which review was requested on the tech-pkg
8205: mailing list.
1.1 dsieger 8206:
8207: Part III. The pkgsrc infrastructure internals
8208:
8209: This part of the guide deals with everything from the infrastructure that is
8210: behind the interfaces described in the developer's guide. A casual package
8211: maintainer should not need anything from this part.
8212:
8213: Table of Contents
8214:
1.184 rillig 8215: 25. Design of the pkgsrc infrastructure
8216: 25.1. The meaning of variable definitions
8217: 25.2. Avoiding problems before they arise
8218: 25.3. Variable evaluation
8219: 25.3.1. At load time
8220: 25.3.2. At runtime
8221: 25.4. How can variables be specified?
8222: 25.5. Designing interfaces for Makefile fragments
8223: 25.5.1. Procedures with parameters
8224: 25.5.2. Actions taken on behalf of parameters
8225: 25.6. The order in which files are loaded
8226: 25.6.1. The order in bsd.prefs.mk
8227: 25.6.2. The order in bsd.pkg.mk
8228: 26. Regression tests
8229: 26.1. Running the regression tests
8230: 26.2. Adding a new regression test
8231: 26.2.1. Overridable functions
8232: 26.2.2. Helper functions
8233: 27. Porting pkgsrc
8234: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8235:
1.184 rillig 8236: Chapter 25. Design of the pkgsrc infrastructure
1.1 dsieger 8237:
8238: Table of Contents
8239:
1.184 rillig 8240: 25.1. The meaning of variable definitions
8241: 25.2. Avoiding problems before they arise
8242: 25.3. Variable evaluation
8243: 25.3.1. At load time
8244: 25.3.2. At runtime
8245: 25.4. How can variables be specified?
8246: 25.5. Designing interfaces for Makefile fragments
8247: 25.5.1. Procedures with parameters
8248: 25.5.2. Actions taken on behalf of parameters
8249: 25.6. The order in which files are loaded
8250: 25.6.1. The order in bsd.prefs.mk
8251: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 8252:
8253: The pkgsrc infrastructure consists of many small Makefile fragments. Each such
8254: fragment needs a properly specified interface. This chapter explains how such
8255: an interface looks like.
8256:
1.184 rillig 8257: 25.1. The meaning of variable definitions
1.1 dsieger 8258:
8259: Whenever a variable is defined in the pkgsrc infrastructure, the location and
8260: the way of definition provide much information about the intended use of that
8261: variable. Additionally, more documentation may be found in a header comment or
8262: in this pkgsrc guide.
8263:
8264: A special file is mk/defaults/mk.conf, which lists all variables that are
8265: intended to be user-defined. They are either defined using the ?= operator or
8266: they are left undefined because defining them to anything would effectively
8267: mean "yes". All these variables may be overridden by the pkgsrc user in the
8268: MAKECONF file.
8269:
8270: Outside this file, the following conventions apply: Variables that are defined
8271: using the ?= operator may be overridden by a package.
8272:
8273: Variables that are defined using the = operator may be used read-only at
8274: run-time.
8275:
8276: Variables whose name starts with an underscore must not be accessed outside the
8277: pkgsrc infrastructure at all. They may change without further notice.
8278:
8279: Note
8280:
8281: These conventions are currently not applied consistently to the complete pkgsrc
8282: infrastructure.
8283:
1.184 rillig 8284: 25.2. Avoiding problems before they arise
1.1 dsieger 8285:
8286: All variables that contain lists of things should default to being empty. Two
8287: examples that do not follow this rule are USE_LANGUAGES and DISTFILES. These
8288: variables cannot simply be modified using the += operator in package Makefiles
8289: (or other files included by them), since there is no guarantee whether the
8290: variable is already set or not, and what its value is. In the case of
8291: DISTFILES, the packages "know" the default value and just define it as in the
8292: following example.
8293:
8294: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
8295:
8296: Because of the selection of this default value, the same value appears in many
8297: package Makefiles. Similarly for USE_LANGUAGES, but in this case the default
8298: value ("c") is so short that it doesn't stand out. Nevertheless it is mentioned
8299: in many files.
8300:
1.184 rillig 8301: 25.3. Variable evaluation
1.1 dsieger 8302:
1.184 rillig 8303: 25.3.1. At load time
1.1 dsieger 8304:
8305: Variable evaluation takes place either at load time or at runtime, depending on
8306: the context in which they occur. The contexts where variables are evaluated at
8307: load time are:
8308:
8309: * The right hand side of the := and != operators,
8310:
8311: * Make directives like .if or .for,
8312:
8313: * Dependency lines.
8314:
8315: A special exception are references to the iteration variables of .for loops,
8316: which are expanded inline, no matter in which context they appear.
8317:
8318: As the values of variables may change during load time, care must be taken not
8319: to evaluate them by accident. Typical examples for variables that should not be
8320: evaluated at load time are DEPENDS and CONFIGURE_ARGS. To make the effect more
8321: clear, here is an example:
8322:
8323: CONFIGURE_ARGS= # none
8324: CFLAGS= -O
8325: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
8326:
8327: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
8328:
8329: CFLAGS+= -Wall
8330:
8331: This code shows how the use of the := operator can quickly lead to unexpected
8332: results. The first paragraph is fairly common code. The second paragraph
8333: evaluates the CONFIGURE_ARGS variable, which results in CFLAGS=-O. In the third
8334: paragraph, the -Wall is appended to the CFLAGS, but this addition will not
8335: appear in CONFIGURE_ARGS. In actual code, the three paragraphs from above
8336: typically occur in completely unrelated files.
8337:
1.184 rillig 8338: 25.3.2. At runtime
1.1 dsieger 8339:
8340: After all the files have been loaded, the values of the variables cannot be
8341: changed anymore. Variables that are used in the shell commands are expanded at
8342: this point.
8343:
1.184 rillig 8344: 25.4. How can variables be specified?
1.1 dsieger 8345:
8346: There are many ways in which the definition and use of a variable can be
8347: restricted in order to detect bugs and violations of the (mostly unwritten)
1.108 rillig 8348: policies. A package can be checked with pkglint -Wall to see whether it meets
8349: these rules.
1.1 dsieger 8350:
1.184 rillig 8351: 25.5. Designing interfaces for Makefile fragments
1.1 dsieger 8352:
8353: Most of the .mk files fall into one of the following classes. Cases where a
8354: file falls into more than one class should be avoided as it often leads to
8355: subtle bugs.
8356:
1.184 rillig 8357: 25.5.1. Procedures with parameters
1.1 dsieger 8358:
8359: In a traditional imperative programming language some of the .mk files could be
1.198 leot 8360: described as procedures. They take some input parameters and--after
8361: inclusion--provide a result in output parameters. Since all variables in
1.23 jakllsch 8362: Makefiles have global scope care must be taken not to use parameter names that
8363: have already another meaning. For example, PKGNAME is a bad choice for a
8364: parameter name.
1.1 dsieger 8365:
8366: Procedures are completely evaluated at preprocessing time. That is, when
8367: calling a procedure all input parameters must be completely resolvable. For
8368: example, CONFIGURE_ARGS should never be an input parameter since it is very
8369: likely that further text will be added after calling the procedure, which would
8370: effectively apply the procedure to only a part of the variable. Also,
1.108 rillig 8371: references to other variables will be modified after calling the procedure.
1.1 dsieger 8372:
8373: A procedure can declare its output parameters either as suitable for use in
8374: preprocessing directives or as only available at runtime. The latter
8375: alternative is for variables that contain references to other runtime
8376: variables.
8377:
8378: Procedures shall be written such that it is possible to call the procedure more
8379: than once. That is, the file must not contain multiple-inclusion guards.
8380:
8381: Examples for procedures are mk/bsd.options.mk and mk/buildlink3/bsd.builtin.mk.
8382: To express that the parameters are evaluated at load time, they should be
8383: assigned using the := operator, which should be used only for this purpose.
8384:
1.184 rillig 8385: 25.5.2. Actions taken on behalf of parameters
1.1 dsieger 8386:
8387: Action files take some input parameters and may define runtime variables. They
8388: shall not define loadtime variables. There are action files that are included
8389: implicitly by the pkgsrc infrastructure, while other must be included
8390: explicitly.
8391:
8392: An example for action files is mk/subst.mk.
8393:
1.184 rillig 8394: 25.6. The order in which files are loaded
1.1 dsieger 8395:
8396: Package Makefiles usually consist of a set of variable definitions, and include
8397: the file ../../mk/bsd.pkg.mk in the very last line. Before that, they may also
8398: include various other *.mk files if they need to query the availability of
8399: certain features like the type of compiler or the X11 implementation. Due to
8400: the heavy use of preprocessor directives like .if and .for, the order in which
8401: the files are loaded matters.
8402:
8403: This section describes at which point the various files are loaded and gives
8404: reasons for that order.
8405:
1.184 rillig 8406: 25.6.1. The order in bsd.prefs.mk
1.1 dsieger 8407:
8408: The very first action in bsd.prefs.mk is to define some essential variables
8409: like OPSYS, OS_VERSION and MACHINE_ARCH.
8410:
1.4 rillig 8411: Then, the user settings are loaded from the file specified in MAKECONF, which
8412: is usually mk.conf. After that, those variables that have not been overridden
8413: by the user are loaded from mk/defaults/mk.conf.
1.1 dsieger 8414:
8415: After the user settings, the system settings and platform settings are loaded,
8416: which may override the user settings.
8417:
8418: Then, the tool definitions are loaded. The tool wrappers are not yet in effect.
8419: This only happens when building a package, so the proper variables must be used
8420: instead of the direct tool names.
8421:
8422: As the last steps, some essential variables from the wrapper and the package
8423: system flavor are loaded, as well as the variables that have been cached in
8424: earlier phases of a package build.
8425:
1.184 rillig 8426: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 8427:
8428: First, bsd.prefs.mk is loaded.
8429:
8430: Then, the various *-vars.mk files are loaded, which fill default values for
8431: those variables that have not been defined by the package. These variables may
8432: later be used even in unrelated files.
8433:
8434: Then, the file bsd.pkg.error.mk provides the target error-check that is added
8435: as a special dependency to all other targets that use DELAYED_ERROR_MSG or
8436: DELAYED_WARNING_MSG.
8437:
8438: Then, the package-specific hacks from hacks.mk are included.
8439:
8440: Then, various other files follow. Most of them don't have any dependencies on
8441: what they need to have included before or after them, though some do.
8442:
8443: The code to check PKG_FAIL_REASON and PKG_SKIP_REASON is then executed, which
8444: restricts the use of these variables to all the files that have been included
8445: before. Appearances in later files will be silently ignored.
8446:
8447: Then, the files for the main targets are included, in the order of later
8448: execution, though the actual order should not matter.
8449:
8450: At last, some more files are included that don't set any interesting variables
8451: but rather just define make targets to be executed.
8452:
1.184 rillig 8453: Chapter 26. Regression tests
1.1 dsieger 8454:
8455: Table of Contents
8456:
1.184 rillig 8457: 26.1. Running the regression tests
8458: 26.2. Adding a new regression test
8459: 26.2.1. Overridable functions
8460: 26.2.2. Helper functions
1.1 dsieger 8461:
8462: The pkgsrc infrastructure consists of a large codebase, and there are many
8463: corners where every little bit of a file is well thought out, making pkgsrc
8464: likely to fail as soon as anything is changed near those parts. To prevent most
8465: changes from breaking anything, a suite of regression tests should go along
8466: with every important part of the pkgsrc infrastructure. This chapter describes
8467: how regression tests work in pkgsrc and how you can add new tests.
8468:
1.184 rillig 8469: 26.1. Running the regression tests
1.1 dsieger 8470:
1.25 wiz 8471: You first need to install the pkgtools/pkg_regress package, which provides the
1.1 dsieger 8472: pkg_regress command. Then you can simply run that command, which will run all
1.168 rillig 8473: tests in the regress/ directory.
1.1 dsieger 8474:
1.184 rillig 8475: 26.2. Adding a new regression test
1.1 dsieger 8476:
1.168 rillig 8477: Every directory in the regress/ directory that contains a file called spec is
1.1 dsieger 8478: considered a regression test. This file is a shell program that is included by
8479: the pkg_regress command. The following functions can be overridden to suit your
8480: needs.
8481:
1.184 rillig 8482: 26.2.1. Overridable functions
1.1 dsieger 8483:
1.108 rillig 8484: These functions do not take any parameters. Although they are called in "set -e
1.168 rillig 8485: " mode, they don't stop at the first failing command. See this Stack Overflow
1.108 rillig 8486: question for details.
1.1 dsieger 8487:
1.108 rillig 8488: do_setup
1.1 dsieger 8489:
8490: This function prepares the environment for the test. By default it does
8491: nothing.
8492:
1.108 rillig 8493: do_test
1.1 dsieger 8494:
8495: This function runs the actual test. By default, it calls TEST_MAKE with the
8496: arguments MAKEARGS_TEST and writes its output including error messages into
8497: the file TEST_OUTFILE.
8498:
1.108 rillig 8499: When defining this function, make sure that all output that needs to be
8500: checked is written to the correct output file. Example:
8501:
8502: do_test() {
8503: echo "Example output"
8504: } 1>$TEST_OUTFILE 2>&1
8505:
8506: check_result
1.1 dsieger 8507:
8508: This function is run after the test and is typically used to compare the
8509: actual output from the one that is expected. It can make use of the various
1.108 rillig 8510: helper functions from the next section. Example:
8511:
8512: check_result() {
8513: exit_status 0
8514: output_require "Example"
8515: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
8516: output_prohibit "no such file or directory"
1.169 rillig 8517: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 8518: }
1.1 dsieger 8519:
1.108 rillig 8520: do_cleanup
1.1 dsieger 8521:
8522: This function cleans everything up after the test has been run. By default
8523: it does nothing.
8524:
1.184 rillig 8525: 26.2.2. Helper functions
1.1 dsieger 8526:
1.168 rillig 8527: regress_fail message...
8528:
8529: This function makes the test fail with the given error message.
8530:
1.108 rillig 8531: exit_status expected
1.1 dsieger 8532:
1.108 rillig 8533: This function compares the exitcode of the do_test function with its first
8534: parameter. If they differ, the test will fail.
1.1 dsieger 8535:
1.108 rillig 8536: output_require regex...
1.1 dsieger 8537:
8538: This function checks for each of its parameters if the output from do_test
1.108 rillig 8539: matches the extended regular expression. If it does not, the test will
8540: fail. Example:
8541:
8542: output_require "looks fine"
8543: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.1 dsieger 8544:
1.177 leot 8545: output_prohibit regex...
1.1 dsieger 8546:
8547: This function checks for each of its parameters if the output from do_test
8548: () does not match the extended regular expression. If any of the regular
8549: expressions matches, the test will fail.
8550:
1.184 rillig 8551: Chapter 27. Porting pkgsrc
1.1 dsieger 8552:
8553: Table of Contents
8554:
1.184 rillig 8555: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8556:
8557: The pkgsrc system has already been ported to many operating systems, hardware
8558: architectures and compilers. This chapter explains the necessary steps to make
8559: pkgsrc even more portable.
8560:
1.184 rillig 8561: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8562:
8563: To port pkgsrc to a new operating system (called MyOS in this example), you
8564: need to touch the following files:
8565:
8566: pkgtools/bootstrap-mk-files/files/mods/MyOS.sys.mk
8567:
8568: This file contains some basic definitions, for example the name of the C
8569: compiler.
8570:
8571: mk/bsd.prefs.mk
8572:
1.212 wiz 8573: Insert code that defines the variables OPSYS, OS_VERSION, OPSYS_VERSION,
1.1 dsieger 8574: LOWER_VENDOR, MACHINE_ARCH, OBJECT_FMT, APPEND_ELF, and the other variables
8575: that appear in this file.
8576:
8577: mk/platform/MyOS.mk
8578:
8579: This file contains the platform-specific definitions that are used by
8580: pkgsrc. Start by copying one of the other files and edit it to your needs.
8581:
8582: mk/tools/tools.MyOS.mk
8583:
8584: This file defines the paths to all the tools that are needed by one or the
8585: other package in pkgsrc, as well as by pkgsrc itself. Find out where these
8586: tools are on your platform and add them.
8587:
8588: Now, you should be able to build some basic packages, like lang/perl5, shells/
8589: bash.
8590:
8591: Appendix A. A simple example package: bison
8592:
8593: Table of Contents
8594:
8595: A.1. files
8596: A.1.1. Makefile
8597: A.1.2. DESCR
8598: A.1.3. PLIST
8599: A.1.4. Checking a package with pkglint
8600: A.2. Steps for building, installing, packaging
8601:
8602: We checked to find a piece of software that wasn't in the packages collection,
1.25 wiz 8603: and picked GNU bison. Quite why someone would want to have bison when Berkeley
1.1 dsieger 8604: yacc is already present in the tree is beyond us, but it's useful for the
8605: purposes of this exercise.
8606:
8607: A.1. files
8608:
8609: A.1.1. Makefile
8610:
1.2 rillig 8611: # $NetBSD$
1.1 dsieger 8612: #
8613:
8614: DISTNAME= bison-1.25
8615: CATEGORIES= devel
1.171 rillig 8616: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 8617:
1.30 dholland 8618: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 8619: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 8620: COMMENT= GNU yacc clone
8621:
8622: GNU_CONFIGURE= yes
1.47 wiz 8623: INFO_FILES= yes
1.1 dsieger 8624:
8625: .include "../../mk/bsd.pkg.mk"
8626:
8627: A.1.2. DESCR
8628:
8629: GNU version of yacc. Can make re-entrant parsers, and numerous other
8630: improvements. Why you would want this when Berkeley yacc(1) is part
8631: of the NetBSD source tree is beyond me.
8632:
8633: A.1.3. PLIST
8634:
1.2 rillig 8635: @comment $NetBSD$
1.1 dsieger 8636: bin/bison
8637: man/man1/bison.1.gz
8638: share/bison.simple
8639: share/bison.hairy
8640:
8641: A.1.4. Checking a package with pkglint
8642:
8643: The NetBSD package system comes with pkgtools/pkglint which helps to check the
8644: contents of these files. After installation it is quite easy to use, just
1.171 rillig 8645: change to the directory of the package you wish to examine and run pkglint:
1.1 dsieger 8646:
8647: $ pkglint
1.171 rillig 8648: ERROR: Makefile: Each package must define its LICENSE.
8649: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
8650: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
8651: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
8652: 1 error, 2 warnings and 1 note found.
8653: (Run "pkglint -e" to show explanations.)
8654: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 8655: (Run "pkglint -F" to automatically fix some issues.)
1.1 dsieger 8656:
8657: Depending on the supplied command line arguments (see pkglint(1)), more checks
1.170 rillig 8658: will be performed. Use e.g. pkglint -Wall for a very thorough check.
1.1 dsieger 8659:
8660: A.2. Steps for building, installing, packaging
8661:
8662: Create the directory where the package lives, plus any auxiliary directories:
8663:
8664: # cd /usr/pkgsrc/lang
8665: # mkdir bison
8666: # cd bison
8667: # mkdir patches
8668:
1.184 rillig 8669: Create Makefile, DESCR and PLIST (see Chapter 12, Package components - files,
1.1 dsieger 8670: directories and contents) then continue with fetching the distfile:
8671:
8672: # make fetch
8673: >> bison-1.25.tar.gz doesn't seem to exist on this system.
8674: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
8675: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8676: ftp: Error retrieving file: 500 Internal error
8677:
8678: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
8679: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8680: ftp: Error retrieving file: 500 Internal error
8681:
8682: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
8683: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8684: Successfully retrieved file.
8685:
8686: Generate the checksum of the distfile into distinfo:
8687:
8688: # make makedistinfo
8689:
8690: Now compile:
8691:
8692: # make
8693: >> Checksum OK for bison-1.25.tar.gz.
8694: ===> Extracting for bison-1.25
8695: ===> Patching for bison-1.25
8696: ===> Ignoring empty patch directory
8697: ===> Configuring for bison-1.25
8698: creating cache ./config.cache
8699: checking for gcc... cc
8700: checking whether we are using GNU C... yes
8701: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
8702: checking how to run the C preprocessor... cc -E
8703: checking for minix/config.h... no
8704: checking for POSIXized ISC... no
8705: checking whether cross-compiling... no
8706: checking for ANSI C header files... yes
8707: checking for string.h... yes
8708: checking for stdlib.h... yes
8709: checking for memory.h... yes
8710: checking for working const... yes
8711: checking for working alloca.h... no
8712: checking for alloca... yes
8713: checking for strerror... yes
8714: updating cache ./config.cache
8715: creating ./config.status
8716: creating Makefile
8717: ===> Building for bison-1.25
8718: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
8719: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
8720: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
8721: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
8722: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
8723: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\" -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -g ./files.c
8724: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
8725: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
8726: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lalr.c
8727: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lex.c
8728: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g main.c
8729: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g nullable.c
8730: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g output.c
8731: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g print.c
8732: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reader.c
8733: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reduce.c
8734: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g symtab.c
8735: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g warshall.c
8736: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g version.c
8737: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt.c
8738: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt1.c
8739: cc -g -o bison LR0.o allocate.o closure.o conflicts.o derives.o files.o getargs.o gram.o lalr.o lex.o main.o nullable.o output.o print.o reader.o reduce.o symtab.o warshall.o version.o getopt.o getopt1.o
8740: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
8741: rm -f bison.s1
8742: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1
8743:
8744: Everything seems OK, so install the files:
8745:
8746: # make install
8747: >> Checksum OK for bison-1.25.tar.gz.
8748: ===> Installing for bison-1.25
8749: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
8750: rm -f /usr/pkg/bin/bison
8751: cd /usr/pkg/share; rm -f bison.simple bison.hairy
8752: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
8753: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
8754: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
8755: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
8756: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
8757: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
8758: ===> Registering installation for bison-1.25
8759:
8760: You can now use bison, and also - if you decide so - remove it with pkg_delete
8761: bison. Should you decide that you want a binary package, do this now:
8762:
8763: # make package
8764: >> Checksum OK for bison-1.25.tar.gz.
8765: ===> Building package for bison-1.25
8766: Creating package bison-1.25.tgz
8767: Registering depends:.
8768: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
8769:
8770: Now that you don't need the source and object files any more, clean up:
8771:
8772: # make clean
8773: ===> Cleaning for bison-1.25
8774:
1.207 leot 8775: Appendix B. Security hardening
8776:
8777: Table of Contents
8778:
8779: B.1. Mechanisms
8780: B.1.1. Enabled by default
8781: B.1.2. Not enabled by default
8782: B.2. Caveats
8783: B.2.1. Problems with PKGSRC_MKPIE
8784: B.2.2. Problems with PKGSRC_USE_FORTIFY
8785: B.2.3. Problems with PKGSRC_USE_RELRO
8786: B.2.4. Problems with PKGSRC_USE_SSP
8787: B.3. Auditing the system
8788: B.3.1. Checking for PIE
8789: B.3.2. Checking for partial RELRO
8790: B.3.3. Checking for full RELRO
8791: B.3.4. Checking for SSP
8792:
8793: A number of mechanisms are available in pkgsrc to improve the security of the
8794: resulting system. This page describes the mechanisms, and gives hints about
8795: detecting and fixing problems.
8796:
8797: Mechanisms can be enabled individually in mk.conf, and are individually
8798: described below.
8799:
8800: Typically, a feature will cause some programs to fail to build or work when
8801: first enabled. This can be due to latent problems in the program, and can be
8802: due to other reasons. After enough testing to have confidence that user
8803: problems will be quite rare, individual mechanisms will be enabled by default.
8804:
8805: For each mechanism, see the Caveats section below for an explanation of what
8806: might go wrong at compile time and at run time, and how to notice and address
8807: these problems.
8808:
8809: B.1. Mechanisms
8810:
8811: B.1.1. Enabled by default
8812:
8813: B.1.1.1. PKGSRC_USE_FORTIFY
8814:
8815: This allows substitute wrappers to be used for some commonly used library
8816: functions that do not have built-in bounds checking - but could in some cases.
8817:
8818: Two mitigation levels are available:
8819:
8820: * "weak" only enables checks at compile-time.
8821:
8822: * "strong" enables checks at compile-time and runtime.
8823:
8824: "strong" has been enabled by default since pkgsrc-2017Q3.
8825:
8826: B.1.1.2. PKGSRC_USE_SSP
8827:
8828: This enables a stack-smashing protection mitigation. It is done by adding a
8829: guard variable to functions with vulnerable objects. The guards are initialized
8830: when a function is entered and then checked when the function exits. The guard
8831: check will fail and the program forcibly exited if the variable was modified in
8832: the meantime. This can happen in case of buffer overflows or memory corruption,
8833: and therefore exposing these bugs.
8834:
8835: Different mitigation levels are available:
8836:
8837: * "yes", which will only protect functions considered vulnerable by the
8838: compiler;
8839:
8840: * "all", which will protect every function;
8841:
8842: * "strong", the default, which will apply a better balance between the two
8843: settings above.
8844:
8845: This mitigation is supported by both GCC and clang. It may be supported in
8846: additional compilers, possibly under a different name. It is particularly
8847: useful for unsafe programming languages, such as C/C++.
8848:
8849: * "yes" is enabled by default where known supported since pkgsrc-2017Q3.
8850:
8851: * "strong" is enabled by default where known supported since pkgsrc-2021Q4.
8852:
8853: More details can be found here:
8854:
8855: * Buffer overflow protection on Wikipedia
8856:
8857: B.1.1.3. PKGSRC_MKPIE
8858:
8859: This requests the creation of PIE (Position Independent Executables) for all
8860: executables. The PIE mechanism is normally used for shared libraries, so that
8861: they can be loaded at differing addresses at runtime. PIE itself does not have
8862: useful security properties; however, it is necessary to fully leverage some,
8863: such as ASLR. Some operating systems support Address Space Layout Randomization
8864: (ASLR), which causes different addresses to be used each time a program is run.
8865: This makes it more difficult for an attacker to guess addresses and thus makes
8866: exploits harder to construct. With PIE, ASLR can really be applied to the
8867: entire program, instead of the stack and heap only.
8868:
8869: PIE executables will only be built for toolchains that are known to support
8870: PIE. Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
8871:
8872: PKGSRC_MKPIE was enabled by default after the pkgsrc-2021Q3 branch.
8873:
1.219 nia 8874: B.1.1.4. PKGSRC_USE_RELRO
1.207 leot 8875:
8876: This also makes the exploitation of some security vulnerabilities more
8877: difficult in some cases.
8878:
8879: Two different mitigation levels are available:
8880:
1.219 nia 8881: * partial (the default): the ELF sections are reordered so that internal data
8882: sections precede the program's own data sections, and non-PLT GOT is
8883: read-only;
1.207 leot 8884:
8885: * full: in addition to partial RELRO, every relocation is performed
1.218 nia 8886: immediately when starting the program, allowing the entire GOT to be
8887: read-only. This can greatly slow down startup of large programs.
1.207 leot 8888:
8889: This is currently supported by GCC. Many software distributions now enable this
1.220 nia 8890: feature by default, at the "partial" level.
1.207 leot 8891:
8892: More details can be found here:
8893:
8894: * Hardening ELF binaries using Relocation Read-Only (RELRO)
8895:
1.219 nia 8896: B.1.2. Not enabled by default
8897:
8898: B.1.2.1. PKGSRC_MKREPRO
8899:
8900: With this option, pkgsrc will try to build packages reproducibly. This allows
8901: packages built from the same tree and with the same options, to produce
8902: identical results bit by bit. This option should be combined with ASLR and
8903: PKGSRC_MKPIE to avoid predictable address offsets for attackers attempting to
8904: exploit security vulnerabilities.
8905:
8906: More details can be found here:
8907:
8908: * Reproducible Builds - a set of software development practices that create
8909: an independently-verifiable path from source to binary code
8910:
8911: More work likely needs to be done before pkgsrc is fully reproducible.
8912:
8913: B.1.2.2. PKGSRC_USE_STACK_CHECK
1.207 leot 8914:
8915: This uses -fstack-check with GCC for another stack protection mitigation.
8916:
8917: It asks the compiler to generate code verifying that it does not corrupt the
8918: stack. According to GCC's manual page, this is really only useful for
8919: multi-threaded programs.
8920:
8921: B.2. Caveats
8922:
8923: B.2.1. Problems with PKGSRC_MKPIE
8924:
8925: B.2.1.1. Packages failing to build
8926:
8927: A number of packages may fail to build with this option enabled. The failures
8928: are often related to the absence of the -fPIC compilation flag when building
8929: libraries or executables (or ideally -fPIE in the latter case). This flag is
8930: added to the CFLAGS already, but requires the package to actually support it.
8931:
8932: B.2.1.1.1. How to fix
8933:
8934: These instructions are meant as a reference only; they likely need to be
8935: adapted for many packages individually.
8936:
8937: For packages using Makefiles:
8938:
8939: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
8940: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
8941:
8942: For packages using Imakefiles:
8943:
8944: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
8945: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
8946:
8947: B.2.1.2. Run-time crashes
8948:
8949: Some programs may fail to run, or crash at random times once built as PIE. Two
8950: scenarios are essentially possible. This is nearly always due to a bug in the
8951: program being exposed due to ASLR.
8952:
8953: B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis
8954:
8955: Ideally, packages should be fixed for compatibility with MKPIE. However, in
8956: some cases this is very difficult, due to complex build systems, packages using
8957: non-standard toolchains, or programming languages with odd bootstrapping
8958: mechanisms.
8959:
8960: To disable PKGSRC_MKPIE on a per-package basis, set MKPIE_SUPPORTED= no in the
8961: package's Makefile before bsd.prefs.mk is included.
8962:
8963: B.2.2. Problems with PKGSRC_USE_FORTIFY
8964:
8965: B.2.2.1. Packages failing to build
8966:
8967: This feature makes use of pre-processing directives to look for hardened,
8968: alternative implementations of essential library calls. Some programs may fail
8969: to build as a result; this usually happens for those trying too hard to be
8970: portable, or otherwise abusing definitions in the standard library.
8971:
8972: B.2.2.2. Run-time crashes
8973:
8974: This feature may cause some programs to crash, usually indicating an actual bug
8975: in the program. The fix will typically involve patching the original program's
8976: source code.
8977:
8978: B.2.2.3. Optimization is required
8979:
8980: At least in the case of GCC, FORTIFY will only be applied if optimization is
8981: applied while compiling. This means that the CFLAGS should also contain -O, -O2
8982: or another optimization level. This cannot easily be applied globally, as some
8983: packages may require specific optimization levels.
8984:
8985: B.2.2.4. Disabling FORTIFY on a per-package basis
8986:
8987: Note
8988:
8989: FORTIFY should not be disabled to work around runtime crashes in the program!
8990: This is a very bad idea and will expose you to security vulnerabilities.
8991:
8992: To disable FORTIFY on a per-package basis, set the following in the package's
8993: Makefile before bsd.prefs.mk is included:
8994:
8995: FORTIFY_SUPPORTED= no
8996:
8997: B.2.3. Problems with PKGSRC_USE_RELRO
8998:
8999: B.2.3.1. Performance impact
9000:
9001: For better protection, full RELRO requires every symbol to be resolved when the
9002: program starts, rather than simply when required at run-time. This will have
9003: more impact on programs using a lot of symbols, or linked to libraries exposing
9004: a lot of symbols. Therefore, daemons or programs otherwise running in
9005: background are affected only when started. Programs loading plug-ins at
9006: run-time are affected when loading the plug-ins.
9007:
9008: The impact is not expected to be noticeable on modern hardware, except in some
9009: cases for big programs.
9010:
9011: B.2.3.2. Run-time crashes
9012:
9013: Some programs handle plug-ins and dependencies in a way that conflicts with
9014: RELRO: for instance, with an initialization routine listing any other plug-in
9015: required. With full RELRO, the missing symbols are resolved before the
9016: initialization routine can run, and the dynamic loader will not be able to find
9017: them directly and abort as a result. Unfortunately, this is how Xorg loads its
9018: drivers. Partial RELRO can be applied instead in this case.
9019:
9020: B.2.3.3. Disabling RELRO on a per-package basis
9021:
9022: To disable RELRO on a per-package basis, set the following in the package's
9023: Makefile before bsd.prefs.mk is included:
9024:
9025: RELRO_SUPPORTED= no
9026:
1.209 nia 9027: It is also possible to at most enable partial RELRO, by setting RELRO_SUPPORTED
9028: to partial.
9029:
1.207 leot 9030: B.2.4. Problems with PKGSRC_USE_SSP
9031:
9032: B.2.4.1. Packages failing to build
9033:
9034: The stack-smashing protection provided by this option does not work for some
9035: programs. The most common situation in which this happens is when the program
9036: allocates variables on the stack, with the size determined at run-time.
9037:
9038: B.2.4.2. Run-time crashes
9039:
9040: Again, this feature may cause some programs to crash via a SIGABRT, usually
9041: indicating an actual bug in the program.
9042:
9043: On NetBSD LOG_CRIT level syslog messages are sent and - by default - appended
9044: to /var/log/messages, e.g.:
9045:
9046: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
9047:
9048: (where hostname is the hostname(1) and program is the basename(1) of the
9049: program crashed).
9050:
9051: Patching the original program is then required.
9052:
9053: Rebuilding the package via:
9054:
9055: % env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace
9056:
9057: and inspecting the backtrace of the coredump via the debugger should point out
9058: the problematic call by inspecting the frame calling the _chk() (SSP) function.
9059:
9060: B.2.4.3. Performance impact
9061:
9062: The compiler emits extra code when using this feature: a check for buffer
9063: overflows is performed when entering and exiting functions, requiring an extra
9064: variable on the stack. The level of protection can otherwise be adjusted to
9065: affect only those functions considered more sensitive by the compiler (with
9066: -fstack-protector instead of -fstack-protector-all).
9067:
9068: The impact is not expected to be noticeable on modern hardware. However,
9069: programs with a hard requirement to run at the fastest possible speed should
9070: avoid using this feature, or using libraries built with this feature.
9071:
9072: B.2.4.4. Disabling SSP on a per-package basis
9073:
9074: Note
9075:
9076: SSP should not be disabled to work around runtime crashes in the program! This
9077: is a very bad idea and will expose you to security vulnerabilities.
9078:
9079: To disable SSP on a per-package basis, set the following in the package's
9080: Makefile before bsd.prefs.mk is included:
9081:
9082: SSP_SUPPORTED= no
9083:
9084: B.3. Auditing the system
9085:
9086: The illusion of security is worse than having no security at all. This section
9087: lists a number of ways to ensure the security features requested are actually
9088: effective.
9089:
9090: These instructions were obtained and tested on a system derived from NetBSD 7
9091: (amd64). YMMV.
9092:
9093: B.3.1. Checking for PIE
9094:
9095: The ELF executable type in use changes for binaries built as PIE; without:
9096:
9097: $ file /path/to/bin/ary
9098: /path/to/bin/ary: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for NetBSD 7.0, not stripped
9099:
9100: as opposed to the following binary, built as PIE:
9101:
9102: $ file /path/to/pie/bin/ary
9103: /path/to/pie/bin/ary: ELF 64-bit LSB shared object, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for NetBSD 7.0, not stripped
9104:
9105: The latter result is then what is expected.
9106:
9107: B.3.2. Checking for partial RELRO
9108:
9109: The following command should list a section called RELRO:
9110:
9111: $ objdump -p /path/to/bin/ary
9112:
9113: /path/to/bin/ary: file format elf64-x86-64
9114:
9115: Program Header:
9116: [...]
9117: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
9118:
9119: This check is now performed automatically if PKG_DEVELOPER is set and RELRO is
9120: enabled.
9121:
9122: B.3.3. Checking for full RELRO
9123:
9124: The dynamic loader will apply RELRO immediately when detecting the presence of
9125: the BIND_NOW flag:
9126:
9127: $ objdump -x /path/to/bin/ary
9128:
9129: /path/to/bin/ary: file format elf64-x86-64
9130:
9131: Dynamic Section:
9132: [...]
9133: BIND_NOW 0x0000000000000000
9134:
9135: This has to be combined with partial RELRO (see above) to be fully efficient.
9136:
9137: This check is now performed automatically (where supported) if PKG_DEVELOPER is
9138: set.
9139:
9140: B.3.4. Checking for SSP
9141:
1.208 nia 9142: Note
9143:
9144: Checking for SSP using this method only works where the operating system uses
9145: libssp. libssp is not used on recent NetBSD/FreeBSD/Linux versions.
9146:
1.207 leot 9147: Building objects, binaries and libraries with SSP will affect the presence of
9148: additional symbols in the resulting file:
9149:
9150: $ nm /path/to/bin/ary
9151: [...]
9152: U __stack_chk_fail
9153: 0000000000600ea0 B __stack_chk_guard
9154:
9155: This is an indicator that the program was indeed built with support for SSP.
9156:
9157: This check is now performed automatically (where supported) if PKG_DEVELOPER is
9158: set and SSP is enabled.
9159:
9160: Appendix C. Build logs
1.1 dsieger 9161:
9162: Table of Contents
9163:
1.207 leot 9164: C.1. Building figlet
9165: C.2. Packaging figlet
1.1 dsieger 9166:
1.207 leot 9167: C.1. Building figlet
1.1 dsieger 9168:
9169: # make
9170: ===> Checking for vulnerabilities in figlet-2.2.1nb2
9171: => figlet221.tar.gz doesn't seem to exist on this system.
9172: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
9173: => [172219 bytes]
9174: Connected to ftp.plig.net.
9175: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
9176: 331 Guest login ok, send your complete e-mail address as password.
9177: 230-You are user #5 of 500 simultaneous users allowed.
9178: 230-
9179: 230- ___ _ _ _
9180: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
9181: 230- | _| _| . |_| . | | | . |_| . | _| . |
9182: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
9183: 230- |_| |_| |___| |___|
9184: 230-
9185: 230-** Welcome to ftp.plig.org **
9186: 230-
9187: 230-Please note that all transfers from this FTP site are logged. If you
9188: 230-do not like this, please disconnect now.
9189: 230-
1.19 snj 9190: 230-This archive is available via
1.1 dsieger 9191: 230-
9192: 230-HTTP: http://ftp.plig.org/
9193: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
9194: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
9195: 230-
9196: 230-Please email comments, bug reports and requests for packages to be
9197: 230-mirrored to ftp-admin@plig.org.
9198: 230-
9199: 230-
9200: 230 Logged in anonymously.
9201: Remote system type is UNIX.
9202: Using binary mode to transfer files.
9203: 200 Type okay.
9204: 250 "/pub" is new cwd.
9205: 250-"/pub/figlet" is new cwd.
9206: 250-
9207: 250-Welcome to the figlet archive at ftp.figlet.org
9208: 250-
9209: 250- ftp://ftp.figlet.org/pub/figlet/
9210: 250-
9211: 250-The official FIGlet web page is:
9212: 250- http://www.figlet.org/
9213: 250-
9214: 250-If you have questions, please mailto:info@figlet.org. If you want to
9215: 250-contribute a font or something else, you can email us.
9216: 250
9217: 250 "/pub/figlet/program" is new cwd.
9218: 250 "/pub/figlet/program/unix" is new cwd.
9219: local: figlet221.tar.gz remote: figlet221.tar.gz
9220: 502 Unimplemented command.
9221: 227 Entering Passive Mode (195,40,6,41,246,104)
9222: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
9223: 38% |************** | 65800 64.16 KB/s 00:01 ETA
9224: 226 Transfer completed.
9225: 172219 bytes received in 00:02 (75.99 KB/s)
9226: 221 Goodbye.
9227: => Checksum OK for figlet221.tar.gz.
9228: ===> Extracting for figlet-2.2.1nb2
9229: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
9230: ===> Patching for figlet-2.2.1nb2
9231: ===> Applying pkgsrc patches for figlet-2.2.1nb2
9232: ===> Overriding tools for figlet-2.2.1nb2
9233: ===> Creating toolchain wrappers for figlet-2.2.1nb2
9234: ===> Configuring for figlet-2.2.1nb2
9235: ===> Building for figlet-2.2.1nb2
9236: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
9237: chmod a+x figlet
9238: gcc -O2 -o chkfont chkfont.c
9239: => Unwrapping files-to-be-installed.
9240: #
9241: # make install
9242: ===> Checking for vulnerabilities in figlet-2.2.1nb2
9243: ===> Installing for figlet-2.2.1nb2
9244: install -d -o root -g wheel -m 755 /usr/pkg/bin
9245: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
9246: mkdir -p /usr/pkg/share/figlet
9247: cp figlet /usr/pkg/bin
9248: cp chkfont /usr/pkg/bin
9249: chmod 555 figlist showfigfonts
9250: cp figlist /usr/pkg/bin
9251: cp showfigfonts /usr/pkg/bin
9252: cp fonts/*.flf /usr/pkg/share/figlet
9253: cp fonts/*.flc /usr/pkg/share/figlet
9254: cp figlet.6 /usr/pkg/man/man6
9255: ===> Registering installation for figlet-2.2.1nb2
9256: #
9257:
1.207 leot 9258: C.2. Packaging figlet
1.1 dsieger 9259:
9260: # make package
9261: ===> Checking for vulnerabilities in figlet-2.2.1nb2
9262: ===> Packaging figlet-2.2.1nb2
9263: ===> Building binary package for figlet-2.2.1nb2
9264: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
9265: Using SrcDir value of /usr/pkg
9266: Registering depends:.
9267: #
9268:
1.207 leot 9269: Appendix D. Directory layout of the pkgsrc FTP server
1.1 dsieger 9270:
9271: Table of Contents
9272:
1.207 leot 9273: D.1. distfiles: The distributed source files
9274: D.2. misc: Miscellaneous things
9275: D.3. packages: Binary packages
9276: D.4. reports: Bulk build reports
9277: D.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 9278:
9279: As in other big projects, the directory layout of pkgsrc is quite complex for
9280: newbies. This chapter explains where you find things on the FTP server. The
9281: base directory on ftp.NetBSD.org is /pub/pkgsrc/. On other servers it may be
9282: different, but inside this directory, everything should look the same, no
9283: matter on which server you are. This directory contains some subdirectories,
9284: which are explained below.
9285:
1.207 leot 9286: D.1. distfiles: The distributed source files
1.1 dsieger 9287:
9288: The directory distfiles contains lots of archive files from all pkgsrc
9289: packages, which are mirrored here. The subdirectories are called after their
9290: package names and are used when the distributed files have names that don't
9291: explicitly contain a version number or are otherwise too generic (for example
9292: release.tar.gz).
9293:
1.207 leot 9294: D.2. misc: Miscellaneous things
1.1 dsieger 9295:
9296: This directory contains things that individual pkgsrc developers find worth
9297: publishing.
9298:
1.207 leot 9299: D.3. packages: Binary packages
1.1 dsieger 9300:
1.3 rillig 9301: This directory contains binary packages for the various platforms that are
9302: supported by pkgsrc. Each subdirectory is of the form OPSYS/ARCH/OSVERSION_TAG.
9303: The meaning of these variables is:
9304:
9305: * OPSYS is the name of the operating system for which the packages have been
1.9 rillig 9306: built. The name is taken from the output of the uname command, so it may
9307: differ from the one you are used to hear.
1.3 rillig 9308:
1.8 rillig 9309: * ARCH is the hardware architecture of the platform for which the packages
1.10 hubertf 9310: have been built. It also includes the ABI (Application Binary Interface)
9311: for platforms that have several of them.
1.3 rillig 9312:
1.8 rillig 9313: * OSVERSION is the version of the operating system. For version numbers that
9314: change often (for example NetBSD-current), the often-changing part should
9315: be replaced with an x, for example 4.99.x.
1.3 rillig 9316:
1.23 jakllsch 9317: * TAG is either 20xxQy for a stable branch, or head for packages built from
1.8 rillig 9318: the HEAD branch. The latter should only be used when the packages are
9319: updated on a regular basis. Otherwise the date from checking out pkgsrc
9320: should be appended, for example head_20071015.
1.3 rillig 9321:
9322: The rationale for exactly this scheme is that the pkgsrc users looking for
9323: binary packages can quickly click through the directories on the server and
9324: find the best binary packages for their machines. Since they usually know the
9325: operating system and the hardware architecture, OPSYS and ARCH are placed
9326: first. After these choices, they can select the best combination of OSVERSION
9327: and TAG together, since it is usually the case that packages stay compatible
9328: between different version of the operating system.
9329:
9330: In each of these directories, there is a whole binary packages collection for a
9331: specific platform. It has a directory called All which contains all binary
9332: packages. Besides that, there are various category directories that contain
9333: symbolic links to the real binary packages.
1.1 dsieger 9334:
1.207 leot 9335: D.4. reports: Bulk build reports
1.8 rillig 9336:
9337: Here are the reports from bulk builds, for those who want to fix packages that
9338: didn't build on some of the platforms. The structure of subdirectories should
1.207 leot 9339: look like the one in Section D.3, "packages: Binary packages".
1.8 rillig 9340:
1.207 leot 9341: D.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 9342:
9343: These directories contain the "real" pkgsrc, that is the files that define how
9344: to create binary packages from source archives.
9345:
1.149 leot 9346: Each of the current, stable and pkgsrc-20xxQy directories share the same
9347: structure. They each contain a pkgsrc directory and pkgsrc.tar.{bz,gz,xz} file.
9348:
1.1 dsieger 9349: The directory pkgsrc contains a snapshot of the CVS repository, which is
1.149 leot 9350: updated regularly. The file pkgsrc.tar.{bz,gz,xz} contains the same as the
9351: directory, ready to be downloaded as a whole.
1.1 dsieger 9352:
1.149 leot 9353: The current directory contains files related to the HEAD branch of the CVS
9354: repository. In this directory there is an additional file called
9355: pkgsrc-readmes.tar.{bz,gz,xz} that contains all pkgsrc READMEs with information
9356: about categories and packages.
9357:
9358: The stable directory is a symlink to the latest pkgsrc-20xxQy.
9359:
9360: The pkgsrc-20xxQy. directories contain files related to the -20xxQy stable
9361: branch of the CVS repository. In these directories there is an additional file
9362: called pkgsrc-20xxQy.tar.{bz,gz,xz}, which contains the state of pkgsrc when it
9363: was branched.
1.148 leot 9364:
1.207 leot 9365: Appendix E. Help topics
1.154 rillig 9366:
9367: The following list contains all help topics that are available when running
9368: bmake help topic=:index.
9369:
1.243 gutterid 9370: #! -lintl
9371: 32bit 64bit
9372: ABI ACCEPTABLE_LICENSES
9373: ACROREAD_FONTPATH ADDITIONAL
9374: AFAIK AIX
9375: ALLOW_NEWER_COMPILER ALLOW_VULNERABLE_PACKAGES
1.246 leot 9376: ALL_ENV ALSA_PC
9377: ALTERNATIVES_SRC AMANDA_TMP
9378: AMANDA_USER AMANDA_VAR
9379: APACHE_GROUP APACHE_MODULE_NAME
9380: APACHE_MODULE_SRC APACHE_MODULE_SRCDIR
9381: APACHE_PKG_PREFIX APACHE_SUEXEC_CONFIGURE_ARGS
9382: APACHE_SUEXEC_DOCROOT APACHE_USER
9383: APPEND_ABI APPEND_ELF
9384: ARLA_CACHE AUDIT_PACKAGES_FLAGS
9385: AUTOCONF_REQD AUTOMAKE_OVERRIDE
9386: AUTOMAKE_REQD AUTO_MKDIRS
9387: BDB185_DEFAULT BDBBASE
9388: BDB_ACCEPTED BDB_DEFAULT
9389: BDB_LIBS BDB_TYPE
9390: BINCIMAP_GROUP BINCIMAP_USER
9391: BIND_DIR BIND_GROUP
9392: BIND_USER BINOWN
9393: BINPKG_SITES BIN_INSTALL_FLAGS
9394: BISON_PKGDATADIR BLAS
9395: BLAS_ACCEPTED BLAS_C_INTERFACE
9396: BLAS_INCLUDES BLAS_INDEX64
9397: BLAS_LIBS BLAS_PC
9398: BLAS_TYPE BOOTSTRAP_DEPENDS
9399: BROKEN BROKEN_EXCEPT_ON_PLATFORM
9400: BROKEN_ON_PLATFORM BSDSRCDIR
9401: BSDXSRCDIR BSD_MAKE_ENV
9402: BUILDLINK_AUTO_DIRS BUILDLINK_AUTO_VARS
9403: BUILDLINK_CFLAGS BUILDLINK_CONTENTS_FILTER
9404: BUILDLINK_CPPFLAGS BUILDLINK_DEPMETHOD
1.243 gutterid 9405: BUILDLINK_FILES BUILDLINK_FILES_CMD
9406: BUILDLINK_FNAME_TRANSFORM BUILDLINK_LDFLAGS
9407: BUILDLINK_LIBS BUILDLINK_OPSYS_SUPPORT_PTHREAD
9408: BUILDLINK_PKGNAME BUILDLINK_PREFIX
9409: BUILDLINK_RPATHDIRS BUILDLINK_TREE
9410: BUILD_DEFS BUILD_DEFS_EFFECTS
9411: BUILD_DEPENDS BUILD_DIRS
9412: BUILD_ENV_SHELL BUILD_MAKE_CMD
9413: BUILD_MAKE_FLAGS BUILD_TARGET
9414: BUILTIN_FIND_FILES BUILTIN_FIND_FILES_VAR
9415: BUILTIN_FIND_GREP BUILTIN_FIND_HEADERS
9416: BUILTIN_FIND_HEADERS_VAR BUILTIN_FIND_PKGCONFIG
9417: BUILTIN_FIND_PKGCONFIG_VAR BUILTIN_PKG
9418: BUILTIN_TEST_CURSES_DEFINES BUILTIN_TEST_CURSES_FUNCS
9419: BUILTIN_VERSION_SCRIPT BUILTIN_X11_TYPE
9420: BUILTIN_X11_VERSION CACTI_GROUP
9421: CACTI_USER CANNA_GROUP
9422: CANNA_USER CAT
9423: CBLAS_LIBS CBLAS_PC
9424: CCACHE_BASE CCACHE_DIR
9425: CCACHE_LOGFILE CC_VERSION
9426: CC_VERSION_STRING CDRECORD_CONF
9427: CDROM_PKG_URL_DIR CDROM_PKG_URL_HOST
1.246 leot 9428: CHANGES CHECKOUT_DATE
9429: CHECK_COMPILER CHECK_FAKEHOME
9430: CHECK_FILES CHECK_FILES_SKIP
9431: CHECK_FILES_STRICT CHECK_HEADERS
9432: CHECK_HEADERS_SKIP CHECK_INTERPRETER
9433: CHECK_INTERPRETER_SKIP CHECK_PERMS
9434: CHECK_PERMS_AUTOFIX CHECK_PERMS_SKIP
9435: CHECK_PIE CHECK_PIE_SKIP
9436: CHECK_PIE_SUPPORTED CHECK_PORTABILITY
9437: CHECK_PORTABILITY_EXPERIMENTAL CHECK_PORTABILITY_SKIP
9438: CHECK_RELRO CHECK_RELRO_SKIP
9439: CHECK_RELRO_SUPPORTED CHECK_SHLIBS
9440: CHECK_SHLIBS_SKIP CHECK_SHLIBS_SUPPORTED
9441: CHECK_SHLIBS_TOXIC CHECK_SSP
9442: CHECK_SSP_SKIP CHECK_SSP_SUPPORTED
9443: CHECK_STRIPPED CHECK_STRIPPED_SKIP
9444: CHECK_WRKREF CHECK_WRKREF_EXTRA_DIRS
9445: CHECK_WRKREF_SKIP CLAMAV_DBDIR
9446: CLAMAV_GROUP CLAMAV_USER
9447: CLANGBASE CLEANDEPENDS
9448: CMAKE_DEPENDENCIES_REWRITE CMAKE_INSTALL_NAME_DIR
9449: CMAKE_INSTALL_PREFIX CMAKE_MODULE_PATH_OVERRIDE
9450: CMAKE_PKGSRC_BUILD_FLAGS CMAKE_PREFIX_PATH
9451: CMAKE_USE_GNU_INSTALL_DIRS COMMON_LISP_DOCFILES
9452: COMMON_LISP_EXAMPLES COMMON_LISP_EXTRAFILES
9453: COMMON_LISP_PACKAGES COMMON_LISP_SYSTEM
1.243 gutterid 9454: COMPILER_RPATH_FLAG COMPILER_USE_SYMLINKS
9455: CONFIGURE_ARGS CONFIGURE_DIRS
9456: CONFIGURE_ENV CONFIGURE_ENV_SHELL
9457: CONFIGURE_HAS_INFODIR CONFIGURE_HAS_MANDIR
9458: CONFIGURE_SCRIPT CONFIG_SHELL
9459: CONFIG_SHELL_FLAGS CONF_FILES
9460: CONF_FILES_MODE CONF_FILES_PERMS
9461: CONSERVER_DEFAULTHOST CONSERVER_DEFAULTPORT
9462: CP CPE
9463: CPE_EDITION CPE_LANG
9464: CPE_OTHER CPE_PART
9465: CPE_PRODUCT CPE_SW_EDITION
9466: CPE_TARGET_HW CPE_TARGET_SW
9467: CPE_UPDATE CPE_URI
9468: CPE_VENDOR CPE_VERSION
9469: CPP CPP_PRECOMP_FLAGS
9470: CREATE_WRKDIR_SYMLINK CROSSBASE
9471: CTFCONVERT CTF_FILES_SKIP
9472: CTF_SUPPORTED CTYPE
9473: CUPS_GROUP CUPS_SYSTEM_GROUPS
9474: CUPS_USER CURSES_DEFAULT
1.246 leot 9475: CURSES_TYPE CVS_EXTRACTDIR
9476: CVS_MODULE CVS_PROJECT
9477: CVS_REPOSITORIES CVS_ROOT
9478: CVS_ROOT_GNU CVS_ROOT_NONGNU
9479: CVS_ROOT_SOURCEFORGE CVS_TAG
9480: CXX CYRUS_GROUP
9481: CYRUS_IDLE CYRUS_USER
9482: DAEMONTOOLS_GROUP DAEMONTOOLS_LOG_USER
9483: DARWIN_NO_SYSTEM_LIBS DARWIN_REQUIRES_FILTER
9484: DBUS_GROUP DBUS_USER
9485: DEFANG_GROUP DEFANG_USER
9486: DEFAULT_ACCEPTABLE_LICENSES DEFAULT_DISTFILES
9487: DEFAULT_IRC_SERVER DEFAULT_SERIAL_DEVICE
9488: DEF_UMASK DEINSTALLDEPENDS
9489: DEINSTALL_SRC DEINSTALL_TEMPLATES
9490: DELAYED_ERROR_MSG DELAYED_WARNING_MSG
9491: DEPENDS DEPENDS_TARGET
9492: DEPENDS_TYPE DESTDIR
9493: DESTDIR_VARNAME DIALER_GROUP
9494: DIGEST_REQD DISTDIR
9495: DISTFILES DISTINFO_FILE
9496: DISTNAME DIST_PATH
9497: DIST_SUBDIR DJBDNS_AXFR_USER
9498: DJBDNS_CACHE_USER DJBDNS_DJBDNS_GROUP
9499: DJBDNS_LOG_USER DJBDNS_RBL_USER
9500: DJBDNS_TINY_USER DLOPEN_REQUIRE_PTHREADS
9501: DL_AUTO_VARS DL_CFLAGS
9502: DL_LDFLAGS DL_LIBS
9503: DNS DOCOWN
9504: DOWNLOADED_DISTFILE DQCACHE_GROUP
9505: DQCACHE_USER DT_LAYOUT
9506: DYNAMIC_SITES_CMD DYNAMIC_SITES_SCRIPT
9507: ECHO ECHO_N
9508: ELK_GUI EMACS_TYPE
9509: EMULDIR EMULSUBDIR
9510: EMULSUBDIRSLASH EMUL_ARCH
9511: EMUL_DISTRO EMUL_EXEC_FMT
9512: EMUL_IS_NATIVE EMUL_MODULES
9513: EMUL_OPSYS EMUL_PKG_FMT
9514: EMUL_PLATFORM EMUL_PLATFORMS
9515: EMUL_PREFER EMUL_REQD
9516: EMUL_TYPE ERROR_MSG
9517: EXIM_GROUP EXIM_USER
9518: EXPORT_SYMBOLS_LDFLAGS EXTRACTOR
9519: EXTRACT_CMD EXTRACT_CMD_DEFAULT
9520: EXTRACT_DIR EXTRACT_ELEMENTS
9521: EXTRACT_ENV EXTRACT_ONLY
9522: EXTRACT_OPTS EXTRACT_SUFX
9523: EXTRACT_USING FAIL
9524: FAILOVER_FETCH FAIL_MSG
9525: FAKE_NCURSES FAM
9526: FAM_ACCEPTED FAM_DEFAULT
9527: FAM_SERVER FCPATH
9528: FEATURE_CPPFLAGS FEATURE_LDFLAGS
9529: FEATURE_LIBS FETCH_AFTER_ARGS
9530: FETCH_BEFORE_ARGS FETCH_CMD
9531: FETCH_OUTPUT_ARGS FETCH_PROXY
9532: FETCH_RESUME_ARGS FETCH_TIMEOUT
9533: FETCH_USE_IPV4_ONLY FETCH_USING
9534: FILES_SUBST FILES_SUBST_SED
9535: FIX_SYSTEM_HEADERS FONTDIR
1.243 gutterid 9536: FONTS_DIRS FONTS_VERBOSE
1.244 gutterid 9537: FOO_HACKS_MK FORCE_CXX_STD
1.246 leot 9538: FORCE_C_STD FOSSIL_EXTRACTDIR
9539: FOSSIL_REPO FOSSIL_REPOSITORIES
9540: FOSSIL_VERSION FOX_USE_XUNICODE
1.243 gutterid 9541: FREEWNN_GROUP FREEWNN_USER
9542: FTP_PKG_URL_DIR FTP_PKG_URL_HOST
9543: GAMEDATAMODE GAMEDATA_PERMS
9544: GAMEDIRMODE GAMEDIR_PERMS
9545: GAMEGRP GAMEMODE
9546: GAMEOWN GAMES_GROUP
9547: GAMES_USER GCC
9548: GCCBASE GCC_REQD
9549: GCC_VERSION_SUFFIX GEM_BUILD
9550: GEM_CLEANBUILD GEM_CLEANBUILD_EXTENSIONS
9551: GEM_DOCDIR GEM_EXTSDIR
9552: GEM_HOME GEM_KEEPBUILD
9553: GEM_LIBDIR GEM_NAME
9554: GEM_PATH GEM_PLUGINSDIR
9555: GEM_SPECFILE GENERATE_PLIST
9556: GHC GHOSTSCRIPT_REQD
9557: GITHUB_PROJECT GITHUB_RELEASE
9558: GITHUB_SUBMODULES GITHUB_TAG
9559: GITHUB_TYPE GITLAB_PROJECT
9560: GITLAB_RELEASE GITLAB_SUBMODULES
9561: GITLAB_TAG GITLAB_TYPE
1.246 leot 9562: GIT_BRANCH GIT_ENV
9563: GIT_EXTRACTDIR GIT_REPO
9564: GIT_REPOSITORIES GIT_REVISION
9565: GIT_TAG GNU
9566: GNU_CONFIGURE GNU_CONFIGURE_INFODIR
9567: GNU_CONFIGURE_MANDIR GNU_CONFIGURE_QUIET
9568: GNU_CONFIGURE_STRICT GODEP_REDIRECTS
9569: GO_BUILD_PATTERN GO_DEPS
9570: GO_DIST_BASE GO_EXTRA_MOD_DIRS
9571: GO_MODULE_FILES GO_SRCPATH
9572: GROUP_SPECIFIC_PKGS GRUB_NETWORK_CARDS
9573: GRUB_PRESET_COMMAND GRUB_SCAN_ARGS
9574: GZIP HASKELL_COMPILER
1.243 gutterid 9575: HASKELL_ENABLE_DYNAMIC_EXECUTABLE HASKELL_ENABLE_HADDOCK_DOCUMENTATION
9576: HASKELL_ENABLE_LIBRARY_PROFILING HASKELL_ENABLE_SHARED_LIBRARY
9577: HASKELL_ENABLE_TESTS HASKELL_OPTIMIZATION_LEVEL
9578: HASKELL_PKG_NAME HASKELL_UNRESTRICT_DEPENDENCIES
1.246 leot 9579: HEADER_TEMPLATES HG_REPO
9580: HG_REPOSITORIES HG_TAG
9581: HOMEPAGE HOST_PKGTOOLS_ARGS
9582: HOST_SPECIFIC_PKGS HOWL_GROUP
9583: HOWL_USER ICCBASE
9584: ICECAST_CHROOTDIR ICON_THEMES
9585: IDOBASE IGNORE_CCACHE
9586: IGNORE_INFO_DIRS IGNORE_INTERACTIVE_FETCH
9587: IMAKE IMAKEOPTS
9588: IMAKE_MAKE IMAKE_MANINSTALL
9589: IMAP_UW_CCLIENT_MBOX_FMT IMDICTDIR
9590: INCOMPAT_CURSES INFO_DIR
9591: INFO_FILES INFO_MSG
9592: INIT_SYSTEM INN_DATA_DIR
9593: INN_GROUP INN_USER
9594: INSTALLATION_DIRS INSTALLATION_DIRS_FROM_PLIST
9595: INSTALL_ENV INSTALL_SH_OVERRIDE
9596: INSTALL_SRC INSTALL_TEMPLATES
9597: INSTALL_UNSTRIPPED IRCD_HYBRID_IRC_GROUP
9598: IRCD_HYBRID_IRC_USER IRCD_HYBRID_MAXCONN
9599: IRCD_HYBRID_NICLEN IRCD_HYBRID_SYSLOG_EVENTS
9600: IRCD_HYBRID_SYSLOG_FACILITY IRCD_HYBRID_TOPICLEN
9601: IRIX IRRD_USE_PGP
9602: JABBERD_GROUP JABBERD_LOGDIR
9603: JABBERD_PIDDIR JABBERD_SPOOLDIR
9604: JABBERD_USER JAVA_APP_PATH
9605: JAVA_APP_TARGETS JAVA_BINPREFIX
9606: JAVA_CLASSPATH JAVA_HOME
9607: JAVA_LD_LIBRARY_PATH JAVA_NAME
9608: JAVA_UNLIMIT JAVA_WRAPPERS
9609: JPEG_ACCEPTED JPEG_DEFAULT
9610: KERBEROS KERMIT_SUID_UUCP
9611: KJS_USE_PCRE KNEWS_DOMAIN_FILE
9612: KNEWS_DOMAIN_NAME KRB5_ACCEPTED
9613: KRB5_DEFAULT LANGUAGES
9614: LAPACKE_LIBS LAPACKE_PC
9615: LAPACK_LIBS LAPACK_PC
9616: LATEX2HTML_ICONPATH LDCONFIG_ADD_CMD
9617: LDCONFIG_REMOVE_CMD LDD
9618: LEAFNODE_DATA_DIR LEAFNODE_GROUP
9619: LEAFNODE_USER LIBDVDCSS_HOMEPAGE
9620: LIBDVDCSS_MASTER_SITES LIBIMAGEQUANT_TYPE
9621: LIBRSVG_TYPE LIBTOOL
9622: LIBTOOLIZE_PLIST LIBTOOL_M4_OVERRIDE
9623: LIBUSB_TYPE LICENSE
9624: LINKER_RPATH_FLAG LINK_RPATH_FLAG
9625: LINUX_BASE_NODEPS LINUX_BASE_PREFERRED
9626: LINUX_BASE_REQUIRED LINUX_LOCALES
1.244 gutterid 9627: LOCALBASE LOCALBASE_LOCKTYPE
9628: LOCALPATCHES LOVE_DATA
9629: LOVE_GAME LOVE_VERSION
9630: LP32PLATFORMS LP64PLATFORMS
9631: LUA_BUSTED_ARGS LUA_CDIR
9632: LUA_COMPILER LUA_DOCDIR
9633: LUA_EXAMPLESDIR LUA_INCDIR
9634: LUA_INTERPRETER LUA_LDIR
9635: LUA_LINKER_MAGIC LUA_PKGPREFIX
9636: LUA_SELF_CONFLICT LUA_USE_BUSTED
9637: LUA_VERSIONS_ACCEPTED LUA_VERSIONS_INCOMPATIBLE
9638: LUA_VERSION_DEFAULT LUA_VERSION_REQD
9639: Lua MACHINE_PLATFORM
9640: MAILAGENT_DOMAIN MAILAGENT_EMAIL
9641: MAILAGENT_FQDN MAILAGENT_ORGANIZATION
1.246 leot 9642: MAJORDOMO_HOMEDIR MAJOR_OS_VERSION
9643: MAKEINFO_ARGS MAKE_DIRS
9644: MAKE_DIRS_PERMS MAKE_ENV
9645: MAKE_FILE MAKE_FLAGS
9646: MAKE_JOBS MAKE_JOBS_SAFE
9647: MAKE_PROGRAM MANCOMPRESSED_IF_MANZ
9648: MANINSTALL MANZ
9649: MARIADB_VERSIONS_ALL MASTER_SITES
9650: MASTER_SITE_BACKUP MASTER_SITE_LOCAL
9651: MASTER_SITE_MOZILLA MASTER_SITE_OVERRIDE
9652: MASTER_SITE_PERL_CPAN MASTER_SORT
9653: MASTER_SORT_RANDOM MASTER_SORT_REGEX
9654: MECAB_CHARSET MEDIATOMB_GROUP
9655: MEDIATOMB_USER MIPSPROBASE
9656: MIREDO_GROUP MIREDO_USER
9657: MISSING_FEATURES MKDIR
9658: MKPIE_SUPPORTED MLDONKEY_GROUP
9659: MLDONKEY_HOME MLDONKEY_USER
9660: MONOTONE_GROUP MONOTONE_USER
9661: MOTIFBASE MOTIF_TYPE
9662: MOTIF_TYPE_DEFAULT MPI_TYPE
9663: MSGFMT_STRIP_MSGCTXT MSGFMT_STRIP_MSGID_PLURAL
9664: MTOOLS_ENABLE_FLOPPYD MUST
1.244 gutterid 9665: MV MYSQL_CHARSET
9666: MYSQL_DATADIR MYSQL_EXTRA_CHARSET
9667: MYSQL_GROUP MYSQL_USER
9668: MYSQL_VERSION MYSQL_VERSIONS_ACCEPTED
9669: MYSQL_VERSION_DEFAULT NAGIOSCMD_GROUP
9670: NAGIOSDIR NAGIOS_GROUP
9671: NAGIOS_USER NATIVE_APPEND_ABI
9672: NATIVE_APPEND_ELF NATIVE_EXEC_FMT
9673: NATIVE_MACHINE_PLATFORM NATIVE_OBJECT_FMT
9674: NBPAX_PROGRAM_PREFIX NETBSD_LOGIN_NAME
9675: NMH_EDITOR NMH_MTA
9676: NMH_PAGER NODE_VERSIONS_ACCEPTED
9677: NODE_VERSIONS_INCOMPATIBLE NODE_VERSION_DEFAULT
9678: NODE_VERSION_REQD NOLOGIN
9679: NOTE NOT_FOR_PLATFORM
9680: NOT_PAX_ASLR_SAFE NOT_PAX_MPROTECT_SAFE
9681: NO_BUILD NO_CHECKSUM
9682: NO_CONFIGURE NO_SKIP
9683: NS_PREFERRED NULLMAILER_GROUP
9684: NULLMAILER_USER OBJHOSTNAME
9685: OBJMACHINE OCAML_FINDLIB_DIRS
9686: OCAML_FINDLIB_REGISTER OCAML_FINDLIB_REGISTER_VERBOSE
9687: OCAML_SITELIBDIR OMF
9688: ONLY_FOR_COMPILER ONLY_FOR_PLATFORM
9689: OPENSSH_CHROOT OPENSSH_GROUP
9690: OPENSSH_USER OPSYS
9691: OPSYS_EMULDIR OPSYS_VERSION
9692: OS OSS_TYPE
1.246 leot 9693: OSX OS_HAVE_ALSA
9694: OS_HAVE_RCD OS_VARIANT
1.244 gutterid 9695: OS_VERSION OTF_FONTS_DIR
9696: OVERRIDE_DIRDEPTH OVERRIDE_GEMSPEC
1.246 leot 9697: OVERRIDE_GNU_CONFIG_SCRIPTS OVERRIDE_ROCKSPEC
9698: OWN_DIRS OWN_DIRS_PERMS
9699: P4GROUP P4PORT
9700: P4ROOT P4USER
9701: PACKAGES PALMOS_DEFAULT_SDK
9702: PAMBASE PAM_DEFAULT
9703: PAPERSIZE PASSIVE_FETCH
9704: PATCHDIR PATCHFILES
9705: PATCH_ARGS PATCH_DEBUG
9706: PATCH_DIST_ARGS PATCH_DIST_CAT
9707: PATCH_DIST_STRIP PATCH_FUZZ_FACTOR
9708: PATCH_STRIP PATH
9709: PCCBASE PEAR
9710: PEAR_CHANNEL PEAR_CHANNEL_ALIAS
9711: PEAR_CHANNEL_VERSION PEAR_CMD
9712: PEAR_LIB PEAR_PACKAGE_XML
9713: PERL5 PERL5_CONFIGURE
9714: PERL5_CONFIGURE_DIRS PERL5_LDFLAGS
9715: PERL5_LICENSE PERL5_MODULE_TYPE
9716: PERL5_PACKLIST PERL5_PACKLIST_DIR
9717: PERL5_PERLBASE PERL5_SITEBASE
9718: PERL5_USE_PACKLIST PERL5_VENDORBASE
9719: PFCTL PFVAR_H
9720: PF_VERSION PGGROUP
9721: PGHOME PGPKGSRCDIR
9722: PGSQL_TYPE PGSQL_VERSION
9723: PGSQL_VERSIONS_ACCEPTED PGSQL_VERSION_DEFAULT
9724: PGUSER PG_LIB_EXT
9725: PHP PHPCOMMON_MK
9726: PHPPKGSRCDIR PHP_BASE_VERS
9727: PHP_CHECK_INSTALLED PHP_EXTENSION_DIR
9728: PHP_INITIAL_TEENY PHP_PKG_PREFIX
9729: PHP_VERSION PHP_VERSIONS_ACCEPTED
9730: PHP_VERSIONS_INCOMPATIBLE PHP_VERSION_DEFAULT
9731: PHP_VERSION_REQD PILRC_USE_GTK
9732: PKGCONFIG_BASE PKGCONFIG_FILE
9733: PKGCONFIG_OVERRIDE PKGCONFIG_OVERRIDE_STAGE
9734: PKGDIR PKGGNUDIR
9735: PKGINFODIR PKGLOCALEDIR
9736: PKGMANDIR PKGNAME
9737: PKGNAME_REQD PKGPATH
9738: PKGREVISION PKGSRC_BLAS_TYPES
9739: PKGSRC_CHANGES PKGSRC_COMPILER
9740: PKGSRC_KEEP_BIN_PKGS PKGSRC_LOCKTYPE
9741: PKGSRC_MAKE_ENV PKGSRC_MESSAGE_RECIPIENTS
9742: PKGSRC_MKPIE PKGSRC_MKREPRO
9743: PKGSRC_OVERRIDE_MKPIE PKGSRC_RUN_TEST
9744: PKGSRC_SETENV PKGSRC_SLEEPSECS
9745: PKGSRC_TODO PKGSRC_USE_CTF
9746: PKGSRC_USE_FORTIFY PKGSRC_USE_MKTOOLS
9747: PKGSRC_USE_RELRO PKGSRC_USE_SSP
9748: PKGSRC_USE_STACK_CHECK PKGTASKS_DATAFILE
9749: PKGTOOLS_ARGS PKGTOOLS_ENV
9750: PKG_ALTERNATIVES PKG_APACHE
9751: PKG_APACHE_ACCEPTED PKG_APACHE_DEFAULT
9752: PKG_BEST_EXISTS PKG_BUILD_OPTIONS
9753: PKG_COMPRESSION PKG_CONFIG
9754: PKG_CONFIG_PERMS PKG_CREATE_USERGROUP
9755: PKG_DB_TMPDIR PKG_DEBUG_LEVEL
9756: PKG_DEFAULT_OPTIONS PKG_DESTDIR_SUPPORT
9757: PKG_DEVELOPER PKG_DISABLED_OPTIONS
9758: PKG_FATAL_ERRORS PKG_FC
9759: PKG_FILELIST_CMD PKG_GECOS
9760: PKG_GID PKG_GROUPS
9761: PKG_GROUPS_VARS PKG_HOME
9762: PKG_INIT_SCRIPTS PKG_JAVA_HOME
9763: PKG_JVM PKG_JVMS_ACCEPTED
9764: PKG_JVM_DEFAULT PKG_LEGACY_OPTIONS
9765: PKG_LIBTOOL PKG_MKSYMLINKS
9766: PKG_OPTIONS PKG_OPTIONS_DEPRECATED_WARNINGS
9767: PKG_OPTIONS_LEGACY_OPTS PKG_OPTIONS_LEGACY_VARS
9768: PKG_OPTIONS_NONEMPTY_SETS PKG_OPTIONS_OPTIONAL_GROUPS
9769: PKG_OPTIONS_REQUIRED_GROUPS PKG_OPTIONS_VAR
9770: PKG_PHP PKG_PHP_MAJOR_VERS
9771: PKG_PHP_VERSION PKG_RCD_SCRIPTS
9772: PKG_REFCOUNT_DBDIR PKG_REGISTER_SHELLS
9773: PKG_RESUME_TRANSFERS PKG_SHELL
9774: PKG_SUGGESTED_OPTIONS PKG_SUPPORTED_OPTIONS
9775: PKG_SYSCONFBASE PKG_SYSCONFBASEDIR
9776: PKG_SYSCONFDIR PKG_SYSCONFDIR_PERMS
9777: PKG_SYSCONFSUBDIR PKG_SYSCONFVAR
9778: PKG_TOOLS_BIN PKG_UID
9779: PKG_UPDATE_FONTS_DB PKG_USERS
9780: PKG_USERS_VARS PKG_VERBOSE
9781: PLEASE PLIST
9782: PLIST_AWK PLIST_AWK_ENV
9783: PLIST_SRC PLIST_SUBST
9784: PLIST_TYPE PLIST_VARS
9785: POPTOP_USE_MPPE POSSIBLE_GFORTRAN_VERSION
9786: POST_FETCH_HOOK PREFER
9787: PREFER_NATIVE PREFER_NATIVE_PTHREADS
9788: PREFER_PKGSRC PREFIX
9789: PREPEND_PATH PRE_ROOT_CMD
9790: PRIVILEGED_STAGES PS
9791: PTHREAD_AUTO_VARS PTHREAD_CFLAGS
9792: PTHREAD_LDFLAGS PTHREAD_LIBS
9793: PTHREAD_OPTS PTHREAD_TYPE
9794: PVM_SSH PYPKGPREFIX
9795: PYTHON_FOR_BUILD_ONLY PYTHON_SELF_CONFLICT
9796: PYTHON_VERSION PYTHON_VERSIONED_DEPENDENCIES
9797: PYTHON_VERSIONS_ACCEPTED PYTHON_VERSIONS_INCOMPATIBLE
9798: PYTHON_VERSION_DEFAULT PYTHON_VERSION_REQD
9799: PYVERSSUFFIX QMAILDIR
9800: QMAIL_ALIAS_USER QMAIL_DAEMON_USER
9801: QMAIL_LOG_USER QMAIL_NOFILES_GROUP
9802: QMAIL_PASSWD_USER QMAIL_QMAIL_GROUP
9803: QMAIL_QUEUE_DIR QMAIL_QUEUE_EXTRA
9804: QMAIL_QUEUE_USER QMAIL_REMOTE_USER
9805: QMAIL_ROOT_USER QMAIL_SEND_USER
9806: QORE_LATEST_MODULE_API QORE_MODULE_API
9807: QORE_MODULE_DIR QORE_USER_MODULE_DIR
9808: QORE_VERSION QPOPPER_FAC
9809: QPOPPER_SPOOL_DIR QPOPPER_USER
9810: RAKE_NAME RASMOL_DEPTH
9811: RCD_DIR RCD_ORDER
9812: RCD_SCRIPTS RCD_SCRIPTS_DIR
9813: RCD_SCRIPTS_EXAMPLEDIR RCD_SCRIPTS_MODE
9814: RCD_SCRIPTS_SHELL RCD_SCRIPT_SRC
9815: RCD_SUBR RDOC
1.244 gutterid 9816: READLINE_DEFAULT READLINE_TYPE
9817: REAL_ROOT_GROUP REAL_ROOT_USER
9818: RECURSIVE_MAKE RELAY_CTRL_DIR
9819: RELRO_SUPPORTED REPLACE_AWK
9820: REPLACE_BASH REPLACE_CSH
9821: REPLACE_KSH REPLACE_LUA
9822: REPLACE_NODEJS REPLACE_OCTAVE
9823: REPLACE_PERL REPLACE_PERL6
9824: REPLACE_PHP REPLACE_PYTHON
9825: REPLACE_QORE REPLACE_R
9826: REPLACE_RUBY REPLACE_RUBY_DIRS
9827: REPLACE_RUBY_PAT REPLACE_SH
9828: REPLACE_TEXLUA REPLACE_WISH
9829: REQD_DIRS REQD_DIRS_PERMS
9830: REQD_FILES REQD_FILES_MODE
9831: REQD_FILES_PERMS RESOLV_AUTO_VARS
9832: RESOLV_LDFLAGS RESOLV_LIBS
1.246 leot 9833: RM ROCKSPEC_NAME
9834: ROCKSPEC_SPECFILE ROOT_CMD
1.244 gutterid 9835: ROOT_GROUP ROOT_USER
9836: RPCGEN RPM
9837: RPM2PKG_PLIST RPM2PKG_PREFIX
9838: RPM2PKG_STAGE RPM2PKG_STRIP
9839: RPM2PKG_SUBPREFIX RPMFILES
9840: RPMIGNOREPATH RPM_DB_PREFIX
9841: RSSH_CVS_PATH RSSH_RDIST_PATH
9842: RSSH_RSYNC_PATH RSSH_SCP_PATH
9843: RSSH_SFTP_SERVER_PATH RUBY
9844: RUBYGEM RUBYGEM_MANPAGES
9845: RUBYGEM_NAME RUBYGEM_OPTIONS
9846: RUBYGEM_USE_MANPAGES RUBYGEM_VERBOSE
9847: RUBY_ABI_VERSION RUBY_ARCH
9848: RUBY_ARCHINC RUBY_ARCHLIB
9849: RUBY_BASE RUBY_BASERIDIR
9850: RUBY_BUILD_DOCUMENT RUBY_DLEXT
9851: RUBY_DOC RUBY_DYNAMIC_DIRS
9852: RUBY_EG RUBY_ENCODING_ARG
9853: RUBY_EXTCONF RUBY_EXTCONF_CHECK
9854: RUBY_EXTCONF_DEBUG RUBY_EXTCONF_MAKEFILE
9855: RUBY_GEM_ARCH RUBY_GEM_BASE
9856: RUBY_INC RUBY_LIB
9857: RUBY_LIB_BASE RUBY_NAME
9858: RUBY_NOVERSION RUBY_PKGPREFIX
9859: RUBY_RAILS RUBY_RAILS61_VERSION
9860: RUBY_RAILS70_VERSION RUBY_RAILS_ACCEPTED
9861: RUBY_RAILS_DEFAULT RUBY_RAILS_REQD
9862: RUBY_RAILS_STRICT_DEP RUBY_RIDIR
9863: RUBY_SETUP RUBY_SHLIB
9864: RUBY_SHLIBALIAS RUBY_SHLIBVER
9865: RUBY_SIMPLE_INSTALL RUBY_SITEARCHLIB
9866: RUBY_SITELIB RUBY_SITELIB_BASE
9867: RUBY_SITERIDIR RUBY_SLEXT
9868: RUBY_SRCDIR RUBY_STATICLIB
9869: RUBY_SUFFIX RUBY_SYSRIDIR
9870: RUBY_USE_PTHREAD RUBY_VENDORARCHLIB
9871: RUBY_VENDORLIB RUBY_VENDORLIB_BASE
9872: RUBY_VER RUBY_VERSION
9873: RUBY_VERSIONS_ACCEPTED RUBY_VERSIONS_INCOMPATIBLE
9874: RUBY_VERSION_DEFAULT RUBY_VERSION_REQD
9875: RUBY_VER_DIR RUN
9876: RUN_LDCONFIG RUST_TYPE
9877: SCO SCREWS_GROUP
9878: SCREWS_USER SCRIPTS_ENV
9879: SCROLLKEEPER_DATADIR SCROLLKEEPER_REBUILDDB
9880: SCROLLKEEPER_UPDATEDB SDIST_PAWD
9881: SDL12_TYPE SERIAL_DEVICES
9882: SETGIDGAME SETGID_GAMES_PERMS
9883: SETUID_ROOT_PERMS SH
1.246 leot 9884: SHLIB SHORTNAME
9885: SIGN_PACKAGES SILC_CLIENT_WITH_PERL
9886: SITE_SPECIFIC_PKGS SKIP_DEPENDS
9887: SMF_INSTANCES SMF_MANIFEST
9888: SMF_METHODS SMF_METHOD_SHELL
9889: SMF_METHOD_SRC SMF_NAME
9890: SMF_PREFIX SMF_SRCDIR
9891: SNIPROXY_GROUP SNIPROXY_USER
9892: SOURCE_BUFFSIZE SPECIAL_PERMS
9893: SPECIFIC_PKGS SSH_SUID
9894: SSP_SUPPORTED SSYNC_PAWD
9895: STEP_MSG STRIP
9896: STRIP_DBG STRIP_DEBUG
9897: STRIP_DEBUG_SUPPORTED STRIP_FILES_SKIP
9898: SU SUBDIR
9899: SUBST SUBST_CLASSES
9900: SUBST_FILES SUBST_FILTER_CMD
9901: SUBST_MESSAGE SUBST_NOOP_OK
9902: SUBST_SED SUBST_SHOW_DIFF
9903: SUBST_SKIP_TEXT_CHECK SUBST_STAGE
9904: SUBST_VARS SUNWSPROBASE
9905: SUSE_PREFER SU_CMD
9906: SVN_EXTRACTDIR SVN_REPO
9907: SVN_REPOSITORIES SVN_REVISION
9908: SYSCONFBASE TARGET_ARCH
9909: TBL TERMCAP_TYPE
9910: TERMINFO_DEFAULT TERMINFO_TYPE
9911: TEST TEST_DEPENDS
9912: TEST_DIRS TEST_ENV
9913: TEST_ENV_SHELL TEST_MAKE_CMD
9914: TEST_MAKE_FLAGS TEST_TARGET
9915: TEXLIVE_IGNORE_PATTERNS TEXLIVE_REV
9916: TEXLIVE_UNVERSIONED TEXMFSITE
9917: TEX_FORMATS TEX_HYPHEN_DAT
9918: TEX_HYPHEN_DEF TEX_TEXMF_DIRS
9919: THTTPD_LOG_FACILITY TINYDYN_USER
9920: TLSWRAPPER_CHROOT TO
9921: TOOLS_ALIASES TOOLS_ALWAYS_WRAP
9922: TOOLS_ARGS TOOLS_BROKEN
9923: TOOLS_CMD TOOLS_CMDLINE_SED
9924: TOOLS_CREATE TOOLS_CROSS_DESTDIR
9925: TOOLS_DIR TOOLS_FAIL
9926: TOOLS_GNU_MISSING TOOLS_LDCONFIG
9927: TOOLS_NOOP TOOLS_PATH
9928: TOOLS_SCRIPT TOOLS_USE_CROSS_COMPILE
9929: TOOL_DEPENDS TTF_FONTDIR
1.244 gutterid 9930: TTF_FONTS_DIR TYPE
9931: UAC_REQD_EXECS UCSPI_SSL_GROUP
9932: UCSPI_SSL_USER UNLIMIT_RESOURCES
9933: UNPRIVILEGED UNPRIVILEGED_GROUP
9934: UNPRIVILEGED_GROUPS UNPRIVILEGED_USER
9935: UNWRAP_FILES UNWRAP_PATTERNS
9936: UPDATE_GEMSPEC UPDATE_TARGET
9937: URI USERGROUP_PHASE
9938: USERPPP_GROUP USER_SPECIFIC_PKGS
9939: USE_ABI_DEPENDS USE_APR
9940: USE_BSD_MAKEFILE USE_BUILTIN
9941: USE_CC_FEATURES USE_CROSS_COMPILE
9942: USE_CURSES USE_CWRAPPERS
9943: USE_CXX_FEATURES USE_DB185
9944: USE_FEATURES USE_GAMESGROUP
9945: USE_GCC_RUNTIME USE_IMAKE
9946: USE_JAVA USE_JAVA2
9947: USE_LANGUAGES USE_LIBTOOL
9948: USE_NATIVE_GCC USE_NETBSD_REPO
9949: USE_PKGSRC_GCC USE_PKGSRC_GCC_RUNTIME
9950: USE_PKGTASKS USE_PKG_ADMIN_DIGEST
9951: USE_RUBY_EXTCONF USE_RUBY_INSTALL
9952: USE_RUBY_SETUP USE_RUBY_SETUP_PKG
9953: USE_TOOLS UUCP_GROUP
9954: UUCP_USER VARBASE
9955: VARNAME VIM_EXTRA_OPTS
9956: WARNING_MSG WCALC_CGIDIR
9957: WCALC_CGIPATH WCALC_HTMLDIR
9958: WCALC_HTMLPATH WDM_MANAGERS
9959: WRAPPER_CC WRAPPER_REORDER_CMDS
9960: WRKDIR WRKDIR_BASENAME
9961: WRKDIR_LOCKTYPE WRKLOG
9962: WRKOBJDIR WRKSRC
9963: X10_PORT X11
9964: X11BASE X11_PKGSRCDIR
9965: X11_TYPE X509_CERTIFICATE
9966: X509_KEY XAW_TYPE
9967: XLOCK_DEFAULT_MODE XMKMF
9968: XMKMF_FLAGS XXX
1.246 leot 9969: XXXX YES
9970: ZSH_STATIC __stdc__
9971: _vargroups accept
9972: acquire-localbase-lock acquire-lock
9973: add added
9974: administrator alloca
9975: alternatives aslr
9976: asprintf atlas
9977: autoconf automake
9978: autoreconf awk
9979: bash big-endian
9980: bin-install bind
9981: binpkg-list blas
9982: bootstrap-depends broken
9983: broken_on_platform bsd
9984: bsd.prog.mk build
9985: build-env buildlink-directories
9986: buildlink-oss-soundcard-h built-in
9987: builtin c
9988: c++ ccache
9989: cce cdefs
9990: ceil changes
9991: changes-entry changes-entry-noupdate
9992: check check-clean
9993: check-files check-files-clean
9994: check-vulnerable checksum
9995: checksum-phase clean
9996: clean-depends cleandir
9997: commit commit-changes-entry
9998: compact compiler
9999: conf config.guess
10000: config.sub configuration
10001: configure configure-env
10002: configure-help configure_args
10003: connect cos
10004: cpe cputime
10005: create-usergroup csh
10006: ctf cvs
1.244 gutterid 10007: debug declaration
10008: declare defined
10009: depend dependencies
10010: depends depends-checksum
10011: depends-fetch deps
10012: describe destdir
10013: disable distclean
10014: distinfo dl
10015: dlopen do-buildlink
10016: do-clean do-configure
10017: do-configure-post-hook do-extract
10018: do-fetch do-install
10019: emul emul-distinfo
10020: emul-fetch emulation
10021: emulator enable
1.246 leot 10022: endian endif
10023: enomem ensurepip
10024: err errx
10025: etc exp
10026: extract-rpm fabs
10027: feature features
10028: fetch fetch-list
10029: follows forbids
10030: form format
10031: fortify fortify_source
10032: fossil friend
1.244 gutterid 10033: fts fts_close
10034: fts_open fts_read
10035: fts_set gcc
10036: gethostbyaddr gethostbyname
10037: gethostbyname2 getopt_long
10038: getprogname getservbyname
10039: getservbyport getservent
1.246 leot 10040: gettext git
10041: github gitlab
10042: glob gnu
10043: gnu_configure_strict go
10044: go-deps golang
10045: guess-license hashbang
10046: heimdal help
10047: hg imake
1.244 gutterid 10048: in-tree increment
10049: indirect inet_aton
10050: interp interpreter
10051: intl ip4
10052: ip6 ipv4
10053: ipv6 iso
10054: kerberos krb
10055: krb5 ksh
10056: lapack latex
10057: libintl_bindtextdomain libintl_gettext
10058: libintl_textdomain libnbcompat
10059: libs libtool
10060: licence license
10061: lintl little-endian
10062: lock locking
10063: lua lvalue
10064: make makesum
1.246 leot 10065: memory mercurial
10066: meta meta-package
10067: meta_package mit-krb5
10068: mk.conf mkl
10069: mount move
10070: moved mprotect
10071: mremap native
10072: nb nbcompat
10073: netlib node
10074: node.js nodejs
10075: obstack obstack_ptr_grow
10076: occurs only
10077: openblas options
10078: options.mk order
10079: override override-intltool
10080: override-message-intltool package
10081: parallel path
10082: pax paxctl
10083: pbulk-index pc
10084: perl perl5
10085: perms php
10086: pkg-build-options pkg-config
10087: pkg_build_options pkgsrc
10088: platform plist
10089: post-extract post-fetch
10090: post-wrapper pre-build-checks-hook
10091: pre-configure-checks-hook pre-extract
10092: pre-fetch print-go-deps
10093: print-plist print-summary-data
10094: privileged-install-hook pypi
10095: python r
10096: readme-all recursive
10097: recv recvfrom
10098: regcomp release-localbase-lock
10099: release-lock relro
10100: remove removed
10101: rename renamed
10102: reorder replace
10103: replace_interpreter reproducible
10104: resolv root
10105: ruby send
10106: sendfile sendto
10107: setenv setgid
10108: setprogname setuid
10109: sh shebang
10110: show show-all
10111: show-build-defs show-depends
10112: show-depends-dirs show-depends-pkgpaths
10113: show-depends-recursive show-deps
10114: show-distfiles show-downlevel
10115: show-subdir-var show-tools
10116: show-var show-vars
10117: snprintf socket
10118: ssp st_mode
10119: stage-install strcasestr
10120: strict strip
10121: strndup strnlen
10122: strsep subst
10123: substitutions subversion
1.244 gutterid 10124: sun sunpro
1.246 leot 10125: sunwspro svn
10126: symlink test
10127: test-env tex
10128: texlive tmp
10129: todo tool
10130: tools tools-libtool-m4-override
10131: transitive type
10132: ulimit undefined
10133: undo-replace unlimit
10134: unprivileged unprivileged-install-hook
10135: unstripped update
10136: updated upload
10137: upload-distfiles use_tools
10138: user utimes
10139: vasprintf verbose
10140: vsnprintf warn
10141: warning warnings
10142: warnx wattr_off
10143: wattr_on work
10144: wrapper wrkdir
1.154 rillig 10145:
1.207 leot 10146: Appendix F. Editing guidelines for the pkgsrc guide
1.1 dsieger 10147:
10148: Table of Contents
10149:
1.207 leot 10150: F.1. Make targets
10151: F.2. Procedure
1.1 dsieger 10152:
10153: This section contains information on editing the pkgsrc guide itself.
10154:
1.207 leot 10155: F.1. Make targets
1.1 dsieger 10156:
10157: The pkgsrc guide's source code is stored in pkgsrc/doc/guide/files, and several
10158: files are created from it:
10159:
10160: * pkgsrc/doc/pkgsrc.txt
10161:
10162: * pkgsrc/doc/pkgsrc.html
10163:
1.174 leot 10164: * https://www.NetBSD.org/docs/pkgsrc/
1.1 dsieger 10165:
1.174 leot 10166: * https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf: The PDF version of the
10167: pkgsrc guide.
1.1 dsieger 10168:
1.174 leot 10169: * https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps: PostScript version of the
1.2 rillig 10170: pkgsrc guide.
1.1 dsieger 10171:
1.207 leot 10172: F.2. Procedure
1.1 dsieger 10173:
10174: The procedure to edit the pkgsrc guide is:
10175:
1.190 bacon 10176: 1. Make sure you have checked out the htdocs repository into a sibling
10177: directory of your pkgsrc directory. You will need the ability to commit
10178: from both pkgsrc and htdocs.
10179:
10180: 2. Make sure you have the packages needed to regenerate the pkgsrc guide (and
1.46 obache 10181: other XML-based NetBSD documentation) installed. These are automatically
10182: installed when you install the meta-pkgs/pkgsrc-guide-tools package.
1.1 dsieger 10183:
1.190 bacon 10184: 3. Run cd doc/guide to get to the right directory. All further steps will take
1.1 dsieger 10185: place here.
10186:
1.190 bacon 10187: 4. Edit the XML file(s) in files/.
1.1 dsieger 10188:
1.190 bacon 10189: 5. Run bmake to check the pkgsrc guide for valid XML and to build the final
1.1 dsieger 10190: output files. If you get any errors at this stage, you can just edit the
10191: files, as there are only symbolic links in the working directory, pointing
10192: to the files in files/.
10193:
1.190 bacon 10194: 6. (cd files && cvs commit)
1.1 dsieger 10195:
1.190 bacon 10196: 7. Run bmake clean && bmake to regenerate the output files with the proper RCS
1.1 dsieger 10197: Ids.
10198:
1.190 bacon 10199: 8. Run bmake regen to install and commit the files in both pkgsrc/doc and
1.1 dsieger 10200: htdocs.
10201:
10202: Note
10203:
10204: If you have added, removed or renamed some chapters, you need to
10205: synchronize them using cvs add or cvs delete in the htdocs directory.
10206:
CVSweb <webmaster@jp.NetBSD.org>