Annotation of htdocs/docs/pkgsrc/pkgsrc.txt, revision 1.196
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.196 ! jnemeth 15: Copyright 1994-2021 The NetBSD Foundation, Inc
1.1 dsieger 16:
1.196 ! jnemeth 17: $NetBSD: pkgsrc.xml,v 1.39 2021/01/02 08:32:15 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:
32: 1.1. Introduction
33:
34: 1.1.1. Why pkgsrc?
35: 1.1.2. Supported platforms
36:
37: 1.2. Overview
38: 1.3. Terminology
39:
40: 1.3.1. Roles involved in pkgsrc
41:
42: 1.4. Typography
43:
44: I. The pkgsrc user's guide
45:
1.154 rillig 46: 2. Getting help
47: 3. Where to get pkgsrc and how to keep it up-to-date
1.1 dsieger 48:
1.154 rillig 49: 3.1. Getting pkgsrc for the first time
1.1 dsieger 50:
1.154 rillig 51: 3.1.1. As tar archive
52: 3.1.2. Via anonymous CVS
1.1 dsieger 53:
1.154 rillig 54: 3.2. Keeping pkgsrc up-to-date
1.1 dsieger 55:
1.154 rillig 56: 3.2.1. Via tar files
57: 3.2.2. Via CVS
1.1 dsieger 58:
1.154 rillig 59: 4. Using pkgsrc on systems other than NetBSD
1.1 dsieger 60:
1.154 rillig 61: 4.1. Binary distribution
62: 4.2. Bootstrapping pkgsrc
1.1 dsieger 63:
1.154 rillig 64: 5. Using pkgsrc
1.1 dsieger 65:
1.154 rillig 66: 5.1. Using binary packages
1.1 dsieger 67:
1.154 rillig 68: 5.1.1. Finding binary packages
69: 5.1.2. Installing binary packages
70: 5.1.3. Deinstalling packages
71: 5.1.4. Getting information about installed packages
72: 5.1.5. Checking for security vulnerabilities in installed packages
73: 5.1.6. Finding if newer versions of your installed packages are in
1.1 dsieger 74: pkgsrc
1.154 rillig 75: 5.1.7. Other administrative functions
1.1 dsieger 76:
1.154 rillig 77: 5.2. Building packages from source
1.1 dsieger 78:
1.154 rillig 79: 5.2.1. Requirements
80: 5.2.2. Fetching distfiles
81: 5.2.3. How to build and install
1.1 dsieger 82:
1.154 rillig 83: 6. Configuring pkgsrc
1.1 dsieger 84:
1.154 rillig 85: 6.1. General configuration
86: 6.2. Variables affecting the build process
87: 6.3. Variables affecting the installation process
88: 6.4. Selecting and configuring the compiler
1.1 dsieger 89:
1.154 rillig 90: 6.4.1. Selecting the compiler
91: 6.4.2. Additional flags to the compiler (CFLAGS)
92: 6.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 93:
1.154 rillig 94: 6.5. Developer/advanced settings
95: 6.6. Selecting Build Options
1.1 dsieger 96:
1.154 rillig 97: 7. Creating binary packages
1.1 dsieger 98:
1.154 rillig 99: 7.1. Building a single binary package
100: 7.2. Settings for creation of binary packages
1.1 dsieger 101:
1.154 rillig 102: 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6 rillig 103:
1.154 rillig 104: 8.1. Preparations
1.180 rillig 105: 8.2. Running a bulk build
1.6 rillig 106:
1.154 rillig 107: 8.2.1. Configuration
1.6 rillig 108:
1.154 rillig 109: 8.3. Requirements of a full bulk build
1.178 rillig 110: 8.4. Bulk build variants
1.6 rillig 111:
1.179 rillig 112: 8.4.1. Detect unknown configure options
113: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 114: 8.4.3. Force compiler options only in the build phase
115: 8.4.4. Use custom directories
116: 8.4.5. Turn warnings into errors
117: 8.4.6. Reject packages for which pkglint reports errors
118: 8.4.7. Reject packages that contain forbidden strings
119: 8.4.8. Reject packages whose self-test fails
120: 8.4.9. Reject packages that use undefined shell variables
121: 8.4.10. Turn off verbose logging
1.178 rillig 122:
123: 8.5. Creating a multiple CD-ROM packages collection
124:
125: 8.5.1. Example of cdpack
1.6 rillig 126:
1.154 rillig 127: 9. Directory layout of the installed files
1.6 rillig 128:
1.154 rillig 129: 9.1. File system layout in ${LOCALBASE}
130: 9.2. File system layout in ${VARBASE}
1.6 rillig 131:
1.154 rillig 132: 10. Frequently Asked Questions
1.6 rillig 133:
1.154 rillig 134: 10.1. Are there any mailing lists for pkg-related discussion?
135: 10.2. Utilities for package management (pkgtools)
136: 10.3. How to use pkgsrc as non-root
137: 10.4. How to resume transfers when fetching distfiles?
138: 10.5. How can I install/use modular X.org from pkgsrc?
139: 10.6. How to fetch files from behind a firewall
140: 10.7. How to fetch files from HTTPS sites
141: 10.8. How do I tell make fetch to do passive FTP?
142: 10.9. How to fetch all distfiles at once
143: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc"
1.24 wiz 144: mean?
1.154 rillig 145: 10.11. What does "Could not find bsd.own.mk" mean?
146: 10.12. Using 'sudo' with pkgsrc
147: 10.13. How do I change the location of configuration files?
148: 10.14. Automated security checks
149: 10.15. Why do some packages ignore my CFLAGS?
150: 10.16. A package does not build. What shall I do?
151: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/???
1.24 wiz 152: merge conflicts" mean?
1.1 dsieger 153:
154: II. The pkgsrc developer's guide
155:
1.154 rillig 156: 11. Getting help
1.184 rillig 157: 12. Package components - files, directories and contents
1.1 dsieger 158:
1.184 rillig 159: 12.1. Makefile
160: 12.2. distinfo
161: 12.3. patches/*
1.1 dsieger 162:
1.184 rillig 163: 12.3.1. Structure of a single patch file
164: 12.3.2. Creating patch files
165: 12.3.3. Sources where the patch files come from
166: 12.3.4. Patching guidelines
167: 12.3.5. Feedback to the author
1.1 dsieger 168:
1.184 rillig 169: 12.4. Other mandatory files
170: 12.5. Optional files
1.1 dsieger 171:
1.184 rillig 172: 12.5.1. Files affecting the binary package
173: 12.5.2. Files affecting the build process
174: 12.5.3. Files affecting nothing at all
1.1 dsieger 175:
1.184 rillig 176: 12.6. work*
177: 12.7. files/*
1.1 dsieger 178:
1.184 rillig 179: 13. The build process
1.1 dsieger 180:
1.184 rillig 181: 13.1. Introduction
182: 13.2. Program location
183: 13.3. Directories used during the build process
184: 13.4. Running a phase
185: 13.5. The fetch phase
1.1 dsieger 186:
1.184 rillig 187: 13.5.1. What to fetch and where to get it from
188: 13.5.2. How are the files fetched?
1.1 dsieger 189:
1.184 rillig 190: 13.6. The checksum phase
191: 13.7. The extract phase
192: 13.8. The patch phase
193: 13.9. The tools phase
194: 13.10. The wrapper phase
195: 13.11. The configure phase
196: 13.12. The build phase
197: 13.13. The test phase
198: 13.14. The install phase
199: 13.15. The package phase
200: 13.16. Cleaning up
201: 13.17. Other helpful targets
1.1 dsieger 202:
1.184 rillig 203: 14. Creating a new pkgsrc package from scratch
1.1 dsieger 204:
1.184 rillig 205: 14.1. Common types of packages
1.1 dsieger 206:
1.184 rillig 207: 14.1.1. Perl modules
208: 14.1.2. Python modules and programs
209: 14.1.3. R packages
210: 14.1.4. TeXlive packages
1.1 dsieger 211:
1.184 rillig 212: 14.2. Examples
1.1 dsieger 213:
1.184 rillig 214: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 215:
1.184 rillig 216: 15. Programming in Makefiles
1.1 dsieger 217:
1.184 rillig 218: 15.1. Caveats
219: 15.2. Makefile variables
1.1 dsieger 220:
1.184 rillig 221: 15.2.1. Naming conventions
1.1 dsieger 222:
1.184 rillig 223: 15.3. Code snippets
1.1 dsieger 224:
1.184 rillig 225: 15.3.1. Adding things to a list
226: 15.3.2. Echoing a string exactly as-is
227: 15.3.3. Passing CFLAGS to GNU configure scripts
228: 15.3.4. Handling possibly empty variables
1.1 dsieger 229:
1.184 rillig 230: 16. Options handling
1.1 dsieger 231:
1.184 rillig 232: 16.1. Global default options
233: 16.2. Converting packages to use bsd.options.mk
234: 16.3. Option Names
235: 16.4. Determining the options of dependencies
1.1 dsieger 236:
1.184 rillig 237: 17. Tools needed for building or running
1.1 dsieger 238:
1.184 rillig 239: 17.1. Tools for pkgsrc builds
240: 17.2. Tools needed by packages
241: 17.3. Tools provided by platforms
1.1 dsieger 242:
1.184 rillig 243: 18. Buildlink methodology
1.1 dsieger 244:
1.184 rillig 245: 18.1. Converting packages to use buildlink3
246: 18.2. Writing buildlink3.mk files
1.1 dsieger 247:
1.184 rillig 248: 18.2.1. Anatomy of a buildlink3.mk file
249: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and
250: BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files
1.1 dsieger 251:
1.184 rillig 252: 18.3. Writing builtin.mk files
1.1 dsieger 253:
1.184 rillig 254: 18.3.1. Anatomy of a builtin.mk file
255: 18.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 256:
1.184 rillig 257: 19. PLIST issues
1.1 dsieger 258:
1.184 rillig 259: 19.1. RCS ID
260: 19.2. Semi-automatic PLIST generation
261: 19.3. Tweaking output of make print-PLIST
262: 19.4. Variable substitution in PLIST
263: 19.5. Man page compression
264: 19.6. Changing PLIST source with PLIST_SRC
265: 19.7. Platform-specific and differing PLISTs
266: 19.8. Build-specific PLISTs
267: 19.9. Sharing directories between packages
1.1 dsieger 268:
1.184 rillig 269: 20. The pkginstall framework
1.1 dsieger 270:
1.184 rillig 271: 20.1. Files and directories outside the installation prefix
1.1 dsieger 272:
1.184 rillig 273: 20.1.1. Directory manipulation
274: 20.1.2. File manipulation
1.1 dsieger 275:
1.184 rillig 276: 20.2. Configuration files
1.1 dsieger 277:
1.184 rillig 278: 20.2.1. How PKG_SYSCONFDIR is set
279: 20.2.2. Telling the software where configuration files are
280: 20.2.3. Patching installations
281: 20.2.4. Disabling handling of configuration files
1.1 dsieger 282:
1.184 rillig 283: 20.3. System startup scripts
1.1 dsieger 284:
1.184 rillig 285: 20.3.1. Disabling handling of system startup scripts
1.1 dsieger 286:
1.184 rillig 287: 20.4. System users and groups
288: 20.5. System shells
1.1 dsieger 289:
1.184 rillig 290: 20.5.1. Disabling shell registration
1.1 dsieger 291:
1.184 rillig 292: 20.6. Fonts
1.1 dsieger 293:
1.184 rillig 294: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 295:
1.154 rillig 296: 21. Making your package work
1.1 dsieger 297:
1.154 rillig 298: 21.1. General operation
1.1 dsieger 299:
1.154 rillig 300: 21.1.1. How to pull in user-settable variables from mk.conf
301: 21.1.2. User interaction
302: 21.1.3. Handling licenses
303: 21.1.4. Restricted packages
304: 21.1.5. Handling dependencies
305: 21.1.6. Handling conflicts with other packages
306: 21.1.7. Packages that cannot or should not be built
307: 21.1.8. Packages which should not be deleted, once installed
308: 21.1.9. Handling packages with security problems
309: 21.1.10. How to handle incrementing versions when fixing an
1.1 dsieger 310: existing package
1.154 rillig 311: 21.1.11. Substituting variable text in the package files (the SUBST
1.1 dsieger 312: framework)
313:
1.154 rillig 314: 21.2. The fetch phase
1.1 dsieger 315:
1.154 rillig 316: 21.2.1. Packages whose distfiles aren't available for plain
1.1 dsieger 317: downloading
1.154 rillig 318: 21.2.2. How to handle modified distfiles with the 'old' name
319: 21.2.3. Packages hosted on github.com
1.1 dsieger 320:
1.154 rillig 321: 21.3. The configure phase
1.1 dsieger 322:
1.154 rillig 323: 21.3.1. Shared libraries - libtool
324: 21.3.2. Using libtool on GNU packages that already support libtool
325: 21.3.3. GNU Autoconf/Automake
326:
327: 21.4. Programming languages
328:
329: 21.4.1. C, C++, and Fortran
330: 21.4.2. Java
331: 21.4.3. Packages containing perl scripts
332: 21.4.4. Packages containing shell scripts
333: 21.4.5. Other programming languages
334:
335: 21.5. The build phase
336:
337: 21.5.1. Compiling C and C++ code conditionally
338: 21.5.2. How to handle compiler bugs
1.172 rillig 339: 21.5.3. No such file or directory
340: 21.5.4. Undefined reference to "..."
341: 21.5.5. Running out of memory
1.154 rillig 342:
343: 21.6. The install phase
344:
345: 21.6.1. Creating needed directories
346: 21.6.2. Where to install documentation
347: 21.6.3. Installing highscore files
348: 21.6.4. Adding DESTDIR support to packages
349: 21.6.5. Packages with hardcoded paths to other interpreters
350: 21.6.6. Packages installing perl modules
351: 21.6.7. Packages installing info files
352: 21.6.8. Packages installing man pages
353: 21.6.9. Packages installing GConf data files
354: 21.6.10. Packages installing scrollkeeper/rarian data files
355: 21.6.11. Packages installing X11 fonts
356: 21.6.12. Packages installing GTK2 modules
357: 21.6.13. Packages installing SGML or XML data
358: 21.6.14. Packages installing extensions to the MIME database
359: 21.6.15. Packages using intltool
360: 21.6.16. Packages installing startup scripts
361: 21.6.17. Packages installing TeX modules
362: 21.6.18. Packages supporting running binaries in emulation
363: 21.6.19. Packages installing hicolor theme icons
364: 21.6.20. Packages installing desktop files
365:
366: 21.7. Marking packages as having problems
367:
1.184 rillig 368: 22. GNOME packaging and porting
369:
370: 22.1. Meta packages
371: 22.2. Packaging a GNOME application
372: 22.3. Updating GNOME to a newer version
373: 22.4. Patching guidelines
374:
1.154 rillig 375: 23. Submitting and Committing
376:
377: 23.1. Submitting binary packages
378: 23.2. Submitting source packages (for non-NetBSD-developers)
379: 23.3. General notes when adding, updating, or removing packages
380: 23.4. Commit Messages
381: 23.5. Committing: Adding a package to CVS
382: 23.6. Updating a package to a newer version
383: 23.7. Renaming a package in pkgsrc
384: 23.8. Moving a package in pkgsrc
385:
386: 24. Frequently Asked Questions
1.1 dsieger 387:
388: III. The pkgsrc infrastructure internals
389:
1.184 rillig 390: 25. Design of the pkgsrc infrastructure
1.1 dsieger 391:
1.184 rillig 392: 25.1. The meaning of variable definitions
393: 25.2. Avoiding problems before they arise
394: 25.3. Variable evaluation
1.1 dsieger 395:
1.184 rillig 396: 25.3.1. At load time
397: 25.3.2. At runtime
1.1 dsieger 398:
1.184 rillig 399: 25.4. How can variables be specified?
400: 25.5. Designing interfaces for Makefile fragments
1.1 dsieger 401:
1.184 rillig 402: 25.5.1. Procedures with parameters
403: 25.5.2. Actions taken on behalf of parameters
1.1 dsieger 404:
1.184 rillig 405: 25.6. The order in which files are loaded
1.1 dsieger 406:
1.184 rillig 407: 25.6.1. The order in bsd.prefs.mk
408: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 409:
1.184 rillig 410: 26. Regression tests
1.1 dsieger 411:
1.184 rillig 412: 26.1. Running the regression tests
413: 26.2. Adding a new regression test
1.1 dsieger 414:
1.184 rillig 415: 26.2.1. Overridable functions
416: 26.2.2. Helper functions
1.1 dsieger 417:
1.184 rillig 418: 27. Porting pkgsrc
1.1 dsieger 419:
1.184 rillig 420: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 421:
422: A. A simple example package: bison
423:
424: A.1. files
425:
426: A.1.1. Makefile
427: A.1.2. DESCR
428: A.1.3. PLIST
429: A.1.4. Checking a package with pkglint
430:
431: A.2. Steps for building, installing, packaging
432:
433: B. Build logs
434:
435: B.1. Building figlet
436: B.2. Packaging figlet
437:
438: C. Directory layout of the pkgsrc FTP server
439:
1.23 jakllsch 440: C.1. distfiles: The distributed source files
441: C.2. misc: Miscellaneous things
442: C.3. packages: Binary packages
443: C.4. reports: Bulk build reports
1.148 leot 444: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 445:
1.154 rillig 446: D. Help topics
447: E. Editing guidelines for the pkgsrc guide
1.1 dsieger 448:
1.154 rillig 449: E.1. Make targets
450: E.2. Procedure
1.1 dsieger 451:
452: List of Tables
453:
454: 1.1. Platforms supported by pkgsrc
1.184 rillig 455: 12.1. Patching examples
456: 22.1. PLIST handling for GNOME packages
1.1 dsieger 457:
458: Chapter 1. What is pkgsrc?
459:
460: Table of Contents
461:
462: 1.1. Introduction
463:
464: 1.1.1. Why pkgsrc?
465: 1.1.2. Supported platforms
466:
467: 1.2. Overview
468: 1.3. Terminology
469:
470: 1.3.1. Roles involved in pkgsrc
471:
472: 1.4. Typography
473:
474: 1.1. Introduction
475:
476: There is a lot of software freely available for Unix-based systems, which is
477: usually available in form of the source code. Before such software can be used,
478: it needs to be configured to the local system, compiled and installed, and this
479: is exactly what The NetBSD Packages Collection (pkgsrc) does. pkgsrc also has
480: some basic commands to handle binary packages, so that not every user has to
481: build the packages for himself, which is a time-costly task.
482:
483: pkgsrc currently contains several thousand packages, including:
484:
1.104 sevan 485: * www/apache24 - The Apache web server
1.1 dsieger 486:
487: * www/firefox - The Firefox web browser
488:
489: * meta-pkgs/gnome - The GNOME Desktop Environment
490:
1.102 ryoon 491: * meta-pkgs/kde4 - The K Desktop Environment
1.1 dsieger 492:
1.108 rillig 493: ? just to name a few.
1.1 dsieger 494:
495: pkgsrc has built-in support for handling varying dependencies, such as pthreads
496: and X11, and extended features such as IPv6 support on a range of platforms.
497:
498: 1.1.1. Why pkgsrc?
499:
500: pkgsrc provides the following key features:
501:
502: * Easy building of software from source as well as the creation and
503: installation of binary packages. The source and latest patches are
504: retrieved from a master or mirror download site, checksum verified, then
505: built on your system. Support for binary-only distributions is available
506: for both native platforms and NetBSD emulated platforms.
507:
508: * All packages are installed in a consistent directory tree, including
509: binaries, libraries, man pages and other documentation.
510:
1.104 sevan 511: * Tracking of package dependencies automatically, including when performing
512: updates, to ensure required packages are installed. The configuration files
513: of various packages are handled automatically during updates, so local
514: changes are preserved.
1.1 dsieger 515:
516: * Like NetBSD, pkgsrc is designed with portability in mind and consists of
517: highly portable code. This allows the greatest speed of development when
1.26 spz 518: porting to a new platform. This portability also ensures that pkgsrc is
1.1 dsieger 519: consistent across all platforms.
520:
521: * The installation prefix, acceptable software licenses, international
522: encryption requirements and build-time options for a large number of
523: packages are all set in a simple, central configuration file.
524:
525: * The entire source (not including the distribution files) is freely
526: available under a BSD license, so you may extend and adapt pkgsrc to your
527: needs. Support for local packages and patches is available right out of the
528: box, so you can configure it specifically for your environment.
529:
530: The following principles are basic to pkgsrc:
531:
532: * "It should only work if it's right." ? That means, if a package contains
533: bugs, it's better to find them and to complain about them rather than to
534: just install the package and hope that it works. There are numerous checks
1.175 gutterid 535: in pkgsrc that try to find such bugs: static analysis tools (pkgtools/
1.1 dsieger 536: pkglint), build-time checks (portability of shell scripts), and
537: post-installation checks (installed files, references to shared libraries,
538: script interpreters).
539:
540: * "If it works, it should work everywhere" ? Like NetBSD has been ported to
541: many hardware architectures, pkgsrc has been ported to many operating
542: systems. Care is taken that packages behave the same on all platforms.
543:
544: 1.1.2. Supported platforms
545:
546: pkgsrc consists of both a source distribution and a binary distribution for
547: these operating systems. After retrieving the required source or binaries, you
548: can be up and running with pkgsrc in just minutes!
549:
550: pkgsrc was derived from FreeBSD's ports system, and initially developed for
551: NetBSD only. Since then, pkgsrc has grown a lot, and now supports the following
552: platforms:
553:
554: Table 1.1. Platforms supported by pkgsrc
555:
1.92 sevan 556: +-----------------------------------------------------------------------------+
557: | Platform | Date Support | Notes |
558: | | Added | |
559: |--------------------------------------+---------------+----------------------|
560: |NetBSD | Aug 1997 | |
561: |--------------------------------------+---------------+----------------------|
562: |Solaris | Mar 1999 |README.Solaris |
563: |--------------------------------------+---------------+----------------------|
564: |Linux | Jun 1999 |README.Linux |
565: |--------------------------------------+---------------+----------------------|
1.191 bacon 566: |Darwin / Mac OS X / OS X / macOS | Oct 2001 |README.macOS |
1.92 sevan 567: |--------------------------------------+---------------+----------------------|
568: |FreeBSD | Nov 2002 |README.FreeBSD |
569: |--------------------------------------+---------------+----------------------|
570: |OpenBSD | Nov 2002 |README.OpenBSD |
571: |--------------------------------------+---------------+----------------------|
572: |IRIX | Dec 2002 |README.IRIX |
573: | | |README.IRIX5.3 |
574: |--------------------------------------+---------------+----------------------|
575: |BSD/OS | Dec 2003 | |
576: |--------------------------------------+---------------+----------------------|
577: |AIX | Dec 2003 |README.AIX |
578: |--------------------------------------+---------------+----------------------|
579: |Interix (Microsoft Windows Services | Mar 2004 |README.Interix |
580: |for Unix) | | |
581: |--------------------------------------+---------------+----------------------|
582: |DragonFlyBSD | Oct 2004 | |
583: |--------------------------------------+---------------+----------------------|
584: |OSF/1 | Nov 2004 |README.OSF1 |
585: |--------------------------------------+---------------+----------------------|
586: |HP-UX | Apr 2007 |README.HPUX |
587: |--------------------------------------+---------------+----------------------|
588: |Haiku | Sep 2010 |README.Haiku |
589: |--------------------------------------+---------------+----------------------|
590: |MirBSD | Jan 2011 | |
591: |--------------------------------------+---------------+----------------------|
592: |Minix3 | Nov 2011 |README.Minix3 |
593: |--------------------------------------+---------------+----------------------|
594: |Cygwin | Mar 2013 |README.Cygwin |
595: |--------------------------------------+---------------+----------------------|
596: |GNU/kFreeBSD | Jul 2013 |README.GNUkFreeBSD |
1.104 sevan 597: |--------------------------------------+---------------+----------------------|
598: |Bitrig | Jun 2014 |README.Bitrig |
1.92 sevan 599: +-----------------------------------------------------------------------------+
1.1 dsieger 600:
601:
602: 1.2. Overview
603:
604: This document is divided into three parts. The first, The pkgsrc user's guide,
605: describes how one can use one of the packages in the Package Collection, either
606: by installing a precompiled binary package, or by building one's own copy using
607: the NetBSD package system. The second part, The pkgsrc developer's guide,
608: explains how to prepare a package so it can be easily built by other NetBSD
609: users without knowing about the package's building details. The third part, The
610: pkgsrc infrastructure internals is intended for those who want to understand
611: how pkgsrc is implemented.
612:
613: This document is available in various formats: HTML, PDF, PS, TXT.
614:
615: 1.3. Terminology
616:
617: There has been a lot of talk about "ports", "packages", etc. so far. Here is a
618: description of all the terminology used within this document.
619:
620: Package
621:
622: A set of files and building instructions that describe what's necessary to
623: build a certain piece of software using pkgsrc. Packages are traditionally
1.123 wiz 624: stored under /usr/pkgsrc, but may be stored in any location, referred to as
625: PKGSRCDIR.
1.1 dsieger 626:
627: The NetBSD package system
628:
629: This is the former name of "pkgsrc". It is part of the NetBSD operating
630: system and can be bootstrapped to run on non-NetBSD operating systems as
631: well. It handles building (compiling), installing, and removing of
632: packages.
633:
634: Distfile
635:
636: This term describes the file or files that are provided by the author of
637: the piece of software to distribute his work. All the changes necessary to
638: build on NetBSD are reflected in the corresponding package. Usually the
639: distfile is in the form of a compressed tar-archive, but other types are
640: possible, too. Distfiles are usually stored below /usr/pkgsrc/distfiles.
641:
642: Port
643:
644: This is the term used by FreeBSD and OpenBSD people for what we call a
645: package. In NetBSD terminology, "port" refers to a different architecture.
646:
647: Precompiled/binary package
648:
649: A set of binaries built with pkgsrc from a distfile and stuffed together in
650: a single .tgz file so it can be installed on machines of the same machine
651: architecture without the need to recompile. Packages are usually generated
652: in /usr/pkgsrc/packages; there is also an archive on ftp.NetBSD.org.
653:
654: Sometimes, this is referred to by the term "package" too, especially in the
655: context of precompiled packages.
656:
657: Program
658:
659: The piece of software to be installed which will be constructed from all
660: the files in the distfile by the actions defined in the corresponding
661: package.
662:
663: 1.3.1. Roles involved in pkgsrc
664:
665: pkgsrc users
666:
667: The pkgsrc users are people who use the packages provided by pkgsrc.
668: Typically they are system administrators. The people using the software
669: that is inside the packages (maybe called "end users") are not covered by
670: the pkgsrc guide.
671:
672: There are two kinds of pkgsrc users: Some only want to install pre-built
673: binary packages. Others build the pkgsrc packages from source, either for
674: installing them directly or for building binary packages themselves. For
675: pkgsrc users Part I, "The pkgsrc user's guide" should provide all necessary
676: documentation.
677:
678: package maintainers
679:
680: A package maintainer creates packages as described in Part II, "The pkgsrc
681: developer's guide".
682:
683: infrastructure developers
684:
685: These people are involved in all those files that live in the mk/ directory
686: and below. Only these people should need to read through Part III, "The
687: pkgsrc infrastructure internals", though others might be curious, too.
688:
689: 1.4. Typography
690:
691: When giving examples for commands, shell prompts are used to show if the
692: command should/can be issued as root, or if "normal" user privileges are
1.115 sevan 693: sufficient. We use a # for root's shell prompt, a % for users' shell prompt,
694: assuming they use the C-shell or tcsh and a $ for bourne shell and derivatives.
1.1 dsieger 695:
696: Part I. The pkgsrc user's guide
697:
698: Table of Contents
699:
1.154 rillig 700: 2. Getting help
701: 3. Where to get pkgsrc and how to keep it up-to-date
1.1 dsieger 702:
1.154 rillig 703: 3.1. Getting pkgsrc for the first time
1.1 dsieger 704:
1.154 rillig 705: 3.1.1. As tar archive
706: 3.1.2. Via anonymous CVS
1.1 dsieger 707:
1.154 rillig 708: 3.2. Keeping pkgsrc up-to-date
1.1 dsieger 709:
1.154 rillig 710: 3.2.1. Via tar files
711: 3.2.2. Via CVS
1.1 dsieger 712:
1.154 rillig 713: 4. Using pkgsrc on systems other than NetBSD
1.1 dsieger 714:
1.154 rillig 715: 4.1. Binary distribution
716: 4.2. Bootstrapping pkgsrc
1.1 dsieger 717:
1.154 rillig 718: 5. Using pkgsrc
1.1 dsieger 719:
1.154 rillig 720: 5.1. Using binary packages
1.1 dsieger 721:
1.154 rillig 722: 5.1.1. Finding binary packages
723: 5.1.2. Installing binary packages
724: 5.1.3. Deinstalling packages
725: 5.1.4. Getting information about installed packages
726: 5.1.5. Checking for security vulnerabilities in installed packages
727: 5.1.6. Finding if newer versions of your installed packages are in
1.1 dsieger 728: pkgsrc
1.154 rillig 729: 5.1.7. Other administrative functions
1.1 dsieger 730:
1.154 rillig 731: 5.2. Building packages from source
1.1 dsieger 732:
1.154 rillig 733: 5.2.1. Requirements
734: 5.2.2. Fetching distfiles
735: 5.2.3. How to build and install
1.1 dsieger 736:
1.154 rillig 737: 6. Configuring pkgsrc
1.1 dsieger 738:
1.154 rillig 739: 6.1. General configuration
740: 6.2. Variables affecting the build process
741: 6.3. Variables affecting the installation process
742: 6.4. Selecting and configuring the compiler
1.1 dsieger 743:
1.154 rillig 744: 6.4.1. Selecting the compiler
745: 6.4.2. Additional flags to the compiler (CFLAGS)
746: 6.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 747:
1.154 rillig 748: 6.5. Developer/advanced settings
749: 6.6. Selecting Build Options
1.1 dsieger 750:
1.154 rillig 751: 7. Creating binary packages
1.1 dsieger 752:
1.154 rillig 753: 7.1. Building a single binary package
754: 7.2. Settings for creation of binary packages
1.1 dsieger 755:
1.154 rillig 756: 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6 rillig 757:
1.154 rillig 758: 8.1. Preparations
1.180 rillig 759: 8.2. Running a bulk build
1.6 rillig 760:
1.154 rillig 761: 8.2.1. Configuration
1.6 rillig 762:
1.154 rillig 763: 8.3. Requirements of a full bulk build
1.178 rillig 764: 8.4. Bulk build variants
765:
1.179 rillig 766: 8.4.1. Detect unknown configure options
767: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 768: 8.4.3. Force compiler options only in the build phase
769: 8.4.4. Use custom directories
770: 8.4.5. Turn warnings into errors
771: 8.4.6. Reject packages for which pkglint reports errors
772: 8.4.7. Reject packages that contain forbidden strings
773: 8.4.8. Reject packages whose self-test fails
774: 8.4.9. Reject packages that use undefined shell variables
775: 8.4.10. Turn off verbose logging
1.6 rillig 776:
1.178 rillig 777: 8.5. Creating a multiple CD-ROM packages collection
778:
779: 8.5.1. Example of cdpack
1.6 rillig 780:
1.154 rillig 781: 9. Directory layout of the installed files
1.6 rillig 782:
1.154 rillig 783: 9.1. File system layout in ${LOCALBASE}
784: 9.2. File system layout in ${VARBASE}
1.6 rillig 785:
1.154 rillig 786: 10. Frequently Asked Questions
1.6 rillig 787:
1.154 rillig 788: 10.1. Are there any mailing lists for pkg-related discussion?
789: 10.2. Utilities for package management (pkgtools)
790: 10.3. How to use pkgsrc as non-root
791: 10.4. How to resume transfers when fetching distfiles?
792: 10.5. How can I install/use modular X.org from pkgsrc?
793: 10.6. How to fetch files from behind a firewall
794: 10.7. How to fetch files from HTTPS sites
795: 10.8. How do I tell make fetch to do passive FTP?
796: 10.9. How to fetch all distfiles at once
797: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
798: 10.11. What does "Could not find bsd.own.mk" mean?
799: 10.12. Using 'sudo' with pkgsrc
800: 10.13. How do I change the location of configuration files?
801: 10.14. Automated security checks
802: 10.15. Why do some packages ignore my CFLAGS?
803: 10.16. A package does not build. What shall I do?
804: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.24 wiz 805: conflicts" mean?
1.1 dsieger 806:
1.154 rillig 807: Chapter 2. Getting help
808:
809: To get help when using pkgsrc, the definitive source is this document, the
810: pkgsrc guide. If you don't find anything here, there are alternatives:
811:
812: * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
813: Run bmake help topic=? to get help for any topic, such as a variable name
814: like BUILD_DEFS, a make target like do-build, a missing C or C++ function
815: like strcasecmp or any other topic.
816:
817: The available help topics are listed in Appendix D, Help topics.
818:
1.163 rillig 819: * To see the value of a single variable, run bmake show-var VARNAME=X.
820:
821: * To see the values of the most common variables, run bmake show-all. These
822: variables are grouped by topic. To see the variables for a single topic,
823: run bmake show-all-topic, for example bmake show-all-fetch.
824:
1.154 rillig 825: * The pkgsrc-users mailing list, to which you can subscribe and then ask your
826: questions.
827:
828: * The #pkgsrc IRC channel, which is accessible via a web browser or by using
829: a specialized chat program such as XChat. Pick any user name and join the
830: channel #pkgsrc.
831:
832: Chapter 3. Where to get pkgsrc and how to keep it up-to-date
1.1 dsieger 833:
834: Table of Contents
835:
1.154 rillig 836: 3.1. Getting pkgsrc for the first time
1.1 dsieger 837:
1.154 rillig 838: 3.1.1. As tar archive
839: 3.1.2. Via anonymous CVS
1.1 dsieger 840:
1.154 rillig 841: 3.2. Keeping pkgsrc up-to-date
1.1 dsieger 842:
1.154 rillig 843: 3.2.1. Via tar files
844: 3.2.2. Via CVS
1.1 dsieger 845:
846: Before you download and extract the files, you need to decide where you want to
847: extract them. When using pkgsrc as root user, pkgsrc is usually installed in /
848: usr/pkgsrc. You are though free to install the sources and binary packages
849: wherever you want in your filesystem, provided that the pathname does not
850: contain white-space or other characters that are interpreted specially by the
851: shell and some other programs. A safe bet is to use only letters, digits,
852: underscores and dashes.
853:
1.154 rillig 854: 3.1. Getting pkgsrc for the first time
1.1 dsieger 855:
1.25 wiz 856: Before you download any pkgsrc files, you should decide whether you want the
1.1 dsieger 857: current branch or the stable branch. The latter is forked on a quarterly basis
858: from the current branch and only gets modified for security updates. The names
859: of the stable branches are built from the year and the quarter, for example
1.194 leot 860: 2020Q3.
1.1 dsieger 861:
862: The second step is to decide how you want to download pkgsrc. You can get it as
1.24 wiz 863: a tar file or via CVS. Both ways are described here.
1.1 dsieger 864:
1.52 asau 865: Note that tar archive contains CVS working copy. Thus you can switch to using
866: CVS at any later time.
1.1 dsieger 867:
1.154 rillig 868: 3.1.1. As tar archive
1.52 asau 869:
1.151 sevan 870: The primary download location for all pkgsrc files is https://cdn.NetBSD.org/
871: pub/pkgsrc/ or ftp://ftp.NetBSD.org/pub/pkgsrc/ (it points to the same
872: location). There are a number of subdirectories for different purposes, which
873: are described in detail in Appendix C, Directory layout of the pkgsrc FTP
874: server.
1.1 dsieger 875:
1.52 asau 876: The tar archive for the current branch is in the directory current and is
1.118 sevan 877: called pkgsrc.tar.gz. It is autogenerated weekly.
1.52 asau 878:
879: To save download time we provide bzip2- and xz-compressed archives which are
880: published at pkgsrc.tar.bz2 and pkgsrc.tar.xz respectively.
881:
882: You can fetch the same files using FTP.
1.1 dsieger 883:
1.194 leot 884: The tar file for the stable branch 2020Q3 is in the directory pkgsrc-2020Q3 and
1.59 jnemeth 885: is also called pkgsrc.tar.gz.
1.1 dsieger 886:
1.136 leot 887: To download the latest pkgsrc stable tarball, run:
1.12 weinem 888:
1.194 leot 889: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2020Q3/pkgsrc.tar.gz
1.12 weinem 890:
1.78 snj 891: If you prefer, you can also fetch it using "wget", "curl", or your web browser.
1.52 asau 892:
1.12 weinem 893: Then, extract it with:
894:
1.78 snj 895: $ tar -xzf pkgsrc.tar.gz -C /usr
1.12 weinem 896:
897: This will create the directory pkgsrc/ in /usr/ and all the package source will
898: be stored under /usr/pkgsrc/.
899:
900: To download pkgsrc-current, run:
901:
902: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz
1.1 dsieger 903:
1.154 rillig 904: 3.1.2. Via anonymous CVS
1.1 dsieger 905:
1.24 wiz 906: To fetch a specific pkgsrc stable branch, run:
1.1 dsieger 907:
1.194 leot 908: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2020Q3 -P pkgsrc
1.13 weinem 909:
1.24 wiz 910: This will create the directory pkgsrc/ in your /usr/ directory and all the
911: package source will be stored under /usr/pkgsrc/.
912:
913: To fetch the pkgsrc current branch, run:
1.1 dsieger 914:
1.40 wiz 915: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 916:
1.30 dholland 917: Refer to the list of available mirrors to choose a faster CVS mirror, if
918: needed.
1.1 dsieger 919:
1.24 wiz 920: If you get error messages from rsh, you need to set CVS_RSH variable. E.g.:
1.1 dsieger 921:
1.40 wiz 922: $ cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 923:
1.24 wiz 924: Refer to documentation on your command shell how to set CVS_RSH=ssh
925: permanently. For Bourne shells, you can set it in your .profile or better
926: globally in /etc/profile:
927:
928: # set CVS remote shell command
929: CVS_RSH=ssh
930: export CVS_RSH
1.12 weinem 931:
1.13 weinem 932: By default, CVS doesn't do things like most people would expect it to do. But
933: there is a way to convince CVS, by creating a file called .cvsrc in your home
1.12 weinem 934: directory and saving the following lines to it. This file will save you lots of
935: headache and some bug reports, so we strongly recommend it. You can find an
936: explanation of this file in the CVS documentation.
1.2 rillig 937:
938: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 939: cvs -q
1.2 rillig 940: checkout -P
1.4 rillig 941: update -dP
942: diff -upN
1.2 rillig 943: rdiff -u
1.24 wiz 944: release -d
1.1 dsieger 945:
1.154 rillig 946: 3.2. Keeping pkgsrc up-to-date
1.1 dsieger 947:
948: The preferred way to keep pkgsrc up-to-date is via CVS (which also works if you
949: have first installed it via a tar file). It saves bandwidth and hard disk
950: activity, compared to downloading the tar file again.
951:
1.154 rillig 952: 3.2.1. Via tar files
1.1 dsieger 953:
954: Warning
955:
956: When updating from a tar file, you first need to completely remove the old
957: pkgsrc directory. Otherwise those files that have been removed from pkgsrc in
958: the mean time will not be removed on your local disk, resulting in
959: inconsistencies. When removing the old files, any changes that you have done to
960: the pkgsrc files will be lost after updating. Therefore updating via CVS is
961: strongly recommended.
962:
963: Note that by default the distfiles and the binary packages are saved in the
964: pkgsrc tree, so don't forget to rescue them before updating. You can also
1.78 snj 965: configure pkgsrc to store distfiles and packages in directories outside the
1.154 rillig 966: pkgsrc tree by setting the DISTDIR and PACKAGES variables. See Chapter 6,
1.78 snj 967: Configuring pkgsrc for the details.
1.1 dsieger 968:
969: To update pkgsrc from a tar file, download the tar file as explained above.
970: Then, make sure that you have not made any changes to the files in the pkgsrc
971: directory. Remove the pkgsrc directory and extract the new tar file. Done.
972:
1.154 rillig 973: 3.2.2. Via CVS
1.1 dsieger 974:
1.26 spz 975: To update pkgsrc via CVS, change to the pkgsrc directory and run cvs:
1.12 weinem 976:
1.26 spz 977: $ cd /usr/pkgsrc && cvs update -dP
978:
979: If you get error messages from rsh, you need to set CVS_RSH variable as
980: described above. E.g.:
981:
982: $ cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP
1.1 dsieger 983:
1.154 rillig 984: 3.2.2.1. Switching between different pkgsrc branches
1.1 dsieger 985:
986: When updating pkgsrc, the CVS program keeps track of the branch you selected.
987: But if you, for whatever reason, want to switch from the stable branch to the
988: current one, you can do it by adding the option "-A" after the "update"
1.25 wiz 989: keyword. To switch from the current branch back to the stable branch, add the "
1.194 leot 990: -rpkgsrc-2020Q3" option.
1.1 dsieger 991:
1.154 rillig 992: 3.2.2.2. What happens to my changes when updating?
1.1 dsieger 993:
994: When you update pkgsrc, the CVS program will only touch those files that are
995: registered in the CVS repository. That means that any packages that you created
996: on your own will stay unmodified. If you change files that are managed by CVS,
997: later updates will try to merge your changes with those that have been done by
998: others. See the CVS manual, chapter "update" for details.
999:
1.154 rillig 1000: Chapter 4. Using pkgsrc on systems other than NetBSD
1.1 dsieger 1001:
1002: Table of Contents
1003:
1.154 rillig 1004: 4.1. Binary distribution
1005: 4.2. Bootstrapping pkgsrc
1.1 dsieger 1006:
1.154 rillig 1007: 4.1. Binary distribution
1.1 dsieger 1008:
1.154 rillig 1009: See Section 5.1, "Using binary packages".
1.1 dsieger 1010:
1.154 rillig 1011: 4.2. Bootstrapping pkgsrc
1.1 dsieger 1012:
1.44 asau 1013: pkgsrc can be bootstrapped for use in two different modes: privileged and
1014: unprivileged one. In unprivileged mode in contrast to privileged one all
1.45 asau 1015: programs are installed under one particular user and cannot utilise privileged
1.44 asau 1016: operations (packages don't create special users and all special file
1017: permissions like setuid are ignored).
1018:
1.1 dsieger 1019: Installing the bootstrap kit from source should be as simple as:
1020:
1.60 asau 1021: # env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 1022: # cd pkgsrc/bootstrap
1023: # ./bootstrap
1024:
1025:
1.44 asau 1026: To bootstrap in unprivileged mode pass "--unprivileged" flag to bootstrap
1027:
1028: By default, in privileged mode pkgsrc uses /usr/pkg for prefix where programs
1.118 sevan 1029: will be installed in, and /usr/pkg/pkgdb for the package database directory
1030: where pkgsrc will do its internal bookkeeping, /var is used as varbase, where
1.44 asau 1031: packages install their persistent data. In unprivileged mode pkgsrc uses ~/pkg
1.118 sevan 1032: for prefix, ~/pkg/pkgdb for the package database, and ~/pkg/var for varbase.
1.44 asau 1033:
1034: You can change default layout using command-line arguments. Run "./bootstrap
1035: --help" to get details.
1.1 dsieger 1036:
1037: Note
1038:
1039: The bootstrap installs a bmake tool. Use this bmake when building via pkgsrc.
1040: For examples in this guide, use bmake instead of "make".
1041:
1.44 asau 1042: Note
1043:
1044: It is possible to bootstrap multiple instances of pkgsrc using non-intersecting
1045: directories. Use bmake corresponding to the installation you're working with to
1046: build and install packages.
1047:
1.154 rillig 1048: Chapter 5. Using pkgsrc
1.1 dsieger 1049:
1050: Table of Contents
1051:
1.154 rillig 1052: 5.1. Using binary packages
1.1 dsieger 1053:
1.154 rillig 1054: 5.1.1. Finding binary packages
1055: 5.1.2. Installing binary packages
1056: 5.1.3. Deinstalling packages
1057: 5.1.4. Getting information about installed packages
1058: 5.1.5. Checking for security vulnerabilities in installed packages
1059: 5.1.6. Finding if newer versions of your installed packages are in pkgsrc
1060: 5.1.7. Other administrative functions
1061:
1062: 5.2. Building packages from source
1063:
1064: 5.2.1. Requirements
1065: 5.2.2. Fetching distfiles
1066: 5.2.3. How to build and install
1.1 dsieger 1067:
1068: Basically, there are two ways of using pkgsrc. The first is to only install the
1069: package tools and to use binary packages that someone else has prepared. This
1070: is the "pkg" in pkgsrc. The second way is to install the "src" of pkgsrc, too.
1071: Then you are able to build your own packages, and you can still use binary
1072: packages from someone else.
1073:
1.154 rillig 1074: 5.1. Using binary packages
1.1 dsieger 1075:
1.151 sevan 1076: On the cdn.NetBSD.org site and mirrors, there are collections of binary
1.9 rillig 1077: packages, ready to be installed. These binary packages have been built using
1078: the default settings for the directories, that is:
1079:
1080: * /usr/pkg for LOCALBASE, where most of the files are installed,
1081:
1082: * /usr/pkg/etc for configuration files,
1083:
1084: * /var for VARBASE, where those files are installed that may change after
1085: installation.
1086:
1087: If you cannot use these directories for whatever reasons (maybe because you're
1088: not root), you cannot use these binary packages, but have to build the packages
1.154 rillig 1089: yourself, which is explained in Section 4.2, "Bootstrapping pkgsrc".
1.1 dsieger 1090:
1.154 rillig 1091: 5.1.1. Finding binary packages
1.1 dsieger 1092:
1.5 weinem 1093: To install binary packages, you first need to know from where to get them. The
1094: first place where you should look is on the main pkgsrc FTP server in the
1095: directory /pub/pkgsrc/packages.
1096:
1097: This directory contains binary packages for multiple platforms. First, select
1098: your operating system. (Ignore the directories with version numbers attached to
1099: it, they just exist for legacy reasons.) Then, select your hardware
1100: architecture, and in the third step, the OS version and the "version" of
1.9 rillig 1101: pkgsrc.
1102:
1103: In this directory, you often find a file called bootstrap.tar.gz which contains
1104: the package management tools. If the file is missing, it is likely that your
1105: operating system already provides those tools. Download the file and extract it
1106: in the / directory. It will create the directories /usr/pkg (containing the
1.118 sevan 1107: tools for managing binary packages and the database of installed packages).
1.1 dsieger 1108:
1.154 rillig 1109: 5.1.2. Installing binary packages
1.1 dsieger 1110:
1.85 wiz 1111: In the directory from the last section, there is a subdirectory called All/,
1.9 rillig 1112: which contains all the binary packages that are available for the platform,
1113: excluding those that may not be distributed via FTP or CDROM (depending on
1.24 wiz 1114: which medium you are using).
1.9 rillig 1115:
1116: To install packages directly from an FTP or HTTP server, run the following
1117: commands in a Bourne-compatible shell (be sure to su to root first):
1118:
1119: # PATH="/usr/pkg/sbin:$PATH"
1.179 rillig 1120:
1121: # PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages"
1.169 rillig 1122: # PKG_PATH="$PKG_PATH/OPSYS/ARCH/VERSIONS/All/"
1.9 rillig 1123: # export PATH PKG_PATH
1124:
1125: Instead of URLs, you can also use local paths, for example if you are
1126: installing from a set of CDROMs, DVDs or an NFS-mounted repository. If you want
1127: to install packages from multiple sources, you can separate them by a semicolon
1128: in PKG_PATH.
1129:
1130: After these preparations, installing a package is very easy:
1131:
1.118 sevan 1132: # pkg_add libreoffice
1133: # pkg_add ap24-php71-*
1.1 dsieger 1134:
1135: Note that any prerequisite packages needed to run the package in question will
1136: be installed, too, assuming they are present where you install from.
1137:
1.25 wiz 1138: Adding packages might install vulnerable packages. Thus you should run
1.24 wiz 1139: pkg_admin audit regularly, especially after installing new packages, and verify
1140: that the vulnerabilities are acceptable for your configuration.
1.1 dsieger 1141:
1142: After you've installed packages, be sure to have /usr/pkg/bin and /usr/pkg/sbin
1143: in your PATH so you can actually start the just installed program.
1144:
1.154 rillig 1145: 5.1.3. Deinstalling packages
1.1 dsieger 1146:
1147: To deinstall a package, it does not matter whether it was installed from source
1148: code or from a binary package. The pkg_delete command does not know it anyway.
1149: To delete a package, you can just run pkg_delete package-name. The package name
1150: can be given with or without version number. Wildcards can also be used to
1151: deinstall a set of packages, for example *emacs*. Be sure to include them in
1152: quotes, so that the shell does not expand them before pkg_delete sees them.
1153:
1154: The -r option is very powerful: it removes all the packages that require the
1155: package in question and then removes the package itself. For example:
1156:
1157: # pkg_delete -r jpeg
1158:
1159:
1160: will remove jpeg and all the packages that used it; this allows upgrading the
1161: jpeg package.
1162:
1.154 rillig 1163: 5.1.4. Getting information about installed packages
1.1 dsieger 1164:
1165: The pkg_info shows information about installed packages or binary package
1166: files.
1167:
1.154 rillig 1168: 5.1.5. Checking for security vulnerabilities in installed packages
1.1 dsieger 1169:
1.164 leot 1170: The pkgsrc Security Team and Packages Groups maintain a list of known security
1171: vulnerabilities to packages which are (or have been) included in pkgsrc. The
1.179 rillig 1172: list is available from the NetBSD FTP site at http://ftp.NetBSD.org/pub/NetBSD/
1173: packages/vulns/pkg-vulnerabilities.
1.1 dsieger 1174:
1.23 jakllsch 1175: Through pkg_admin fetch-pkg-vulnerabilities, this list can be downloaded
1176: automatically, and a security audit of all packages installed on a system can
1177: take place.
1178:
1179: There are two components to auditing. The first step, pkg_admin
1180: fetch-pkg-vulnerabilities, is for downloading the list of vulnerabilities from
1181: the NetBSD FTP site. The second step, pkg_admin audit, checks to see if any of
1182: your installed packages are vulnerable. If a package is vulnerable, you will
1183: see output similar to the following:
1.1 dsieger 1184:
1185: Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1186: https://www.samba.org/samba/whatsnew/macroexploit.html
1.1 dsieger 1187:
1.23 jakllsch 1188: You may wish to have the vulnerabilities file downloaded daily so that it
1189: remains current. This may be done by adding an appropriate entry to the root
1190: users crontab(5) entry. For example the entry
1191:
1.121 sevan 1192: # Download vulnerabilities file
1.118 sevan 1193: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1194: # Audit the installed packages and email results to root
1195: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1196: root >/dev/null 2>&1
1.118 sevan 1197:
1198:
1199: will update the vulnerability list every day at 3AM, followed by an audit at
1200: 3:09AM. The result of the audit are then emailed to root. On NetBSD this may be
1201: accomplished instead by adding the following line to /etc/daily.conf:
1202:
1203: fetch_pkg_vulnerabilities=YES
1204:
1.23 jakllsch 1205:
1.118 sevan 1206: to fetch the vulnerability list from the daily security script. The system is
1207: set to audit the packages by default but can be set explicitly, if desired (not
1.123 wiz 1208: required), by adding the following line to /etc/security.conf:
1.23 jakllsch 1209:
1.118 sevan 1210: check_pkg_vulnerabilities=YES
1.23 jakllsch 1211:
1212:
1.118 sevan 1213: see daily.conf(5) and security.conf(5) for more details.
1.1 dsieger 1214:
1.154 rillig 1215: 5.1.6. Finding if newer versions of your installed packages are in pkgsrc
1.1 dsieger 1216:
1.12 weinem 1217: Install pkgtools/lintpkgsrc and run lintpkgsrc with the "-i" argument to check
1218: if your packages are up-to-date, e.g.
1.1 dsieger 1219:
1220: % lintpkgsrc -i
1221: ...
1222: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1223:
1224:
1225: You can then use make update to update the package on your system and rebuild
1226: any dependencies.
1227:
1.154 rillig 1228: 5.1.7. Other administrative functions
1.1 dsieger 1229:
1230: The pkg_admin executes various administrative functions on the package system.
1231:
1.154 rillig 1232: 5.2. Building packages from source
1.1 dsieger 1233:
1234: After obtaining pkgsrc, the pkgsrc directory now contains a set of packages,
1.25 wiz 1235: organized into categories. You can browse the online index of packages, or run
1.1 dsieger 1236: make readme from the pkgsrc directory to build local README.html files for all
1237: packages, viewable with any web browser such as www/lynx or www/firefox.
1238:
1239: The default prefix for installed packages is /usr/pkg. If you wish to change
1240: this, you should do so by setting LOCALBASE in mk.conf. You should not try to
1241: use multiple different LOCALBASE definitions on the same system (inside a
1242: chroot is an exception).
1243:
1244: The rest of this chapter assumes that the package is already in pkgsrc. If it
1245: is not, see Part II, "The pkgsrc developer's guide" for instructions how to
1246: create your own packages.
1247:
1.154 rillig 1248: 5.2.1. Requirements
1.1 dsieger 1249:
1250: To build packages from source, you need a working C compiler. On NetBSD, you
1251: need to install the "comp" and the "text" distribution sets. If you want to
1252: build X11-related packages, the "xbase" and "xcomp" distribution sets are
1253: required, too.
1254:
1.154 rillig 1255: 5.2.2. Fetching distfiles
1.1 dsieger 1256:
1257: The first step for building a package is downloading the distfiles (i.e. the
1258: unmodified source). If they have not yet been downloaded, pkgsrc will fetch
1259: them automatically.
1260:
1261: If you have all files that you need in the distfiles directory, you don't need
1262: to connect. If the distfiles are on CD-ROM, you can mount the CD-ROM on /cdrom
1263: and add:
1264:
1265: DISTDIR=/cdrom/pkgsrc/distfiles
1266:
1267: to your mk.conf.
1268:
1269: By default a list of distribution sites will be randomly intermixed to prevent
1270: huge load on servers which holding popular packages (for example,
1271: SourceForge.net mirrors). Thus, every time when you need to fetch yet another
1272: distfile all the mirrors will be tried in new (random) order. You can turn this
1273: feature off by setting MASTER_SORT_RANDOM=NO (for PKG_DEVELOPERs it's already
1274: disabled).
1275:
1276: You can overwrite some of the major distribution sites to fit to sites that are
1277: close to your own. By setting one or two variables you can modify the order in
1278: which the master sites are accessed. MASTER_SORT contains a whitespace
1279: delimited list of domain suffixes. MASTER_SORT_REGEX is even more flexible, it
1280: contains a whitespace delimited list of regular expressions. It has higher
1281: priority than MASTER_SORT. Have a look at pkgsrc/mk/defaults/mk.conf to find
1282: some examples. This may save some of your bandwidth and time.
1283:
1284: You can change these settings either in your shell's environment, or, if you
1.4 rillig 1285: want to keep the settings, by editing the mk.conf file, and adding the
1.1 dsieger 1286: definitions there.
1287:
1.132 wiz 1288: If a package depends on many other packages (such as meta-pkgs/kde4), the build
1.1 dsieger 1289: process may alternate between periods of downloading source, and compiling. To
1290: ensure you have all the source downloaded initially you can run the command:
1291:
1292: % make fetch-list | sh
1293:
1294: which will output and run a set of shell commands to fetch the necessary files
1295: into the distfiles directory. You can also choose to download the files
1296: manually.
1297:
1.154 rillig 1298: 5.2.3. How to build and install
1.1 dsieger 1299:
1300: Once the software has downloaded, any patches will be applied, then it will be
1301: compiled for you. This may take some time depending on your computer, and how
1302: many other packages the software depends on and their compile time.
1303:
1304: Note
1305:
1306: If using bootstrap or pkgsrc on a non-NetBSD system, use the pkgsrc bmake
1307: command instead of "make" in the examples in this guide.
1308:
1309: For example, type
1310:
1311: % cd misc/figlet
1312: % make
1313:
1314:
1315: at the shell prompt to build the various components of the package.
1316:
1317: The next stage is to actually install the newly compiled program onto your
1318: system. Do this by entering:
1319:
1320: % make install
1321:
1322:
1323: while you are still in the directory for whatever package you are installing.
1324:
1325: Installing the package on your system may require you to be root. However,
1326: pkgsrc has a just-in-time-su feature, which allows you to only become root for
1327: the actual installation step.
1328:
1329: That's it, the software should now be installed and setup for use. You can now
1330: enter:
1331:
1332: % make clean
1333:
1334:
1335: to remove the compiled files in the work directory, as you shouldn't need them
1336: any more. If other packages were also added to your system (dependencies) to
1337: allow your program to compile, you can tidy these up also with the command:
1338:
1339: % make clean-depends
1340:
1341:
1342: Taking the figlet utility as an example, we can install it on our system by
1343: building as shown in Appendix B, Build logs.
1344:
1345: The program is installed under the default root of the packages tree - /usr/
1346: pkg. Should this not conform to your tastes, set the LOCALBASE variable in your
1347: environment, and it will use that value as the root of your packages tree. So,
1348: to use /usr/local, set LOCALBASE=/usr/local in your environment. Please note
1349: that you should use a directory which is dedicated to packages and not shared
1350: with other programs (i.e., do not try and use LOCALBASE=/usr). Also, you should
1351: not try to add any of your own files or directories (such as src/, obj/, or
1352: pkgsrc/) below the LOCALBASE tree. This is to prevent possible conflicts
1353: between programs and other files installed by the package system and whatever
1354: else may have been installed there.
1355:
1.4 rillig 1356: Some packages look in mk.conf to alter some configuration options at build
1.1 dsieger 1357: time. Have a look at pkgsrc/mk/defaults/mk.conf to get an overview of what will
1358: be set there by default. Environment variables such as LOCALBASE can be set in
1.4 rillig 1359: mk.conf to save having to remember to set them each time you want to use
1.1 dsieger 1360: pkgsrc.
1361:
1362: Occasionally, people want to "look under the covers" to see what is going on
1363: when a package is building or being installed. This may be for debugging
1364: purposes, or out of simple curiosity. A number of utility values have been
1365: added to help with this.
1366:
1367: 1. If you invoke the make(1) command with PKG_DEBUG_LEVEL=2, then a huge
1368: amount of information will be displayed. For example,
1369:
1370: make patch PKG_DEBUG_LEVEL=2
1371:
1.25 wiz 1372: will show all the commands that are invoked, up to and including the "patch
1373: " stage.
1.1 dsieger 1374:
1375: 2. If you want to know the value of a certain make(1) definition, then the
1376: VARNAME definition should be used, in conjunction with the show-var target.
1377: e.g. to show the expansion of the make(1) variable LOCALBASE:
1378:
1379: % make show-var VARNAME=LOCALBASE
1380: /usr/pkg
1381: %
1382:
1383:
1384: If you want to install a binary package that you've either created yourself
1385: (see next section), that you put into pkgsrc/packages manually or that is
1386: located on a remote FTP server, you can use the "bin-install" target. This
1387: target will install a binary package - if available - via pkg_add(1), else do a
1388: make package. The list of remote FTP sites searched is kept in the variable
1389: BINPKG_SITES, which defaults to ftp.NetBSD.org. Any flags that should be added
1390: to pkg_add(1) can be put into BIN_INSTALL_FLAGS. See pkgsrc/mk/defaults/mk.conf
1391: for more details.
1392:
1393: A final word of warning: If you set up a system that has a non-standard setting
1394: for LOCALBASE, be sure to set that before any packages are installed, as you
1395: cannot use several directories for the same purpose. Doing so will result in
1396: pkgsrc not being able to properly detect your installed packages, and fail
1397: miserably. Note also that precompiled binary packages are usually built with
1398: the default LOCALBASE of /usr/pkg, and that you should not install any if you
1399: use a non-standard LOCALBASE.
1400:
1.154 rillig 1401: Chapter 6. Configuring pkgsrc
1.1 dsieger 1402:
1403: Table of Contents
1404:
1.154 rillig 1405: 6.1. General configuration
1406: 6.2. Variables affecting the build process
1407: 6.3. Variables affecting the installation process
1408: 6.4. Selecting and configuring the compiler
1409:
1410: 6.4.1. Selecting the compiler
1411: 6.4.2. Additional flags to the compiler (CFLAGS)
1412: 6.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 1413:
1.154 rillig 1414: 6.5. Developer/advanced settings
1415: 6.6. Selecting Build Options
1.1 dsieger 1416:
1417: The whole pkgsrc system is configured in a single file, usually called mk.conf.
1418: In which directory pkgsrc looks for that file depends on the installation. On
1419: NetBSD, when you use make(1) from the base system, it is in the directory /etc
1420: /. In all other cases the default location is ${PREFIX}/etc/, depending on
1421: where you told the bootstrap program to install the binary packages.
1422:
1423: The format of the configuration file is that of the usual BSD-style Makefiles.
1424: The whole pkgsrc configuration is done by setting variables in this file. Note
1425: that you can define all kinds of variables, and no special error checking (for
1.112 rillig 1426: example for spelling mistakes) takes place.
1.1 dsieger 1427:
1.154 rillig 1428: 6.1. General configuration
1.1 dsieger 1429:
1.112 rillig 1430: The following variables apply to all pkgsrc packages. A complete list of the
1431: variables that can be configured by the user is available in mk/defaults/
1432: mk.conf, together with some comments that describe each variable's intent.
1.1 dsieger 1433:
1434: * LOCALBASE: Where packages will be installed. The default is /usr/pkg. Do
1435: not mix binary packages with different LOCALBASEs!
1436:
1437: * CROSSBASE: Where "cross" category packages will be installed. The default
1438: is ${LOCALBASE}/cross.
1439:
1.84 wiz 1440: * X11BASE: Where X11 is installed on the system. The default is /usr/X11R7.
1.1 dsieger 1441:
1442: * DISTDIR: Where to store the downloaded copies of the original source
1443: distributions used for building pkgsrc packages. The default is $
1444: {PKGSRCDIR}/distfiles.
1445:
1446: * PKG_DBDIR: Where the database about installed packages is stored. The
1.118 sevan 1447: default is /usr/pkg/pkgdb.
1.1 dsieger 1448:
1449: * MASTER_SITE_OVERRIDE: If set, override the packages' MASTER_SITES with this
1450: value.
1451:
1452: * MASTER_SITE_BACKUP: Backup location(s) for distribution files and patch
1453: files if not found locally or in ${MASTER_SITES} or ${PATCH_SITES}
1.118 sevan 1454: respectively. The defaults is ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/$
1.1 dsieger 1455: {DIST_SUBDIR}/.
1456:
1457: * BINPKG_SITES: List of sites carrying binary pkgs. rel and arch are replaced
1458: with OS release ("2.0", etc.) and architecture ("mipsel", etc.).
1459:
1.23 jakllsch 1460: * ACCEPTABLE_LICENSES: List of acceptable licenses. License names are
1461: case-sensitive. Whenever you try to build a package whose license is not in
1462: this list, you will get an error message. If the license condition is
1463: simple enough, the error message will include specific instructions on how
1464: to change this variable.
1.1 dsieger 1465:
1.154 rillig 1466: 6.2. Variables affecting the build process
1.1 dsieger 1467:
1468: * PACKAGES: The top level directory for the binary packages. The default is $
1469: {PKGSRCDIR}/packages.
1470:
1471: * WRKOBJDIR: The top level directory where, if defined, the separate working
1472: directories will get created, and symbolically linked to from ${WRKDIR}
1473: (see below). This is useful for building packages on several architectures,
1474: then ${PKGSRCDIR} can be NFS-mounted while ${WRKOBJDIR} is local to every
1475: architecture. (It should be noted that PKGSRCDIR should not be set by the
1476: user ? it is an internal definition which refers to the root of the pkgsrc
1477: tree. It is possible to have many pkgsrc tree instances.)
1478:
1479: * LOCALPATCHES: Directory for local patches that aren't part of pkgsrc. See
1.184 rillig 1480: Section 12.3, "patches/*" for more information.
1.1 dsieger 1481:
1482: * PKGMAKECONF: Location of the mk.conf file used by a package's BSD-style
1483: Makefile. If this is not set, MAKECONF is set to /dev/null to avoid picking
1484: up settings used by builds in /usr/src.
1485:
1.154 rillig 1486: 6.3. Variables affecting the installation process
1.1 dsieger 1487:
1.143 maya 1488: * PKGSRC_KEEP_BIN_PKGSRC: By default, binary packages of built packages are
1.150 leot 1489: preserved in ${PACKAGES}/All. Setting this variable to "no" prevents this.
1.1 dsieger 1490:
1.107 jnemeth 1491: Packages have to support installation into a subdirectory of WRKDIR. This
1492: allows a package to be built, before the actual filesystem is touched. DESTDIR
1493: support exists in two variations:
1.4 rillig 1494:
1495: * Basic DESTDIR support means that the package installation and packaging is
1496: still run as root.
1497:
1498: * Full DESTDIR support can run the complete build, installation and packaging
1499: as normal user. Root privileges are only needed to add packages.
1500:
1501: With basic DESTDIR support, make clean needs to be run as root.
1502:
1.17 imil 1503: Considering the foo/bar package, DESTDIR full support can be tested using the
1504: following commands
1505:
1506: $ id
1507: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1508: $ mkdir $HOME/packages
1509: $ cd $PKGSRCDIR/foo/bar
1510:
1511: Verify DESTDIR full support, no root privileges should be needed
1512:
1.66 asau 1513: $ make stage-install
1.17 imil 1514:
1515: Create a package without root privileges
1516:
1.66 asau 1517: $ make PACKAGES=$HOME/packages package
1.17 imil 1518:
1519: For the following command, you must be able to gain root privileges using su(1)
1520:
1.66 asau 1521: $ make PACKAGES=$HOME/packages install
1.17 imil 1522:
1523: Then, as a simple user
1524:
1525: $ make clean
1526:
1.154 rillig 1527: 6.4. Selecting and configuring the compiler
1.4 rillig 1528:
1.154 rillig 1529: 6.4.1. Selecting the compiler
1.1 dsieger 1530:
1531: By default, pkgsrc will use GCC to build packages. This may be overridden by
1532: setting the following variables in /etc/mk.conf:
1533:
1534: PKGSRC_COMPILER:
1535:
1536: This is a list of values specifying the chain of compilers to invoke when
1537: building packages. Valid values are:
1538:
1.66 asau 1539: + ccc: Compaq C Compilers (Tru64)
1540:
1541: + ccache: compiler cache (chainable)
1542:
1543: + clang: Clang C and Objective-C compiler
1544:
1.42 asau 1545: + distcc: distributed C/C++ (chainable)
1.1 dsieger 1546:
1.66 asau 1547: + f2c: Fortran 77 to C compiler (chainable)
1548:
1549: + icc: Intel C++ Compiler (Linux)
1550:
1551: + ido: SGI IRIS Development Option cc (IRIX 5)
1.1 dsieger 1552:
1.42 asau 1553: + gcc: GNU C/C++ Compiler
1.1 dsieger 1554:
1.66 asau 1555: + hp: HP-UX C/aC++ compilers
1556:
1.42 asau 1557: + mipspro: Silicon Graphics, Inc. MIPSpro (n32/n64)
1.1 dsieger 1558:
1.66 asau 1559: + mipspro-ucode: Silicon Graphics, Inc. MIPSpro (o32)
1.1 dsieger 1560:
1.42 asau 1561: + sunpro: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio
1.1 dsieger 1562:
1.118 sevan 1563: + xlc: IBM's XL C/C++ compiler suite
1.66 asau 1564:
1.1 dsieger 1565: The default is "gcc". You can use ccache and/or distcc with an appropriate
1566: PKGSRC_COMPILER setting, e.g. "ccache gcc". This variable should always be
1567: terminated with a value for a real compiler. Note that only one real
1568: compiler should be listed (e.g. "sunpro gcc" is not allowed).
1569:
1570: GCC_REQD:
1571:
1572: This specifies the minimum version of GCC to use when building packages. If
1573: the system GCC doesn't satisfy this requirement, then pkgsrc will build and
1574: install one of the GCC packages to use instead.
1575:
1.153 leot 1576: PYTHON_VERSION_DEFAULT:
1.114 maya 1577:
1578: Specifies which version of python to use when several options are
1579: available.
1580:
1581: PKGSRC_FORTRAN:
1582:
1.176 gutterid 1583: Specifies the Fortran compiler to use. The default is gfortran.
1.114 maya 1584:
1585: GFORTRAN_VERSION:
1586:
1587: If PKGSRC_FORTRAN= gfortran is used, this option specifies which version to
1588: use.
1589:
1.154 rillig 1590: 6.4.2. Additional flags to the compiler (CFLAGS)
1.1 dsieger 1591:
1592: If you wish to set the CFLAGS variable, please make sure to use the += operator
1593: instead of the = operator:
1594:
1595: CFLAGS+= -your -flags
1596:
1597: Using CFLAGS= (i.e. without the "+") may lead to problems with packages that
1.16 jnemeth 1598: need to add their own flags. You may want to take a look at the devel/cpuflags
1.24 wiz 1599: package if you're interested in optimization specifically for the current CPU.
1.1 dsieger 1600:
1.154 rillig 1601: 6.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 1602:
1603: If you want to pass flags to the linker, both in the configure step and the
1604: build step, you can do this in two ways. Either set LDFLAGS or LIBS. The
1605: difference between the two is that LIBS will be appended to the command line,
1606: while LDFLAGS come earlier. LDFLAGS is pre-loaded with rpath settings for ELF
1607: machines depending on the setting of USE_IMAKE or the inclusion of mk/
1608: x11.buildlink3.mk. As with CFLAGS, if you do not wish to override these
1609: settings, use the += operator:
1610:
1611: LDFLAGS+= -your -linkerflags
1612:
1.154 rillig 1613: 6.5. Developer/advanced settings
1.1 dsieger 1614:
1615: * PKG_DEVELOPER: Run some sanity checks that package developers want:
1616:
1.42 asau 1617: + make sure patches apply with zero fuzz
1.1 dsieger 1618:
1.42 asau 1619: + run check-shlibs to see that all binaries will find their shared libs.
1.1 dsieger 1620:
1621: * PKG_DEBUG_LEVEL: The level of debugging output which is displayed whilst
1622: making and installing the package. The default value for this is 0, which
1623: will not display the commands as they are executed (normal, default, quiet
1624: operation); the value 1 will display all shell commands before their
1625: invocation, and the value 2 will display both the shell commands before
1.112 rillig 1626: their invocation, as well as their actual execution progress with set -x.
1.1 dsieger 1627:
1.154 rillig 1628: 6.6. Selecting Build Options
1.1 dsieger 1629:
1630: Some packages have build time options, usually to select between different
1631: dependencies, enable optional support for big dependencies or enable
1632: experimental features.
1633:
1634: To see which options, if any, a package supports, and which options are
1635: mutually exclusive, run make show-options, for example:
1636:
1637: The following options are supported by this package:
1638: ssl Enable SSL support.
1639: Exactly one of the following gecko options is required:
1640: firefox Use firefox as gecko rendering engine.
1641: mozilla Use mozilla as gecko rendering engine.
1642: At most one of the following database options may be selected:
1643: mysql Enable support for MySQL database.
1644: pgsql Enable support for PostgreSQL database.
1645:
1646: These options are enabled by default: firefox
1647: These options are currently enabled: mozilla ssl
1648:
1.4 rillig 1649: The following variables can be defined in mk.conf to select which options to
1650: enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
1.1 dsieger 1651: disable options for all packages that support them, and PKG_OPTIONS.pkgbase,
1652: which can be used to select or disable options specifically for package pkgbase
1653: . Options listed in these variables are selected, options preceded by "-" are
1654: disabled. A few examples:
1655:
1.4 rillig 1656: $ grep "PKG.*OPTION" mk.conf
1.1 dsieger 1657: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1658: PKG_OPTIONS.kdebase= debug -sasl
1659: PKG_OPTIONS.apache= suexec
1660:
1.11 rillig 1661: It is important to note that options that were specifically suggested by the
1.19 snj 1662: package maintainer must be explicitly removed if you do not wish to include the
1663: option. If you are unsure you can view the current state with make show-options
1664: .
1.11 rillig 1665:
1.1 dsieger 1666: The following settings are consulted in the order given, and the last setting
1667: that selects or disables an option is used:
1668:
1669: 1. the default options as suggested by the package maintainer
1670:
1671: 2. the options implied by the settings of legacy variables (see below)
1672:
1673: 3. PKG_DEFAULT_OPTIONS
1674:
1675: 4. PKG_OPTIONS.pkgbase
1676:
1677: For groups of mutually exclusive options, the last option selected is used, all
1678: others are automatically disabled. If an option of the group is explicitly
1679: disabled, the previously selected option, if any, is used. It is an error if no
1680: option from a required group of options is selected, and building the package
1681: will fail.
1682:
1683: Before the options framework was introduced, build options were selected by
1.4 rillig 1684: setting a variable (often named USE_FOO) in mk.conf for each option. To ease
1685: transition to the options framework for the user, these legacy variables are
1686: converted to the appropriate options setting (PKG_OPTIONS.pkgbase)
1687: automatically. A warning is issued to prompt the user to update mk.conf to use
1688: the options framework directly. Support for the legacy variables will be
1.1 dsieger 1689: removed eventually.
1690:
1.154 rillig 1691: Chapter 7. Creating binary packages
1.1 dsieger 1692:
1693: Table of Contents
1694:
1.154 rillig 1695: 7.1. Building a single binary package
1696: 7.2. Settings for creation of binary packages
1.1 dsieger 1697:
1.154 rillig 1698: 7.1. Building a single binary package
1.1 dsieger 1699:
1700: Once you have built and installed a package, you can create a binary package
1701: which can be installed on another system with pkg_add(1). This saves having to
1702: build the same package on a group of hosts and wasting CPU time. It also
1703: provides a simple means for others to install your package, should you
1704: distribute it.
1705:
1706: To create a binary package, change into the appropriate directory in pkgsrc,
1707: and run make package:
1708:
1.112 rillig 1709: $ cd misc/figlet
1710: $ make package
1.1 dsieger 1711:
1712: This will build and install your package (if not already done), and then build
1713: a binary package from what was installed. You can then use the pkg_* tools to
1714: manipulate it. Binary packages are created by default in /usr/pkgsrc/packages,
1715: in the form of a gzipped tar file. See Section B.2, "Packaging figlet" for a
1716: continuation of the above misc/figlet example.
1717:
1.154 rillig 1718: See Chapter 23, Submitting and Committing for information on how to submit such
1.1 dsieger 1719: a binary package.
1720:
1.154 rillig 1721: 7.2. Settings for creation of binary packages
1.1 dsieger 1722:
1.184 rillig 1723: See Section 13.17, "Other helpful targets".
1.6 rillig 1724:
1.154 rillig 1725: Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6 rillig 1726:
1727: Table of Contents
1728:
1.154 rillig 1729: 8.1. Preparations
1.180 rillig 1730: 8.2. Running a bulk build
1.6 rillig 1731:
1.154 rillig 1732: 8.2.1. Configuration
1.6 rillig 1733:
1.154 rillig 1734: 8.3. Requirements of a full bulk build
1.178 rillig 1735: 8.4. Bulk build variants
1736:
1.179 rillig 1737: 8.4.1. Detect unknown configure options
1738: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 1739: 8.4.3. Force compiler options only in the build phase
1740: 8.4.4. Use custom directories
1741: 8.4.5. Turn warnings into errors
1742: 8.4.6. Reject packages for which pkglint reports errors
1743: 8.4.7. Reject packages that contain forbidden strings
1744: 8.4.8. Reject packages whose self-test fails
1745: 8.4.9. Reject packages that use undefined shell variables
1746: 8.4.10. Turn off verbose logging
1.6 rillig 1747:
1.178 rillig 1748: 8.5. Creating a multiple CD-ROM packages collection
1749:
1750: 8.5.1. Example of cdpack
1.6 rillig 1751:
1.175 gutterid 1752: For a number of reasons, you may want to build binary packages for a large
1753: selected set of packages in pkgsrc, or even for all pkgsrc packages. For
1.71 wiz 1754: instance, when you have multiple machines that should run the same software, it
1755: is wasted time if they all build their packages themselves from source. Or you
1756: may want to build a list of packages you want and check them before deploying
1.175 gutterid 1757: onto production systems. There is a way of getting a set of binary packages:
1758: the bulk build system, or pbulk ("p" stands for "parallel"). This chapter
1759: describes how to set it up.
1.71 wiz 1760:
1.154 rillig 1761: 8.1. Preparations
1.71 wiz 1762:
1763: First of all, you have to decide whether you build all packages or a limited
1764: set of them. Full bulk builds usually consume a lot more resources, both space
1.175 gutterid 1765: and time, than builds for some practical sets of packages. A number of
1766: particularly heavy packages exist that are not actually interesting to a wide
1767: audience. (The approximate resource consumption for a full bulk build is given
1768: in section Section 8.3, "Requirements of a full bulk build".) For limited bulk
1769: builds you need to make a list of packages you want to build. Note that all
1770: their dependencies will be built, so you don't need to track them manually.
1.71 wiz 1771:
1772: During bulk builds various packages are installed and deinstalled in /usr/pkg
1773: (or whatever LOCALBASE is), so make sure that you don't need any package during
1.112 rillig 1774: the builds. Essentially, you should provide a fresh system, either a chroot
1.71 wiz 1775: environment or something even more restrictive, depending on what the operating
1776: system provides, or dedicate the whole physical machine. As a useful side
1777: effect this makes sure that bulk builds cannot break anything in your system.
1778: There have been numerous cases where certain packages tried to install files
1779: outside the LOCALBASE or wanted to edit some files in /etc.
1.6 rillig 1780:
1.180 rillig 1781: 8.2. Running a bulk build
1.6 rillig 1782:
1.180 rillig 1783: Running a bulk build works roughly as follows:
1.15 rillig 1784:
1785: * First, build the pbulk infrastructure in a fresh pkgsrc location.
1786:
1787: * Then, build each of the packages from a clean installation directory using
1788: the infrastructure.
1789:
1.154 rillig 1790: 8.2.1. Configuration
1.6 rillig 1791:
1.112 rillig 1792: To simplify configuration, we provide the helper script mk/pbulk/pbulk.sh.
1.6 rillig 1793:
1.68 asau 1794: In order to use it, prepare a clear system (real one, chroot environment, jail,
1795: zone, virtual machine). Configure network access to fetch distribution files.
1.112 rillig 1796: Create a user with name "pbulk".
1.68 asau 1797:
1798: Fetch and extract pkgsrc. Use a command like one of these:
1799:
1.151 sevan 1800: # (cd /usr && ftp -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1801: # (cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1.72 wiz 1802: # (cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)
1.68 asau 1803:
1804: Or any other way that fits (e.g., curl, wget).
1805:
1806: Deploy and configure pbulk tools, e.g.:
1807:
1.118 sevan 1808: # sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)
1.68 asau 1809: # sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment
1810: # sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build
1811:
1812: Note
1813:
1814: mk.conf.frag is a fragment of mk.conf that contains settings you want to apply
1815: to packages you build. For instance,
1816:
1.112 rillig 1817: PKG_DEVELOPER= yes # perform more checks
1818: X11_TYPE= modular # use pkgsrc X11
1819: SKIP_LICENSE_CHECK= yes # accept all licences (useful
1820: # when building all packages)
1.68 asau 1821:
1822: If configured for limited list, replace the list in /usr/pbulk/etc/pbulk.list
1.112 rillig 1823: with your list of packages, one per line without empty lines or comments. E.g.:
1.68 asau 1824:
1825: www/firefox
1826: mail/thunderbird
1827: misc/libreoffice4
1828:
1.69 asau 1829: At this point you can also review configuration in /usr/pbulk/etc and make
1830: final amendments, if wanted.
1831:
1.68 asau 1832: Start it:
1833:
1834: # /usr/pbulk/bin/bulkbuild
1835:
1836: After it finishes, you'll have /mnt filled with distribution files, binary
1837: packages, and reports, plain text summary in /mnt/bulklog/meta/report.txt
1838:
1839: Note
1840:
1841: The pbulk.sh script does not cover all possible use cases. While being ready to
1842: run, it serves as a good starting point to understand and build more complex
1843: setups. The script is kept small enough for better understanding.
1844:
1845: Note
1846:
1847: The pbulk.sh script supports running unprivileged bulk build and helps
1848: configuring distributed bulk builds.
1.15 rillig 1849:
1.154 rillig 1850: 8.3. Requirements of a full bulk build
1.71 wiz 1851:
1852: A complete bulk build requires lots of disk space. Some of the disk space can
1853: be read-only, some other must be writable. Some can be on remote filesystems
1854: (such as NFS) and some should be local. Some can be temporary filesystems,
1855: others must survive a sudden reboot.
1856:
1857: * 40 GB for the distfiles (read-write, remote, temporary)
1858:
1859: * 30 GB for the binary packages (read-write, remote, permanent)
1860:
1861: * 1 GB for the pkgsrc tree (read-only, remote, permanent)
1862:
1863: * 5 GB for LOCALBASE (read-write, local, temporary)
1864:
1865: * 10 GB for the log files (read-write, remote, permanent)
1866:
1867: * 5 GB for temporary files (read-write, local, temporary)
1868:
1.178 rillig 1869: 8.4. Bulk build variants
1870:
1871: To ensure that pkgsrc packages work in different configurations, it makes sense
1872: to run non-default bulk builds from time to time. This section lists some ideas
1873: for bulk builds that intentionally let packages fail if they don't follow the
1874: pkgsrc style.
1875:
1.179 rillig 1876: 8.4.1. Detect unknown configure options
1.178 rillig 1877:
1878: Add the following line to mk.conf.
1879:
1880: GNU_CONFIGURE_STRICT= yes
1881:
1882: When a package fails this additional check, the most common cause is that the
1883: configure option was valid for an older version of the package but does not
1884: apply anymore. In that case, just remove it.
1885:
1.179 rillig 1886: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.178 rillig 1887:
1888: The job of a compiler is not restricted to producing executable code, most
1.179 rillig 1889: compilers also detect typical programming mistakes. The pkgsrc compiler
1890: wrappers make it easy to force compiler options when the package is built. This
1891: can be used to find typical bugs across all packages that are in pkgsrc. By
1892: reporting these bugs upstream, the packages will be more reliable with the next
1893: updates.
1.178 rillig 1894:
1.179 rillig 1895: Add some of the following lines to mk.conf:
1.178 rillig 1896:
1897: CFLAGS+= -Werror=char-subscripts
1.179 rillig 1898: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 1899:
1.179 rillig 1900: When a package fails to build using these stricter compiler options, document
1901: the circumstances in which the compiler produced the error message. This
1902: includes:
1.178 rillig 1903:
1904: * The platform (MACHINE_PLATFORM)
1905:
1906: * The source file
1907:
1908: * An excerpt of the code. GCC and Clang already do this as part of the
1909: diagnostic.
1910:
1.179 rillig 1911: * The exact error message from the compiler.
1.178 rillig 1912:
1.179 rillig 1913: If a package produces these error messages, but the package is fine, record
1914: this in your local mk.conf, like this, to skip this check in the next builds:
1.178 rillig 1915:
1.179 rillig 1916: .if ${PKGPATH} == category/package
1.178 rillig 1917: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
1918: # error message
1919: # code
1.179 rillig 1920: # Reason why the code does not need to be fixed.
1.178 rillig 1921: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 1922: .endif
1.178 rillig 1923:
1924: If the error messages from the compiler are valid and the code needs to be
1.179 rillig 1925: fixed, prepare a local patch (see LOCALPATCHES) and report the bug to the
1926: upstream authors of the package, providing them with the information you
1927: collected above.
1.178 rillig 1928:
1.179 rillig 1929: Patches that are not essential for the package to work should only be reported
1930: upstream but not committed to pkgsrc, to make future updates easier.
1931:
1.181 rillig 1932: 8.4.3. Force compiler options only in the build phase
1933:
1934: When adding custom compiler flags via CFLAGS, these apply to all phases of the
1935: package build process. Especially in the configure phase, adding -Werror leads
1936: to wrong decisions. The GNU configure scripts feed many small test programs to
1937: the C compiler to see whether certain headers are available, functions are
1938: defined in a library and programs can be run. In many cases these programs
1939: would not survive a strict compiler run with -Wall -Wextra -Werror.
1940:
1941: The pkgsrc infrastructure is flexible enough to support compiler options being
1942: added between the configure and build phases. It's a little more complicated
1943: than the other examples in this section but still easy enough.
1944:
1945: The basic idea is to use the pkgsrc compiler wrapper to inject the desired
1946: compiler options. The compiler wrapper's original task is to hide unwanted
1947: directories of include files and to normalize compiler options. It does this by
1948: wrapping the compiler command and rewriting the command line. To see this in
1949: action, run bmake patch in a package directory and examine the work/.cwrappers/
1950: config directory. It contains individual configurations for the C compiler and
1951: the related tools. The plan is to find a hook between the configure and build
1952: phases, and to modify these configuration files at that point.
1953:
1954: To find this hook, have a look at mk/build/build.mk, which contains among
1955: others the pre-build-checks-hook. The word checks doesn't quite fit, but the
1956: pre-build-hook sounds good enough.
1957:
1958: The code to be included in mk.conf is:
1959:
1960: # Just a few example options.
1961: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
1962:
1963: .if ${BUILD_ONLY_CFLAGS:U:M*}
1964: pre-build-checks-hook: add-build-only-cflags
1965:
1966: add-build-only-cflags: .PHONY
1967: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
1968: ${TEST} ! -f ${.TARGET} || exit 0; \
1969: for flag in ${BUILD_ONLY_CFLAGS}; do \
1970: ${ECHO} "append=$$flag" >> cc; \
1971: done; \
1972: > ${.TARGET}
1973: .endif
1974:
1975: (When editing the mk.conf, make sure that the commands of the
1976: add-build-only-cflags target are indented with a tab, not with spaces.)
1977:
1978: The condition in the .if statement contains the :U modifier to prevent parse
1979: errors if the variable should be undefined, possibly because it is only defined
1980: for a subset of the packages. The :M* modifier ensures that there is at least
1981: one compiler option, to prevent a syntax error in the shell parser.
1982:
1983: The code around the ${.TARGET} variable ensures that the additional compiler
1984: options are only appended once, even if bmake build is run multiple times. To
1985: do this, it creates a marker file.
1986:
1987: To verify that this setup works, run bmake configure in a package directory. Up
1988: to now, everything works as usual. Examine the directory work/.cwrappers/config
1989: to see that the compiler options from BUILD_ONLY_CFLAGS are not yet added to
1990: the file cc. Examine the tail of the work/.work.log file to see that the normal
1991: compiler options are used.
1992:
1993: Now run bmake build. This will append the options to the file cc and will
1994: create the marker file in the same directory. After that, the build starts as
1995: usual, but with the added compiler options. Examine the tail of the file work
1996: /.work.log to see that the lines starting with [*] don't contain the compiler
1997: options, but the corresponding lines starting with <.> do end with these
1998: options.
1999:
2000: Building packages using this setup variant and fixing the resulting bugs is the
2001: same as in Section 8.4.2, "Detect classes of bugs by forcing compiler warnings"
2002: .
2003:
2004: 8.4.4. Use custom directories
1.178 rillig 2005:
2006: Some directories like PREFIX, VARBASE, PKG_SYSCONFDIR, PKGMANDIR, PKG_INFODIR
2007: can be configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2008: afterwards in mk.conf.
2009:
2010: PREFIX= /a-random-uuid
2011: PKG_SYSCONFDIR= /a-random-uuid
2012: VARBASE= /a-random-uuid
2013: PKGMANDIR= a-random-uuid
2014: PKG_INFODIR= a-random-uuid
2015:
1.181 rillig 2016: 8.4.5. Turn warnings into errors
1.178 rillig 2017:
2018: When building a package, warnings are typically ignored since they just flow by
2019: and do not cause the build to fail immediately. To find these warnings,
2020: redefine them to errors in mk.conf.
2021:
2022: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2023: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2024:
2025: (There are many more classes of warnings in pkgsrc, and most of them can be
2026: redefined with a simple definition like above.
2027:
1.179 rillig 2028: If a package suggests to add USE_TOOLS+=perl to the package Makefile, research
1.178 rillig 2029: whether the package actually needs Perl. If it does, add USE_TOOLS+=perl to the
2030: package Makefile, and if it doesn't, add TOOLS_BROKEN+=perl.
2031:
1.181 rillig 2032: 8.4.6. Reject packages for which pkglint reports errors
1.178 rillig 2033:
2034: Using pkglint as part of the regular build process is mostly a waste of time.
2035: If you want to fix some of the warnings, just run pkglint recursively on the
2036: whole pkgsrc tree. This will take a few minutes (up to 10), which is much
2037: faster than a complete bulk build.
2038:
1.181 rillig 2039: 8.4.7. Reject packages that contain forbidden strings
1.178 rillig 2040:
2041: To ensure that the binary packages don't contain references to the build
2042: directory, there is already CHECK_WRKREF. If that variable includes the item
2043: extra, it is possible to define additional patterns that must not appear in any
2044: installed file. This is specified in mk.conf.
2045:
2046: CHECK_WRKREF= extra
2047: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2048: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2049: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2050:
2051: The above patterns will probably generate many false positives, therefore the
2052: results need to be taken with a grain of salt.
2053:
1.181 rillig 2054: 8.4.8. Reject packages whose self-test fails
1.178 rillig 2055:
2056: To run the test suites that come with each package, add this line to mk.conf.
2057:
2058: PKGSRC_RUN_TEST= yes
2059:
2060: Be prepared that even the most basic packages fail this test. When doing a bulk
2061: build with this, it will often abort in the early phase where the packages are
2062: scanned for their dependencies since there are cyclic dependencies. There is
2063: still a lot to do in this area.
2064:
1.181 rillig 2065: 8.4.9. Reject packages that use undefined shell variables
1.178 rillig 2066:
2067: To catch typos in the shell snippets from the Makefile fragments, add the -u
2068: flag to most of the commands by adding this line to mk.conf.
2069:
2070: RUN= @set -eu;
2071:
1.181 rillig 2072: After that, ensure that none of the bulk build log files (even those for
2073: successfully built packages) contains the string parameter not set or whatever
2074: error message the command sh -ceu '$undefined' outputs.
2075:
1.178 rillig 2076: See mk/misc/common.mk for the existing definition.
2077:
1.181 rillig 2078: 8.4.10. Turn off verbose logging
1.178 rillig 2079:
2080: The build logs of a package are often quite long. This allows error messages or
2081: other interesting details to hide between the noise. To make the actual error
2082: message stand out more, add these lines to mk.conf.
2083:
2084: GNU_CONFIGURE_QUIET= yes
2085: MAKE_FLAGS+= -s
2086:
2087: The -s option works for both GNU Make and BSD Make. On exotic platforms with
2088: their own make, it may be a little different.
2089:
2090: 8.5. Creating a multiple CD-ROM packages collection
1.1 dsieger 2091:
2092: After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set
2093: of the resulting binary packages to assist in installing packages on other
2094: machines. The pkgtools/cdpack package provides a simple tool for creating the
2095: ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a way that
2096: keeps all the dependencies for a given package on the same CD as that package.
2097:
1.178 rillig 2098: 8.5.1. Example of cdpack
1.1 dsieger 2099:
2100: Complete documentation for cdpack is found in the cdpack(1) man page. The
2101: following short example assumes that the binary packages are left in /usr/
2102: pkgsrc/packages/All and that sufficient disk space exists in /u2 to hold the
2103: ISO 9660 images.
2104:
2105: # mkdir /u2/images
2106: # pkg_add /usr/pkgsrc/packages/All/cdpack
2107: # cdpack /usr/pkgsrc/packages/All /u2/images
2108:
2109:
2110: If you wish to include a common set of files (COPYRIGHT, README, etc.) on each
2111: CD in the collection, then you need to create a directory which contains these
1.175 gutterid 2112: files, e.g.:
1.1 dsieger 2113:
2114: # mkdir /tmp/common
2115: # echo "This is a README" > /tmp/common/README
2116: # echo "Another file" > /tmp/common/COPYING
2117: # mkdir /tmp/common/bin
2118: # echo "#!/bin/sh" > /tmp/common/bin/myscript
2119: # echo "echo Hello world" >> /tmp/common/bin/myscript
2120: # chmod 755 /tmp/common/bin/myscript
2121:
2122:
2123: Now create the images:
2124:
2125: # cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images
2126:
2127: Each image will contain README, COPYING, and bin/myscript in their root
2128: directories.
2129:
1.154 rillig 2130: Chapter 9. Directory layout of the installed files
1.1 dsieger 2131:
2132: Table of Contents
2133:
1.154 rillig 2134: 9.1. File system layout in ${LOCALBASE}
2135: 9.2. File system layout in ${VARBASE}
1.1 dsieger 2136:
2137: The files that are installed by pkgsrc are organized in a way that is similar
2138: to what you find in the /usr directory of the base system. But some details are
2139: different. This is because pkgsrc initially came from FreeBSD and had adopted
2140: its file system hierarchy. Later it was largely influenced by NetBSD. But no
2141: matter which operating system you are using pkgsrc with, you can expect the
2142: same layout for pkgsrc.
2143:
2144: There are mainly four root directories for pkgsrc, which are all configurable
2145: in the bootstrap/bootstrap script. When pkgsrc has been installed as root, the
2146: default locations are:
2147:
2148: LOCALBASE= /usr/pkg
2149: PKG_SYSCONFBASE= /usr/pkg/etc
2150: VARBASE= /var
1.119 sevan 2151: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2152:
2153: In unprivileged mode (when pkgsrc has been installed as any other user), the
2154: default locations are:
2155:
2156: LOCALBASE= ${HOME}/pkg
2157: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2158: VARBASE= ${HOME}/pkg/var
1.119 sevan 2159: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2160:
2161: What these four directories are for, and what they look like is explained
2162: below.
2163:
1.25 wiz 2164: * LOCALBASE corresponds to the /usr directory in the base system. It is the "
2165: main" directory where the files are installed and contains the well-known
1.1 dsieger 2166: subdirectories like bin, include, lib, share and sbin.
2167:
2168: * VARBASE corresponds to /var in the base system. Some programs (especially
2169: games, network daemons) need write access to it during normal operation.
2170:
2171: * PKG_SYSCONFDIR corresponds to /etc in the base system. It contains
2172: configuration files of the packages, as well as pkgsrc's mk.conf itself.
2173:
1.154 rillig 2174: 9.1. File system layout in ${LOCALBASE}
1.1 dsieger 2175:
2176: The following directories exist in a typical pkgsrc installation in $
2177: {LOCALBASE}.
2178:
2179: bin
2180:
2181: Contains executable programs that are intended to be directly used by the
2182: end user.
2183:
2184: emul
2185:
2186: Contains files for the emulation layers of various other operating systems,
2187: especially for NetBSD.
2188:
2189: etc (the usual location of ${PKG_SYSCONFDIR})
2190:
2191: Contains the configuration files.
2192:
2193: include
2194:
2195: Contains headers for the C and C++ programming languages.
2196:
2197: info
2198:
2199: Contains GNU info files of various packages.
2200:
2201: lib
2202:
2203: Contains shared and static libraries.
2204:
2205: libdata
2206:
2207: Contains data files that don't change after installation. Other data files
2208: belong into ${VARBASE}.
2209:
2210: libexec
2211:
2212: Contains programs that are not intended to be used by end users, such as
2213: helper programs or network daemons.
2214:
2215: libexec/cgi-bin
2216:
2217: Contains programs that are intended to be executed as CGI scripts by a web
2218: server.
2219:
2220: man (the usual value of ${PKGMANDIR})
2221:
2222: Contains brief documentation in form of manual pages.
2223:
2224: sbin
2225:
2226: Contains programs that are intended to be used only by the super-user.
2227:
2228: share
2229:
2230: Contains platform-independent data files that don't change after
2231: installation.
2232:
2233: share/doc
2234:
2235: Contains documentation files provided by the packages.
2236:
2237: share/examples
2238:
2239: Contains example files provided by the packages. Among others, the original
2240: configuration files are saved here and copied to ${PKG_SYSCONFDIR} during
2241: installation.
2242:
2243: share/examples/rc.d
2244:
2245: Contains the original files for rc.d scripts.
2246:
2247: var (the usual location of ${VARBASE})
2248:
2249: Contains files that may be modified after installation.
2250:
1.154 rillig 2251: 9.2. File system layout in ${VARBASE}
1.1 dsieger 2252:
2253: db/pkg (the usual location of ${PKG_DBDIR})
2254:
2255: Contains information about the currently installed packages.
2256:
2257: games
2258:
2259: Contains highscore files.
2260:
2261: log
2262:
2263: Contains log files.
2264:
2265: run
2266:
2267: Contains informational files about daemons that are currently running.
2268:
1.154 rillig 2269: Chapter 10. Frequently Asked Questions
1.1 dsieger 2270:
2271: Table of Contents
2272:
1.154 rillig 2273: 10.1. Are there any mailing lists for pkg-related discussion?
2274: 10.2. Utilities for package management (pkgtools)
2275: 10.3. How to use pkgsrc as non-root
2276: 10.4. How to resume transfers when fetching distfiles?
2277: 10.5. How can I install/use modular X.org from pkgsrc?
2278: 10.6. How to fetch files from behind a firewall
2279: 10.7. How to fetch files from HTTPS sites
2280: 10.8. How do I tell make fetch to do passive FTP?
2281: 10.9. How to fetch all distfiles at once
2282: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
2283: 10.11. What does "Could not find bsd.own.mk" mean?
2284: 10.12. Using 'sudo' with pkgsrc
2285: 10.13. How do I change the location of configuration files?
2286: 10.14. Automated security checks
2287: 10.15. Why do some packages ignore my CFLAGS?
2288: 10.16. A package does not build. What shall I do?
2289: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.24 wiz 2290: conflicts" mean?
1.1 dsieger 2291:
2292: This section contains hints, tips & tricks on special things in pkgsrc that we
2293: didn't find a better place for in the previous chapters, and it contains items
2294: for both pkgsrc users and developers.
2295:
1.154 rillig 2296: 10.1. Are there any mailing lists for pkg-related discussion?
1.1 dsieger 2297:
2298: The following mailing lists may be of interest to pkgsrc users:
2299:
2300: * pkgsrc-users: This is a general purpose list for most issues regarding
2301: pkgsrc, regardless of platform, e.g. soliciting user help for pkgsrc
2302: configuration, unexpected build failures, using particular packages,
2303: upgrading pkgsrc installations, questions regarding the pkgsrc release
2304: branches, etc. General announcements or proposals for changes that impact
2305: the pkgsrc user community, e.g. major infrastructure changes, new features,
2306: package removals, etc., may also be posted.
2307:
2308: * pkgsrc-bulk: A list where the results of pkgsrc bulk builds are sent and
2309: discussed.
2310:
2311: * pkgsrc-changes: This list is for those who are interested in getting a
2312: commit message for every change committed to pkgsrc. It is also available
2313: in digest form, meaning one daily message containing all commit messages
2314: for changes to the package source tree in that 24 hour period.
2315:
2316: To subscribe, do:
2317:
2318: % echo subscribe listname | mail majordomo@NetBSD.org
2319:
1.174 leot 2320: Archives for all these mailing lists are available from https://
1.1 dsieger 2321: mail-index.NetBSD.org/.
2322:
1.154 rillig 2323: 10.2. Utilities for package management (pkgtools)
1.1 dsieger 2324:
2325: The directory pkgsrc/pkgtools contains a number of useful utilities for both
2326: users and developers of pkgsrc. This section attempts only to make the reader
1.121 sevan 2327: aware of some of the utilities and when they might be useful, and not to
2328: duplicate the documentation that comes with each package.
1.1 dsieger 2329:
2330: Utilities used by pkgsrc (automatically installed when needed):
2331:
2332: * pkgtools/x11-links: Symlinks for use by buildlink.
2333:
2334: OS tool augmentation (automatically installed when needed):
2335:
1.121 sevan 2336: * pkgtools/digest: Calculates various kinds of checksums (including SHA3).
1.1 dsieger 2337:
2338: * pkgtools/libnbcompat: Compatibility library for pkgsrc tools.
2339:
2340: * pkgtools/mtree: Installed on non-BSD systems due to lack of native mtree.
2341:
2342: * pkgtools/pkg_install: Up-to-date replacement for /usr/sbin/pkg_install, or
2343: for use on operating systems where pkg_install is not present.
2344:
2345: Utilities used by pkgsrc (not automatically installed):
2346:
2347: * pkgtools/pkg_tarup: Create a binary package from an already-installed
2348: package. Used by make replace to save the old package.
2349:
2350: * pkgtools/dfdisk: Adds extra functionality to pkgsrc, allowing it to fetch
2351: distfiles from multiple locations. It currently supports the following
2352: methods: multiple CD-ROMs and network FTP/HTTP connections.
2353:
2354: * devel/cpuflags: Determine the best compiler flags to optimise code for your
1.24 wiz 2355: current CPU and compiler.
1.1 dsieger 2356:
2357: Utilities for keeping track of installed packages, being up to date, etc:
2358:
1.65 wiz 2359: * pkgtools/pkgin: A package update tool similar to apt(1). Download, install,
2360: and upgrade binary packages easily.
2361:
1.1 dsieger 2362: * pkgtools/pkg_chk: Reports on packages whose installed versions do not match
2363: the latest pkgsrc entries.
2364:
2365: * pkgtools/pkgdep: Makes dependency graphs of packages, to aid in choosing a
2366: strategy for updating.
2367:
2368: * pkgtools/pkgdepgraph: Makes graphs from the output of pkgtools/pkgdep (uses
2369: graphviz).
2370:
1.12 weinem 2371: * pkgtools/pkglint: The pkglint(1) program checks a pkgsrc entry for errors.
2372:
2373: * pkgtools/lintpkgsrc: The lintpkgsrc(1) program does various checks on the
2374: complete pkgsrc system.
1.1 dsieger 2375:
2376: * pkgtools/pkgsurvey: Report what packages you have installed.
2377:
2378: Utilities for people maintaining or creating individual packages:
2379:
2380: * pkgtools/pkgdiff: Automate making and maintaining patches for a package
2381: (includes pkgdiff, pkgvi, mkpatches, etc.).
2382:
1.65 wiz 2383: * pkgtools/url2pkg: Aids in converting to pkgsrc.
1.1 dsieger 2384:
2385: Utilities for people maintaining pkgsrc (or: more obscure pkg utilities)
2386:
2387: * pkgtools/pkg_comp: Build packages in a chrooted area.
2388:
2389: * pkgtools/libkver: Spoof kernel version for chrooted cross builds.
2390:
1.154 rillig 2391: 10.3. How to use pkgsrc as non-root
1.1 dsieger 2392:
1.108 rillig 2393: To install packages from source as a non-root user, download pkgsrc as
1.154 rillig 2394: described in Chapter 3, Where to get pkgsrc and how to keep it up-to-date, cd
1.108 rillig 2395: into that directory and run the command ./bootstrap/bootstrap --unprivileged.
2396:
2397: This will install the binary part of pkgsrc to ~/pkg and put the pkgsrc
2398: configuration mk.conf into ~/pkg/etc.
2399:
2400: For more details, see mk/unprivileged.mk.
1.1 dsieger 2401:
1.154 rillig 2402: 10.4. How to resume transfers when fetching distfiles?
1.1 dsieger 2403:
2404: By default, resuming transfers in pkgsrc is disabled, but you can enable this
1.4 rillig 2405: feature by adding the option PKG_RESUME_TRANSFERS=YES into mk.conf. If, during
2406: a fetch step, an incomplete distfile is found, pkgsrc will try to resume it.
1.1 dsieger 2407:
1.61 wiz 2408: You can also use a different program than the platform default program by
2409: changing the FETCH_USING variable. You can specify the program by using of ftp,
2410: fetch, wget or curl. Alternatively, fetching can be disabled by using the value
2411: manual. A value of custom disables the system defaults and dependency tracking
2412: for the fetch program. In that case you have to provide FETCH_CMD,
2413: FETCH_BEFORE_ARGS, FETCH_RESUME_ARGS, FETCH_OUTPUT_ARGS, FETCH_AFTER_ARGS.
1.1 dsieger 2414:
1.16 jnemeth 2415: For example, if you want to use wget to download, you'll have to use something
2416: like:
1.1 dsieger 2417:
1.16 jnemeth 2418: FETCH_USING= wget
1.1 dsieger 2419:
1.154 rillig 2420: 10.5. How can I install/use modular X.org from pkgsrc?
1.1 dsieger 2421:
1.4 rillig 2422: If you want to use modular X.org from pkgsrc instead of your system's own X11
2423: (/usr/X11R6, /usr/openwin, ...) you will have to add the following line into
1.1 dsieger 2424: mk.conf:
2425:
1.4 rillig 2426: X11_TYPE=modular
1.1 dsieger 2427:
1.154 rillig 2428: 10.6. How to fetch files from behind a firewall
1.1 dsieger 2429:
2430: If you are sitting behind a firewall which does not allow direct connections to
2431: Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This
2432: is done using an environment variable in the form of a URL, e.g. in Amdahl, the
2433: machine "orpheus.amdahl.com" is one of the firewalls, and it uses port 80 as
2434: the proxy port number. So the proxy environment variables are:
2435:
2436: ftp_proxy=ftp://orpheus.amdahl.com:80/
2437: http_proxy=http://orpheus.amdahl.com:80/
2438:
1.154 rillig 2439: 10.7. How to fetch files from HTTPS sites
1.65 wiz 2440:
2441: Some fetch tools are not prepared to support HTTPS by default (for example, the
2442: one in NetBSD 6.0), or the one installed by the pkgsrc bootstrap (to avoid an
2443: openssl dependency that low in the dependency graph).
2444:
2445: Usually you won't notice, because distribution files are mirrored weekly to "
2446: ftp.NetBSD.org", but that might not be often enough if you are following
2447: pkgsrc-current. In that case, set FETCH_USING in your mk.conf file to "curl" or
2448: "wget", which are both compiled with HTTPS support by default. Of course, these
2449: tools need to be installed before you can use them this way.
2450:
1.154 rillig 2451: 10.8. How do I tell make fetch to do passive FTP?
1.1 dsieger 2452:
2453: This depends on which utility is used to retrieve distfiles. From bsd.pkg.mk,
2454: FETCH_CMD is assigned the first available command from the following list:
2455:
2456: * ${LOCALBASE}/bin/ftp
2457:
2458: * /usr/bin/ftp
2459:
2460: On a default NetBSD installation, this will be /usr/bin/ftp, which
2461: automatically tries passive connections first, and falls back to active
2462: connections if the server refuses to do passive. For the other tools, add the
1.4 rillig 2463: following to your mk.conf file: PASSIVE_FETCH=1.
1.1 dsieger 2464:
2465: Having that option present will prevent /usr/bin/ftp from falling back to
2466: active transfers.
2467:
1.154 rillig 2468: 10.9. How to fetch all distfiles at once
1.1 dsieger 2469:
2470: You would like to download all the distfiles in a single batch from work or
2471: university, where you can't run a make fetch. There is an archive of distfiles
2472: on ftp.NetBSD.org, but downloading the entire directory may not be appropriate.
2473:
2474: The answer here is to do a make fetch-list in /usr/pkgsrc or one of its
2475: subdirectories, carry the resulting list to your machine at work/school and use
2476: it there. If you don't have a NetBSD-compatible ftp(1) (like tnftp) at work,
2477: don't forget to set FETCH_CMD to something that fetches a URL:
2478:
2479: At home:
2480:
2481: % cd /usr/pkgsrc
2482: % make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh
2483: % scp /tmp/fetch.sh work:/tmp
2484:
2485: At work:
2486:
2487: % sh /tmp/fetch.sh
2488:
2489: then tar up /tmp/distfiles and take it home.
2490:
2491: If you have a machine running NetBSD, and you want to get all distfiles (even
2492: ones that aren't for your machine architecture), you can do so by using the
2493: above-mentioned make fetch-list approach, or fetch the distfiles directly by
2494: running:
2495:
2496: % make mirror-distfiles
2497:
2498: If you even decide to ignore NO_{SRC,BIN}_ON_{FTP,CDROM}, then you can get
2499: everything by running:
2500:
2501: % make fetch NO_SKIP=yes
2502:
1.154 rillig 2503: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
1.1 dsieger 2504:
2505: When compiling the pkgtools/pkg_install package, you get the error from make
2506: that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates
2507: that you don't have installed the "text" set (nroff, ...) from the NetBSD base
2508: distribution on your machine. It is recommended to do that to format man pages.
2509:
2510: In the case of the pkgtools/pkg_install package, you can get away with setting
1.4 rillig 2511: NOMAN=YES either in the environment or in mk.conf.
1.1 dsieger 2512:
1.154 rillig 2513: 10.11. What does "Could not find bsd.own.mk" mean?
1.1 dsieger 2514:
2515: You didn't install the compiler set, comp.tgz, when you installed your NetBSD
2516: machine. Please get and install it, by extracting it in /:
2517:
2518: # cd /
2519: # tar --unlink -zxvpf .../comp.tgz
2520:
2521: comp.tgz is part of every NetBSD release. Get the one that corresponds to your
2522: release (determine via uname -r).
2523:
1.154 rillig 2524: 10.12. Using 'sudo' with pkgsrc
1.1 dsieger 2525:
2526: When installing packages as non-root user and using the just-in-time su(1)
2527: feature of pkgsrc, it can become annoying to type in the root password for each
2528: required package installed. To avoid this, the sudo package can be used, which
2529: does password caching over a limited time. To use it, install sudo (either as
1.4 rillig 2530: binary package or from security/sudo) and then put the following into your
2531: mk.conf, somewhere after the definition of the LOCALBASE variable:
1.1 dsieger 2532:
2533: .if exists(${LOCALBASE}/bin/sudo)
2534: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2535: .endif
2536:
1.154 rillig 2537: 10.13. How do I change the location of configuration files?
1.1 dsieger 2538:
2539: As the system administrator, you can choose where configuration files are
2540: installed. The default settings make all these files go into ${PREFIX}/etc or
2541: some of its subdirectories; this may be suboptimal depending on your
2542: expectations (e.g., a read-only, NFS-exported PREFIX with a need of per-machine
2543: configuration of the provided packages).
2544:
2545: In order to change the defaults, you can modify the PKG_SYSCONFBASE variable
1.4 rillig 2546: (in mk.conf) to point to your preferred configuration directory; some common
2547: examples include /etc or /etc/pkg.
1.1 dsieger 2548:
2549: Furthermore, you can change this value on a per-package basis by setting the
2550: PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. PKG_SYSCONFVAR's value usually
2551: matches the name of the package you would like to modify, that is, the contents
2552: of PKGBASE.
2553:
2554: Note that after changing these settings, you must rebuild and reinstall any
2555: affected packages.
2556:
1.154 rillig 2557: 10.14. Automated security checks
1.1 dsieger 2558:
2559: Please be aware that there can often be bugs in third-party software, and some
2560: of these bugs can leave a machine vulnerable to exploitation by attackers. In
2561: an effort to lessen the exposure, the NetBSD packages team maintains a database
2562: of known-exploits to packages which have at one time been included in pkgsrc.
2563: The database can be downloaded automatically, and a security audit of all
1.14 jmcneill 2564: packages installed on a system can take place. To do this, refer to the
2565: following two tools (installed as part of the pkgtools/pkg_install package):
1.1 dsieger 2566:
1.21 snj 2567: 1. pkg_admin fetch-pkg-vulnerabilities, an easy way to download a list of the
2568: security vulnerabilities information. This list is kept up to date by the
1.26 spz 2569: pkgsrc security team, and is distributed from the NetBSD ftp server:
1.1 dsieger 2570:
1.177 leot 2571: https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities
1.1 dsieger 2572:
1.21 snj 2573: 2. pkg_admin audit, an easy way to audit the current machine, checking each
1.24 wiz 2574: known vulnerability. If a vulnerable package is installed, it will be shown
2575: by output to stdout, including a description of the type of vulnerability,
2576: and a URL containing more information.
1.1 dsieger 2577:
1.154 rillig 2578: Use of these tools is strongly recommended! See Section 5.1.5, "Checking for
1.121 sevan 2579: security vulnerabilities in installed packages" for instructions on how to
2580: automate checking and reporting.
2581:
2582: If this database is installed, pkgsrc builds will use it to perform a security
2583: check before building any package.
1.1 dsieger 2584:
1.154 rillig 2585: 10.15. Why do some packages ignore my CFLAGS?
1.1 dsieger 2586:
2587: When you add your own preferences to the CFLAGS variable in your mk.conf, these
2588: flags are passed in environment variables to the ./configure scripts and to
2589: make(1). Some package authors ignore the CFLAGS from the environment variable
2590: by overriding them in the Makefiles of their package.
2591:
2592: Currently there is no solution to this problem. If you really need the package
2593: to use your CFLAGS you should run make patch in the package directory and then
2594: inspect any Makefile and Makefile.in for whether they define CFLAGS explicitly.
2595: Usually you can remove these lines. But be aware that some "smart" programmers
2596: write so bad code that it only works for the specific combination of CFLAGS
2597: they have chosen.
2598:
1.172 rillig 2599: To find out where the CFLAGS are ignored, add the following lines to mk.conf:
2600:
2601: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
2602: CFLAGS+= -Dpkgsrc___CFLAGS
2603: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
2604:
2605: Then run bmake show-all-configure show-all-build to see whether the above flags
2606: are passed to the actual build commands in general.
2607:
2608: To find out whether the flags are passed to individual compiler commands, have
2609: a look at the file work/.work.log. In most cases, the flags from the original
2610: command lines (the lines starting with [*]) are passed unmodified to the actual
2611: compiler (the lines starting with <.>). If the flag is missing from the actual
2612: compiler command, it must have been removed by the pkgsrc compiler wrappers.
2613:
1.154 rillig 2614: 10.16. A package does not build. What shall I do?
1.1 dsieger 2615:
2616: 1. Make sure that your copy of pkgsrc is consistent. A case that occurs often
2617: is that people only update pkgsrc in parts, because of performance reasons.
2618: Since pkgsrc is one large system, not a collection of many small systems,
2619: there are sometimes changes that only work when the whole pkgsrc tree is
2620: updated.
2621:
1.25 wiz 2622: 2. Make sure that you don't have any CVS conflicts. Search for "<<<<<<" or "
2623: >>>>>>" in all your pkgsrc files.
1.1 dsieger 2624:
1.25 wiz 2625: 3. Make sure that you don't have old copies of the packages extracted. Run
1.1 dsieger 2626: make clean clean-depends to verify this.
2627:
1.108 rillig 2628: 4. If you are a package developer who wants to invest some work, have a look
1.154 rillig 2629: at Chapter 21, Making your package work.
1.108 rillig 2630:
2631: 5. If the problem still exists, write a mail to the pkgsrc-users mailing list.
1.1 dsieger 2632:
1.154 rillig 2633: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.1 dsieger 2634: conflicts" mean?
2635:
2636: You have modified a file from pkgsrc, and someone else has modified that same
2637: file afterwards in the CVS repository. Both changes are in the same region of
2638: the file, so when you updated pkgsrc, the cvs command marked the conflicting
2639: changes in the file. Because of these markers, the file is no longer a valid
2640: Makefile.
2641:
2642: Have a look at that file, and if you don't need your local changes anymore, you
2643: can remove that file and run cvs -q update -dP in that directory to download
2644: the current version.
2645:
2646: Part II. The pkgsrc developer's guide
2647:
2648: This part of the book deals with creating and modifying packages. It starts
2649: with a "HOWTO"-like guide on creating a new package. The remaining chapters are
2650: more like a reference manual for pkgsrc.
2651:
2652: Table of Contents
2653:
1.154 rillig 2654: 11. Getting help
1.184 rillig 2655: 12. Package components - files, directories and contents
1.1 dsieger 2656:
1.184 rillig 2657: 12.1. Makefile
2658: 12.2. distinfo
2659: 12.3. patches/*
1.1 dsieger 2660:
1.184 rillig 2661: 12.3.1. Structure of a single patch file
2662: 12.3.2. Creating patch files
2663: 12.3.3. Sources where the patch files come from
2664: 12.3.4. Patching guidelines
2665: 12.3.5. Feedback to the author
1.1 dsieger 2666:
1.184 rillig 2667: 12.4. Other mandatory files
2668: 12.5. Optional files
1.1 dsieger 2669:
1.184 rillig 2670: 12.5.1. Files affecting the binary package
2671: 12.5.2. Files affecting the build process
2672: 12.5.3. Files affecting nothing at all
1.1 dsieger 2673:
1.184 rillig 2674: 12.6. work*
2675: 12.7. files/*
1.1 dsieger 2676:
1.184 rillig 2677: 13. The build process
1.1 dsieger 2678:
1.184 rillig 2679: 13.1. Introduction
2680: 13.2. Program location
2681: 13.3. Directories used during the build process
2682: 13.4. Running a phase
2683: 13.5. The fetch phase
1.1 dsieger 2684:
1.184 rillig 2685: 13.5.1. What to fetch and where to get it from
2686: 13.5.2. How are the files fetched?
1.1 dsieger 2687:
1.184 rillig 2688: 13.6. The checksum phase
2689: 13.7. The extract phase
2690: 13.8. The patch phase
2691: 13.9. The tools phase
2692: 13.10. The wrapper phase
2693: 13.11. The configure phase
2694: 13.12. The build phase
2695: 13.13. The test phase
2696: 13.14. The install phase
2697: 13.15. The package phase
2698: 13.16. Cleaning up
2699: 13.17. Other helpful targets
1.1 dsieger 2700:
1.184 rillig 2701: 14. Creating a new pkgsrc package from scratch
1.1 dsieger 2702:
1.184 rillig 2703: 14.1. Common types of packages
1.1 dsieger 2704:
1.184 rillig 2705: 14.1.1. Perl modules
2706: 14.1.2. Python modules and programs
2707: 14.1.3. R packages
2708: 14.1.4. TeXlive packages
1.1 dsieger 2709:
1.184 rillig 2710: 14.2. Examples
1.1 dsieger 2711:
1.184 rillig 2712: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 2713:
1.184 rillig 2714: 15. Programming in Makefiles
1.1 dsieger 2715:
1.184 rillig 2716: 15.1. Caveats
2717: 15.2. Makefile variables
1.1 dsieger 2718:
1.184 rillig 2719: 15.2.1. Naming conventions
1.1 dsieger 2720:
1.184 rillig 2721: 15.3. Code snippets
1.1 dsieger 2722:
1.184 rillig 2723: 15.3.1. Adding things to a list
2724: 15.3.2. Echoing a string exactly as-is
2725: 15.3.3. Passing CFLAGS to GNU configure scripts
2726: 15.3.4. Handling possibly empty variables
1.1 dsieger 2727:
1.184 rillig 2728: 16. Options handling
1.1 dsieger 2729:
1.184 rillig 2730: 16.1. Global default options
2731: 16.2. Converting packages to use bsd.options.mk
2732: 16.3. Option Names
2733: 16.4. Determining the options of dependencies
1.1 dsieger 2734:
1.184 rillig 2735: 17. Tools needed for building or running
1.1 dsieger 2736:
1.184 rillig 2737: 17.1. Tools for pkgsrc builds
2738: 17.2. Tools needed by packages
2739: 17.3. Tools provided by platforms
1.1 dsieger 2740:
1.184 rillig 2741: 18. Buildlink methodology
1.1 dsieger 2742:
1.184 rillig 2743: 18.1. Converting packages to use buildlink3
2744: 18.2. Writing buildlink3.mk files
1.1 dsieger 2745:
1.184 rillig 2746: 18.2.1. Anatomy of a buildlink3.mk file
2747: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.
2748: pkg in buildlink3.mk files
1.1 dsieger 2749:
1.184 rillig 2750: 18.3. Writing builtin.mk files
1.1 dsieger 2751:
1.184 rillig 2752: 18.3.1. Anatomy of a builtin.mk file
2753: 18.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 2754:
1.184 rillig 2755: 19. PLIST issues
1.1 dsieger 2756:
1.184 rillig 2757: 19.1. RCS ID
2758: 19.2. Semi-automatic PLIST generation
2759: 19.3. Tweaking output of make print-PLIST
2760: 19.4. Variable substitution in PLIST
2761: 19.5. Man page compression
2762: 19.6. Changing PLIST source with PLIST_SRC
2763: 19.7. Platform-specific and differing PLISTs
2764: 19.8. Build-specific PLISTs
2765: 19.9. Sharing directories between packages
1.1 dsieger 2766:
1.184 rillig 2767: 20. The pkginstall framework
1.1 dsieger 2768:
1.184 rillig 2769: 20.1. Files and directories outside the installation prefix
1.1 dsieger 2770:
1.184 rillig 2771: 20.1.1. Directory manipulation
2772: 20.1.2. File manipulation
1.1 dsieger 2773:
1.184 rillig 2774: 20.2. Configuration files
1.1 dsieger 2775:
1.184 rillig 2776: 20.2.1. How PKG_SYSCONFDIR is set
2777: 20.2.2. Telling the software where configuration files are
2778: 20.2.3. Patching installations
2779: 20.2.4. Disabling handling of configuration files
1.1 dsieger 2780:
1.184 rillig 2781: 20.3. System startup scripts
1.1 dsieger 2782:
1.184 rillig 2783: 20.3.1. Disabling handling of system startup scripts
1.1 dsieger 2784:
1.184 rillig 2785: 20.4. System users and groups
2786: 20.5. System shells
1.1 dsieger 2787:
1.184 rillig 2788: 20.5.1. Disabling shell registration
1.1 dsieger 2789:
1.184 rillig 2790: 20.6. Fonts
1.1 dsieger 2791:
1.184 rillig 2792: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 2793:
1.154 rillig 2794: 21. Making your package work
1.1 dsieger 2795:
1.154 rillig 2796: 21.1. General operation
1.1 dsieger 2797:
1.154 rillig 2798: 21.1.1. How to pull in user-settable variables from mk.conf
2799: 21.1.2. User interaction
2800: 21.1.3. Handling licenses
2801: 21.1.4. Restricted packages
2802: 21.1.5. Handling dependencies
2803: 21.1.6. Handling conflicts with other packages
2804: 21.1.7. Packages that cannot or should not be built
2805: 21.1.8. Packages which should not be deleted, once installed
2806: 21.1.9. Handling packages with security problems
2807: 21.1.10. How to handle incrementing versions when fixing an existing
1.1 dsieger 2808: package
1.154 rillig 2809: 21.1.11. Substituting variable text in the package files (the SUBST
1.1 dsieger 2810: framework)
2811:
1.154 rillig 2812: 21.2. The fetch phase
1.1 dsieger 2813:
1.154 rillig 2814: 21.2.1. Packages whose distfiles aren't available for plain downloading
2815: 21.2.2. How to handle modified distfiles with the 'old' name
2816: 21.2.3. Packages hosted on github.com
2817:
2818: 21.3. The configure phase
2819:
2820: 21.3.1. Shared libraries - libtool
2821: 21.3.2. Using libtool on GNU packages that already support libtool
2822: 21.3.3. GNU Autoconf/Automake
2823:
2824: 21.4. Programming languages
2825:
2826: 21.4.1. C, C++, and Fortran
2827: 21.4.2. Java
2828: 21.4.3. Packages containing perl scripts
2829: 21.4.4. Packages containing shell scripts
2830: 21.4.5. Other programming languages
2831:
2832: 21.5. The build phase
2833:
2834: 21.5.1. Compiling C and C++ code conditionally
2835: 21.5.2. How to handle compiler bugs
1.172 rillig 2836: 21.5.3. No such file or directory
2837: 21.5.4. Undefined reference to "..."
2838: 21.5.5. Running out of memory
1.154 rillig 2839:
2840: 21.6. The install phase
2841:
2842: 21.6.1. Creating needed directories
2843: 21.6.2. Where to install documentation
2844: 21.6.3. Installing highscore files
2845: 21.6.4. Adding DESTDIR support to packages
2846: 21.6.5. Packages with hardcoded paths to other interpreters
2847: 21.6.6. Packages installing perl modules
2848: 21.6.7. Packages installing info files
2849: 21.6.8. Packages installing man pages
2850: 21.6.9. Packages installing GConf data files
2851: 21.6.10. Packages installing scrollkeeper/rarian data files
2852: 21.6.11. Packages installing X11 fonts
2853: 21.6.12. Packages installing GTK2 modules
2854: 21.6.13. Packages installing SGML or XML data
2855: 21.6.14. Packages installing extensions to the MIME database
2856: 21.6.15. Packages using intltool
2857: 21.6.16. Packages installing startup scripts
2858: 21.6.17. Packages installing TeX modules
2859: 21.6.18. Packages supporting running binaries in emulation
2860: 21.6.19. Packages installing hicolor theme icons
2861: 21.6.20. Packages installing desktop files
2862:
2863: 21.7. Marking packages as having problems
2864:
1.184 rillig 2865: 22. GNOME packaging and porting
2866:
2867: 22.1. Meta packages
2868: 22.2. Packaging a GNOME application
2869: 22.3. Updating GNOME to a newer version
2870: 22.4. Patching guidelines
2871:
1.154 rillig 2872: 23. Submitting and Committing
2873:
2874: 23.1. Submitting binary packages
2875: 23.2. Submitting source packages (for non-NetBSD-developers)
2876: 23.3. General notes when adding, updating, or removing packages
2877: 23.4. Commit Messages
2878: 23.5. Committing: Adding a package to CVS
2879: 23.6. Updating a package to a newer version
2880: 23.7. Renaming a package in pkgsrc
2881: 23.8. Moving a package in pkgsrc
2882:
2883: 24. Frequently Asked Questions
2884:
2885: Chapter 11. Getting help
2886:
2887: To get help when developing pkgsrc, the definitive source is this document, the
2888: pkgsrc guide. If you don't find anything here, there are alternatives:
2889:
2890: * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
2891: Run bmake help topic=? to get help for any topic, such as a variable name
2892: like BUILD_DEFS, a make target like do-build, a missing C or C++ function
2893: like strcasecmp or any other topic.
2894:
2895: The available help topics are listed in Appendix D, Help topics.
2896:
1.163 rillig 2897: * To see the value of a single variable, run bmake show-var VARNAME=X.
2898:
2899: * To see the values of the most common variables, run bmake show-all. These
2900: variables are grouped by topic. To see the variables for a single topic,
2901: run bmake show-all-topic, for example bmake show-all-fetch.
2902:
1.154 rillig 2903: * The tech-pkg mailing list, to which you can subscribe and then ask your
2904: questions.
2905:
2906: * The #pkgsrc IRC channel, which is accessible via a web browser or by using
2907: a specialized chat program such as XChat. Pick any user name and join the
2908: channel #pkgsrc.
1.1 dsieger 2909:
1.184 rillig 2910: Chapter 12. Package components - files, directories and contents
1.1 dsieger 2911:
2912: Table of Contents
2913:
1.184 rillig 2914: 12.1. Makefile
2915: 12.2. distinfo
2916: 12.3. patches/*
2917:
2918: 12.3.1. Structure of a single patch file
2919: 12.3.2. Creating patch files
2920: 12.3.3. Sources where the patch files come from
2921: 12.3.4. Patching guidelines
2922: 12.3.5. Feedback to the author
2923:
2924: 12.4. Other mandatory files
2925: 12.5. Optional files
2926:
2927: 12.5.1. Files affecting the binary package
2928: 12.5.2. Files affecting the build process
2929: 12.5.3. Files affecting nothing at all
1.1 dsieger 2930:
1.184 rillig 2931: 12.6. work*
2932: 12.7. files/*
1.1 dsieger 2933:
1.184 rillig 2934: Whenever you're preparing a package, there are a number of files involved which
2935: are described in the following sections.
1.1 dsieger 2936:
1.184 rillig 2937: 12.1. Makefile
1.1 dsieger 2938:
1.184 rillig 2939: Building, installation and creation of a binary package are all controlled by
2940: the package's Makefile. The Makefile describes various things about a package,
2941: for example from where to get it, how to configure, build, and install it.
1.1 dsieger 2942:
1.184 rillig 2943: A package Makefile contains several sections that describe the package.
1.1 dsieger 2944:
1.184 rillig 2945: In the first section there are the following variables, which should appear
2946: exactly in the order given here. The order and grouping of the variables is
2947: mostly historical and has no further meaning.
1.1 dsieger 2948:
1.184 rillig 2949: * DISTNAME is the basename of the distribution file to be downloaded from the
2950: package's website.
1.1 dsieger 2951:
1.184 rillig 2952: * PKGNAME is the name of the package, as used by pkgsrc. You need to provide
2953: it if DISTNAME (which is the default) is not a good name for the package in
2954: pkgsrc or DISTNAME is not provided (no distribution file is required).
2955: Usually it is the pkgsrc directory name together with the version number.
2956: It must match the regular expression ^[A-Za-z0-9][A-Za-z0-9-_.+]*$, that
2957: is, it starts with a letter or digit, and contains only letters, digits,
2958: dashes, underscores, dots and plus signs.
1.26 spz 2959:
1.184 rillig 2960: * CATEGORIES is a list of categories which the package fits in. You can
2961: choose any of the top-level directories of pkgsrc for it.
1.1 dsieger 2962:
1.184 rillig 2963: Currently the following values are available for CATEGORIES. If more than
2964: one is used, they need to be separated by spaces:
1.1 dsieger 2965:
1.184 rillig 2966: archivers cross geography meta-pkgs security
2967: audio databases graphics misc shells
2968: benchmarks devel ham multimedia sysutils
2969: biology editors inputmethod net textproc
2970: cad emulators lang news time
2971: chat finance mail parallel wm
2972: comms fonts math pkgtools www
2973: converters games mbone print x11
1.1 dsieger 2974:
1.184 rillig 2975: * MASTER_SITES, DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES
2976: are discussed in detail in Section 13.5, "The fetch phase".
1.1 dsieger 2977:
1.184 rillig 2978: The second section contains information about separately downloaded patches, if
2979: any.
1.1 dsieger 2980:
1.184 rillig 2981: * PATCHFILES: Name(s) of additional files that contain distribution patches.
2982: There is no default. pkgsrc will look for them at PATCH_SITES. They will
2983: automatically be uncompressed before patching if the names end with .gz or
2984: .Z.
1.1 dsieger 2985:
1.184 rillig 2986: * PATCH_SITES: Primary location(s) for distribution patch files (see
2987: PATCHFILES above) if not found locally.
1.1 dsieger 2988:
1.184 rillig 2989: * PATCH_DIST_STRIP: an argument to patch(1) that sets the pathname strip
2990: count to help find the correct files to patch. It defaults to -p0.
1.1 dsieger 2991:
1.184 rillig 2992: The third section contains the following variables.
1.1 dsieger 2993:
1.184 rillig 2994: * MAINTAINER is the email address of the person who feels responsible for
2995: this package, and who is most likely to look at problems or questions
2996: regarding this package which have been reported with send-pr(1). Other
2997: developers may contact the MAINTAINER before making changes to the package,
2998: but are not required to do so. When packaging a new program, set MAINTAINER
2999: to yourself. If you really can't maintain the package for future updates,
3000: set it to <pkgsrc-users@NetBSD.org>.
1.1 dsieger 3001:
1.184 rillig 3002: * OWNER should be used instead of MAINTAINER when you do not want other
3003: developers to update or change the package without contacting you first. A
3004: package Makefile should contain one of MAINTAINER or OWNER, but not both.
1.1 dsieger 3005:
1.184 rillig 3006: * HOMEPAGE is a URL where users can find more information about the package.
1.1 dsieger 3007:
1.184 rillig 3008: * COMMENT is a one-line description of the package (should not include the
3009: package name).
1.1 dsieger 3010:
1.184 rillig 3011: * LICENSE indicates the license(s) applicable for the package. See
3012: Section 21.1.3, "Handling licenses" for further details.
1.1 dsieger 3013:
1.184 rillig 3014: Other variables that affect the build:
1.1 dsieger 3015:
1.184 rillig 3016: * WRKSRC: The directory where the interesting distribution files of the
3017: package are found. The default is ${WRKDIR}/${DISTNAME}, which works for
3018: most packages.
1.1 dsieger 3019:
1.184 rillig 3020: If a package doesn't create a subdirectory for itself (most GNU software
3021: does, for instance), but extracts itself in the current directory, you
3022: should set WRKSRC=${WRKDIR}.
1.1 dsieger 3023:
1.184 rillig 3024: If a package doesn't create a subdirectory with the name of DISTNAME but
3025: some different name, set WRKSRC to point to the proper name in ${WRKDIR},
3026: for example WRKSRC=${WRKDIR}/${DISTNAME}/unix. See lang/tcl and x11/tk for
3027: other examples.
1.17 imil 3028:
1.184 rillig 3029: The name of the working directory created by pkgsrc is taken from the
3030: WRKDIR_BASENAME variable. By default, its value is work. If you want to use
3031: the same pkgsrc tree for building different kinds of binary packages, you
3032: can change the variable according to your needs. Two other variables handle
3033: common cases of setting WRKDIR_BASENAME individually. If OBJHOSTNAME is
3034: defined in mk.conf, the first component of the host's name is attached to
3035: the directory name. If OBJMACHINE is defined, the platform name is
3036: attached, which might look like work.i386 or work.sparc.
1.17 imil 3037:
1.184 rillig 3038: Please pay attention to the following gotchas:
1.17 imil 3039:
1.184 rillig 3040: * Add MANCOMPRESSED if man pages are installed in compressed form by the
3041: package. For packages using BSD-style makefiles which honor MANZ, there is
3042: MANCOMPRESSED_IF_MANZ.
1.17 imil 3043:
1.184 rillig 3044: * Replace /usr/local with "${PREFIX}" in all files (see patches, below).
1.103 wiz 3045:
1.184 rillig 3046: * If the package installs any info files, see Section 21.6.7, "Packages
3047: installing info files".
1.103 wiz 3048:
1.184 rillig 3049: 12.2. distinfo
1.17 imil 3050:
1.184 rillig 3051: The distinfo file contains the message digest, or checksum, of each distfile
3052: needed for the package. This ensures that the distfiles retrieved from the
3053: Internet have not been corrupted during transfer or altered by a malign force
3054: to introduce a security hole. To provide maximum security, all distfiles are
3055: protected using three different message digest algorithms (SHA1, RMD160,
3056: SHA512), as well as the file size.
1.17 imil 3057:
1.184 rillig 3058: The distinfo file also contains the checksums for all the patches found in the
3059: patches directory (see Section 12.3, "patches/*"). These checksums ensure that
3060: patches are only applied intentionally and that they don't accidentally change,
3061: e.g. when merging different changes together. They also make sure that new
3062: patches are actually added to CVS and old ones are removed. Too see whether the
3063: patches and the distinfo file match, run pkglint after changing the patches.
1.17 imil 3064:
1.184 rillig 3065: To regenerate the distinfo file, use the make distinfo command.
1.17 imil 3066:
1.184 rillig 3067: Some packages have different sets of distfiles depending on the platform, for
3068: example lang/openjdk8. These are kept in the same distinfo file and care should
3069: be taken when upgrading such a package to ensure distfile information is not
3070: lost.
1.17 imil 3071:
1.184 rillig 3072: 12.3. patches/*
1.63 wiz 3073:
1.184 rillig 3074: Some packages don't work out-of-the box on the various platforms that are
3075: supported by pkgsrc. These packages need to be patched to make them work. The
3076: patch files can be found in the patches/ directory.
1.17 imil 3077:
1.184 rillig 3078: In the patch phase, these patches are applied to the files in WRKSRC directory
3079: after extracting them, in alphabetic order.
1.160 brook 3080:
1.184 rillig 3081: 12.3.1. Structure of a single patch file
1.160 brook 3082:
1.184 rillig 3083: The patch-* files should be in diff -bu format, and apply without a fuzz to
3084: avoid problems. (To force patches to apply with fuzz you can set
3085: PATCH_FUZZ_FACTOR=-F2). Furthermore, each patch should contain only changes for
3086: a single file, and no file should be patched by more than one patch file. This
3087: helps to keep future modifications simple.
1.160 brook 3088:
1.184 rillig 3089: Each patch file is structured as follows: In the first line, there is the RCS
3090: Id of the patch itself. The second line should be empty for aesthetic reasons.
3091: After that, there should be a comment for each change that the patch does.
3092: There are a number of standard cases:
1.160 brook 3093:
1.184 rillig 3094: * Patches for commonly known vulnerabilities should mention the vulnerability
3095: ID (CAN, CVE).
1.160 brook 3096:
1.184 rillig 3097: * Patches that change source code should mention the platform and other
3098: environment (for example, the compiler) that the patch is needed for.
1.160 brook 3099:
1.184 rillig 3100: The patch should be commented so that any developer who knows the code of the
3101: application can make some use of the patch. Special care should be taken for
3102: the upstream developers, since we generally want that they accept our patches,
3103: so we have less work in the future.
1.160 brook 3104:
1.184 rillig 3105: 12.3.2. Creating patch files
1.160 brook 3106:
1.184 rillig 3107: One important thing to mention is to pay attention that no RCS IDs get stored
3108: in the patch files, as these will cause problems when later checked into the
3109: NetBSD CVS tree. Use the pkgdiff command from the pkgtools/pkgdiff package to
3110: avoid these problems.
1.160 brook 3111:
1.184 rillig 3112: For even more automation, we recommend using mkpatches from the same package to
3113: make a whole set of patches. You just have to backup files before you edit them
3114: to filename.orig, e.g. with cp -p filename filename.orig or, easier, by using
3115: pkgvi again from the same package. If you upgrade a package this way, you can
3116: easily compare the new set of patches with the previously existing one with
3117: patchdiff. The files in patches are replaced by new files, so carefully check
3118: if you want to take all the changes.
1.160 brook 3119:
1.184 rillig 3120: When you have finished a package, remember to generate the checksums for the
3121: patch files by using the make makepatchsum command, see Section 12.2,
3122: "distinfo".
1.1 dsieger 3123:
1.184 rillig 3124: When adding a patch that corrects a problem in the distfile (rather than e.g.
3125: enforcing pkgsrc's view of where man pages should go), send the patch as a bug
3126: report to the maintainer. This benefits non-pkgsrc users of the package, and
3127: usually makes it possible to remove the patch in future version.
1.1 dsieger 3128:
1.184 rillig 3129: The file names of the patch files are usually of the form patch-
3130: path_to_file__with__underscores.c. Many packages still use the previous
3131: convention patch-[a-z][a-z], but new patches should be of the form containing
3132: the filename. mkpatches included in pkgtools/pkgdiff takes care of the name
3133: automatically.
1.1 dsieger 3134:
1.184 rillig 3135: 12.3.3. Sources where the patch files come from
1.1 dsieger 3136:
1.184 rillig 3137: If you want to share patches between multiple packages in pkgsrc, e.g. because
3138: they use the same distfiles, set PATCHDIR to the path where the patch files can
3139: be found, e.g.:
1.1 dsieger 3140:
1.184 rillig 3141: PATCHDIR= ../../editors/xemacs/patches
1.1 dsieger 3142:
1.184 rillig 3143: Patch files that are distributed by the author or other maintainers can be
3144: listed in PATCHFILES.
1.1 dsieger 3145:
1.184 rillig 3146: If it is desired to store any patches that should not be committed into pkgsrc,
3147: they can be kept outside the pkgsrc tree in the $LOCALPATCHES directory. The
3148: directory tree there is expected to have the same "category/package" structure
3149: as pkgsrc, and patches are expected to be stored inside these dirs (also known
3150: as $LOCALPATCHES/$PKGPATH). For example, if you want to keep a private patch
3151: for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All
3152: files in the named directory are expected to be patch files, and they are
3153: applied after pkgsrc patches are applied.
1.1 dsieger 3154:
1.184 rillig 3155: 12.3.4. Patching guidelines
1.1 dsieger 3156:
1.184 rillig 3157: When fixing a portability issue in the code do not use preprocessor magic to
3158: check for the current operating system nor platform. Doing so hurts portability
3159: to other platforms because the OS-specific details are not abstracted
3160: appropriately.
1.1 dsieger 3161:
1.184 rillig 3162: The general rule to follow is: instead of checking for the operating system the
3163: application is being built on, check for the specific features you need. For
3164: example, instead of assuming that kqueue is available under NetBSD and using
3165: the __NetBSD__ macro to conditionalize kqueue support, add a check that detects
3166: kqueue itself ? yes, this generally involves patching the configure script.
3167: There is absolutely nothing that prevents some OSes from adopting interfaces
3168: from other OSes (e.g. Linux implementing kqueue), something that the above
3169: checks cannot take into account.
1.1 dsieger 3170:
1.184 rillig 3171: Of course, checking for features generally involves more work on the
3172: developer's side, but the resulting changes are cleaner and there are chances
3173: they will work on many other platforms. Not to mention that there are higher
3174: chances of being later integrated into the mainstream sources. Remember: It
3175: doesn't work unless it is right!
1.1 dsieger 3176:
1.184 rillig 3177: Some typical examples:
1.121 sevan 3178:
1.184 rillig 3179: Table 12.1. Patching examples
1.1 dsieger 3180:
1.184 rillig 3181: +-------------------------------------------------------------------------------------------+
3182: | Where | Incorrect | Correct |
3183: |---------+--------------------------+------------------------------------------------------|
3184: | |case ${target_os} in | |
3185: |configure|netbsd*) have_kvm=yes ;; |AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)|
3186: |script |*) have_kvm=no ;; | |
3187: | |esac | |
3188: |---------+--------------------------+------------------------------------------------------|
3189: |C source |#if defined(__NetBSD__) |#if defined(HAVE_SYS_EVENT_H) |
3190: |file |# include <sys/event.h> |# include <sys/event.h> |
3191: | |#endif |#endif |
3192: |---------+--------------------------+------------------------------------------------------|
3193: | |int |int |
3194: | |monitor_file(...) |monitor_file(...) |
3195: | |{ |{ |
3196: | |#if defined(__NetBSD__) |#if defined(HAVE_KQUEUE) |
3197: |C source | int fd = kqueue();| int fd = kqueue(); |
3198: |file | ... | ... |
3199: | |#else |#else |
3200: | | ... | ... |
3201: | |#endif |#endif |
3202: | |} |} |
3203: +-------------------------------------------------------------------------------------------+
1.1 dsieger 3204:
3205:
1.184 rillig 3206: 12.3.5. Feedback to the author
1.1 dsieger 3207:
1.184 rillig 3208: Always, always, always feed back any portability fixes or improvements you do
3209: to a package to the mainstream developers. This is the only way to get their
3210: attention on portability issues and to ensure that future versions can be built
3211: out-of-the box on NetBSD. Furthermore, any user that gets newer distfiles will
3212: get the fixes straight from the packaged code.
1.1 dsieger 3213:
1.184 rillig 3214: This generally involves cleaning up the patches (because sometimes the patches
3215: that are added to pkgsrc are quick hacks), filing bug reports in the
3216: appropriate trackers for the projects and working with the mainstream authors
3217: to accept your changes. It is extremely important that you do it so that the
3218: packages in pkgsrc are kept simple and thus further changes can be done without
3219: much hassle.
1.1 dsieger 3220:
1.184 rillig 3221: When you have done this, please add a URL to the upstream bug report to the
3222: patch comment.
1.1 dsieger 3223:
1.184 rillig 3224: Support the idea of free software!
1.1 dsieger 3225:
1.184 rillig 3226: 12.4. Other mandatory files
1.1 dsieger 3227:
1.184 rillig 3228: DESCR
1.1 dsieger 3229:
1.184 rillig 3230: A multi-line description of the piece of software. This should include any
3231: credits where they are due. Please bear in mind that others do not share
3232: your sense of humour (or spelling idiosyncrasies), and that others will
3233: read everything that you write here.
1.1 dsieger 3234:
1.184 rillig 3235: PLIST
1.1 dsieger 3236:
1.184 rillig 3237: This file governs the files that are installed on your system: all the
3238: binaries, manual pages, etc. There are other directives which may be
3239: entered in this file, to control the creation and deletion of directories,
3240: and the location of inserted files. See Chapter 19, PLIST issues for more
3241: information.
1.1 dsieger 3242:
1.184 rillig 3243: 12.5. Optional files
1.1 dsieger 3244:
1.184 rillig 3245: 12.5.1. Files affecting the binary package
1.1 dsieger 3246:
1.184 rillig 3247: INSTALL
1.1 dsieger 3248:
1.184 rillig 3249: This shell script is invoked twice by pkg_add(1). First time after package
3250: extraction and before files are moved in place, the second time after the
3251: files to install are moved in place. This can be used to do any custom
3252: procedures not possible with @exec commands in PLIST. See pkg_add(1) and
3253: pkg_create(1) for more information. See also Section 20.1, "Files and
3254: directories outside the installation prefix". Please note that you can
3255: modify variables in it easily by using FILES_SUBST in the package's
3256: Makefile:
1.1 dsieger 3257:
1.184 rillig 3258: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3259:
1.184 rillig 3260: replaces "@SOMEVAR@" with "somevalue" in the INSTALL. By default,
3261: substitution is performed for PREFIX, LOCALBASE, X11BASE, VARBASE, and a
3262: few others, type make help topic=FILES_SUBST for a complete list.
1.1 dsieger 3263:
1.184 rillig 3264: DEINSTALL
1.1 dsieger 3265:
1.184 rillig 3266: This script is executed before and after any files are removed. It is this
3267: script's responsibility to clean up any additional messy details around the
3268: package's installation, since all pkg_delete knows is how to delete the
3269: files created in the original distribution. See pkg_delete(1) and
3270: pkg_create(1) for more information. The same methods to replace variables
3271: can be used as for the INSTALL file.
1.1 dsieger 3272:
1.184 rillig 3273: MESSAGE
1.1 dsieger 3274:
1.184 rillig 3275: This file is displayed after installation of the package. Useful for things
3276: like legal notices on almost-free software and hints for updating config
3277: files after installing modules for apache, PHP etc. Please note that you
3278: can modify variables in it easily by using MESSAGE_SUBST in the package's
3279: Makefile:
1.1 dsieger 3280:
1.184 rillig 3281: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3282:
1.184 rillig 3283: replaces "${SOMEVAR}" with "somevalue" in MESSAGE. By default, substitution
3284: is performed for PKGNAME, PKGBASE, PREFIX, LOCALBASE, X11BASE,
3285: PKG_SYSCONFDIR, ROOT_GROUP, and ROOT_USER.
1.1 dsieger 3286:
1.184 rillig 3287: You can display a different or additional files by setting the MESSAGE_SRC
3288: variable. Its default is MESSAGE, if the file exists.
1.1 dsieger 3289:
1.184 rillig 3290: ALTERNATIVES
1.1 dsieger 3291:
1.184 rillig 3292: This file is used by the alternatives framework. It creates, configures,
3293: and destroys generic wrappers used to run programs with similar interfaces.
3294: See pkg_alternatives(8) from pkgtools/pkg_alternatives for more
3295: information.
1.1 dsieger 3296:
1.184 rillig 3297: Each line of the file contains two filenames, first the wrapper and then
3298: the alternative provided by the package. Both paths are relative to PREFIX.
1.1 dsieger 3299:
1.184 rillig 3300: 12.5.2. Files affecting the build process
1.1 dsieger 3301:
1.184 rillig 3302: Makefile.common
1.1 dsieger 3303:
1.184 rillig 3304: This file contains arbitrary things that could also go into a Makefile, but
3305: its purpose is to be used by more than one package. This file should only
3306: be used when the packages that will use the file are known in advance. For
3307: other purposes it is often better to write a *.mk file and give it a good
3308: name that describes what it does.
1.1 dsieger 3309:
1.184 rillig 3310: buildlink3.mk
1.1 dsieger 3311:
1.184 rillig 3312: This file contains the dependency information for the buildlink3 framework
3313: (see Chapter 18, Buildlink methodology).
1.1 dsieger 3314:
1.184 rillig 3315: hacks.mk
1.1 dsieger 3316:
1.184 rillig 3317: This file contains workarounds for compiler bugs and similar things. It is
3318: included automatically by the pkgsrc infrastructure, so you don't need an
3319: extra .include line for it.
1.1 dsieger 3320:
1.184 rillig 3321: options.mk
1.1 dsieger 3322:
1.184 rillig 3323: This file contains the code for the package-specific options (see
3324: Chapter 16, Options handling) that can be selected by the user. If a
3325: package has only one or two options, it is equally acceptable to put the
3326: code directly into the Makefile.
1.1 dsieger 3327:
1.184 rillig 3328: 12.5.3. Files affecting nothing at all
1.1 dsieger 3329:
1.184 rillig 3330: README*
1.1 dsieger 3331:
1.184 rillig 3332: These files do not take place in the creation of a package and thus are
3333: purely informative to the package developer.
1.1 dsieger 3334:
1.184 rillig 3335: TODO
1.1 dsieger 3336:
1.184 rillig 3337: This file contains things that need to be done to make the package even
3338: better.
1.1 dsieger 3339:
1.184 rillig 3340: 12.6. work*
1.1 dsieger 3341:
1.184 rillig 3342: When you type make, the distribution files are unpacked into the directory
3343: denoted by WRKDIR. It can be removed by running make clean. Besides the
3344: sources, this directory is also used to keep various timestamp files. The
3345: directory gets removed completely on clean. The default is ${.CURDIR}/work or $
3346: {.CURDIR}/work.${MACHINE_ARCH} if OBJMACHINE is set.
1.1 dsieger 3347:
1.184 rillig 3348: 12.7. files/*
1.80 wiz 3349:
1.184 rillig 3350: If you have any files that you wish to be placed in the package prior to
3351: configuration or building, you can place these files here and use a ${CP}
3352: command in the "post-extract" target to achieve this.
1.1 dsieger 3353:
1.184 rillig 3354: If you want to share files in this way with other packages, set the FILESDIR
3355: variable to point to the other package's files directory, e.g.:
1.1 dsieger 3356:
1.184 rillig 3357: FILESDIR= ../../editors/xemacs/files
1.14 jmcneill 3358:
1.184 rillig 3359: Chapter 13. The build process
1.1 dsieger 3360:
1.184 rillig 3361: Table of Contents
1.1 dsieger 3362:
1.184 rillig 3363: 13.1. Introduction
3364: 13.2. Program location
3365: 13.3. Directories used during the build process
3366: 13.4. Running a phase
3367: 13.5. The fetch phase
3368:
3369: 13.5.1. What to fetch and where to get it from
3370: 13.5.2. How are the files fetched?
3371:
3372: 13.6. The checksum phase
3373: 13.7. The extract phase
3374: 13.8. The patch phase
3375: 13.9. The tools phase
3376: 13.10. The wrapper phase
3377: 13.11. The configure phase
3378: 13.12. The build phase
3379: 13.13. The test phase
3380: 13.14. The install phase
3381: 13.15. The package phase
3382: 13.16. Cleaning up
3383: 13.17. Other helpful targets
1.1 dsieger 3384:
1.184 rillig 3385: 13.1. Introduction
1.122 leot 3386:
1.184 rillig 3387: This chapter gives a detailed description on how a package is built. Building a
3388: package is separated into different phases (for example fetch, build, install),
3389: all of which are described in the following sections. Each phase is split into
3390: so-called stages, which take the name of the containing phase, prefixed by one
3391: of pre-, do- or post-. (Examples are pre-configure, post-build.) Most of the
3392: actual work is done in the do-* stages.
1.1 dsieger 3393:
1.184 rillig 3394: Never override the regular targets (like fetch), if you have to, override the
3395: do-* ones instead.
1.1 dsieger 3396:
1.184 rillig 3397: The basic steps for building a program are always the same. First the program's
3398: source (distfile) must be brought to the local system and then extracted. After
3399: any pkgsrc-specific patches to compile properly are applied, the software can
3400: be configured, then built (usually by compiling), and finally the generated
3401: binaries, etc. can be put into place on the system.
1.1 dsieger 3402:
1.184 rillig 3403: To get more details about what is happening at each step, you can set the
3404: PKG_VERBOSE variable, or the PATCH_DEBUG variable if you are just interested in
3405: more details about the patch step.
1.1 dsieger 3406:
1.184 rillig 3407: 13.2. Program location
1.1 dsieger 3408:
1.184 rillig 3409: Before outlining the process performed by the NetBSD package system in the next
3410: section, here's a brief discussion on where programs are installed, and which
3411: variables influence this.
1.1 dsieger 3412:
1.184 rillig 3413: The automatic variable PREFIX indicates where all files of the final program
3414: shall be installed. It is usually set to LOCALBASE (/usr/pkg), or CROSSBASE for
3415: pkgs in the cross category. The value of PREFIX needs to be put into the
3416: various places in the program's source where paths to these files are encoded.
3417: See Section 12.3, "patches/*" and Section 21.3.1, "Shared libraries - libtool"
3418: for more details.
1.1 dsieger 3419:
1.184 rillig 3420: When choosing which of these variables to use, follow the following rules:
1.1 dsieger 3421:
1.184 rillig 3422: * PREFIX always points to the location where the current pkg will be
3423: installed. When referring to a pkg's own installation path, use "${PREFIX}"
3424: .
1.1 dsieger 3425:
1.184 rillig 3426: * LOCALBASE is where all non-X11 pkgs are installed. If you need to construct
3427: a -I or -L argument to the compiler to find includes and libraries
3428: installed by another non-X11 pkg, use "${LOCALBASE}". The name LOCALBASE
3429: stems from FreeBSD, which installed all packages in /usr/local. As pkgsrc
3430: leaves /usr/local for the system administrator, this variable is a
3431: misnomer.
1.1 dsieger 3432:
1.184 rillig 3433: * X11BASE is where the actual X11 distribution (from xsrc, etc.) is
3434: installed. When looking for standard X11 includes (not those installed by a
3435: package), use "${X11BASE}".
1.1 dsieger 3436:
1.184 rillig 3437: * X11-based packages using imake must set USE_IMAKE to be installed correctly
3438: under LOCALBASE.
1.1 dsieger 3439:
1.184 rillig 3440: * Within ${PREFIX}, packages should install files according to hier(7), with
3441: the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/
3442: man.
1.1 dsieger 3443:
1.184 rillig 3444: 13.3. Directories used during the build process
1.2 rillig 3445:
1.184 rillig 3446: When building a package, various directories are used to store source files,
3447: temporary files, pkgsrc-internal files, and so on. These directories are
3448: explained here.
1.1 dsieger 3449:
1.184 rillig 3450: Some of the directory variables contain relative pathnames. There are two
3451: common base directories for these relative directories: PKGSRCDIR/PKGPATH is
3452: used for directories that are pkgsrc-specific. WRKSRC is used for directories
3453: inside the package itself.
1.1 dsieger 3454:
1.184 rillig 3455: PKGSRCDIR
1.1 dsieger 3456:
1.184 rillig 3457: This is an absolute pathname that points to the pkgsrc root directory.
3458: Generally, you don't need it.
1.1 dsieger 3459:
1.184 rillig 3460: PKGDIR
1.1 dsieger 3461:
1.184 rillig 3462: This is an absolute pathname that points to the current package.
1.1 dsieger 3463:
1.184 rillig 3464: PKGPATH
1.1 dsieger 3465:
1.184 rillig 3466: This is a pathname relative to PKGSRCDIR that points to the current
3467: package.
1.1 dsieger 3468:
1.184 rillig 3469: WRKDIR
1.1 dsieger 3470:
1.184 rillig 3471: This is an absolute pathname pointing to the directory where all work takes
3472: place. The distfiles are extracted to this directory. It also contains
3473: temporary directories and log files used by the various pkgsrc frameworks,
3474: like buildlink or the wrappers.
1.1 dsieger 3475:
1.184 rillig 3476: WRKSRC
1.1 dsieger 3477:
1.184 rillig 3478: This is an absolute pathname pointing to the directory where the distfiles
3479: are extracted. It is usually a direct subdirectory of WRKDIR, and often
3480: it's the only directory entry that isn't hidden. This variable may be
3481: changed by a package Makefile.
1.1 dsieger 3482:
1.184 rillig 3483: The CREATE_WRKDIR_SYMLINK definition takes either the value yes or no and
3484: defaults to no. It indicates whether a symbolic link to the WRKDIR is to be
3485: created in the pkgsrc entry's directory. If users would like to have their
3486: pkgsrc trees behave in a read-only manner, then the value of
3487: CREATE_WRKDIR_SYMLINK should be set to no.
1.1 dsieger 3488:
1.184 rillig 3489: 13.4. Running a phase
1.1 dsieger 3490:
1.184 rillig 3491: You can run a particular phase by typing make phase, where phase is the name of
3492: the phase. This will automatically run all phases that are required for this
3493: phase. The default phase is build, that is, when you run make without
3494: parameters in a package directory, the package will be built, but not
3495: installed.
1.1 dsieger 3496:
1.184 rillig 3497: 13.5. The fetch phase
1.1 dsieger 3498:
1.184 rillig 3499: The first step in building a package is to fetch the distribution files
3500: (distfiles) from the sites that are providing them. This is the task of the
3501: fetch phase.
1.25 wiz 3502:
1.184 rillig 3503: 13.5.1. What to fetch and where to get it from
1.1 dsieger 3504:
1.184 rillig 3505: In simple cases, MASTER_SITES defines all URLs from where the distfile, whose
3506: name is derived from the DISTNAME variable, is fetched. The more complicated
3507: cases are described below.
1.1 dsieger 3508:
1.184 rillig 3509: The variable DISTFILES specifies the list of distfiles that have to be fetched.
3510: Its value defaults to ${DEFAULT_DISTFILES} and its value is ${DISTNAME}$
3511: {EXTRACT_SUFX}, so that most packages don't need to define it at all.
3512: EXTRACT_SUFX is .tar.gz by default, but can be changed freely. Note that if
3513: your package requires additional distfiles to the default one, you cannot just
3514: append the additional filenames using the += operator, but you have write for
3515: example:
1.1 dsieger 3516:
1.184 rillig 3517: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 3518:
1.184 rillig 3519: Each distfile is fetched from a list of sites, usually MASTER_SITES. If the
3520: package has multiple DISTFILES or multiple PATCHFILES from different sites, you
3521: can set SITES.distfile to the list of URLs where the file distfile (including
3522: the suffix) can be found.
1.1 dsieger 3523:
1.184 rillig 3524: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
3525: DISTFILES+= foo-file.tar.gz
3526: SITES.foo-file.tar.gz= \
3527: https://www.somewhere.com/somehow/ \
3528: https://www.somewhereelse.com/mirror/somehow/
1.1 dsieger 3529:
1.184 rillig 3530: When actually fetching the distfiles, each item from MASTER_SITES or SITES.*
3531: gets the name of each distfile appended to it, without an intermediate slash.
3532: Therefore, all site values have to end with a slash or other separator
3533: character. This allows for example to set MASTER_SITES to a URL of a CGI script
3534: that gets the name of the distfile as a parameter. In this case, the definition
3535: would look like:
1.1 dsieger 3536:
1.184 rillig 3537: MASTER_SITES= https://www.example.com/download.cgi?file=
1.1 dsieger 3538:
1.184 rillig 3539: The exception to this rule are URLs starting with a dash. In that case the URL
3540: is taken as is, fetched and the result stored under the name of the distfile.
3541: You can use this style for the case when the download URL style does not match
3542: the above common case. For example, if permanent download URL is a redirector
3543: to the real download URL, or the download file name is offered by an HTTP
3544: Content-Disposition header. In the following example, foo-1.0.0.tar.gz will be
3545: created instead of the default v1.0.0.tar.gz.
1.1 dsieger 3546:
1.184 rillig 3547: DISTNAME= foo-1.0.0
3548: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
1.29 wiz 3549:
1.184 rillig 3550: There are some predefined values for MASTER_SITES, which can be used in
3551: packages. The names of the variables should speak for themselves.
1.29 wiz 3552:
1.184 rillig 3553: MASTER_SITE_APACHE MASTER_SITE_BACKUP
3554: MASTER_SITE_CRATESIO MASTER_SITE_CYGWIN
3555: MASTER_SITE_DEBIAN MASTER_SITE_FREEBSD
3556: MASTER_SITE_FREEBSD_LOCAL MASTER_SITE_GENTOO
3557: MASTER_SITE_GITHUB MASTER_SITE_GNOME
3558: MASTER_SITE_GNU MASTER_SITE_GNUSTEP
3559: MASTER_SITE_HASKELL_HACKAGE MASTER_SITE_IFARCHIVE
3560: MASTER_SITE_KDE MASTER_SITE_MOZILLA
3561: MASTER_SITE_MOZILLA_ALL MASTER_SITE_MYSQL
3562: MASTER_SITE_NETLIB MASTER_SITE_OPENBSD
3563: MASTER_SITE_OPENOFFICE MASTER_SITE_OSDN
3564: MASTER_SITE_PERL_CPAN MASTER_SITE_PGSQL
3565: MASTER_SITE_PYPI MASTER_SITE_RUBYGEMS
3566: MASTER_SITE_R_CRAN MASTER_SITE_SOURCEFORGE
3567: MASTER_SITE_SUNSITE MASTER_SITE_SUSE
3568: MASTER_SITE_TEX_CTAN MASTER_SITE_XCONTRIB
3569: MASTER_SITE_XEMACS MASTER_SITE_XORG
1.1 dsieger 3570:
1.184 rillig 3571: Some explanations for the less self-explaining ones: MASTER_SITE_BACKUP
3572: contains backup sites for packages that are maintained in ftp://ftp.NetBSD.org/
3573: pub/pkgsrc/distfiles/${DIST_SUBDIR}. MASTER_SITE_LOCAL contains local package
3574: source distributions that are maintained in ftp://ftp.NetBSD.org/pub/pkgsrc/
3575: distfiles/LOCAL_PORTS/.
1.1 dsieger 3576:
1.184 rillig 3577: If you choose one of these predefined sites, you may want to specify a
3578: subdirectory of that site. Since these macros may expand to more than one
3579: actual site, you must use the following construct to specify a subdirectory:
1.1 dsieger 3580:
1.184 rillig 3581: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
3582: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 3583:
1.184 rillig 3584: Note the trailing slash after the subdirectory name.
1.1 dsieger 3585:
1.184 rillig 3586: 13.5.2. How are the files fetched?
1.1 dsieger 3587:
1.184 rillig 3588: The fetch phase makes sure that all the distfiles exist in a local directory
3589: (DISTDIR, which can be set by the pkgsrc user). If the files do not exist, they
3590: are fetched using commands of the form
1.1 dsieger 3591:
1.184 rillig 3592: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
1.1 dsieger 3593:
1.184 rillig 3594: where ${site} varies through several possibilities in turn: first,
3595: MASTER_SITE_OVERRIDE is tried, then the sites specified in either SITES.file if
3596: defined, else MASTER_SITES or PATCH_SITES, as applies, then finally the value
3597: of MASTER_SITE_BACKUP. The order of all except the first and the last can be
3598: optionally sorted by the user, via setting either MASTER_SORT_RANDOM, and
3599: MASTER_SORT_AWK or MASTER_SORT_REGEX.
1.1 dsieger 3600:
1.184 rillig 3601: The specific command and arguments used depend on the FETCH_USING parameter.
3602: The example above is for FETCH_USING=custom.
1.66 asau 3603:
1.184 rillig 3604: The distfiles mirror run by the NetBSD Foundation uses the mirror-distfiles
3605: target to mirror the distfiles, if they are freely distributable. Packages
3606: setting NO_SRC_ON_FTP (usually to "${RESTRICTED}") will not have their
3607: distfiles mirrored.
1.1 dsieger 3608:
1.184 rillig 3609: 13.6. The checksum phase
1.1 dsieger 3610:
1.184 rillig 3611: After the distfile(s) are fetched, their checksum is generated and compared
3612: with the checksums stored in the distinfo file. If the checksums don't match,
3613: the build is aborted. This is to ensure the same distfile is used for building,
3614: and that the distfile wasn't changed, e.g. by some malign force, deliberately
3615: changed distfiles on the master distribution site or network lossage.
1.1 dsieger 3616:
1.184 rillig 3617: 13.7. The extract phase
1.1 dsieger 3618:
1.184 rillig 3619: When the distfiles are present on the local system, they need to be extracted,
3620: as they usually come in the form of some compressed archive format.
1.1 dsieger 3621:
1.184 rillig 3622: By default, all DISTFILES are extracted. If you only need some of them, you can
3623: set the EXTRACT_ONLY variable to the list of those files.
1.1 dsieger 3624:
1.184 rillig 3625: Extracting the files is usually done by a little program, mk/extract/extract,
3626: which already knows how to extract various archive formats, so most likely you
3627: will not need to change anything here. But if you need, the following variables
3628: may help you:
1.1 dsieger 3629:
1.184 rillig 3630: EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}
1.1 dsieger 3631:
1.184 rillig 3632: Use these variables to override the default options for an extract command,
3633: which are defined in mk/extract/extract.
1.1 dsieger 3634:
1.184 rillig 3635: EXTRACT_USING
1.1 dsieger 3636:
1.184 rillig 3637: This variable can be set to bsdtar, gtar, nbtar (which is the default
3638: value), pax, or an absolute pathname pointing to the command with which tar
3639: archives should be extracted. It is preferred to choose bsdtar over gtar if
3640: NetBSD's pax-as-tar is not good enough.
1.1 dsieger 3641:
1.184 rillig 3642: If the extract program doesn't serve your needs, you can also override the
3643: EXTRACT_CMD variable, which holds the command used for extracting the files.
3644: This command is executed in the ${WRKSRC} directory. During execution of this
3645: command, the shell variable extract_file holds the absolute pathname of the
3646: file that is going to be extracted.
1.1 dsieger 3647:
1.184 rillig 3648: And if that still does not suffice, you can override the do-extract target in
3649: the package Makefile.
1.1 dsieger 3650:
1.184 rillig 3651: 13.8. The patch phase
1.1 dsieger 3652:
1.184 rillig 3653: After extraction, all the patches named by the PATCHFILES, those present in the
3654: patches subdirectory of the package as well as in $LOCALPATCHES/$PKGPATH (e.g.
3655: /usr/local/patches/graphics/png) are applied. Patchfiles ending in .Z or .gz
3656: are uncompressed before they are applied, files ending in .orig or .rej are
3657: ignored. Any special options to patch(1) can be handed in PATCH_DIST_ARGS. See
3658: Section 12.3, "patches/*" for more details.
1.1 dsieger 3659:
1.184 rillig 3660: By default patch(1) is given special arguments to make it fail if the expected
3661: text from the patch context is not found in the patched file. If that happens,
3662: fix the patch file by comparing it with the actual text in the file to be
3663: patched.
1.1 dsieger 3664:
1.184 rillig 3665: 13.9. The tools phase
1.1 dsieger 3666:
1.184 rillig 3667: This is covered in Chapter 17, Tools needed for building or running.
1.1 dsieger 3668:
1.184 rillig 3669: 13.10. The wrapper phase
1.1 dsieger 3670:
1.184 rillig 3671: This phase creates wrapper programs for the compilers and linkers. The
3672: following variables can be used to tweak the wrappers.
1.1 dsieger 3673:
1.184 rillig 3674: ECHO_WRAPPER_MSG
1.1 dsieger 3675:
1.184 rillig 3676: The command used to print progress messages. Does nothing by default. Set
3677: to ${ECHO} to see the progress messages.
1.1 dsieger 3678:
1.184 rillig 3679: WRAPPER_DEBUG
1.1 dsieger 3680:
1.184 rillig 3681: This variable can be set to yes (default) or no, depending on whether you
3682: want additional information in the wrapper log file.
1.1 dsieger 3683:
1.184 rillig 3684: WRAPPER_UPDATE_CACHE
1.1 dsieger 3685:
1.184 rillig 3686: This variable can be set to yes or no, depending on whether the wrapper
3687: should use its cache, which will improve the speed. The default value is
3688: yes, but is forced to no if the platform does not support it.
1.1 dsieger 3689:
1.184 rillig 3690: WRAPPER_REORDER_CMDS
1.1 dsieger 3691:
1.184 rillig 3692: A list of reordering commands. A reordering command has the form reorder:l:
3693: lib1:lib2. It ensures that that -llib1 occurs before -llib2.
1.1 dsieger 3694:
1.184 rillig 3695: 13.11. The configure phase
1.1 dsieger 3696:
1.184 rillig 3697: Most pieces of software need information on the header files, system calls, and
3698: library routines which are available on the platform they run on. The process
3699: of determining this information is known as configuration, and is usually
3700: automated. In most cases, a script is supplied with the distfiles, and its
3701: invocation results in generation of header files, Makefiles, etc.
1.1 dsieger 3702:
1.184 rillig 3703: If the package contains a configure script, this can be invoked by setting
3704: HAS_CONFIGURE to "yes". If the configure script is a GNU autoconf script, you
1.187 rillig 3705: should set GNU_CONFIGURE to "yes" instead.
1.1 dsieger 3706:
1.187 rillig 3707: In the do-configure stage, a rough equivalent of the following command is run.
3708: See mk/configure/configure.mk, target do-configure-script for the exact
3709: definition.
3710:
3711: .for dir in ${CONFIGURE_DIRS}
3712: cd ${WRKSRC} && cd ${dir} \
3713: && env ${CONFIGURE_ENV} \
3714: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 3715: .endfor
1.1 dsieger 3716:
1.184 rillig 3717: CONFIGURE_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In
3718: each of these directories, the configure script is run with the environment
3719: CONFIGURE_ENV and arguments CONFIGURE_ARGS. The variables CONFIGURE_ENV,
3720: CONFIGURE_SCRIPT (default: "./configure") and CONFIGURE_ARGS may all be changed
3721: by the package.
1.1 dsieger 3722:
1.184 rillig 3723: If the program uses the Perl way of configuration (mainly Perl modules, but not
3724: only), i.e. a file called Makefile.PL, it should include ../../lang/perl5/
3725: module.mk. To set any parameter for Makefile.PL use the MAKE_PARAMS variable
3726: (e.g., MAKE_PARAMS+=foo=bar
1.1 dsieger 3727:
1.184 rillig 3728: If the program uses an Imakefile for configuration, the appropriate steps can
3729: be invoked by setting USE_IMAKE to "yes". If you only need xmkmf, add it to
3730: USE_TOOLS. You can add variables to xmkmf's environment by adding them to the
3731: SCRIPTS_ENV variable.
1.1 dsieger 3732:
1.184 rillig 3733: If the program uses cmake for configuration, the appropriate steps can be
3734: invoked by setting USE_CMAKE to "yes". You can add variables to cmake's
3735: environment by adding them to the CONFIGURE_ENV variable and arguments to cmake
3736: by adding them to the CMAKE_ARGS variable. The top directory argument is given
3737: by the CMAKE_ARG_PATH variable, that defaults to "." (relative to
3738: CONFIGURE_DIRS)
1.1 dsieger 3739:
1.184 rillig 3740: If there is no configure step at all, set NO_CONFIGURE to "yes".
1.1 dsieger 3741:
1.184 rillig 3742: 13.12. The build phase
1.1 dsieger 3743:
1.187 rillig 3744: For building a package, a rough equivalent of the following code is executed;
3745: see mk/build/build.mk, target do-build for the exact definition.
1.154 rillig 3746:
1.187 rillig 3747: .for dir in ${BUILD_DIRS}
3748: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 3749: && env ${MAKE_ENV} \
1.187 rillig 3750: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 3751: -f ${MAKE_FILE} \
3752: ${BUILD_TARGET}
3753: .endfor
1.1 dsieger 3754:
1.184 rillig 3755: BUILD_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In each of
3756: these directories, MAKE_PROGRAM is run with the environment MAKE_ENV and
3757: arguments BUILD_MAKE_FLAGS. The variables MAKE_ENV, BUILD_MAKE_FLAGS, MAKE_FILE
3758: and BUILD_TARGET may all be changed by the package.
1.1 dsieger 3759:
1.184 rillig 3760: The default value of MAKE_PROGRAM is "gmake" if USE_TOOLS contains "gmake", "
3761: make" otherwise. The default value of MAKE_FILE is "Makefile", and BUILD_TARGET
3762: defaults to "all".
1.1 dsieger 3763:
1.184 rillig 3764: If there is no build step at all, set NO_BUILD to "yes".
1.1 dsieger 3765:
1.184 rillig 3766: 13.13. The test phase
1.1 dsieger 3767:
1.184 rillig 3768: [TODO]
1.1 dsieger 3769:
1.184 rillig 3770: 13.14. The install phase
1.1 dsieger 3771:
1.184 rillig 3772: Once the build stage has completed, the final step is to install the software
3773: in public directories, so users can access the programs and files.
1.1 dsieger 3774:
1.187 rillig 3775: In the install phase, a rough equivalent of the following code is executed; see
3776: mk/install/install.mk, target do-install for the exact definition.
3777: Additionally, before and after this code, several consistency checks are run
3778: against the files-to-be-installed, see mk/check/*.mk for details.
3779:
3780: .for dir in ${INSTALL_DIRS}
3781: cd ${WRKSRC} && cd ${dir} \
3782: && env ${INSTALL_ENV} ${MAKE_ENV} \
3783: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
3784: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 3785: .endfor
1.1 dsieger 3786:
1.184 rillig 3787: The variable's meanings are analogous to the ones in the build phase.
3788: INSTALL_DIRS defaults to BUILD_DIRS. INSTALL_TARGET is "install" by default,
3789: plus "install.man" if USE_IMAKE is defined and NO_INSTALL_MANPAGES is not
3790: defined.
1.1 dsieger 3791:
1.184 rillig 3792: In the install phase, the following variables are useful. They are all
3793: variations of the install(1) command that have the owner, group and permissions
3794: preset. INSTALL is the plain install command. The specialized variants,
3795: together with their intended use, are:
1.1 dsieger 3796:
1.184 rillig 3797: INSTALL_PROGRAM_DIR
1.1 dsieger 3798:
1.184 rillig 3799: directories that contain binaries
1.1 dsieger 3800:
1.184 rillig 3801: INSTALL_SCRIPT_DIR
1.1 dsieger 3802:
1.184 rillig 3803: directories that contain scripts
1.1 dsieger 3804:
1.184 rillig 3805: INSTALL_LIB_DIR
1.1 dsieger 3806:
1.184 rillig 3807: directories that contain shared and static libraries
1.1 dsieger 3808:
1.184 rillig 3809: INSTALL_DATA_DIR
1.108 rillig 3810:
1.184 rillig 3811: directories that contain data files
1.108 rillig 3812:
1.184 rillig 3813: INSTALL_MAN_DIR
1.108 rillig 3814:
1.184 rillig 3815: directories that contain man pages
1.108 rillig 3816:
1.184 rillig 3817: INSTALL_GAME_DIR
1.108 rillig 3818:
1.184 rillig 3819: directories that contain data files for games
1.108 rillig 3820:
1.184 rillig 3821: INSTALL_PROGRAM
1.108 rillig 3822:
1.184 rillig 3823: binaries that can be stripped from debugging symbols
1.108 rillig 3824:
1.184 rillig 3825: INSTALL_SCRIPT
1.108 rillig 3826:
1.184 rillig 3827: binaries that cannot be stripped
1.108 rillig 3828:
1.184 rillig 3829: INSTALL_GAME
1.108 rillig 3830:
1.184 rillig 3831: game binaries
1.108 rillig 3832:
1.184 rillig 3833: INSTALL_LIB
1.108 rillig 3834:
1.184 rillig 3835: shared and static libraries
1.108 rillig 3836:
1.184 rillig 3837: INSTALL_DATA
1.108 rillig 3838:
1.184 rillig 3839: data files
1.1 dsieger 3840:
1.184 rillig 3841: INSTALL_GAME_DATA
1.1 dsieger 3842:
1.184 rillig 3843: data files for games
1.108 rillig 3844:
1.184 rillig 3845: INSTALL_MAN
1.108 rillig 3846:
1.184 rillig 3847: man pages
1.1 dsieger 3848:
1.184 rillig 3849: Some other variables are:
1.1 dsieger 3850:
1.184 rillig 3851: INSTALL_UNSTRIPPED
1.1 dsieger 3852:
1.184 rillig 3853: If set to yes, do not run strip(1) when installing binaries. Any debugging
3854: sections and symbols present in binaries will be preserved.
1.1 dsieger 3855:
1.184 rillig 3856: INSTALLATION_DIRS
1.1 dsieger 3857:
1.184 rillig 3858: A list of directories relative to PREFIX that are created by pkgsrc at the
3859: beginning of the install phase. The package is supposed to create all
3860: needed directories itself before installing files to it and list all other
3861: directories here.
1.1 dsieger 3862:
1.184 rillig 3863: In the rare cases that a package shouldn't install anything, set NO_INSTALL to
3864: "yes". This is mostly relevant for packages in the regress category.
1.1 dsieger 3865:
1.184 rillig 3866: 13.15. The package phase
1.121 sevan 3867:
1.184 rillig 3868: Once the install stage has completed, a binary package of the installed files
3869: can be built. These binary packages can be used for quick installation without
3870: previous compilation, e.g. by the make bin-install or by using pkg_add.
1.1 dsieger 3871:
1.184 rillig 3872: By default, the binary packages are created in ${PACKAGES}/All and symlinks are
3873: created in ${PACKAGES}/category, one for each category in the CATEGORIES
3874: variable. PACKAGES defaults to pkgsrc/packages.
1.1 dsieger 3875:
1.184 rillig 3876: 13.16. Cleaning up
1.1 dsieger 3877:
1.184 rillig 3878: Once you're finished with a package, you can clean the work directory by
3879: running make clean. If you want to clean the work directories of all
3880: dependencies too, use make clean-depends.
1.1 dsieger 3881:
1.184 rillig 3882: 13.17. Other helpful targets
1.1 dsieger 3883:
1.184 rillig 3884: pre/post-*
1.1 dsieger 3885:
1.184 rillig 3886: For any of the main targets described in the previous section (configure,
3887: build, install, etc.), two auxiliary targets exist with "pre-" and "post-"
3888: used as a prefix for the main target's name. These targets are invoked
3889: before and after the main target is called, allowing extra configuration or
3890: installation steps be performed from a package's Makefile, for example,
3891: which a program's configure script or install target omitted.
3892:
3893: About 5% of the pkgsrc packages define their custom post-extract target,
3894: another 5% define pre-configure, and 10% define post-install. The other pre
3895: /post-* targets are defined even less often.
1.1 dsieger 3896:
1.184 rillig 3897: do-*
1.182 leot 3898:
1.184 rillig 3899: Should one of the main targets do the wrong thing, and should there be no
3900: variable to fix this, you can redefine it with the do-* target. (Note that
3901: redefining the target itself instead of the do-* target is a bad idea, as
3902: the pre-* and post-* targets won't be called anymore, etc.)
1.1 dsieger 3903:
1.184 rillig 3904: About 15% of the pkgsrc packages override the default do-install, the other
3905: do-* targets are overridden even less often.
1.1 dsieger 3906:
1.184 rillig 3907: reinstall
1.1 dsieger 3908:
1.184 rillig 3909: If you did a make install and you noticed some file was not installed
3910: properly, you can repeat the installation with this target, which will
3911: ignore the "already installed" flag.
1.1 dsieger 3912:
1.184 rillig 3913: This is the default value of DEPENDS_TARGET except in the case of make
3914: update and make package, where the defaults are "package" and "update",
3915: respectively.
1.1 dsieger 3916:
1.184 rillig 3917: deinstall
1.1 dsieger 3918:
1.184 rillig 3919: This target does a pkg_delete(1) in the current directory, effectively
3920: de-installing the package. The following variables can be used to tune the
3921: behaviour:
1.1 dsieger 3922:
1.184 rillig 3923: PKG_VERBOSE
1.1 dsieger 3924:
1.184 rillig 3925: Add a "-v" to the pkg_delete(1) command.
1.1 dsieger 3926:
1.184 rillig 3927: DEINSTALLDEPENDS
1.1 dsieger 3928:
1.184 rillig 3929: Remove all packages that require (depend on) the given package. This
3930: can be used to remove any packages that may have been pulled in by a
3931: given package, e.g. if make deinstall DEINSTALLDEPENDS=1 is done in
3932: pkgsrc/x11/kde, this is likely to remove whole KDE. Works by adding "-R
3933: " to the pkg_delete(1) command line.
1.1 dsieger 3934:
1.184 rillig 3935: bin-install
1.1 dsieger 3936:
1.184 rillig 3937: Install a binary package from local disk and via FTP from a list of sites
3938: (see the BINPKG_SITES variable), and do a make package if no binary package
3939: is available anywhere. The arguments given to pkg_add can be set via
3940: BIN_INSTALL_FLAGS e.g., to do verbose operation, etc.
1.1 dsieger 3941:
1.184 rillig 3942: install-clean
1.1 dsieger 3943:
1.184 rillig 3944: This target removes the state files for the "install" and later phases so
3945: that the "install" target may be re-invoked. This can be used after editing
3946: the PLIST to install the package without rebuilding it.
1.1 dsieger 3947:
1.184 rillig 3948: build-clean
1.18 mishka 3949:
1.184 rillig 3950: This target removes the state files for the "build" and later phases so
3951: that the "build" target may be re-invoked.
1.18 mishka 3952:
1.184 rillig 3953: update
1.18 mishka 3954:
1.184 rillig 3955: This target causes the current package to be updated to the latest version.
3956: The package and all depending packages first get de-installed, then current
3957: versions of the corresponding packages get compiled and installed. This is
3958: similar to manually noting which packages are currently installed, then
3959: performing a series of make deinstall and make install (or whatever
3960: UPDATE_TARGET is set to) for these packages.
1.18 mishka 3961:
1.184 rillig 3962: You can use the "update" target to resume package updating in case a
3963: previous make update was interrupted for some reason. However, in this
3964: case, make sure you don't call make clean or otherwise remove the list of
3965: dependent packages in WRKDIR. Otherwise, you lose the ability to
3966: automatically update the current package along with the dependent packages
3967: you have installed.
1.121 sevan 3968:
1.184 rillig 3969: Resuming an interrupted make update will only work as long as the package
3970: tree remains unchanged. If the source code for one of the packages to be
3971: updated has been changed, resuming make update will most certainly fail!
1.1 dsieger 3972:
1.184 rillig 3973: The following variables can be used either on the command line or in
3974: mk.conf to alter the behaviour of make update:
1.1 dsieger 3975:
1.184 rillig 3976: UPDATE_TARGET
1.1 dsieger 3977:
1.184 rillig 3978: Install target to recursively use for the updated package and the
3979: dependent packages. Defaults to DEPENDS_TARGET if set, "install"
3980: otherwise for make update. Other good targets are "package" or "
3981: bin-install". Do not set this to "update" or you will get stuck in an
3982: endless loop!
1.1 dsieger 3983:
1.184 rillig 3984: NOCLEAN
1.1 dsieger 3985:
1.184 rillig 3986: Don't clean up after updating. Useful if you want to leave the work
3987: sources of the updated packages around for inspection or other
3988: purposes. Be sure you eventually clean up the source tree (see the "
3989: clean-update" target below) or you may run into troubles with old
3990: source code still lying around on your next make or make update.
1.1 dsieger 3991:
1.184 rillig 3992: REINSTALL
1.1 dsieger 3993:
1.184 rillig 3994: Deinstall each package before installing (making DEPENDS_TARGET). This
3995: may be necessary if the "clean-update" target (see below) was called
3996: after interrupting a running make update.
1.1 dsieger 3997:
1.184 rillig 3998: DEPENDS_TARGET
1.1 dsieger 3999:
1.184 rillig 4000: Allows you to disable recursion and hardcode the target for packages.
4001: The default is "update" for the update target, facilitating a recursive
4002: update of prerequisite packages. Only set DEPENDS_TARGET if you want to
4003: disable recursive updates. Use UPDATE_TARGET instead to just set a
4004: specific target for each package to be installed during make update
4005: (see above).
1.1 dsieger 4006:
1.184 rillig 4007: clean-update
1.1 dsieger 4008:
1.184 rillig 4009: Clean the source tree for all packages that would get updated if make
4010: update was called from the current directory. This target should not be
4011: used if the current package (or any of its depending packages) have already
4012: been de-installed (e.g., after calling make update) or you may lose some
4013: packages you intended to update. As a rule of thumb: only use this target
4014: before the first time you run make update and only if you have a dirty
4015: package tree (e.g., if you used NOCLEAN).
1.86 wiz 4016:
1.184 rillig 4017: If you are unsure about whether your tree is clean, you can either perform
4018: a make clean at the top of the tree, or use the following sequence of
4019: commands from the directory of the package you want to update (before
4020: running make update for the first time, otherwise you lose all the packages
4021: you wanted to update!):
1.86 wiz 4022:
1.184 rillig 4023: # make clean-update
4024: # make clean CLEANDEPENDS=YES
4025: # make update
1.86 wiz 4026:
4027:
1.184 rillig 4028: The following variables can be used either on the command line or in
4029: mk.conf to alter the behaviour of make clean-update:
1.86 wiz 4030:
1.184 rillig 4031: CLEAR_DIRLIST
1.86 wiz 4032:
1.184 rillig 4033: After make clean, do not reconstruct the list of directories to update
4034: for this package. Only use this if make update successfully installed
4035: all packages you wanted to update. Normally, this is done automatically
4036: on make update, but may have been suppressed by the NOCLEAN variable
4037: (see above).
1.1 dsieger 4038:
1.184 rillig 4039: replace
1.1 dsieger 4040:
1.184 rillig 4041: Update the installation of the current package. This differs from update in
4042: that it does not replace dependent packages. You will need to install
4043: pkgtools/pkg_tarup for this target to work.
1.1 dsieger 4044:
1.184 rillig 4045: Be careful when using this target! There are no guarantees that dependent
4046: packages will still work, in particular they will most certainly break if
4047: you make replace a library package whose shared library major version
4048: changed between your installed version and the new one. For this reason,
4049: this target is not officially supported and only recommended for advanced
4050: users.
1.1 dsieger 4051:
1.184 rillig 4052: info
1.1 dsieger 4053:
1.184 rillig 4054: This target invokes pkg_info(1) for the current package. You can use this
4055: to check which version of a package is installed.
1.86 wiz 4056:
1.184 rillig 4057: index
1.1 dsieger 4058:
1.184 rillig 4059: This is a top-level command, i.e. it should be used in the pkgsrc
4060: directory. It creates a database of all packages in the local pkgsrc tree,
4061: including dependencies, comment, maintainer, and some other useful
4062: information. Individual entries are created by running make describe in the
4063: packages' directories. This index file is saved as pkgsrc/INDEX. It can be
4064: displayed in verbose format by running make print-index. You can search in
4065: it with make search key=something. You can extract a list of all packages
4066: that depend on a particular one by running make show-deps PKG=somepackage.
1.1 dsieger 4067:
1.184 rillig 4068: Running this command takes a very long time, some hours even on fast
4069: machines!
1.1 dsieger 4070:
1.184 rillig 4071: readme
1.1 dsieger 4072:
1.184 rillig 4073: This target generates a README.html file, which can be viewed using a
4074: browser such as www/firefox or www/links. The generated files contain
4075: references to any packages which are in the PACKAGES directory on the local
4076: host. The generated files can be made to refer to URLs based on
4077: FTP_PKG_URL_HOST and FTP_PKG_URL_DIR. For example, if I wanted to generate
4078: README.html files which pointed to binary packages on the local machine, in
4079: the directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
4080: FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
4081: subdirectories will be searched for all the binary packages.
1.1 dsieger 4082:
1.184 rillig 4083: The target can be run at the toplevel or in category directories, in which
4084: case it descends recursively.
1.1 dsieger 4085:
1.184 rillig 4086: readme-all
1.1 dsieger 4087:
1.184 rillig 4088: This is a top-level command, run it in pkgsrc. Use this target to create a
4089: file README-all.html which contains a list of all packages currently
4090: available in the NetBSD Packages Collection, together with the category
4091: they belong to and a short description. This file is compiled from the
4092: pkgsrc/*/README.html files, so be sure to run this after a make readme.
1.1 dsieger 4093:
1.184 rillig 4094: cdrom-readme
1.1 dsieger 4095:
1.184 rillig 4096: This is very much the same as the "readme" target (see above), but is to be
4097: used when generating a pkgsrc tree to be written to a CD-ROM. This target
4098: also produces README.html files, and can be made to refer to URLs based on
4099: CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
1.1 dsieger 4100:
1.184 rillig 4101: show-distfiles
1.1 dsieger 4102:
1.184 rillig 4103: This target shows which distfiles and patchfiles are needed to build the
4104: package (ALLFILES, which contains all DISTFILES and PATCHFILES, but not
4105: patches/*).
1.1 dsieger 4106:
1.184 rillig 4107: show-downlevel
1.1 dsieger 4108:
1.184 rillig 4109: This target shows nothing if the package is not installed. If a version of
4110: this package is installed, but is not the version provided in this version
4111: of pkgsrc, then a warning message is displayed. This target can be used to
4112: show which of your installed packages are downlevel, and so the old
4113: versions can be deleted, and the current ones added.
1.1 dsieger 4114:
1.184 rillig 4115: show-pkgsrc-dir
1.1 dsieger 4116:
1.184 rillig 4117: This target shows the directory in the pkgsrc hierarchy from which the
4118: package can be built and installed. This may not be the same directory as
4119: the one from which the package was installed. This target is intended to be
4120: used by people who may wish to upgrade many packages on a single host, and
4121: can be invoked from the top-level pkgsrc Makefile by using the "
4122: show-host-specific-pkgs" target.
1.1 dsieger 4123:
1.184 rillig 4124: show-installed-depends
1.1 dsieger 4125:
1.184 rillig 4126: This target shows which installed packages match the current package's
4127: DEPENDS. Useful if out of date dependencies are causing build problems.
1.1 dsieger 4128:
1.184 rillig 4129: print-build-depends-list
1.1 dsieger 4130:
1.184 rillig 4131: This target shows the list of packages that the current package depends on
4132: for building.
1.1 dsieger 4133:
1.184 rillig 4134: print-run-depends-list
1.1 dsieger 4135:
1.184 rillig 4136: This target shows the list of packages that the current package depends on
4137: for running.
1.1 dsieger 4138:
1.184 rillig 4139: check-shlibs
1.1 dsieger 4140:
1.184 rillig 4141: After a package is installed, check all its binaries and (on ELF platforms)
4142: shared libraries to see if they find the shared libs they need. Run by
4143: default if PKG_DEVELOPER is set in mk.conf.
1.1 dsieger 4144:
1.184 rillig 4145: print-PLIST
1.1 dsieger 4146:
1.184 rillig 4147: After a "make install" from a new or upgraded pkg, this prints out an
4148: attempt to generate a new PLIST from a find -newer work/.extract_done. An
4149: attempt is made to care for shared libs etc., but it is strongly
4150: recommended to review the result before putting it into PLIST. On upgrades,
4151: it's useful to diff the output of this command against an already existing
4152: PLIST file.
1.1 dsieger 4153:
1.184 rillig 4154: If the package installs files via tar(1) or other methods that don't update
4155: file access times, be sure to add these files manually to your PLIST, as
4156: the "find -newer" command used by this target won't catch them!
1.56 ryoon 4157:
1.184 rillig 4158: See Section 19.3, "Tweaking output of make print-PLIST" for more
4159: information on this target.
1.1 dsieger 4160:
1.184 rillig 4161: Chapter 14. Creating a new pkgsrc package from scratch
1.1 dsieger 4162:
1.184 rillig 4163: Table of Contents
1.1 dsieger 4164:
1.184 rillig 4165: 14.1. Common types of packages
1.1 dsieger 4166:
1.184 rillig 4167: 14.1.1. Perl modules
4168: 14.1.2. Python modules and programs
4169: 14.1.3. R packages
4170: 14.1.4. TeXlive packages
1.1 dsieger 4171:
1.184 rillig 4172: 14.2. Examples
1.1 dsieger 4173:
1.184 rillig 4174: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 4175:
1.184 rillig 4176: When you find a package that is not yet in pkgsrc, you most likely have a URL
4177: from where you can download the source code. Starting with this URL, creating a
4178: package involves only a few steps.
1.1 dsieger 4179:
1.184 rillig 4180: 1. In your mk.conf, set PKG_DEVELOPER=yes to enable the basic quality checks.
1.1 dsieger 4181:
1.184 rillig 4182: 2. Install the package meta-pkgs/pkg_developer, which among others will
4183: install the utilities url2pkg, pkglint, pkgvi and mkpatches:
1.1 dsieger 4184:
1.184 rillig 4185: $ cd /usr/pkgsrc
4186: $ (cd meta-pkgs/pkg_developer && bmake update)
1.1 dsieger 4187:
1.184 rillig 4188: 3. Choose one of the top-level directories as the category in which you want
4189: to place your package. You can also create a directory of your own (maybe
4190: called local). In that category directory, create another directory for
4191: your package and change into it:
1.1 dsieger 4192:
1.184 rillig 4193: $ mkdir category/package
4194: $ cd category/package
1.1 dsieger 4195:
1.184 rillig 4196: 4. Run the program url2pkg, which will ask you for a URL. Enter the URL of the
4197: distribution file (in most cases a .tar.gz file) and watch how the basic
4198: ingredients of your package are created automatically. The distribution
4199: file is extracted automatically to fill in some details in the Makefile
4200: that would otherwise have to be done manually:
1.1 dsieger 4201:
1.184 rillig 4202: $ url2pkg https://www.example.org/packages/package-1.0.tar.gz
1.1 dsieger 4203:
1.184 rillig 4204: 5. Examine the extracted files to determine the dependencies of your package.
4205: Ideally, this is mentioned in some README file, but things may differ. For
4206: each of these dependencies, look where it exists in pkgsrc, and if there is
4207: a file called buildlink3.mk in that directory, add a line to your package
4208: Makefile which includes that file just before the last line. If the
4209: buildlink3.mk file does not exist, it must be created first. The
4210: buildlink3.mk file makes sure that the package's include files and
4211: libraries are provided.
1.1 dsieger 4212:
1.184 rillig 4213: If you just need binaries from a package, add a DEPENDS line to the
4214: Makefile, which specifies the version of the dependency and where it can be
4215: found in pkgsrc. This line should be placed in the third paragraph. If the
4216: dependency is only needed for building the package, but not when using it,
4217: use TOOL_DEPENDS or BUILD_DEPENDS instead of DEPENDS. The difference
4218: between TOOL_DEPENDS and BUILD_DEPENDS occurs when cross-compiling:
4219: TOOL_DEPENDS are native packages, i.e. packages for the architecture where
4220: the package is built; BUILD_DEPENDS are target packages, i.e. packages for
4221: the architecture for which the package is built. There is also
4222: TEST_DEPENDS, which is used to specify a dependency used only for testing
4223: the resulting package built, using the upstream project's included test
4224: suite. Your package may then look like this:
1.1 dsieger 4225:
1.184 rillig 4226: [...]
1.1 dsieger 4227:
1.184 rillig 4228: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
4229: DEPENDS+= screen-[0-9]*:../../misc/screen
4230: DEPENDS+= screen>=4.0:../../misc/screen
1.1 dsieger 4231:
1.184 rillig 4232: [...]
1.1 dsieger 4233:
1.184 rillig 4234: .include "../../category/package/buildlink3.mk"
4235: .include "../../devel/glib2/buildlink3.mk"
4236: .include "../../mk/bsd.pkg.mk"
1.1 dsieger 4237:
1.184 rillig 4238: 6. Run pkglint to see what things still need to be done to make your package a
4239: "good" one. If you don't know what pkglint's warnings want to tell you, try
4240: pkglint --explain or pkglint -e, which outputs additional explanations.
1.1 dsieger 4241:
1.184 rillig 4242: 7. In many cases the package is not yet ready to build. You can find
4243: instructions for the most common cases in the next section, Section 14.1,
4244: "Common types of packages". After you have followed the instructions over
4245: there, you can hopefully continue here.
1.1 dsieger 4246:
1.184 rillig 4247: 8. Run bmake clean to clean the working directory from the extracted files.
4248: Besides these files, a lot of cache files and other system information has
4249: been saved in the working directory, which may become wrong after you
4250: edited the Makefile.
1.1 dsieger 4251:
1.184 rillig 4252: 9. Now, run bmake to build the package. For the various things that can go
4253: wrong in this phase, consult Chapter 21, Making your package work.
1.1 dsieger 4254:
1.184 rillig 4255: If the extracted files from the package need to be fixed, run multiple
4256: rounds of these commands:
1.1 dsieger 4257:
1.184 rillig 4258: $ make
4259: $ pkgvi ${WRKSRC}/some/file/that/does/not/compile
4260: $ mkpatches
4261: $ make mps
4262: $ make clean
1.1 dsieger 4263:
1.184 rillig 4264: 10. When the package builds fine, the next step is to install the package. Run
4265: bmake install and hope that everything works.
1.1 dsieger 4266:
1.184 rillig 4267: 11. Up to now, the file PLIST, which contains a list of the files that are
4268: installed by the package, is nearly empty. Run bmake print-PLIST >PLIST to
4269: generate a probably correct list. Check the file using your preferred text
4270: editor to see if the list of files looks plausible.
1.1 dsieger 4271:
1.184 rillig 4272: 12. Run pkglint again to see if the generated PLIST contains garbage or not.
1.1 dsieger 4273:
1.184 rillig 4274: 13. When you ran bmake install, the package had been registered in the database
4275: of installed files, but with an empty list of files. To fix this, run bmake
4276: deinstall and bmake install again. Now the package is registered with the
4277: list of files from PLIST.
1.48 wiz 4278:
1.184 rillig 4279: 14. Run bmake package to create a binary package from the set of installed
4280: files.
1.48 wiz 4281:
1.184 rillig 4282: 15. Run bmake clean update to run everything from above again in a single step,
4283: making sure that the PLIST is correct and the whole package is created as
4284: intended.
1.48 wiz 4285:
1.184 rillig 4286: 16. Run pkglint to see if there's anything left to do.
1.48 wiz 4287:
1.184 rillig 4288: 17. Commit the package to pkgsrc-wip or main pkgsrc; see Chapter 23, Submitting
4289: and Committing.
1.50 wiz 4290:
1.184 rillig 4291: 14.1. Common types of packages
1.1 dsieger 4292:
1.184 rillig 4293: 14.1.1. Perl modules
1.1 dsieger 4294:
1.184 rillig 4295: Simple Perl modules are handled automatically by url2pkg, including
4296: dependencies.
1.1 dsieger 4297:
1.184 rillig 4298: 14.1.2. Python modules and programs
1.1 dsieger 4299:
1.184 rillig 4300: Python modules and programs packages are easily created using a set of
4301: predefined variables.
1.1 dsieger 4302:
1.184 rillig 4303: If some Python versions are not supported by the software, set the
4304: PYTHON_VERSIONS_INCOMPATIBLE variable to the Python versions that are not
4305: supported, e.g.
1.1 dsieger 4306:
1.184 rillig 4307: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.1 dsieger 4308:
1.184 rillig 4309: If the packaged software is a Python module, include one of ../../lang/python/
4310: egg.mk, ../../lang/python/distutils.mk, or ../../lang/python/extension.mk.
1.1 dsieger 4311:
1.184 rillig 4312: Most Python packages use either "distutils" or easy-setup/setuptools ("eggs").
4313: If the packaged software is using setuptools, you only need to include "../../
4314: lang/python/egg.mk". Otherwise, if the software uses "distutils", include "..
4315: /../lang/python/distutils.mk", so pkgsrc will use this framework. "distutils"
4316: uses a script called setup.py; if the "distutils" driver is not called
4317: setup.py, set the PYSETUP variable to the name of the script.
1.1 dsieger 4318:
1.184 rillig 4319: Either way, the package directory should be called "py-software" and PKGNAME
4320: should be set to "${PYPKGPREFIX}-${DISTNAME}", e.g.
1.1 dsieger 4321:
1.184 rillig 4322: DISTNAME= foopymodule-1.2.10
4323: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
1.1 dsieger 4324:
1.184 rillig 4325: If it is an application, include "../../lang/python/application.mk". In order
4326: to correctly set the path to the Python interpreter, use the REPLACE_PYTHON
4327: variable and set it to the list of files (paths relative to WRKSRC) that must
4328: be corrected. For example:
1.1 dsieger 4329:
1.184 rillig 4330: REPLACE_PYTHON= *.py
1.1 dsieger 4331:
1.184 rillig 4332: Some Python modules have separate distributions for Python-2.x and Python-3.x
4333: support. In pkgsrc this is handled by the versioned_dependencies.mk file. Set
4334: PYTHON_VERSIONED_DEPENDENCIES to the list of packages that should be depended
4335: upon and include "../../lang/python/versioned_dependencies.mk", then the pkgsrc
4336: infrastructure will depend on the appropriate package version. For example:
1.1 dsieger 4337:
1.184 rillig 4338: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.1 dsieger 4339:
1.184 rillig 4340: Look inside versioned_dependencies.mk for a list of supported packages.
1.1 dsieger 4341:
1.184 rillig 4342: 14.1.3. R packages
1.1 dsieger 4343:
1.184 rillig 4344: Simple R packages from CRAN are handled automatically by R2pkg, which is
4345: available in pkgtools/R2pkg. Individual packages (and optionally their
4346: dependencies) may be created and updated. R packages generally follow the same
4347: form, and most of the relevant information needed is contained in a DESCRIPTION
4348: file as part of each R package on CRAN. Consequently, R2pkg downloads that
4349: information and creates or updates a package in the canonical form. The
4350: resulting package should be reviewed for correctness.
1.1 dsieger 4351:
1.184 rillig 4352: 14.1.4. TeXlive packages
1.1 dsieger 4353:
1.184 rillig 4354: TeXlive packages from CTAN are handled automatically by texlive2pkg, which is
4355: available in pkgtools/texlive2pkg.
1.1 dsieger 4356:
1.184 rillig 4357: If the TeXlive package name is not known, it may be useful to search CTAN. A "
4358: Contained in" field on the package page typically identifies the basename of
4359: the package file in the TeXlive archive.
1.1 dsieger 4360:
1.184 rillig 4361: If the TeXlive package name is known, download the files from the TeXlive
4362: archive. For package foo, you will need to download foo.tar.xz. Most TeXlive
4363: packages also have associated documentation packages, so download
4364: foo.doc.tar.xz at the same time. These files should be placed in the
4365: appropriate category directory, which is often but not always print. Then run
4366: the following command in the category directory.
1.1 dsieger 4367:
1.184 rillig 4368: texlive2pkg foo.tar.xz foo.doc.tar.xz
1.1 dsieger 4369:
1.184 rillig 4370: This will create two packages, tex-foo and tex-foo-doc. Be sure to check that
4371: both packages are correct.
1.1 dsieger 4372:
1.184 rillig 4373: Finally, CTAN currently does not include version information in package
4374: filenames and changes their contents periodically when updates occur.
4375: Consequently, pkgsrc avoids downloading distfiles directly from CTAN and
4376: instead relies on the pkgsrc archives. For each new or updated TeXlive package,
4377: e.g., the main one and the corresponding documentation, upload the distfiles
4378: with the following command in each package directory.
1.1 dsieger 4379:
1.184 rillig 4380: make upload-distfiles
1.117 sevan 4381:
1.184 rillig 4382: 14.2. Examples
1.117 sevan 4383:
1.184 rillig 4384: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 4385:
1.184 rillig 4386: 14.2.1.1. The initial package
1.1 dsieger 4387:
1.184 rillig 4388: Looking at the file pkgsrc/doc/TODO, I saw that the "nvu" package has not yet
4389: been imported into pkgsrc. As the description says it has to do with the web,
4390: the obvious choice for the category is "www".
1.1 dsieger 4391:
1.184 rillig 4392: $ mkdir www/nvu
4393: $ cd www/nvu
1.1 dsieger 4394:
1.184 rillig 4395: The web site says that the sources are available as a tar file, so I fed that
4396: URL to the url2pkg program:
1.1 dsieger 4397:
1.184 rillig 4398: $ url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.1 dsieger 4399:
1.184 rillig 4400: My editor popped up, and I added a PKGNAME line below the DISTNAME line, as the
4401: package name should not have the word "sources" in it. I also filled in the
4402: MAINTAINER, HOMEPAGE and COMMENT fields. Then the package Makefile looked like
4403: that:
1.1 dsieger 4404:
1.184 rillig 4405: # $NetBSD $
4406: #
1.1 dsieger 4407:
1.184 rillig 4408: DISTNAME= nvu-1.0-sources
4409: PKGNAME= nvu-1.0
4410: CATEGORIES= www
4411: MASTER_SITES= http://cvs.nvu.com/download/
4412: EXTRACT_SUFX= .tar.bz2
1.1 dsieger 4413:
1.184 rillig 4414: MAINTAINER= rillig@NetBSD.org
4415: HOMEPAGE= http://cvs.nvu.com/
4416: COMMENT= Web Authoring System
1.1 dsieger 4417:
1.184 rillig 4418: # url2pkg-marker (please do not remove this line.)
4419: .include "../../mk/bsd.pkg.mk"
1.1 dsieger 4420:
1.184 rillig 4421: On the first line of output above, an artificial space has been added between
4422: NetBSD and $, this is a workaround to prevent CVS expanding to the filename of
4423: the guide.
1.1 dsieger 4424:
1.184 rillig 4425: Then, I quit the editor and watched pkgsrc downloading a large source archive:
1.1 dsieger 4426:
1.184 rillig 4427: url2pkg> Running "make makesum" ...
4428: => Required installed package digest>=20010302: digest-20060826 found
4429: => Fetching nvu-1.0-sources.tar.bz2
4430: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4431: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4432: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4433: url2pkg> Running "make extract" ...
4434: => Required installed package digest>=20010302: digest-20060826 found
4435: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4436: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4437: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4438: ===> Installing dependencies for nvu-1.0
4439: ===> Overriding tools for nvu-1.0
4440: ===> Extracting for nvu-1.0
4441: url2pkg> Adjusting the Makefile.
1.1 dsieger 4442:
1.184 rillig 4443: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.1 dsieger 4444:
1.184 rillig 4445: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.1 dsieger 4446:
1.184 rillig 4447: 14.2.1.2. Fixing all kinds of problems to make the package work
1.1 dsieger 4448:
1.184 rillig 4449: Now that the package has been extracted, let's see what's inside it. The
4450: package has a README.txt, but that only says something about mozilla, so it's
4451: probably useless for seeing what dependencies this package has. But since there
4452: is a GNU configure script in the package, let's hope that it will complain
4453: about everything it needs.
1.1 dsieger 4454:
1.184 rillig 4455: $ bmake
4456: => Required installed package digest>=20010302: digest-20060826 found
4457: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4458: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4459: ===> Patching for nvu-1.0
4460: ===> Creating toolchain wrappers for nvu-1.0
4461: ===> Configuring for nvu-1.0
4462: [...]
4463: configure: error: Perl 5.004 or higher is required.
4464: [...]
4465: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4466: [...]
1.1 dsieger 4467:
1.184 rillig 4468: That worked quite well. So I opened the package Makefile in my editor, and
4469: since it already has a USE_TOOLS line, I just appended "perl" to it. Since the
4470: dependencies of the package have changed now, and since a perl wrapper is
4471: automatically installed in the "tools" phase, I need to build the package from
4472: scratch.
1.1 dsieger 4473:
1.184 rillig 4474: $ bmake clean
4475: ===> Cleaning for nvu-1.0
4476: $ bmake
4477: [...]
4478: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4479: GNU Make. You will not be able to build Mozilla without GNU Make.
4480: [...]
1.1 dsieger 4481:
1.184 rillig 4482: So I added "gmake" to the USE_TOOLS line and tried again (from scratch).
1.1 dsieger 4483:
1.184 rillig 4484: [...]
4485: checking for GTK - version >= 1.2.0... no
4486: *** Could not run GTK test program, checking why...
4487: [...]
1.1 dsieger 4488:
1.184 rillig 4489: Now to the other dependencies. The first question is: Where is the GTK package
4490: hidden in pkgsrc?
1.1 dsieger 4491:
1.184 rillig 4492: $ echo ../../*/gtk*
4493: [many packages ...]
4494: $ echo ../../*/gtk
4495: ../../x11/gtk
4496: $ echo ../../*/gtk2
4497: ../../x11/gtk2
4498: $ echo ../../*/gtk2/bui*
4499: ../../x11/gtk2/buildlink3.mk
1.1 dsieger 4500:
1.184 rillig 4501: The first try was definitely too broad. The second one had exactly one result,
4502: which is very good. But there is one pitfall with GNOME packages. Before GNOME
4503: 2 had been released, there were already many GNOME 1 packages in pkgsrc. To be
4504: able to continue to use these packages, the GNOME 2 packages were imported as
4505: separate packages, and their names usually have a "2" appended. So I checked
4506: whether this was the case here, and indeed it was.
1.1 dsieger 4507:
1.184 rillig 4508: Since the GTK2 package has a buildlink3.mk file, adding the dependency is very
4509: easy. I just inserted an .include line before the last line of the package
4510: Makefile, so that it now looks like this:
1.1 dsieger 4511:
1.184 rillig 4512: [...]
4513: .include "../../x11/gtk2/buildlink3.mk"
4514: .include "../../mk/bsd.pkg.mk
1.1 dsieger 4515:
1.184 rillig 4516: After another bmake clean && bmake, the answer was:
1.108 rillig 4517:
1.184 rillig 4518: [...]
4519: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4520: checking for GTK - version >= 1.2.0... no
4521: *** Could not run GTK test program, checking why...
4522: *** The test program failed to compile or link. See the file config.log for the
4523: *** exact error that occured. This usually means GTK was incorrectly installed
4524: *** or that you have moved GTK since it was installed. In the latter case, you
4525: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4526: configure: error: Test for GTK failed.
4527: [...]
1.1 dsieger 4528:
1.184 rillig 4529: In this particular case, the assumption that "every package prefers GNOME 2"
4530: had been wrong. The first of the lines above told me that this package really
4531: wanted to have the GNOME 1 version of GTK. If the package had looked for GTK2,
4532: it would have looked for pkg-config instead of gtk-config. So I changed the x11
4533: /gtk2 to x11/gtk in the package Makefile, and tried again.
1.1 dsieger 4534:
1.184 rillig 4535: [...]
4536: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
4537: In file included from xpidl.c:42:
4538: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4539: In file included from xpidl.c:42:
4540: xpidl.h:132: error: parse error before "IDL_ns"
4541: [...]
1.1 dsieger 4542:
1.184 rillig 4543: The package still does not find all of its dependencies. Now the question is:
4544: Which package provides the libIDL/IDL.h header file?
1.1 dsieger 4545:
1.184 rillig 4546: $ echo ../../*/*idl*
4547: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4548: $ echo ../../*/*IDL*
4549: ../../net/libIDL
1.1 dsieger 4550:
1.184 rillig 4551: Let's take the one from the second try. So I included the ../../net/libIDL/
4552: buildlink3.mk file and tried again. But the error didn't change. After digging
4553: through some of the code, I concluded that the build process of the package was
4554: broken and couldn't have ever worked, but since the Mozilla source tree is
4555: quite large, I didn't want to fix it. So I added the following to the package
4556: Makefile and tried again:
1.1 dsieger 4557:
1.184 rillig 4558: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4559: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.1 dsieger 4560:
1.184 rillig 4561: The latter line is needed because the package expects the library libIDL.so,
4562: but only libIDL-2.so is available. So I told the compiler wrapper to rewrite
4563: that on the fly.
1.1 dsieger 4564:
1.184 rillig 4565: The next problem was related to a recent change of the FreeType interface. I
4566: looked up in www/seamonkey which patch files were relevant for this issue and
4567: copied them to the patches directory. Then I retried, fixed the patches so that
4568: they applied cleanly and retried again. This time, everything worked.
1.1 dsieger 4569:
1.184 rillig 4570: 14.2.1.3. Installing the package
1.1 dsieger 4571:
1.184 rillig 4572: $ bmake CHECK_FILES=no install
4573: [...]
4574: $ bmake print-PLIST >PLIST
4575: $ bmake deinstall
4576: $ bmake install
1.1 dsieger 4577:
1.184 rillig 4578: Chapter 15. Programming in Makefiles
1.1 dsieger 4579:
1.184 rillig 4580: Table of Contents
1.1 dsieger 4581:
1.184 rillig 4582: 15.1. Caveats
4583: 15.2. Makefile variables
1.1 dsieger 4584:
1.184 rillig 4585: 15.2.1. Naming conventions
1.1 dsieger 4586:
1.184 rillig 4587: 15.3. Code snippets
1.1 dsieger 4588:
1.184 rillig 4589: 15.3.1. Adding things to a list
4590: 15.3.2. Echoing a string exactly as-is
4591: 15.3.3. Passing CFLAGS to GNU configure scripts
4592: 15.3.4. Handling possibly empty variables
1.1 dsieger 4593:
1.184 rillig 4594: Pkgsrc consists of many Makefile fragments, each of which forms a well-defined
4595: part of the pkgsrc system. Using the make(1) system as a programming language
4596: for a big system like pkgsrc requires some discipline to keep the code correct
4597: and understandable.
1.1 dsieger 4598:
1.184 rillig 4599: The basic ingredients for Makefile programming are variables and shell
4600: commands. Among these shell commands may even be more complex ones like awk(1)
4601: programs. To make sure that every shell command runs as intended it is
4602: necessary to quote all variables correctly when they are used.
1.1 dsieger 4603:
1.184 rillig 4604: This chapter describes some patterns that appear quite often in Makefiles,
4605: including the pitfalls that come along with them.
1.1 dsieger 4606:
1.184 rillig 4607: 15.1. Caveats
1.1 dsieger 4608:
1.184 rillig 4609: * When you are creating a file as a target of a rule, always write the data
4610: to a temporary file first and finally rename that file. Otherwise there
4611: might occur an error in the middle of generating the file, and when the
4612: user runs make(1) for the second time, the file exists and will not be
4613: regenerated properly. Example:
1.1 dsieger 4614:
1.184 rillig 4615: wrong:
4616: @echo "line 1" > ${.TARGET}
4617: @echo "line 2" >> ${.TARGET}
4618: @false
1.1 dsieger 4619:
1.184 rillig 4620: correct:
4621: @echo "line 1" > ${.TARGET}.tmp
4622: @echo "line 2" >> ${.TARGET}.tmp
4623: @false
4624: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 4625:
1.184 rillig 4626: When you run make wrong twice, the file wrong will exist, although there
4627: was an error message in the first run. On the other hand, running make
4628: correct gives an error message twice, as expected.
1.1 dsieger 4629:
1.184 rillig 4630: You might remember that make(1) sometimes removes ${.TARGET} in case of
4631: error, but this only happens when it is interrupted, for example by
4632: pressing Ctrl+C. This does not happen when one of the commands fails (like
4633: false(1) above).
1.1 dsieger 4634:
1.184 rillig 4635: 15.2. Makefile variables
1.1 dsieger 4636:
1.184 rillig 4637: Makefile variables contain strings that can be processed using the five
4638: operators =, +=, ?=, := and !=, which are described in the make(1) man page.
1.1 dsieger 4639:
1.184 rillig 4640: When a variable's value is parsed from a Makefile, the hash character # and the
4641: backslash character \ are handled specially. If a backslash is the last
4642: character in a line, that backslash is removed from the line and the line
4643: continues with the next line of the file.
1.1 dsieger 4644:
1.184 rillig 4645: The # character starts a comment that reaches until the end of the line. To get
4646: an actual # character, such as in a URL, write \# instead.
1.1 dsieger 4647:
1.184 rillig 4648: The evaluation of variables either happens immediately or lazy. It happens
4649: immediately when the variable occurs on the right-hand side of the := or the !=
4650: operator, in a .if condition or a .for loop. In the other cases, it is
4651: evaluated lazily.
1.1 dsieger 4652:
1.184 rillig 4653: Some of the modifiers split the string into words and then operate on the
4654: words, others operate on the string as a whole. When a string is split into
4655: words, double quotes and single quotes are interpreted as delimiters, just like
4656: in sh(1).
1.1 dsieger 4657:
1.184 rillig 4658: 15.2.1. Naming conventions
1.1 dsieger 4659:
1.184 rillig 4660: * All variable names starting with an underscore are reserved for use by the
4661: pkgsrc infrastructure. They shall not be used by packages.
1.1 dsieger 4662:
1.184 rillig 4663: * In .for loops you should use lowercase variable names for the iteration
4664: variables.
1.1 dsieger 4665:
1.184 rillig 4666: * All list variables should have a plural name, such as PKG_OPTIONS or
4667: DISTFILES.
1.1 dsieger 4668:
1.184 rillig 4669: 15.3. Code snippets
1.1 dsieger 4670:
1.184 rillig 4671: 15.3.1. Adding things to a list
1.1 dsieger 4672:
1.184 rillig 4673: When adding a string that possibly contains whitespace or quotes to a list
4674: (example 1), it must be quoted using the :Q modifier.
1.1 dsieger 4675:
1.184 rillig 4676: When adding another list to a list (example 2), it must not be quoted, since
4677: its elements are already quoted.
1.1 dsieger 4678:
1.184 rillig 4679: STRING= foo * bar `date`
4680: LIST= # empty
4681: ANOTHER_LIST= a=b c=d
1.1 dsieger 4682:
1.184 rillig 4683: LIST+= ${STRING:Q} # 1
4684: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4685:
1.184 rillig 4686: 15.3.2. Echoing a string exactly as-is
1.1 dsieger 4687:
1.184 rillig 4688: Echoing a string containing special characters needs special work.
1.1 dsieger 4689:
1.184 rillig 4690: STRING= foo bar < > * `date` $$HOME ' "
4691: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4692:
1.184 rillig 4693: all:
4694: echo ${STRING} # 1
4695: echo ${STRING:Q} # 2
4696: printf '%s\n' ${STRING:Q}'' # 3
4697: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 4698:
1.184 rillig 4699: Example 1 leads to a syntax error in the shell, as the characters are just
4700: copied.
1.1 dsieger 4701:
1.184 rillig 4702: Example 2 quotes the string so that the shell interprets it correctly. But the
4703: echo command may additionally interpret strings with a leading dash or those
4704: containing backslashes.
1.1 dsieger 4705:
1.184 rillig 4706: Example 3 can handle arbitrary strings, since printf(1) only interprets the
4707: format string, but not the next argument. The trailing single quotes handle the
4708: case when the string is empty. In that case, the :Q modifier would result in an
4709: empty string too, which would then be skipped by the shell. For printf(1) this
4710: doesn't make a difference, but other programs may care.
1.1 dsieger 4711:
1.184 rillig 4712: In example 4, the EXAMPLE_ENV does not need to be quoted because the quoting
4713: has already been done when adding elements to the list.
1.1 dsieger 4714:
1.184 rillig 4715: 15.3.3. Passing CFLAGS to GNU configure scripts
1.1 dsieger 4716:
1.184 rillig 4717: When passing CFLAGS or similar variables to a GNU-style configure script
4718: (especially those that call other configure scripts), it must not have leading
4719: or trailing whitespace, since otherwise the configure script gets confused. To
4720: trim leading and trailing whitespace, use the :M modifier, as in the following
4721: example:
1.1 dsieger 4722:
1.184 rillig 4723: CPPFLAGS= # empty
4724: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
4725: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 4726:
1.184 rillig 4727: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 4728:
1.184 rillig 4729: all:
4730: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4731: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4732:
1.184 rillig 4733: In this example, CPPFLAGS has both leading and trailing whitespace because the
4734: += operator always adds a space.
1.1 dsieger 4735:
1.184 rillig 4736: 15.3.4. Handling possibly empty variables
1.1 dsieger 4737:
1.184 rillig 4738: When a possibly empty variable is used in a shell program, it may lead to a
4739: syntax error.
1.1 dsieger 4740:
1.184 rillig 4741: EGFILES= # empty
1.1 dsieger 4742:
1.184 rillig 4743: install-examples: # produces a syntax error in the shell
4744: for egfile in ${EGFILES}; do \
4745: echo "Installing $$egfile"; \
4746: done
1.1 dsieger 4747:
1.184 rillig 4748: The shell only sees the text for egfile in ; do, since ${EGFILES} is replaced
4749: with an empty string by make(1). To fix this syntax error, use one of the
4750: snippets below.
1.1 dsieger 4751:
1.184 rillig 4752: EMPTY= # empty
1.1 dsieger 4753:
1.184 rillig 4754: install-examples:
4755: for egfile in ${EGFILES} ""; do \
4756: [ -n "$$egfile" ] || continue; \
4757: echo "Installing $$egfile"; \
4758: done
1.1 dsieger 4759:
1.184 rillig 4760: In this case, an empty string is appended to the iteration list (to prevent the
4761: syntax error) and filtered out later.
1.1 dsieger 4762:
1.184 rillig 4763: EGFILES= # empty
1.1 dsieger 4764:
1.184 rillig 4765: install-examples:
4766: .for egfile in ${EGFILES}
4767: echo "Installing ${egfile}"
4768: .endfor
1.1 dsieger 4769:
1.184 rillig 4770: If one of the filenames contains special characters, it should be enclosed in
4771: single or double quotes.
1.1 dsieger 4772:
1.184 rillig 4773: To have a shell command test whether a make variable is empty, use the
4774: following code: ${TEST} -z ${POSSIBLY_EMPTY:Q}"".
1.1 dsieger 4775:
1.184 rillig 4776: Chapter 16. Options handling
1.1 dsieger 4777:
4778: Table of Contents
4779:
1.184 rillig 4780: 16.1. Global default options
4781: 16.2. Converting packages to use bsd.options.mk
4782: 16.3. Option Names
4783: 16.4. Determining the options of dependencies
1.1 dsieger 4784:
4785: Many packages have the ability to be built to support different sets of
4786: features. bsd.options.mk is a framework in pkgsrc that provides generic
4787: handling of those options that determine different ways in which the packages
4788: can be built. It's possible for the user to specify exactly which sets of
4789: options will be built into a package or to allow a set of global default
4790: options apply.
4791:
1.7 rillig 4792: There are two broad classes of behaviors that one might want to control via
4793: options. One is whether some particular feature is enabled in a program that
4794: will be built anyway, often by including or not including a dependency on some
4795: other package. The other is whether or not an additional program will be built
4796: as part of the package. Generally, it is better to make a split package for
4797: such additional programs instead of using options, because it enables binary
4798: packages to be built which can then be added separately. For example, the foo
4799: package might have minimal dependencies (those packages without which foo
4800: doesn't make sense), and then the foo-gfoo package might include the GTK
4801: frontend program gfoo. This is better than including a gtk option to foo that
4802: adds gfoo, because either that option is default, in which case binary users
4803: can't get foo without gfoo, or not default, in which case they can't get gfoo.
4804: With split packages, they can install foo without having GTK, and later decide
4805: to install gfoo (pulling in GTK at that time). This is an advantage to source
4806: users too, avoiding the need for rebuilds.
4807:
4808: Plugins with widely varying dependencies should usually be split instead of
4809: options.
4810:
4811: It is often more work to maintain split packages, especially if the upstream
4812: package does not support this. The decision of split vs. option should be made
4813: based on the likelihood that users will want or object to the various pieces,
4814: the size of the dependencies that are included, and the amount of work.
4815:
4816: A further consideration is licensing. Non-free parts, or parts that depend on
4817: non-free dependencies (especially plugins) should almost always be split if
4818: feasible.
4819:
1.184 rillig 4820: 16.1. Global default options
1.1 dsieger 4821:
4822: Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of
4823: the options that should be built into every package if that option is
1.4 rillig 4824: supported. This variable should be set in mk.conf.
1.1 dsieger 4825:
1.184 rillig 4826: 16.2. Converting packages to use bsd.options.mk
1.1 dsieger 4827:
4828: The following example shows how bsd.options.mk should be used by the
4829: hypothetical ``wibble'' package, either in the package Makefile, or in a file,
4830: e.g. options.mk, that is included by the main package Makefile.
4831:
4832: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
4833: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
4834: PKG_OPTIONS_OPTIONAL_GROUPS= database
4835: PKG_OPTIONS_GROUP.database= mysql pgsql
4836: PKG_SUGGESTED_OPTIONS= wibble-foo
4837: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
4838: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
4839:
4840: .include "../../mk/bsd.prefs.mk"
4841:
4842: # this package was previously named wibble2
4843: .if defined(PKG_OPTIONS.wibble2)
4844: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
4845: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
4846: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
4847: .endif
4848:
4849: .include "../../mk/bsd.options.mk"
4850:
4851: # Package-specific option-handling
4852:
4853: ###
4854: ### FOO support
4855: ###
4856: .if !empty(PKG_OPTIONS:Mwibble-foo)
4857: CONFIGURE_ARGS+= --enable-foo
4858: .endif
4859:
4860: ###
4861: ### LDAP support
4862: ###
4863: .if !empty(PKG_OPTIONS:Mldap)
4864: . include "../../databases/openldap-client/buildlink3.mk"
4865: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
4866: .endif
4867:
4868: ###
4869: ### database support
4870: ###
4871: .if !empty(PKG_OPTIONS:Mmysql)
4872: . include "../../mk/mysql.buildlink3.mk"
4873: .endif
4874: .if !empty(PKG_OPTIONS:Mpgsql)
4875: . include "../../mk/pgsql.buildlink3.mk"
4876: .endif
4877:
4878: The first section contains the information about which build options are
4879: supported by the package, and any default options settings if needed.
4880:
4881: 1. PKG_OPTIONS_VAR is the name of the make(1) variable that the user can set
4882: to override the default options. It should be set to PKG_OPTIONS.pkgbase.
4883: Do not set it to PKG_OPTIONS.${PKGBASE}, since PKGBASE is not defined at
4884: the point where the options are processed.
4885:
4886: 2. PKG_SUPPORTED_OPTIONS is a list of build options supported by the package.
4887:
4888: 3. PKG_OPTIONS_OPTIONAL_GROUPS is a list of names of groups of mutually
4889: exclusive options. The options in each group are listed in
4890: PKG_OPTIONS_GROUP.groupname. The most specific setting of any option from
4891: the group takes precedence over all other options in the group. Options
4892: from the groups will be automatically added to PKG_SUPPORTED_OPTIONS.
4893:
4894: 4. PKG_OPTIONS_REQUIRED_GROUPS is like PKG_OPTIONS_OPTIONAL_GROUPS, but
4895: building the packages will fail if no option from the group is selected.
4896:
4897: 5. PKG_OPTIONS_NONEMPTY_SETS is a list of names of sets of options. At least
4898: one option from each set must be selected. The options in each set are
4899: listed in PKG_OPTIONS_SET.setname. Options from the sets will be
4900: automatically added to PKG_SUPPORTED_OPTIONS. Building the package will
4901: fail if no option from the set is selected.
4902:
4903: 6. PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
4904: default.
4905:
4906: 7. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE:option" pairs that map
1.4 rillig 4907: legacy mk.conf variables to their option counterparts. Pairs should be
1.1 dsieger 4908: added with "+=" to keep the listing of global legacy variables. A warning
4909: will be issued if the user uses a legacy variable.
4910:
4911: 8. PKG_OPTIONS_LEGACY_OPTS is a list of "old-option:new-option" pairs that map
4912: options that have been renamed to their new counterparts. Pairs should be
4913: added with "+=" to keep the listing of global legacy options. A warning
4914: will be issued if the user uses a legacy option.
4915:
4916: 9. PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
4917: used. This can be used for cases that neither PKG_OPTIONS_LEGACY_VARS nor
4918: PKG_OPTIONS_LEGACY_OPTS can handle, e. g. when PKG_OPTIONS_VAR is renamed.
4919:
4920: 10. PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
4921: variables or options used, and what to use instead.
4922:
4923: A package should never modify PKG_DEFAULT_OPTIONS or the variable named in
4924: PKG_OPTIONS_VAR. These are strictly user-settable. To suggest a default set of
4925: options, use PKG_SUGGESTED_OPTIONS.
4926:
4927: PKG_OPTIONS_VAR must be defined before including bsd.options.mk. If none of
4928: PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and
4929: PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform-specific
4930: options if none of them is supported on the current platform), PKG_OPTIONS is
4931: set to the empty list and the package is otherwise treated as not using the
4932: options framework.
4933:
4934: After the inclusion of bsd.options.mk, the variable PKG_OPTIONS contains the
4935: list of selected build options, properly filtered to remove unsupported and
4936: duplicate options.
4937:
4938: The remaining sections contain the logic that is specific to each option. The
4939: correct way to check for an option is to check whether it is listed in
4940: PKG_OPTIONS:
4941:
4942: .if !empty(PKG_OPTIONS:Moption)
4943:
1.184 rillig 4944: 16.3. Option Names
1.1 dsieger 4945:
4946: Options that enable similar features in different packages (like optional
4947: support for a library) should use a common name in all packages that support it
4948: (like the name of the library). If another package already has an option with
4949: the same meaning, use the same name.
4950:
4951: Options that enable features specific to one package, where it's unlikely that
4952: another (unrelated) package has the same (or a similar) optional feature,
4953: should use a name prefixed with pkgname-.
4954:
4955: If a group of related packages share an optional feature specific to that
4956: group, prefix it with the name of the "main" package (e. g.
4957: djbware-errno-hack).
4958:
4959: For new options, add a line to mk/defaults/options.description. Lines have two
4960: fields, separated by tab. The first field is the option name, the second its
4961: description. The description should be a whole sentence (starting with an
4962: uppercase letter and ending with a period) that describes what enabling the
4963: option does. E. g. "Enable ispell support." The file is sorted by option names.
4964:
1.184 rillig 4965: 16.4. Determining the options of dependencies
1.7 rillig 4966:
4967: When writing buildlink3.mk files, it is often necessary to list different
4968: dependencies based on the options with which the package was built. For
4969: querying these options, the file pkgsrc/mk/pkg-build-options.mk should be used.
4970: A typical example looks like this:
4971:
4972: pkgbase := libpurple
4973: .include "../../mk/pkg-build-options.mk"
4974:
4975: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
4976: ...
4977: .endif
4978:
4979: Including pkg-build-options.mk here will set the variable
4980: PKG_BUILD_OPTIONS.libpurple to the build options of the libpurple package,
4981: which can then be queried like PKG_OPTIONS in the options.mk file. See the file
4982: pkg-build-options.mk for more details.
4983:
1.184 rillig 4984: Chapter 17. Tools needed for building or running
4985:
4986: Table of Contents
4987:
4988: 17.1. Tools for pkgsrc builds
4989: 17.2. Tools needed by packages
4990: 17.3. Tools provided by platforms
4991:
4992: The USE_TOOLS definition is used both internally by pkgsrc and also for
4993: individual packages to define what commands are needed for building a package
4994: (like TOOL_DEPENDS) or for later run-time of an installed packaged (such as
4995: DEPENDS). If the native system provides an adequate tool, then in many cases, a
4996: pkgsrc package will not be used.
4997:
4998: When building a package, the replacement tools are made available in a
4999: directory (as symlinks or wrapper scripts) that is early in the executable
5000: search path. Just like the buildlink system, this helps with consistent builds.
5001:
5002: A tool may be needed to help build a specific package. For example, perl, GNU
5003: make (gmake) or yacc may be needed.
5004:
5005: Also a tool may be needed, for example, because the native system's supplied
5006: tool may be inefficient for building a package with pkgsrc. For example, a
5007: package may need GNU awk, bison (instead of yacc) or a better sed.
5008:
5009: The tools used by a package can be listed by running make show-tools.
5010:
5011: 17.1. Tools for pkgsrc builds
5012:
5013: The default set of tools used by pkgsrc is defined in bsd.pkg.mk. This includes
5014: standard Unix tools, such as: cat, awk, chmod, test, and so on. These can be
5015: seen by running: make show-var VARNAME=USE_TOOLS.
5016:
5017: If a package needs a specific program to build then the USE_TOOLS variable can
5018: be used to define the tools needed.
5019:
5020: 17.2. Tools needed by packages
5021:
5022: In the following examples, the :run means that it is needed at run-time (and
5023: becomes a DEPENDS). The default is a build dependency which can be set with
5024: :build. (So in this example, it is the same as gmake:build and
5025: pkg-config:build.)
5026:
5027: USE_TOOLS+= gmake perl:run pkg-config
5028:
5029: When using the tools framework, a TOOLS_PATH.foo variable is defined which
5030: contains the full path to the appropriate tool. For example, TOOLS_PATH.bash
5031: could be "/bin/bash" on Linux systems.
5032:
5033: If you always need a pkgsrc version of the tool at run-time, then just use
5034: DEPENDS instead.
5035:
5036: 17.3. Tools provided by platforms
5037:
5038: When improving or porting pkgsrc to a new platform, have a look at (or create)
5039: the corresponding platform specific make file fragment under pkgsrc/mk/tools/
5040: tools.${OPSYS}.mk which defines the name of the common tools. For example:
5041:
5042: .if exists(/usr/bin/bzcat)
5043: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
5044: .elif exists(/usr/bin/bzip2)
5045: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
5046: .endif
5047:
5048: TOOLS_PLATFORM.true?= true # shell builtin
5049:
5050: Chapter 18. Buildlink methodology
1.1 dsieger 5051:
5052: Table of Contents
5053:
1.184 rillig 5054: 18.1. Converting packages to use buildlink3
5055: 18.2. Writing buildlink3.mk files
5056:
5057: 18.2.1. Anatomy of a buildlink3.mk file
5058: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
5059: buildlink3.mk files
5060:
5061: 18.3. Writing builtin.mk files
5062:
5063: 18.3.1. Anatomy of a builtin.mk file
5064: 18.3.2. Global preferences for native or pkgsrc software
5065:
5066: Buildlink is a framework in pkgsrc that controls what headers and libraries are
5067: seen by a package's configure and build processes. This is implemented in a two
5068: step process:
5069:
5070: 1. Symlink headers and libraries for dependencies into BUILDLINK_DIR, which by
5071: default is a subdirectory of WRKDIR.
5072:
5073: 2. Create wrapper scripts that are used in place of the normal compiler tools
5074: that translate -I${LOCALBASE}/include and -L${LOCALBASE}/lib into
5075: references to BUILDLINK_DIR. The wrapper scripts also make native compiler
5076: on some operating systems look like GCC, so that packages that expect GCC
5077: won't require modifications to build with those native compilers.
5078:
5079: This normalizes the environment in which a package is built so that the package
5080: may be built consistently despite what other software may be installed. Please
5081: note that the normal system header and library paths, e.g. /usr/include, /usr/
5082: lib, etc., are always searched -- buildlink3 is designed to insulate the
5083: package build from non-system-supplied software.
5084:
5085: 18.1. Converting packages to use buildlink3
1.1 dsieger 5086:
1.184 rillig 5087: The process of converting packages to use the buildlink3 framework ("bl3ifying"
5088: ) is fairly straightforward. The things to keep in mind are:
1.1 dsieger 5089:
1.184 rillig 5090: 1. Ensure that the build always calls the wrapper scripts instead of the
5091: actual toolchain. Some packages are tricky, and the only way to know for
5092: sure is the check ${WRKDIR}/.work.log to see if the wrappers are being
5093: invoked.
1.1 dsieger 5094:
1.184 rillig 5095: 2. Don't override PREFIX from within the package Makefile, e.g. Java VMs,
5096: standalone shells, etc., because the code to symlink files into $
5097: {BUILDLINK_DIR} looks for files relative to "pkg_info -qp pkgname".
1.1 dsieger 5098:
1.184 rillig 5099: 3. Remember that only the buildlink3.mk files that you list in a package's
5100: Makefile are added as dependencies for that package.
1.1 dsieger 5101:
1.184 rillig 5102: If a dependency on a particular package is required for its libraries and
5103: headers, then we replace:
1.1 dsieger 5104:
1.184 rillig 5105: DEPENDS+= foo>=1.1.0:../../category/foo
1.1 dsieger 5106:
1.184 rillig 5107: with
1.1 dsieger 5108:
1.184 rillig 5109: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 5110:
1.184 rillig 5111: The buildlink3.mk files usually define the required dependencies. If you need a
5112: newer version of the dependency when using buildlink3.mk files, then you can
5113: define it in your Makefile; for example:
1.1 dsieger 5114:
1.184 rillig 5115: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5116: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 5117:
1.184 rillig 5118: There are several buildlink3.mk files in pkgsrc/mk that handle special package
5119: issues:
1.1 dsieger 5120:
1.184 rillig 5121: * bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB
5122: implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT.
1.1 dsieger 5123:
1.184 rillig 5124: * curses.buildlink3.mk: If the system comes with neither Curses nor NCurses,
5125: this will take care to install the devel/ncurses package.
1.1 dsieger 5126:
1.184 rillig 5127: * krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding
5128: a dependency on Heimdal or MIT-krb5 for packages that require a Kerberos 5
5129: implementation.
1.1 dsieger 5130:
1.184 rillig 5131: * motif.buildlink3.mk checks for a system-provided Motif installation or adds
5132: a dependency on x11/lesstif or x11/motif. The user can set MOTIF_TYPE to "
5133: dt", "lesstif" or "motif" to choose which Motif version will be used.
1.1 dsieger 5134:
1.184 rillig 5135: * readline.buildlink3.mk checks for a system-provided GNU readline or
5136: editline (libedit) installation, or adds a dependency on devel/readline,
5137: devel/editline. The user can set READLINE_DEFAULT to choose readline
5138: implementation. If your package really needs GNU readline library, its
5139: Makefile should include devel/readline/buildlink3.mk instead of
5140: readline.buildlink3.mk.
1.1 dsieger 5141:
1.184 rillig 5142: * oss.buildlink3.mk defines several variables that may be used by packages
5143: that use the Open Sound System (OSS) API.
1.1 dsieger 5144:
1.184 rillig 5145: * pgsql.buildlink3.mk will accept any of the Postgres versions in the
5146: variable PGSQL_VERSIONS_ACCEPTED and default to the version
5147: PGSQL_VERSION_DEFAULT. See the file for more information.
1.1 dsieger 5148:
1.184 rillig 5149: * pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native
5150: pthreads or adds a dependency on devel/pth as needed.
1.1 dsieger 5151:
1.184 rillig 5152: * xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena
5153: widgets library.
1.1 dsieger 5154:
1.184 rillig 5155: The comments in those buildlink3.mk files provide a more complete description
5156: of how to use them properly.
1.1 dsieger 5157:
1.184 rillig 5158: 18.2. Writing buildlink3.mk files
1.1 dsieger 5159:
1.184 rillig 5160: A package's buildlink3.mk file is included by Makefiles to indicate the need to
5161: compile and link against header files and libraries provided by the package. A
5162: buildlink3.mk file should always provide enough information to add the correct
5163: type of dependency relationship and include any other buildlink3.mk files that
5164: it needs to find headers and libraries that it needs in turn.
1.1 dsieger 5165:
1.184 rillig 5166: To generate an initial buildlink3.mk file for further editing, Rene Hexel's
5167: pkgtools/createbuildlink package is highly recommended. For most packages, the
5168: following command will generate a good starting point for buildlink3.mk files:
1.1 dsieger 5169:
1.184 rillig 5170: % cd pkgsrc/category/pkgdir
5171: % createbuildlink >buildlink3.mk
1.1 dsieger 5172:
5173:
1.184 rillig 5174: 18.2.1. Anatomy of a buildlink3.mk file
1.1 dsieger 5175:
1.184 rillig 5176: The following real-life example buildlink3.mk is taken from pkgsrc/graphics/
5177: tiff:
1.14 jmcneill 5178:
1.184 rillig 5179: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 5180:
1.184 rillig 5181: BUILDLINK_TREE+= tiff
1.1 dsieger 5182:
1.184 rillig 5183: .if !defined(TIFF_BUILDLINK3_MK)
5184: TIFF_BUILDLINK3_MK:=
1.1 dsieger 5185:
1.184 rillig 5186: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5187: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5188: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 5189:
1.184 rillig 5190: .include "../../devel/zlib/buildlink3.mk"
5191: .include "../../graphics/jpeg/buildlink3.mk"
5192: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 5193:
1.184 rillig 5194: BUILDLINK_TREE+= -tiff
1.1 dsieger 5195:
1.184 rillig 5196: The header and footer manipulate BUILDLINK_TREE, which is common across all
5197: buildlink3.mk files and is used to track the dependency tree.
1.1 dsieger 5198:
1.184 rillig 5199: The main section is protected from multiple inclusion and controls how the
5200: dependency on pkg is added. Several important variables are set in the section:
1.1 dsieger 5201:
1.185 wiz 5202: * BUILDLINK_API_DEPENDS.pkg is the dependency version recorded in the
1.184 rillig 5203: installed package; this should always be set using += to ensure that we're
5204: appending to any pre-existing list of values. This variable should be set
1.185 wiz 5205: to the last version of the package that had an backwards-incompatible API
1.184 rillig 5206: change.
1.1 dsieger 5207:
1.184 rillig 5208: * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory.
1.1 dsieger 5209:
1.184 rillig 5210: * BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use
5211: BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency
5212: is selected by setting BUILDLINK_DEPMETHOD.pkg to "build". By default, the
5213: full dependency is used.
1.1 dsieger 5214:
1.184 rillig 5215: * BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS.pkg (not shown above) are lists
5216: of subdirectories of ${BUILDLINK_PREFIX.pkg} to add to the header and
5217: library search paths. These default to "include" and "lib" respectively.
1.1 dsieger 5218:
1.184 rillig 5219: * BUILDLINK_CPPFLAGS.pkg (not shown above) is the list of preprocessor flags
5220: to add to CPPFLAGS, which are passed on to the configure and build phases.
5221: The "-I" option should be avoided and instead be handled using
5222: BUILDLINK_INCDIRS.pkg as above.
1.66 asau 5223:
1.184 rillig 5224: The following variables are all optionally defined within this second section
5225: (protected against multiple inclusion) and control which package files are
5226: symlinked into ${BUILDLINK_DIR} and how their names are transformed during the
5227: symlinking:
1.23 jakllsch 5228:
1.184 rillig 5229: * BUILDLINK_FILES.pkg (not shown above) is a shell glob pattern relative to $
5230: {BUILDLINK_PREFIX.pkg} to be symlinked into ${BUILDLINK_DIR}, e.g. include/
5231: *.h.
1.1 dsieger 5232:
1.184 rillig 5233: * BUILDLINK_FILES_CMD.pkg (not shown above) is a shell pipeline that outputs
5234: to stdout a list of files relative to ${BUILDLINK_PREFIX.pkg}. The
5235: resulting files are to be symlinked into ${BUILDLINK_DIR}. By default, this
5236: takes the +CONTENTS of a pkg and filters it through $
5237: {BUILDLINK_CONTENTS_FILTER.pkg}.
1.1 dsieger 5238:
1.184 rillig 5239: * BUILDLINK_CONTENTS_FILTER.pkg (not shown above) is a filter command that
5240: filters +CONTENTS input into a list of files relative to $
5241: {BUILDLINK_PREFIX.pkg} on stdout. By default, BUILDLINK_CONTENTS_FILTER.pkg
5242: outputs the contents of the include and lib directories in the package
5243: +CONTENTS.
1.1 dsieger 5244:
1.184 rillig 5245: * BUILDLINK_FNAME_TRANSFORM.pkg (not shown above) is a list of sed arguments
5246: used to transform the name of the source filename into a destination
5247: filename, e.g. -e "s|/curses.h|/ncurses.h|g".
1.1 dsieger 5248:
1.184 rillig 5249: This section can additionally include any buildlink3.mk needed for pkg's
5250: library dependencies. Including these buildlink3.mk files means that the
5251: headers and libraries for these dependencies are also symlinked into $
5252: {BUILDLINK_DIR} whenever the pkg buildlink3.mk file is included. Dependencies
5253: are only added for directly include buildlink3.mk files.
1.1 dsieger 5254:
1.184 rillig 5255: When providing a buildlink3.mk and including other buildlink3.mk files in it,
5256: please only add necessary ones, i.e., those whose libraries or header files are
5257: automatically exposed when the package is use.
1.1 dsieger 5258:
1.184 rillig 5259: In particular, if only an executable (bin/foo) is linked against a library,
5260: that library does not need to be propagated in the buildlink3.mk file.
1.1 dsieger 5261:
1.184 rillig 5262: The following steps should help you decide if a buildlink3.mk file needs to be
5263: included:
1.1 dsieger 5264:
1.184 rillig 5265: * Look at the installed header files: What headers do they include? The
5266: packages providing these files must be buildlinked.
1.1 dsieger 5267:
1.184 rillig 5268: * Run ldd on all installed libraries and look against what other libraries
5269: they link. Some of the packages providing these probably need to be
5270: buildlinked; however, it's not automatic, since e.g. GTK on some systems
5271: pulls in the X libraries, so they will show up in the ldd output, while on
5272: others (like OS X) it won't. ldd output can thus only be used as a hint.
1.1 dsieger 5273:
1.184 rillig 5274: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
5275: buildlink3.mk files
1.16 jnemeth 5276:
1.185 wiz 5277: Both variables set lower bounds for a version of this package. The two
5278: variables differ in that one describes source compatibility (API) and the other
5279: binary compatibility (ABI). The difference is that a change in the API breaks
5280: compilation of programs while changes in the ABI stop compiled programs from
5281: running.
5282:
5283: The BUILDLINK_API_DEPENDS.pkg variable in a buildlink3.mk should be changed
5284: very rarely. (One possible scenario: If all packages using this package need a
5285: higher version than defined in the buildlink3.mk, BUILDLINK_API_DEPENDS.pkg
5286: could be updated to that higher version.)
5287:
5288: On the other hand, changes to BUILDLINK_ABI_DEPENDS.pkg are more common. The
5289: variable will need to be updated every time the major version of one of its
5290: shared libraries is changed, or any other change where a binary built against
5291: the previous version of the package will not run against the new version any
5292: longer.
5293:
5294: In such a case, the package's BUILDLINK_ABI_DEPENDS.pkg must be increased to
5295: require the new package version. Then the PKGREVISION of all packages foo that
5296: depend on this package need to be increased, and if they have buildlink3.mk
5297: files, BUILDLINK_ABI_DEPENDS.foo in their buildlink3.mk files must be increased
5298: to the new version as well. This is required so that a package will pull in the
5299: versions of the packages that use the new ABI and that the packages'
5300: PKGREVISIONs uniquely identify the packages built against the new ABI. The
5301: pkgtools/revbump package can help with these updates.
1.1 dsieger 5302:
1.184 rillig 5303: See Section 21.1.5, "Handling dependencies" for more information about
1.185 wiz 5304: dependencies on other packages, including the BUILDLINK_API_DEPENDS
5305: definitions.
1.1 dsieger 5306:
1.184 rillig 5307: Please take careful consideration before adjusting BUILDLINK_API_DEPENDS.pkg or
1.185 wiz 5308: BUILDLINK_ABI_DEPENDS.pkg in a buildlink3.mk file as we don't want to cause
5309: unneeded package deletions and rebuilds. In many cases, new versions of
5310: packages work just fine with older dependencies.
1.1 dsieger 5311:
1.184 rillig 5312: Also it is not needed to set BUILDLINK_ABI_DEPENDS.pkg when it is identical to
5313: BUILDLINK_API_DEPENDS.pkg.
1.1 dsieger 5314:
1.184 rillig 5315: 18.3. Writing builtin.mk files
1.1 dsieger 5316:
1.184 rillig 5317: Some packages in pkgsrc install headers and libraries that coincide with
5318: headers and libraries present in the base system. Aside from a buildlink3.mk
5319: file, these packages should also include a builtin.mk file that includes the
5320: necessary checks to decide whether using the built-in software or the pkgsrc
5321: software is appropriate.
1.1 dsieger 5322:
1.184 rillig 5323: The only requirements of a builtin.mk file for pkg are:
1.1 dsieger 5324:
1.184 rillig 5325: 1. It should set USE_BUILTIN.pkg to either "yes" or "no" after it is included.
1.1 dsieger 5326:
1.184 rillig 5327: 2. It should not override any USE_BUILTIN.pkg which is already set before the
5328: builtin.mk file is included.
1.1 dsieger 5329:
1.184 rillig 5330: 3. It should be written to allow multiple inclusion. This is very important
5331: and takes careful attention to Makefile coding.
1.1 dsieger 5332:
1.184 rillig 5333: 18.3.1. Anatomy of a builtin.mk file
1.1 dsieger 5334:
1.184 rillig 5335: The following is the recommended template for builtin.mk files:
1.1 dsieger 5336:
1.184 rillig 5337: .if !defined(IS_BUILTIN.foo)
5338: #
5339: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5340: # genuinely exists in the system or not.
5341: #
5342: IS_BUILTIN.foo?= no
1.1 dsieger 5343:
1.184 rillig 5344: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5345: # version can be determined.
5346: #
5347: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5348: BUILTIN_PKG.foo?= foo-1.0
5349: . endif
5350: .endif # IS_BUILTIN.foo
1.1 dsieger 5351:
1.184 rillig 5352: .if !defined(USE_BUILTIN.foo)
5353: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5354: . if defined(BUILTIN_PKG.foo)
5355: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5356: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5357: USE_BUILTIN.foo!= \
5358: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5359: && ${ECHO} "yes" || ${ECHO} "no"
5360: . endif
5361: . endfor
5362: . endif
5363: .endif # USE_BUILTIN.foo
1.1 dsieger 5364:
1.184 rillig 5365: CHECK_BUILTIN.foo?= no
5366: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5367: #
5368: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5369: # "yes" or "no".
5370: #
5371: .endif # CHECK_BUILTIN.foo
1.1 dsieger 5372:
1.184 rillig 5373: The first section sets IS_BUILTIN.pkg depending on if pkg really exists in the
5374: base system. This should not be a base system software with similar
5375: functionality to pkg; it should only be "yes" if the actual package is included
5376: as part of the base system. This variable is only used internally within the
5377: builtin.mk file.
1.1 dsieger 5378:
1.184 rillig 5379: The second section sets BUILTIN_PKG.pkg to the version of pkg in the base
5380: system if it exists (if IS_BUILTIN.pkg is "yes"). This variable is only used
5381: internally within the builtin.mk file.
1.1 dsieger 5382:
1.184 rillig 5383: The third section sets USE_BUILTIN.pkg and is required in all builtin.mk files.
5384: The code in this section must make the determination whether the built-in
5385: software is adequate to satisfy the dependencies listed in
5386: BUILDLINK_API_DEPENDS.pkg. This is typically done by comparing BUILTIN_PKG.pkg
5387: against each of the dependencies in BUILDLINK_API_DEPENDS.pkg. USE_BUILTIN.pkg
5388: must be set to the correct value by the end of the builtin.mk file. Note that
5389: USE_BUILTIN.pkg may be "yes" even if IS_BUILTIN.pkg is "no" because we may make
5390: the determination that the built-in version of the software is similar enough
5391: to be used as a replacement.
1.1 dsieger 5392:
1.184 rillig 5393: The last section is guarded by CHECK_BUILTIN.pkg, and includes code that uses
5394: the value of USE_BUILTIN.pkg set in the previous section. This typically
5395: includes, e.g., adding additional dependency restrictions and listing
5396: additional files to symlink into ${BUILDLINK_DIR} (via BUILDLINK_FILES.pkg).
1.1 dsieger 5397:
1.184 rillig 5398: 18.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 5399:
1.184 rillig 5400: When building packages, it's possible to choose whether to set a global
5401: preference for using either the built-in (native) version or the pkgsrc version
5402: of software to satisfy a dependency. This is controlled by setting
5403: PREFER_PKGSRC and PREFER_NATIVE. These variables take values of either "yes", "
5404: no", or a list of packages. PREFER_PKGSRC tells pkgsrc to use the pkgsrc
5405: versions of software, while PREFER_NATIVE tells pkgsrc to use the built-in
5406: versions. Preferences are determined by the most specific instance of the
5407: package in either PREFER_PKGSRC or PREFER_NATIVE. If a package is specified in
5408: neither or in both variables, then PREFER_PKGSRC has precedence over
5409: PREFER_NATIVE. For example, to require using pkgsrc versions of software for
5410: all but the most basic bits on a NetBSD system, you can set:
1.1 dsieger 5411:
1.184 rillig 5412: PREFER_PKGSRC= yes
5413: PREFER_NATIVE= getopt skey tcp_wrappers
1.1 dsieger 5414:
1.184 rillig 5415: A package must have a builtin.mk file to be listed in PREFER_NATIVE, otherwise
5416: it is simply ignored in that list.
1.1 dsieger 5417:
1.191 bacon 5418: PREFER_PKGSRC and PREFER_NATIVE should be set during bootstrap to ensure that
5419: the bootstrap process does not use inapropriate native tools as dependencies
5420: for core packages.
5421:
5422: # ./bootstrap --prefer-pkgsrc yes --prefer-native openssl
5423:
5424: Switching between settings globally at a later date can introduce complications
5425: with dependency resolution. This is caused by packages built with the opposite
5426: preference being installed alongside each other. Hence, any changes to these
5427: variables after bootstrap will necessitate rebuilding all packages depending on
5428: one whose preference has been changed. This is not trivial and should be
5429: avoided.
5430:
5431: When using pkgsrc on Linux systems, there is high risk of "leakage", where
5432: programs installed by pkgsrc may inadvertently use a command or library not
5433: installed by pkgsrc, e.g. those installed by yum or apt. Such foreign
5434: dependencies may be installed, removed, or upgraded to a version incompatible
5435: with the pkgsrc package at any time, causing pkgsrc packages to subsequently
5436: malfunction. Pkgsrc cannot prevent this, as it has no control over other
5437: package managers. Another potential problem is that under Redhat Enterprise and
5438: related Linux systems, yum packages are only patched and never upgraded, so
5439: eventually they may become too outdated for use by pkgsrc. Even intentionally
5440: using foreign dependencies, not considered leakage, can lead to these problems,
5441: so it is generally discouraged. In order to minimize such problems,
5442: PREFER_PKGSRC defaults to "yes" on Linux systems. This ensures that pkgsrc is
5443: aware of any changes to dependency packages and can rebuild or upgrade the
5444: entire dependency tree as needed. This default can be overridden by setting
5445: --prefer-pkgsrc to "no" or a list of packages, or by setting --prefer-native to
5446: "yes".
1.1 dsieger 5447:
1.184 rillig 5448: Chapter 19. PLIST issues
1.1 dsieger 5449:
1.184 rillig 5450: Table of Contents
1.1 dsieger 5451:
1.184 rillig 5452: 19.1. RCS ID
5453: 19.2. Semi-automatic PLIST generation
5454: 19.3. Tweaking output of make print-PLIST
5455: 19.4. Variable substitution in PLIST
5456: 19.5. Man page compression
5457: 19.6. Changing PLIST source with PLIST_SRC
5458: 19.7. Platform-specific and differing PLISTs
5459: 19.8. Build-specific PLISTs
5460: 19.9. Sharing directories between packages
1.1 dsieger 5461:
1.184 rillig 5462: The PLIST file contains a package's "packing list", i.e. a list of files that
5463: belong to the package (relative to the ${PREFIX} directory it's been installed
5464: in) plus some additional statements - see the pkg_create(1) man page for a full
5465: list. This chapter addresses some issues that need attention when dealing with
5466: the PLIST file (or files, see below!).
1.1 dsieger 5467:
1.184 rillig 5468: 19.1. RCS ID
1.1 dsieger 5469:
1.184 rillig 5470: Be sure to add a RCS ID line as the first thing in any PLIST file you write:
1.1 dsieger 5471:
1.184 rillig 5472: @comment $NetBSD $
1.1 dsieger 5473:
1.184 rillig 5474: An artificial space has been added between NetBSD and $, this is a workaround
5475: here to prevent CVS expanding to the filename of the guide. When adding the RCS
5476: ID the space should be omitted.
1.38 wiz 5477:
1.184 rillig 5478: 19.2. Semi-automatic PLIST generation
1.1 dsieger 5479:
1.184 rillig 5480: You can use the make print-PLIST command to output a PLIST that matches any new
5481: files since the package was extracted. See Section 13.17, "Other helpful
5482: targets" for more information on this target.
1.11 rillig 5483:
1.184 rillig 5484: 19.3. Tweaking output of make print-PLIST
1.1 dsieger 5485:
1.184 rillig 5486: The PRINT_PLIST_AWK variable takes a set of AWK patterns and actions that are
5487: used to filter the output of print-PLIST. You can append any chunk of AWK
5488: scripting you like to it, but be careful with quoting.
1.1 dsieger 5489:
1.184 rillig 5490: For example, to get all files inside the libdata/foo directory removed from the
5491: resulting PLIST:
1.1 dsieger 5492:
1.184 rillig 5493: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 5494:
1.185 wiz 5495: The PRINT_PLIST_AWK transformations are evaluated after the file list and
5496: directory list are sorted. EARLY_PRINT_PLIST_AWK is like PRINT_PLIST_AWK except
5497: it operates before the file list and directory list are sorted.
5498:
1.184 rillig 5499: 19.4. Variable substitution in PLIST
1.1 dsieger 5500:
1.184 rillig 5501: A number of variables are substituted automatically in PLISTs when a package is
5502: installed on a system. This includes the following variables:
1.1 dsieger 5503:
1.184 rillig 5504: ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
1.1 dsieger 5505:
1.184 rillig 5506: Some packages like emacs and perl embed information about which
5507: architecture they were built on into the pathnames where they install their
5508: files. To handle this case, PLIST will be preprocessed before actually
5509: used, and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p
5510: gives. The same is done if the string ${MACHINE_GNU_ARCH} is embedded in
5511: PLIST somewhere - use this on packages that have GNU autoconf-created
5512: configure scripts.
1.1 dsieger 5513:
1.184 rillig 5514: Legacy note
1.1 dsieger 5515:
1.184 rillig 5516: There used to be a symbol "$ARCH" that was replaced by the output of uname
5517: -m, but that's no longer supported and has been removed.
1.1 dsieger 5518:
1.184 rillig 5519: ${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}
1.1 dsieger 5520:
1.184 rillig 5521: Some packages want to embed the OS name and version into some paths. To do
5522: this, use these variables in the PLIST:
1.1 dsieger 5523:
1.184 rillig 5524: + ${OPSYS} - output of "uname -s"
1.1 dsieger 5525:
1.184 rillig 5526: + ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
1.1 dsieger 5527:
1.184 rillig 5528: + ${OS_VERSION} - "uname -r"
1.1 dsieger 5529:
1.184 rillig 5530: For a list of values which are replaced by default, the output of make help
5531: topic=PLIST_SUBST as well as searching the pkgsrc/mk directory with grep for
5532: PLIST_SUBST should help.
1.1 dsieger 5533:
1.184 rillig 5534: If you want to change other variables not listed above, you can add variables
5535: and their expansions to this variable in the following way, similar to
5536: MESSAGE_SUBST (see Section 12.5, "Optional files"):
1.1 dsieger 5537:
1.184 rillig 5538: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 5539:
1.184 rillig 5540: This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue".
1.1 dsieger 5541:
1.184 rillig 5542: The PLIST_VARS variable can be used to simplify the common case of
5543: conditionally including some PLIST entries. It can be done by adding
5544: PLIST_VARS+=foo and setting the corresponding PLIST.foo variable to yes if the
5545: entry should be included. This will substitute "${PLIST.foo}" in the PLIST with
5546: either """" or ""@comment "". For example, in Makefile:
1.1 dsieger 5547:
1.184 rillig 5548: PLIST_VARS+= foo
5549: .if condition
5550: PLIST.foo= yes
5551: .else
1.1 dsieger 5552:
1.184 rillig 5553: And then in PLIST:
1.1 dsieger 5554:
1.184 rillig 5555: @comment $NetBSD $
5556: bin/bar
5557: man/man1/bar.1
5558: ${PLIST.foo}bin/foo
5559: ${PLIST.foo}man/man1/foo.1
5560: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 5561:
1.184 rillig 5562: An artificial space has been added between NetBSD and $, this is a workaround
5563: here to prevent CVS expanding to the filename of the guide. When adding the RCS
1.195 gutterid 5564: ID the space should be omitted.
1.1 dsieger 5565:
1.184 rillig 5566: 19.5. Man page compression
1.1 dsieger 5567:
1.184 rillig 5568: Man pages should be installed in compressed form if MANZ is set (in
5569: bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the
5570: suffix ".gz" is appended/removed automatically for man pages according to MANZ
5571: and MANCOMPRESSED being set or not, see above for details. This modification of
5572: the PLIST file is done on a copy of it, not PLIST itself.
1.100 leot 5573:
1.184 rillig 5574: 19.6. Changing PLIST source with PLIST_SRC
1.100 leot 5575:
1.184 rillig 5576: To use one or more files as source for the PLIST used in generating the binary
5577: package, set the variable PLIST_SRC to the names of that file(s). The files are
5578: later concatenated using cat(1), and the order of things is important. The
5579: default for PLIST_SRC is ${PKGDIR}/PLIST.
1.1 dsieger 5580:
1.184 rillig 5581: 19.7. Platform-specific and differing PLISTs
1.1 dsieger 5582:
1.184 rillig 5583: Some packages decide to install a different set of files based on the operating
5584: system being used. These differences can be automatically handled by using the
5585: following files:
1.1 dsieger 5586:
1.184 rillig 5587: * PLIST.common
1.1 dsieger 5588:
1.184 rillig 5589: * PLIST.${OPSYS}
1.1 dsieger 5590:
1.184 rillig 5591: * PLIST.${MACHINE_ARCH}
1.1 dsieger 5592:
1.184 rillig 5593: * PLIST.${OPSYS}-${MACHINE_ARCH}
1.1 dsieger 5594:
1.184 rillig 5595: * PLIST.common_end
1.1 dsieger 5596:
1.184 rillig 5597: 19.8. Build-specific PLISTs
1.1 dsieger 5598:
1.184 rillig 5599: Some packages decide to generate hard-to-guess file names during installation
5600: that are hard to wire down.
1.1 dsieger 5601:
1.184 rillig 5602: In such cases, you can set the GENERATE_PLIST variable to shell code terminated
5603: (with a semicolon) that will output PLIST entries which will be appended to the
5604: PLIST
1.1 dsieger 5605:
1.184 rillig 5606: You can find one example in editors/xemacs:
1.1 dsieger 5607:
1.184 rillig 5608: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
1.1 dsieger 5609:
1.184 rillig 5610: which will append something like bin/xemacs-21.4.23-54e8ea71.dmp to the PLIST.
1.1 dsieger 5611:
1.184 rillig 5612: 19.9. Sharing directories between packages
1.1 dsieger 5613:
1.184 rillig 5614: A "shared directory" is a directory where multiple (and unrelated) packages
5615: install files. These directories were problematic because you had to add
5616: special tricks in the PLIST to conditionally remove them, or have some
5617: centralized package handle them.
1.106 tnn 5618:
1.184 rillig 5619: In pkgsrc, it is now easy: Each package should create directories and install
5620: files as needed; pkg_delete will remove any directories left empty after
5621: uninstalling a package.
1.106 tnn 5622:
1.184 rillig 5623: If a package needs an empty directory to work, create the directory during
5624: installation as usual, and also add an entry to the PLIST:
1.1 dsieger 5625:
1.184 rillig 5626: @pkgdir path/to/empty/directory
1.1 dsieger 5627:
1.184 rillig 5628: or take a look at MAKE_DIRS and OWN_DIRS.
1.1 dsieger 5629:
1.184 rillig 5630: Chapter 20. The pkginstall framework
1.1 dsieger 5631:
1.184 rillig 5632: Table of Contents
1.1 dsieger 5633:
1.184 rillig 5634: 20.1. Files and directories outside the installation prefix
1.1 dsieger 5635:
1.184 rillig 5636: 20.1.1. Directory manipulation
5637: 20.1.2. File manipulation
1.1 dsieger 5638:
1.184 rillig 5639: 20.2. Configuration files
1.1 dsieger 5640:
1.184 rillig 5641: 20.2.1. How PKG_SYSCONFDIR is set
5642: 20.2.2. Telling the software where configuration files are
5643: 20.2.3. Patching installations
5644: 20.2.4. Disabling handling of configuration files
1.1 dsieger 5645:
1.184 rillig 5646: 20.3. System startup scripts
1.1 dsieger 5647:
1.184 rillig 5648: 20.3.1. Disabling handling of system startup scripts
1.1 dsieger 5649:
1.184 rillig 5650: 20.4. System users and groups
5651: 20.5. System shells
1.1 dsieger 5652:
1.184 rillig 5653: 20.5.1. Disabling shell registration
1.1 dsieger 5654:
1.184 rillig 5655: 20.6. Fonts
1.1 dsieger 5656:
1.184 rillig 5657: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 5658:
1.184 rillig 5659: This chapter describes the framework known as pkginstall, whose key features
5660: are:
1.1 dsieger 5661:
1.184 rillig 5662: * Generic installation and manipulation of directories and files outside the
5663: pkgsrc-handled tree, LOCALBASE.
1.1 dsieger 5664:
1.184 rillig 5665: * Automatic handling of configuration files during installation, provided
5666: that packages are correctly designed.
1.1 dsieger 5667:
1.184 rillig 5668: * Generation and installation of system startup scripts.
1.1 dsieger 5669:
1.184 rillig 5670: * Registration of system users and groups.
1.1 dsieger 5671:
1.184 rillig 5672: * Registration of system shells.
1.1 dsieger 5673:
1.184 rillig 5674: * Automatic updating of fonts databases.
1.1 dsieger 5675:
1.184 rillig 5676: The following sections inspect each of the above points in detail.
1.1 dsieger 5677:
1.184 rillig 5678: You may be thinking that many of the things described here could be easily done
5679: with simple code in the package's post-installation target (post-install). This
5680: is incorrect, as the code in them is only executed when building from source.
5681: Machines using binary packages could not benefit from it at all (as the code
5682: itself could be unavailable). Therefore, the only way to achieve any of the
5683: items described above is by means of the installation scripts, which are
5684: automatically generated by pkginstall.
1.1 dsieger 5685:
1.184 rillig 5686: 20.1. Files and directories outside the installation prefix
1.95 wiz 5687:
1.184 rillig 5688: As you already know, the PLIST file holds a list of files and directories that
5689: belong to a package. The names used in it are relative to the installation
5690: prefix (${PREFIX}), which means that it cannot register files outside this
5691: directory (absolute path names are not allowed). Despite this restriction, some
5692: packages need to install files outside this location; e.g., under ${VARBASE} or
5693: ${PKG_SYSCONFDIR}. The only way to achieve this is to create such files during
5694: installation time by using installation scripts.
1.95 wiz 5695:
1.184 rillig 5696: The generic installation scripts are shell scripts that can contain arbitrary
5697: code. The list of scripts to execute is taken from the INSTALL_FILE variable,
5698: which defaults to INSTALL. A similar variable exists for package removal
5699: (DEINSTALL_FILE, whose default is DEINSTALL). These scripts can run arbitrary
5700: commands, so they have the potential to create and manage files anywhere in the
5701: file system.
1.95 wiz 5702:
1.184 rillig 5703: Using these general installation files is not recommended, but may be needed in
5704: some special cases. One reason for avoiding them is that the user has to trust
5705: the packager that there is no unwanted or simply erroneous code included in the
5706: installation script. Also, previously there were many similar scripts for the
5707: same functionality, and fixing a common error involved finding and changing all
5708: of them.
1.95 wiz 5709:
1.184 rillig 5710: The pkginstall framework offers another, standardized way. It provides generic
5711: scripts to abstract the manipulation of such files and directories based on
5712: variables set in the package's Makefile. The rest of this section describes
5713: these variables.
1.1 dsieger 5714:
1.184 rillig 5715: 20.1.1. Directory manipulation
1.1 dsieger 5716:
1.184 rillig 5717: The following variables can be set to request the creation of directories
5718: anywhere in the file system:
1.1 dsieger 5719:
1.184 rillig 5720: * MAKE_DIRS and OWN_DIRS contain a list of directories that should be created
5721: and should attempt to be destroyed by the installation scripts. The
5722: difference between the two is that the latter prompts the administrator to
5723: remove any directories that may be left after deinstallation (because they
5724: were not empty), while the former does not. Example:
1.1 dsieger 5725:
1.184 rillig 5726: MAKE_DIRS+= ${VARBASE}/foo/private
1.1 dsieger 5727:
1.184 rillig 5728: * MAKE_DIRS_PERMS and OWN_DIRS_PERMS contain a list of tuples describing
5729: which directories should be created and should attempt to be destroyed by
5730: the installation scripts. Each tuple holds the following values, separated
5731: by spaces: the directory name, its owner, its group and its numerical mode.
5732: For example:
1.1 dsieger 5733:
1.184 rillig 5734: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5735: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5736:
1.184 rillig 5737: The difference between the two is exactly the same as their non-PERMS
5738: counterparts.
1.1 dsieger 5739:
1.184 rillig 5740: 20.1.2. File manipulation
1.1 dsieger 5741:
1.184 rillig 5742: Creating non-empty files outside the installation prefix is tricky because the
5743: PLIST forces all files to be inside it. To overcome this problem, the only
5744: solution is to extract the file in the known place (i.e., inside the
5745: installation prefix) and copy it to the appropriate location during
5746: installation (done by the installation scripts generated by pkginstall). We
5747: will call the former the master file in the following paragraphs, which
5748: describe the variables that can be used to automatically and consistently
5749: handle files outside the installation prefix:
1.1 dsieger 5750:
1.184 rillig 5751: * CONF_FILES and REQD_FILES are pairs of master and target files. During
5752: installation time, the master file is copied to the target one if and only
5753: if the latter does not exist. Upon deinstallation, the target file is
5754: removed provided that it was not modified by the installation.
1.1 dsieger 5755:
1.184 rillig 5756: The difference between the two is that the latter prompts the administrator
5757: to remove any files that may be left after deinstallation (because they
5758: were not empty), while the former does not.
1.1 dsieger 5759:
1.184 rillig 5760: * CONF_FILES_PERMS and REQD_FILES_PERMS contain tuples describing master
5761: files as well as their target locations. For each of them, it also
5762: specifies their owner, their group and their numeric permissions, in this
5763: order. For example:
1.1 dsieger 5764:
1.184 rillig 5765: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5766: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5767:
1.184 rillig 5768: The difference between the two is exactly the same as their non-PERMS
5769: counterparts.
1.1 dsieger 5770:
1.184 rillig 5771: 20.2. Configuration files
1.1 dsieger 5772:
1.184 rillig 5773: Configuration files are special in the sense that they are installed in their
5774: own specific directory, PKG_SYSCONFDIR, and need special treatment during
5775: installation (most of which is automated by pkginstall). The main concept you
5776: must bear in mind is that files marked as configuration files are automatically
5777: copied to the right place (somewhere inside PKG_SYSCONFDIR) during installation
5778: if and only if they didn't exist before. Similarly, they will not be removed if
5779: they have local modifications. This ensures that administrators never lose any
5780: custom changes they may have made.
1.1 dsieger 5781:
1.184 rillig 5782: 20.2.1. How PKG_SYSCONFDIR is set
1.1 dsieger 5783:
1.184 rillig 5784: As said before, the PKG_SYSCONFDIR variable specifies where configuration files
5785: shall be installed. Its contents are set based upon the following variables:
1.1 dsieger 5786:
1.184 rillig 5787: * PKG_SYSCONFBASE: The configuration's root directory. Defaults to ${PREFIX}/
5788: etc although it may be overridden by the user to point to his preferred
5789: location (e.g., /etc, /etc/pkg, etc.). Packages must not use it directly.
1.1 dsieger 5790:
1.184 rillig 5791: * PKG_SYSCONFSUBDIR: A subdirectory of PKG_SYSCONFBASE under which the
5792: configuration files for the package being built shall be installed. The
5793: definition of this variable only makes sense in the package's Makefile
5794: (i.e., it is not user-customizable).
1.1 dsieger 5795:
1.184 rillig 5796: As an example, consider the Apache package, www/apache24, which places its
5797: configuration files under the httpd/ subdirectory of PKG_SYSCONFBASE. This
5798: should be set in the package Makefile.
1.1 dsieger 5799:
1.184 rillig 5800: * PKG_SYSCONFVAR: Specifies the name of the variable that holds this
5801: package's configuration directory (if different from PKG_SYSCONFBASE). It
5802: defaults to PKGBASE's value, and is always prefixed with PKG_SYSCONFDIR.
1.1 dsieger 5803:
1.184 rillig 5804: * PKG_SYSCONFDIR.${PKG_SYSCONFVAR}: Holds the directory where the
5805: configuration files for the package identified by PKG_SYSCONFVAR's shall be
5806: placed.
1.1 dsieger 5807:
1.184 rillig 5808: Based on the above variables, pkginstall determines the value of
5809: PKG_SYSCONFDIR, which is the only variable that can be used within a package to
5810: refer to its configuration directory. The algorithm used to set its value is
5811: basically the following:
1.1 dsieger 5812:
1.184 rillig 5813: 1. If PKG_SYSCONFDIR.${PKG_SYSCONFVAR} is set, its value is used.
1.1 dsieger 5814:
1.184 rillig 5815: 2. If the previous variable is not defined but PKG_SYSCONFSUBDIR is set in the
5816: package's Makefile, the resulting value is ${PKG_SYSCONFBASE}/$
5817: {PKG_SYSCONFSUBDIR}.
1.1 dsieger 5818:
1.184 rillig 5819: 3. Otherwise, it is set to ${PKG_SYSCONFBASE}.
1.1 dsieger 5820:
1.184 rillig 5821: It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to
5822: OWN_DIRS. See Section 20.1.1, "Directory manipulation" what this means. This
5823: does not apply to subdirectories of ${PKG_SYSCONFDIR}, they still have to be
5824: created with OWN_DIRS or MAKE_DIRS.
1.1 dsieger 5825:
1.184 rillig 5826: 20.2.2. Telling the software where configuration files are
1.1 dsieger 5827:
1.184 rillig 5828: Given that pkgsrc (and users!) expect configuration files to be in a known
5829: place, you need to teach each package where it shall install its files. In some
5830: cases you will have to patch the package Makefiles to achieve it. If you are
5831: lucky, though, it may be as easy as passing an extra flag to the configuration
5832: script; this is the case of GNU Autoconf- generated files:
1.1 dsieger 5833:
1.184 rillig 5834: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 5835:
1.184 rillig 5836: Note that this specifies where the package has to look for its configuration
5837: files, not where they will be originally installed (although the difference is
5838: never explicit, unfortunately).
1.1 dsieger 5839:
1.184 rillig 5840: 20.2.3. Patching installations
1.1 dsieger 5841:
1.184 rillig 5842: As said before, pkginstall automatically handles configuration files. This
5843: means that the packages themselves must not touch the contents of $
5844: {PKG_SYSCONFDIR} directly. Bad news is that many software installation scripts
5845: will, out of the box, mess with the contents of that directory. So what is the
5846: correct procedure to fix this issue?
1.1 dsieger 5847:
1.184 rillig 5848: You must teach the package (usually by manually patching it) to install any
5849: configuration files under the examples hierarchy, share/examples/${PKGBASE}/.
5850: This way, the PLIST registers them and the administrator always has the
5851: original copies available.
1.1 dsieger 5852:
1.184 rillig 5853: Once the required configuration files are in place (i.e., under the examples
5854: hierarchy), the pkginstall framework can use them as master copies during the
5855: package installation to update what is in ${PKG_SYSCONFDIR}. To achieve this,
5856: the variables CONF_FILES and CONF_FILES_PERMS are used. Check out
5857: Section 20.1.2, "File manipulation" for information about their syntax and
5858: their purpose. Here is an example, taken from the mail/mutt package:
1.1 dsieger 5859:
1.184 rillig 5860: EGDIR= ${PREFIX}/share/doc/mutt/samples
5861: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 dsieger 5862:
1.184 rillig 5863: Note that the EGDIR variable is specific to that package and has no meaning
5864: outside it.
1.1 dsieger 5865:
1.184 rillig 5866: 20.2.4. Disabling handling of configuration files
1.1 dsieger 5867:
1.184 rillig 5868: The automatic copying of config files can be toggled by setting the environment
5869: variable PKG_CONFIG prior to package installation.
1.1 dsieger 5870:
1.184 rillig 5871: 20.3. System startup scripts
1.1 dsieger 5872:
1.184 rillig 5873: System startup scripts are special files because they must be installed in a
5874: place known by the underlying OS, usually outside the installation prefix.
5875: Therefore, the same rules described in Section 20.1, "Files and directories
5876: outside the installation prefix" apply, and the same solutions can be used.
5877: However, pkginstall provides a special mechanism to handle these files.
1.1 dsieger 5878:
1.184 rillig 5879: In order to provide system startup scripts, the package has to:
1.1 dsieger 5880:
1.184 rillig 5881: 1. Store the script inside ${FILESDIR}, with the .sh suffix appended.
5882: Considering the print/cups package as an example, it has a cupsd.sh in its
5883: files directory.
1.95 wiz 5884:
1.184 rillig 5885: 2. Tell pkginstall to handle it, appending the name of the script, without its
5886: extension, to the RCD_SCRIPTS variable. Continuing the previous example:
1.95 wiz 5887:
1.184 rillig 5888: RCD_SCRIPTS+= cupsd
1.95 wiz 5889:
1.184 rillig 5890: Once this is done, pkginstall will do the following steps for each script in an
5891: automated fashion:
1.95 wiz 5892:
1.184 rillig 5893: 1. Process the file found in the files directory applying all the
5894: substitutions described in the FILES_SUBST variable.
1.1 dsieger 5895:
1.184 rillig 5896: 2. Copy the script from the files directory to the examples hierarchy, $
5897: {PREFIX}/share/examples/rc.d/. Note that this master file must be
5898: explicitly registered in the PLIST.
1.1 dsieger 5899:
1.184 rillig 5900: 3. Add code to the installation scripts to copy the startup script from the
5901: examples hierarchy into the system-wide startup scripts directory.
1.1 dsieger 5902:
1.184 rillig 5903: 20.3.1. Disabling handling of system startup scripts
1.1 dsieger 5904:
1.184 rillig 5905: The automatic copying of config files can be toggled by setting the environment
5906: variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts
5907: will be always copied inside the examples hierarchy, ${PREFIX}/share/examples/
5908: rc.d/, no matter what the value of this variable is.
1.1 dsieger 5909:
1.184 rillig 5910: 20.4. System users and groups
1.1 dsieger 5911:
1.184 rillig 5912: If a package needs to create special users and/or groups during installation,
5913: it can do so by using the pkginstall framework.
1.1 dsieger 5914:
1.184 rillig 5915: Users can be created by adding entries to the PKG_USERS variable. Each entry
5916: has the following syntax:
1.1 dsieger 5917:
1.184 rillig 5918: user:group
1.1 dsieger 5919:
1.184 rillig 5920: Further specification of user details may be done by setting per-user
5921: variables. PKG_UID.user is the numeric UID for the user. PKG_GECOS.user is the
5922: user's description or comment. PKG_HOME.user is the user's home directory, and
5923: defaults to /nonexistent if not specified. PKG_SHELL.user is the user's shell,
5924: and defaults to /sbin/nologin if not specified.
1.1 dsieger 5925:
1.184 rillig 5926: Similarly, groups can be created by adding entries to the PKG_GROUPS variable,
5927: whose syntax is:
1.1 dsieger 5928:
1.184 rillig 5929: group
1.1 dsieger 5930:
1.184 rillig 5931: The numeric GID of the group may be set by defining PKG_GID.group.
1.1 dsieger 5932:
1.184 rillig 5933: If a package needs to create the users and groups at an earlier stage, then it
5934: can set USERGROUP_PHASE to either configure,build, or pre-install to indicate
5935: the phase before which the users and groups are created. In this case, the
5936: numeric UIDs and GIDs of the created users and groups are automatically
5937: hardcoded into the final installation scripts.
1.1 dsieger 5938:
1.184 rillig 5939: 20.5. System shells
1.1 dsieger 5940:
1.184 rillig 5941: Packages that install system shells should register them in the shell database,
5942: /etc/shells, to make things easier to the administrator. This must be done from
5943: the installation scripts to keep binary packages working on any system.
5944: pkginstall provides an easy way to accomplish this task.
1.1 dsieger 5945:
1.184 rillig 5946: When a package provides a shell interpreter, it has to set the PKG_SHELL
5947: variable to its absolute file name. This will add some hooks to the
5948: installation scripts to handle it. Consider the following example, taken from
5949: shells/zsh:
1.1 dsieger 5950:
1.184 rillig 5951: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 dsieger 5952:
1.184 rillig 5953: 20.5.1. Disabling shell registration
1.1 dsieger 5954:
1.184 rillig 5955: The automatic registration of shell interpreters can be disabled by the
5956: administrator by setting the PKG_REGISTER_SHELLS environment variable to NO.
1.1 dsieger 5957:
1.184 rillig 5958: 20.6. Fonts
1.1 dsieger 5959:
1.184 rillig 5960: Packages that install X11 fonts should update the database files that index the
5961: fonts within each fonts directory. This can easily be accomplished within the
5962: pkginstall framework.
1.1 dsieger 5963:
1.184 rillig 5964: When a package installs X11 fonts, it must list the directories in which fonts
5965: are installed in the FONTS_DIRS.type variables, where type can be one of "ttf",
5966: "type1" or "x11". This will add hooks to the installation scripts to run the
5967: appropriate commands to update the fonts database files within each of those
5968: directories. For convenience, if the directory path is relative, it is taken to
5969: be relative to the package's installation prefix. Consider the following
5970: example, taken from fonts/dbz-ttf:
1.1 dsieger 5971:
1.184 rillig 5972: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5973:
1.184 rillig 5974: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 5975:
1.184 rillig 5976: The automatic update of fonts databases can be disabled by the administrator by
5977: setting the PKG_UPDATE_FONTS_DB environment variable to NO.
1.1 dsieger 5978:
1.154 rillig 5979: Chapter 21. Making your package work
1.1 dsieger 5980:
5981: Table of Contents
5982:
1.154 rillig 5983: 21.1. General operation
1.1 dsieger 5984:
1.154 rillig 5985: 21.1.1. How to pull in user-settable variables from mk.conf
5986: 21.1.2. User interaction
5987: 21.1.3. Handling licenses
5988: 21.1.4. Restricted packages
5989: 21.1.5. Handling dependencies
5990: 21.1.6. Handling conflicts with other packages
5991: 21.1.7. Packages that cannot or should not be built
5992: 21.1.8. Packages which should not be deleted, once installed
5993: 21.1.9. Handling packages with security problems
5994: 21.1.10. How to handle incrementing versions when fixing an existing
1.1 dsieger 5995: package
1.154 rillig 5996: 21.1.11. Substituting variable text in the package files (the SUBST
1.1 dsieger 5997: framework)
5998:
1.154 rillig 5999: 21.2. The fetch phase
1.1 dsieger 6000:
1.154 rillig 6001: 21.2.1. Packages whose distfiles aren't available for plain downloading
6002: 21.2.2. How to handle modified distfiles with the 'old' name
6003: 21.2.3. Packages hosted on github.com
6004:
6005: 21.3. The configure phase
6006:
6007: 21.3.1. Shared libraries - libtool
6008: 21.3.2. Using libtool on GNU packages that already support libtool
6009: 21.3.3. GNU Autoconf/Automake
6010:
6011: 21.4. Programming languages
6012:
6013: 21.4.1. C, C++, and Fortran
6014: 21.4.2. Java
6015: 21.4.3. Packages containing perl scripts
6016: 21.4.4. Packages containing shell scripts
6017: 21.4.5. Other programming languages
6018:
6019: 21.5. The build phase
6020:
6021: 21.5.1. Compiling C and C++ code conditionally
6022: 21.5.2. How to handle compiler bugs
1.172 rillig 6023: 21.5.3. No such file or directory
6024: 21.5.4. Undefined reference to "..."
6025: 21.5.5. Running out of memory
1.154 rillig 6026:
6027: 21.6. The install phase
6028:
6029: 21.6.1. Creating needed directories
6030: 21.6.2. Where to install documentation
6031: 21.6.3. Installing highscore files
6032: 21.6.4. Adding DESTDIR support to packages
6033: 21.6.5. Packages with hardcoded paths to other interpreters
6034: 21.6.6. Packages installing perl modules
6035: 21.6.7. Packages installing info files
6036: 21.6.8. Packages installing man pages
6037: 21.6.9. Packages installing GConf data files
6038: 21.6.10. Packages installing scrollkeeper/rarian data files
6039: 21.6.11. Packages installing X11 fonts
6040: 21.6.12. Packages installing GTK2 modules
6041: 21.6.13. Packages installing SGML or XML data
6042: 21.6.14. Packages installing extensions to the MIME database
6043: 21.6.15. Packages using intltool
6044: 21.6.16. Packages installing startup scripts
6045: 21.6.17. Packages installing TeX modules
6046: 21.6.18. Packages supporting running binaries in emulation
6047: 21.6.19. Packages installing hicolor theme icons
6048: 21.6.20. Packages installing desktop files
1.1 dsieger 6049:
1.154 rillig 6050: 21.7. Marking packages as having problems
1.1 dsieger 6051:
1.154 rillig 6052: 21.1. General operation
1.1 dsieger 6053:
6054: One appealing feature of pkgsrc is that it runs on many different platforms. As
6055: a result, it is important to ensure, where possible, that packages in pkgsrc
6056: are portable. This chapter mentions some particular details you should pay
6057: attention to while working on pkgsrc.
6058:
1.154 rillig 6059: 21.1.1. How to pull in user-settable variables from mk.conf
1.1 dsieger 6060:
6061: The pkgsrc user can configure pkgsrc by overriding several variables in the
1.4 rillig 6062: file pointed to by MAKECONF, which is mk.conf by default. When you want to use
6063: those variables in the preprocessor directives of make(1) (for example .if or
6064: .for), you need to include the file ../../mk/bsd.prefs.mk before, which in turn
6065: loads the user preferences.
1.1 dsieger 6066:
6067: But note that some variables may not be completely defined after ../../mk/
6068: bsd.prefs.mk has been included, as they may contain references to variables
1.108 rillig 6069: that are not yet defined. In shell commands (the lines in Makefile that are
6070: indented with a tab) this is no problem, since variables are only expanded when
6071: they are used. But in the preprocessor directives mentioned above and in
6072: dependency lines (of the form target: dependencies) the variables are expanded
6073: at load time.
1.1 dsieger 6074:
6075: Note
6076:
1.108 rillig 6077: To check whether a variable can be used at load time, run pkglint -Wall on your
6078: package.
1.1 dsieger 6079:
1.154 rillig 6080: 21.1.2. User interaction
1.1 dsieger 6081:
6082: Occasionally, packages require interaction from the user, and this can be in a
6083: number of ways:
6084:
6085: * When fetching the distfiles, some packages require user interaction such as
6086: entering username/password or accepting a license on a web page.
6087:
6088: * When extracting the distfiles, some packages may ask for passwords.
6089:
6090: * help to configure the package before it is built
6091:
6092: * help during the build process
6093:
6094: * help during the installation of a package
6095:
1.108 rillig 6096: A package can set the INTERACTIVE_STAGE variable to define which stages need
6097: interaction. This should be done in the package's Makefile, e.g.:
1.1 dsieger 6098:
6099: INTERACTIVE_STAGE= configure install
6100:
6101: The user can then decide to skip this package by setting the BATCH variable.
1.108 rillig 6102: Packages that require interaction are also excluded from bulk builds.
1.1 dsieger 6103:
1.154 rillig 6104: 21.1.3. Handling licenses
1.1 dsieger 6105:
6106: Authors of software can choose the licence under which software can be copied.
1.111 sevan 6107: The Free Software Foundation has declared some licenses "Free", and the Open
6108: Source Initiative has a definition of "Open Source".
6109:
6110: By default, pkgsrc allows packages with Free or Open Source licenses to be
6111: built. To allow packages with other licenses to be built as well, the pkgsrc
6112: user needs to add these licenses to the ACCEPTABLE_LICENSES variable in mk.conf
6113: . Note that this variable only affects which packages may be built, while the
6114: license terms often also restrict the actual use of the package and its
6115: redistribution.
1.1 dsieger 6116:
6117: One might want to only install packages with a BSD license, or the GPL, and not
1.20 jnemeth 6118: the other. The free licenses are added to the default ACCEPTABLE_LICENSES
1.111 sevan 6119: variable. The pkgsrc user can override the default by setting the
6120: ACCEPTABLE_LICENSES variable with "=" instead of "+=". The licenses accepted by
6121: default are defined in the DEFAULT_ACCEPTABLE_LICENSES variable in the file
6122: pkgsrc/mk/license.mk.
1.1 dsieger 6123:
6124: The license tag mechanism is intended to address copyright-related issues
6125: surrounding building, installing and using a package, and not to address
1.20 jnemeth 6126: redistribution issues (see RESTRICTED and NO_SRC_ON_FTP, etc.). Packages with
6127: redistribution restrictions should set these tags.
1.1 dsieger 6128:
6129: Denoting that a package may be copied according to a particular license is done
6130: by placing the license in pkgsrc/licenses and setting the LICENSE variable to a
6131: string identifying the license, e.g. in graphics/xv:
6132:
6133: LICENSE= xv-license
6134:
6135: When trying to build, the user will get a notice that the package is covered by
6136: a license which has not been placed in the ACCEPTABLE_LICENSES variable:
6137:
6138: % make
6139: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6140: ===> To view the license, enter "/usr/bin/make show-license".
6141: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6142: ===> ACCEPTABLE_LICENSES+=xv-license
6143: *** Error code 1
6144:
6145: The license can be viewed with make show-license, and if the user so chooses,
1.4 rillig 6146: the line printed above can be added to mk.conf to convey to pkgsrc that it
1.1 dsieger 6147: should not in the future fail because of that license:
6148:
6149: ACCEPTABLE_LICENSES+=xv-license
6150:
1.111 sevan 6151: The use of LICENSE=shareware, LICENSE=no-commercial-use, and similar language
6152: is deprecated because it does not crisply refer to a particular license text.
6153: Another problem with such usage is that it does not enable a user to tell
6154: pkgsrc to proceed for a single package without also telling pkgsrc to proceed
6155: for all packages with that tag.
6156:
1.154 rillig 6157: 21.1.3.1. Adding a package with a new license
1.1 dsieger 6158:
1.49 rodent 6159: When adding a package with a new license, the following steps are required:
6160:
1.111 sevan 6161: 1. Check whether the license qualifies as Free or Open Source by referencing
6162: Various Licenses and Comments about Them and Licenses by Name | Open Source
6163: Initiative. If this is the case, the filename in pkgsrc/licenses/ does not
6164: need the -license suffix, and the license name should be added to:
1.49 rodent 6165:
6166: + DEFAULT_ACCEPTABLE_LICENSES in pkgsrc/mk/license.mk
6167:
6168: + default_acceptable_licenses in pkgsrc/pkgtools/pkg_install/files/lib/
6169: license.c
6170:
6171: 2. The license text should be added to pkgsrc/licenses for displaying. A list
6172: of known licenses can be seen in this directory.
1.1 dsieger 6173:
1.154 rillig 6174: 21.1.3.2. Change to the license
1.1 dsieger 6175:
1.111 sevan 6176: When the license changes (in a way other than formatting), make sure that the
6177: new license has a different name (e.g., append the version number if it exists,
6178: or the date). Just because a user told pkgsrc to build programs under a
6179: previous version of a license does not mean that pkgsrc should build programs
6180: under the new licenses. The higher-level point is that pkgsrc does not evaluate
6181: licenses for reasonableness; the only test is a mechanistic test of whether a
6182: particular text has been approved by either of two bodies (FSF or OSI).
1.1 dsieger 6183:
1.154 rillig 6184: 21.1.4. Restricted packages
1.1 dsieger 6185:
1.111 sevan 6186: Some licenses restrict how software may be re-distributed. By declaring the
6187: restrictions, package tools can automatically refrain from e.g. placing binary
6188: packages on FTP sites.
6189:
6190: There are four possible restrictions, which are the cross product of sources
6191: (distfiles) and binaries not being placed on FTP sites and CD-ROMs. Because
6192: this is rarely the exact language in any license, and because non-Free licenses
6193: tend to be different from each other, pkgsrc adopts a definition of FTP and
6194: CD-ROM. "FTP" means making the source or binary file available over the
6195: Internet at no charge. "CD-ROM" means making the source or binary available on
6196: some kind of media, together with other source and binary packages, which is
6197: sold for a distribution charge.
1.1 dsieger 6198:
6199: In order to encode these restrictions, the package system defines five make
6200: variables that can be set to note these restrictions:
6201:
6202: * RESTRICTED
6203:
6204: This variable should be set whenever a restriction exists (regardless of
6205: its kind). Set this variable to a string containing the reason for the
6206: restriction. It should be understood that those wanting to understand the
6207: restriction will have to read the license, and perhaps seek advice of
6208: counsel.
6209:
6210: * NO_BIN_ON_CDROM
6211:
6212: Binaries may not be placed on CD-ROM containing other binary packages, for
6213: which a distribution charge may be made. In this case, set this variable to
6214: ${RESTRICTED}.
6215:
6216: * NO_BIN_ON_FTP
6217:
6218: Binaries may not made available on the Internet without charge. In this
6219: case, set this variable to ${RESTRICTED}. If this variable is set, binary
6220: packages will not be included on ftp.NetBSD.org.
6221:
6222: * NO_SRC_ON_CDROM
6223:
6224: Distfiles may not be placed on CD-ROM, together with other distfiles, for
6225: which a fee may be charged. In this case, set this variable to $
6226: {RESTRICTED}.
6227:
6228: * NO_SRC_ON_FTP
6229:
6230: Distfiles may not made available via FTP at no charge. In this case, set
6231: this variable to ${RESTRICTED}. If this variable is set, the distfile(s)
6232: will not be mirrored on ftp.NetBSD.org.
6233:
1.111 sevan 6234: Please note that packages will be removed from pkgsrc when the distfiles are
1.33 wiz 6235: not distributable and cannot be obtained for a period of one full quarter
1.111 sevan 6236: branch. Packages with manual/interactive fetch must have a maintainer and it is
6237: his/her responsibility to ensure this.
1.33 wiz 6238:
1.154 rillig 6239: 21.1.5. Handling dependencies
1.1 dsieger 6240:
1.175 gutterid 6241: Your package may depend on some other package being present, and there are
6242: various ways of expressing this dependency. pkgsrc supports the DEPENDS,
6243: BUILD_DEPENDS, TOOL_DEPENDS, and TEST_DEPENDS definitions, the USE_TOOLS
6244: definition, as well as dependencies via buildlink3.mk, which is the preferred
6245: way to handle dependencies, and which uses the variables named above. See
1.184 rillig 6246: Chapter 18, Buildlink methodology for more information.
1.175 gutterid 6247:
6248: The basic difference is that the DEPENDS definition registers that
6249: pre-requisite in the binary package so it will be pulled in when the binary
6250: package is later installed, whilst the BUILD_DEPENDS, TOOL_DEPENDS, and
6251: TEST_DEPENDS definitions do not, marking a dependency that is only needed for
1.184 rillig 6252: building or testing the resulting package. See also Chapter 14, Creating a new
1.175 gutterid 6253: pkgsrc package from scratch for more information.
6254:
6255: This means that if you only need a package present whilst you are building or
6256: testing, it should be noted as a TOOL_DEPENDS, BUILD_DEPENDS, or TEST_DEPENDS.
6257: When cross-compiling, TOOL_DEPENDS are native packages, i.e. packages for the
6258: architecture where the package is built; BUILD_DEPENDS are target packages,
6259: i.e., packages for the architecture for which the package is built.
1.1 dsieger 6260:
1.175 gutterid 6261: The format for a DEPENDS, BUILD_DEPENDS, TOOL_DEPENDS, and TEST_DEPENDS
6262: definition is:
1.1 dsieger 6263:
6264: <pre-req-package-name>:../../<category>/<pre-req-package>
6265:
6266: Please note that the "pre-req-package-name" may include any of the wildcard
6267: version numbers recognized by pkg_info(1).
6268:
1.55 wiz 6269: 1. If your package needs another package's binaries or libraries to build and
1.1 dsieger 6270: run, and if that package has a buildlink3.mk file available, use it:
6271:
6272: .include "../../graphics/jpeg/buildlink3.mk"
6273:
1.55 wiz 6274: 2. If your package needs another package's binaries or libraries only for
6275: building, and if that package has a buildlink3.mk file available, use it:
6276:
6277: .include "../../graphics/jpeg/buildlink3.mk"
6278:
6279: but set BUILDLINK_DEPMETHOD.jpeg?=build to make it a build dependency only.
6280: This case is rather rare.
6281:
6282: 3. If your package needs binaries from another package to build, use the
1.156 leot 6283: TOOL_DEPENDS definition:
6284:
6285: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.1 dsieger 6286:
1.156 leot 6287: 4. If your package needs static libraries to link against, header files to
6288: include, etc. from another package to build, use the BUILD_DEPENDS
6289: definition.
1.1 dsieger 6290:
1.156 leot 6291: 5. If your package needs a library with which to link and there is no
1.26 spz 6292: buildlink3.mk file available, create one. Using DEPENDS won't be sufficient
6293: because the include files and libraries will be hidden from the compiler.
1.1 dsieger 6294:
1.156 leot 6295: 6. If your package needs some executable to be able to run correctly and if
1.26 spz 6296: there's no buildlink3.mk file, this is specified using the DEPENDS
6297: variable. The print/lyx package needs to be able to execute the latex
1.129 wiz 6298: binary from the tex-latex-bin package when it runs, and that is specified:
1.1 dsieger 6299:
1.129 wiz 6300: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.1 dsieger 6301:
1.175 gutterid 6302: 7. If your package includes a test suite that has extra dependencies only
6303: required for this purpose (frequently this can be run as a "make test"
6304: target), use the TEST_DEPENDS variable.
6305:
6306: 8. You can use wildcards in package dependencies. Note that such wildcard
1.26 spz 6307: dependencies are retained when creating binary packages. The dependency is
6308: checked when installing the binary package and any package which matches
6309: the pattern will be used. Wildcard dependencies should be used with care.
1.1 dsieger 6310:
6311: The "-[0-9]*" should be used instead of "-*" to avoid potentially ambiguous
6312: matches such as "tk-postgresql" matching a "tk-*" DEPENDS.
6313:
6314: Wildcards can also be used to specify that a package will only build
6315: against a certain minimum version of a pre-requisite:
6316:
1.26 spz 6317: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 6318:
1.26 spz 6319: This means that the package will build using version 6.0 of ImageMagick or
6320: newer. Such a dependency may be warranted if, for example, the command line
6321: options of an executable have changed.
6322:
1.183 wiz 6323: If you need to depend on minimum versions of libraries, set
6324: BUILDLINK_API_DEPENDS.pkg to the appropriate pattern before including its
6325: buildlink3.mk file, e.g.
6326:
6327: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
6328: .include "../../graphics/jpeg/buildlink3.mk"
1.1 dsieger 6329:
6330: For security fixes, please update the package vulnerabilities file. See
1.154 rillig 6331: Section 21.1.9, "Handling packages with security problems" for more
1.1 dsieger 6332: information.
6333:
6334: If your package needs files from another package to build, add the relevant
6335: distribution files to DISTFILES, so they will be extracted automatically. See
6336: the print/ghostscript package for an example. (It relies on the jpeg sources
6337: being present in source form during the build.)
6338:
1.154 rillig 6339: 21.1.6. Handling conflicts with other packages
1.1 dsieger 6340:
6341: Your package may conflict with other packages a user might already have
6342: installed on his system, e.g. if your package installs the same set of files as
1.80 wiz 6343: another package in the pkgsrc tree or has the same PKGNAME.
1.1 dsieger 6344:
1.142 leot 6345: For example, x11/libXaw3d and x11/Xaw-Xpm install the same shared library, thus
6346: you set in pkgsrc/x11/libXaw3d/Makefile:
1.1 dsieger 6347:
1.142 leot 6348: CONFLICTS= Xaw-Xpm-[0-9]*
1.1 dsieger 6349:
6350:
1.142 leot 6351: and in pkgsrc/x11/Xaw-Xpm/Makefile:
1.1 dsieger 6352:
1.142 leot 6353: CONFLICTS= libXaw3d-[0-9]*
1.1 dsieger 6354:
1.142 leot 6355:
6356: pkg_add(1) is able to detect attempts to install packages that conflict with
6357: existing packages and abort. However, in many situations this is too late in
6358: the process. Binary package managers will not know about the conflict until
6359: they attempt to install the package after already downloading it and all its
6360: dependencies. Users may also waste time building a package and its dependencies
6361: only to find out at the end that it conflicts with another package they have
6362: installed.
6363:
6364: To avoid these issues CONFLICTS entries should be added in all cases where it
6365: is known that packages conflict with each other. These CONFLICTS entries are
6366: exported in pkg_summary(5) files and consumed by binary package managers to
6367: inform users that packages cannot be installed onto the target system.
1.1 dsieger 6368:
1.154 rillig 6369: 21.1.7. Packages that cannot or should not be built
1.1 dsieger 6370:
6371: There are several reasons why a package might be instructed to not build under
6372: certain circumstances. If the package builds and runs on most platforms, the
1.83 dholland 6373: exceptions should be noted with BROKEN_ON_PLATFORM. If the package builds and
6374: runs on a small handful of platforms, set BROKEN_EXCEPT_ON_PLATFORM instead.
6375: Both BROKEN_ON_PLATFORM and BROKEN_EXCEPT_ON_PLATFORM are OS triples
6376: (OS-version-platform) that can use glob-style wildcards.
6377:
1.114 maya 6378: If a package is not appropriate for some platforms (as opposed to merely
1.83 dholland 6379: broken), a different set of variables should be used as this affects failure
6380: reporting and statistics. If the package is appropriate for most platforms, the
6381: exceptions should be noted with NOT_FOR_PLATFORM. If the package is appropriate
6382: for only a small handful of platforms (often exactly one), set
6383: ONLY_FOR_PLATFORM instead. Both ONLY_FOR_PLATFORM and NOT_FOR_PLATFORM are OS
6384: triples (OS-version-platform) that can use glob-style wildcards.
1.1 dsieger 6385:
6386: Some packages are tightly bound to a specific version of an operating system,
6387: e.g. LKMs or sysutils/lsof. Such binary packages are not backwards compatible
6388: with other versions of the OS, and should be uploaded to a version specific
6389: directory on the FTP server. Mark these packages by setting OSVERSION_SPECIFIC
6390: to "yes". This variable is not currently used by any of the package system
6391: internals, but may be used in the future.
6392:
6393: If the package should be skipped (for example, because it provides
6394: functionality already provided by the system), set PKG_SKIP_REASON to a
6395: descriptive message. If the package should fail because some preconditions are
6396: not met, set PKG_FAIL_REASON to a descriptive message.
6397:
1.154 rillig 6398: 21.1.8. Packages which should not be deleted, once installed
1.1 dsieger 6399:
6400: To ensure that a package may not be deleted, once it has been installed, the
6401: PKG_PRESERVE definition should be set in the package Makefile. This will be
1.25 wiz 6402: carried into any binary package that is made from this pkgsrc entry. A "
6403: preserved" package will not be deleted using pkg_delete(1) unless the "-f"
1.1 dsieger 6404: option is used.
6405:
1.154 rillig 6406: 21.1.9. Handling packages with security problems
1.1 dsieger 6407:
6408: When a vulnerability is found, this should be noted in localsrc/security/
1.32 wiz 6409: advisories/pkg-vulnerabilities, and after committing that file, ask
6410: pkgsrc-security@NetBSD.org to update the file on ftp.NetBSD.org.
1.1 dsieger 6411:
6412: After fixing the vulnerability by a patch, its PKGREVISION should be increased
6413: (this is of course not necessary if the problem is fixed by using a newer
1.32 wiz 6414: release of the software), and the pattern in the pkg-vulnerabilities file must
6415: be updated.
1.1 dsieger 6416:
6417: Also, if the fix should be applied to the stable pkgsrc branch, be sure to
6418: submit a pullup request!
6419:
6420: Binary packages already on ftp.NetBSD.org will be handled semi-automatically by
6421: a weekly cron job.
6422:
1.154 rillig 6423: 21.1.10. How to handle incrementing versions when fixing an existing package
1.1 dsieger 6424:
6425: When making fixes to an existing package it can be useful to change the version
6426: number in PKGNAME. To avoid conflicting with future versions by the original
6427: author, a "nb1", "nb2", ... suffix can be used on package versions by setting
6428: PKGREVISION=1 (2, ...). The "nb" is treated like a "." by the package tools.
6429: e.g.
6430:
6431: DISTNAME= foo-17.42
6432: PKGREVISION= 9
6433:
6434: will result in a PKGNAME of "foo-17.42nb9". If you want to use the original
6435: value of PKGNAME without the "nbX" suffix, e.g. for setting DIST_SUBDIR, use
6436: PKGNAME_NOREV.
6437:
6438: When a new release of the package is released, the PKGREVISION should be
6439: removed, e.g. on a new minor release of the above package, things should be
6440: like:
6441:
6442: DISTNAME= foo-17.43
6443:
6444: PKGREVISION should be incremented for any non-trivial change in the resulting
6445: binary package. Without a PKGREVISION bump, someone with the previous version
6446: installed has no way of knowing that their package is out of date. Thus,
6447: changes without increasing PKGREVISION are essentially labeled "this is so
6448: trivial that no reasonable person would want to upgrade", and this is the rough
6449: test for when increasing PKGREVISION is appropriate. Examples of changes that
6450: do not merit increasing PKGREVISION are:
6451:
1.14 jmcneill 6452: * Changing HOMEPAGE, MAINTAINER, OWNER, or comments in Makefile.
1.1 dsieger 6453:
6454: * Changing build variables if the resulting binary package is the same.
6455:
6456: * Changing DESCR.
6457:
6458: * Adding PKG_OPTIONS if the default options don't change.
6459:
6460: Examples of changes that do merit an increase to PKGREVISION include:
6461:
6462: * Security fixes
6463:
6464: * Changes or additions to a patch file
6465:
6466: * Changes to the PLIST
6467:
1.12 weinem 6468: * A dependency is changed or renamed.
6469:
1.1 dsieger 6470: PKGREVISION must also be incremented when dependencies have ABI changes.
6471:
1.154 rillig 6472: 21.1.11. Substituting variable text in the package files (the SUBST framework)
1.1 dsieger 6473:
1.180 rillig 6474: When you want to replace the same text in multiple files, or multiple times in
6475: the same file, it is cumbersome to maintain a patch file for this. This is
6476: where the SUBST framework steps in. It provides an easy-to-use interface for
6477: replacing text in files. It just needs the following information:
1.172 rillig 6478:
1.180 rillig 6479: * In which phase of the package build cycle should the replacement happen?
1.172 rillig 6480:
1.180 rillig 6481: * In which files should the replacement happen?
1.172 rillig 6482:
6483: * Which text should be replaced with what?
6484:
1.180 rillig 6485: This information is encoded in a block of SUBST variables. A minimal example
6486: is:
6487:
6488: SUBST_CLASSES+= paths
6489: SUBST_STAGE.paths= pre-configure
6490: SUBST_FILES.paths= src/*.c
6491: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
6492:
6493: Translated into English, it means: In the pre-configure stage (that is, after
6494: applying the patches from the patches/ directory and before running the
6495: configure script and the portability check), replace the text /usr/local with
6496: the content of the variable PREFIX.
6497:
6498: Each SUBST block starts by appending an identifier to SUBST_CLASSES (note the +
6499: =). This identifier can be chosen freely by the package. If there should ever
6500: be duplicate identifiers, the pkgsrc infrastructure will catch this and fail
6501: early, so don't worry about name collisions.
6502:
6503: Except for SUBST_CLASSES, all variables in a SUBST block are parameterized
6504: using this identifier. In the remainder of this section, these parameterized
6505: variables are written as SUBST_STAGE.*.
6506:
6507: SUBST_CLASSES+= paths
6508: SUBST_STAGE.paths= pre-configure
6509: SUBST_MESSAGE.paths= Fixing absolute paths.
6510: SUBST_FILES.paths= src/*.c
6511: SUBST_FILES.paths+= scripts/*.sh
6512: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
6513: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
6514: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
6515:
6516: To get a complete picture about the SUBST substitutions, run bmake
6517: show-all-subst. If something doesn't work as expected, run pkglint on the
6518: package, which detects several typical mistakes surrounding the SUBST blocks.
6519: For any questions that might remain after this, have a look at mk/subst.mk.
6520:
6521: 21.1.11.1. Choosing the time where the substitutions happen
6522:
6523: The SUBST_STAGE.* is one of {pre,do,post}-
6524: {extract,patch,configure,build,test,install}. Of these, pre-configure is used
6525: most often, by far. The most popular stages are, in chronological order:
6526:
6527: post-extract
6528:
6529: The substitutions are applied immediately after the distfiles are
6530: extracted. Running bmake extract on the package will leave no traces of the
6531: original files.
6532:
6533: When the substitution applies to files for which there is also a patch in
6534: the patches/ directory, this means that the patches will be computed based
6535: on the result of the substitution. When these patches are sent to the
6536: upstream maintainer later, to be fixed in the upstream package, these
6537: patches may no longer match what the upstream author is used to. Because of
6538: this, pre-configure is often a better choice.
6539:
6540: pre-configure
6541:
6542: The substitutions are applied after the patches from the patches/
6543: directory. This makes it possible to run bmake patch on the package, after
6544: which the patches can be edited using the tools pkgvi and mkpatches from
6545: the pkgtools/pkgdiff package.
6546:
6547: When updating the patches, it is helpful to explicitly separate the bmake
6548: patch from the bmake configure, and to only edit the patches between these
6549: commands. Otherwise the substitutions from the SUBST block will end up in
6550: the patch file. When this happens in really obvious ways, pkglint will
6551: complain about patches that contain a hard-coded /usr/pkg instead of the
6552: correct and intended @PREFIX@, but it can only detect these really obvious
6553: cases.
6554:
6555: do-configure
6556:
6557: This stage should only be used if the package defines a pre-configure
6558: action itself, and the substitution must happen after that. Typical
6559: examples are packages that use the pre-configure stage to regenerate the
6560: GNU configure script from configure.ac.
6561:
6562: post-configure
6563:
6564: This stage is used to fix up any mistakes by the configure stage.
6565:
6566: pre-build
6567:
6568: This stage should only be used for substitutions that are clearly related
6569: to building the package, not for fixing the configuration. Substitutions
6570: for pathnames (such as replacing /usr/local with ${PREFIX}) or user names
6571: (such as replacing @MY_USER@ with the actual username) belong in
6572: pre-configure or post-configure instead.
6573:
6574: post-build
6575:
6576: Just as with pre-build, this stage should only be used for substitutions
6577: that are clearly related to building the package, not for fixing the
6578: configuration. Substitutions for pathnames (such as replacing /usr/local
6579: with ${PREFIX}) or user names (such as replacing @MY_USER@ with the actual
6580: username) belong in pre-configure or post-configure instead.
6581:
6582: A typical use is to update pkg-config files to include the rpath compiler
6583: options.
6584:
6585: pre-install
6586:
6587: In general, the install phase should be as simple as possible. As with the
6588: pre-build and post-build stages, it should not be used to fix pathnames or
6589: user names, these belong in pre-configure instead. There are only few
6590: legitimate use cases for applying substitutions in this stage.
6591:
1.181 rillig 6592: 21.1.11.2. Choosing the files where the substitutions happen
1.180 rillig 6593:
6594: The SUBST_FILES.* variable contains a list of filename patterns. These patterns
6595: are relative to WRKSRC since that is where most substitutions happen. A typical
6596: example is:
6597:
6598: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
6599:
6600: The above patterns, especially the last, are quite broad. The SUBST
6601: implementation checks that each filename pattern that is mentioned here has an
6602: effect. For example, if none of the */*/Makefile files contains the patterns to
6603: be found and substituted, that filename pattern is redundant and should be left
1.181 rillig 6604: out. By default, the SUBST framework will complain with an error message. If
6605: the text to be substituted occurs in some of the files from a single pattern,
6606: but not in all of them, that is totally ok, and the SUBST framework will only
6607: print an INFO message for those files.
1.180 rillig 6608:
6609: If there is a good reason for having redundant filename patterns, set
1.181 rillig 6610: SUBST_NOOP_OK.* to yes.
1.180 rillig 6611:
6612: Another popular way of choosing the files for the substitutions is via a shell
6613: command, like this:
6614:
1.181 rillig 6615: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 6616: SUBST_FILES.path= ${C_FILES_CMD:sh}
6617:
6618: The variable name C_FILES_CMD in this example is freely chosen and independent
6619: of the SUBST framework.
6620:
6621: In this variant, the SUBST_FILES.* variable lists each file individually.
6622: Thereby chances are higher that there are filename patterns in which no
6623: substitution happens. Since the SUBST framework cannot know whether the
6624: filename patterns in SUBST_FILES.* have been explicitly listed in the Makefile
6625: (where any redundant filename pattern would be suspicious) or been generated by
6626: a shell command (in which redundant filename patterns are more likely and to be
6627: expected), it will complain about these redundant filename patterns. Therefore,
6628: SUBST blocks that use a shell command to generate the list of filename patterns
6629: often need to set SUBST_NOOP_OK.* to yes.
6630:
6631: 21.1.11.3. Choosing what to substitute
6632:
6633: In most cases, the substitutions are given using one or more sed(1) commands,
6634: like this:
6635:
6636: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
6637:
6638: Each of the sed commands needs to be preceded by the -e option and should be
6639: specified on a line of its own, to avoid hiding short sed commands at the end
6640: of a line.
6641:
6642: Since the sed commands often contain shell metacharacters as the separator (the
6643: | in the above example), it is common to enclose them in single quotes.
6644:
6645: A common substitution is to replace placeholders of the form @VARNAME@ with
6646: their pkgsrc counterpart variable ${VARNAME}. A typical example is:
6647:
6648: SUBST_VARS.path= PREFIX
6649:
1.181 rillig 6650: This type of substitutions is typically done by the GNU configure scripts
6651: during the do-configure stage, but in some cases these need to be overridden.
6652: The same pattern is also used when a package defines patches that replace
6653: previously hard-coded paths like /usr/local with a @PREFIX@ placeholder first,
6654: which then gets substituted by the actual ${PREFIX} in the pre-configure stage.
6655: In many of these cases, it works equally well to just use the SUBST framework
6656: to directly replace /usr/local with ${PREFIX}, thereby omitting the
6657: intermediate patch file.
1.180 rillig 6658:
6659: If the above is not flexible enough, it is possible to not use sed at all for
6660: the substitution but to specify an entirely different command, like this:
6661:
6662: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
1.1 dsieger 6663:
1.180 rillig 6664: This is used for the few remaining packages in which the distributed files use
6665: Windows-style line endings that need to be converted to UNIX-style line
6666: endings.
1.1 dsieger 6667:
1.180 rillig 6668: 21.1.11.4. Other SUBST variables
1.172 rillig 6669:
1.180 rillig 6670: When a SUBST block is applied during a package build, a message is logged. The
6671: default message is fine for most purposes but can be overridden by setting
6672: SUBST_MESSAGE.* to an individual message.
1.1 dsieger 6673:
1.154 rillig 6674: 21.2. The fetch phase
1.1 dsieger 6675:
1.154 rillig 6676: 21.2.1. Packages whose distfiles aren't available for plain downloading
1.1 dsieger 6677:
6678: If you need to download from a dynamic URL you can set DYNAMIC_MASTER_SITES and
6679: a make fetch will call files/getsite.sh with the name of each file to download
6680: as an argument, expecting it to output the URL of the directory from which to
6681: download it. graphics/ns-cult3d is an example of this usage.
6682:
6683: If the download can't be automated, because the user must submit personal
6684: information to apply for a password, or must pay for the source, or whatever,
6685: you can set FETCH_MESSAGE to a list of lines that are displayed to the user
6686: before aborting the build. Example:
6687:
6688: FETCH_MESSAGE= "Please download the files"
6689: FETCH_MESSAGE+= " "${DISTFILES:Q}
6690: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
6691:
1.154 rillig 6692: 21.2.2. How to handle modified distfiles with the 'old' name
1.1 dsieger 6693:
6694: Sometimes authors of a software package make some modifications after the
6695: software was released, and they put up a new distfile without changing the
6696: package's version number. If a package is already in pkgsrc at that time, the
6697: checksum will no longer match. The contents of the new distfile should be
6698: compared against the old one before changing anything, to make sure the
6699: distfile was really updated on purpose, and that no trojan horse or so crept
6700: in. Please mention that the distfiles were compared and what was found in your
1.54 rodent 6701: commit message.
6702:
6703: Then, the correct way to work around this is to set DIST_SUBDIR to a unique
1.109 wiz 6704: directory name, usually based on PKGNAME_NOREV (but take care with python or
6705: ruby packages, where PKGNAME includes a variable prefix). All DISTFILES and
6706: PATCHFILES for this package will be put in that subdirectory of the local
1.154 rillig 6707: distfiles directory. (See Section 21.1.10, "How to handle incrementing versions
1.109 wiz 6708: when fixing an existing package" for more details.) In case this happens more
6709: often, PKGNAME can be used (thus including the nbX suffix) or a date stamp can
6710: be appended, like ${PKGNAME_NOREV}-YYYYMMDD.
1.54 rodent 6711:
6712: DIST_SUBDIR is also used when a distfile's name does not contain a version and
6713: the distfile is apt to change. In cases where the likelihood of this is very
6714: small, DIST_SUBDIR might not be required. Additionally, DIST_SUBDIR must not be
6715: removed unless the distfile name changes, even if a package is being moved or
6716: renamed.
6717:
6718: Do not forget regenerating the distinfo file after that, since it contains the
6719: DIST_SUBDIR path in the filenames. Also, increase the PKGREVISION if the
6720: installed package is different. Furthermore, a mail to the package's authors
6721: seems appropriate telling them that changing distfiles after releases without
6722: changing the file names is not good practice.
1.1 dsieger 6723:
1.154 rillig 6724: 21.2.3. Packages hosted on github.com
1.88 tnn 6725:
1.90 tnn 6726: Helper methods exist for packages hosted on github.com which will often have
6727: distfile names that clash with other packages, for example 1.0.tar.gz. Use one
6728: of the three recipes from below:
1.88 tnn 6729:
1.154 rillig 6730: 21.2.3.1. Fetch based on a tagged release
1.88 tnn 6731:
1.189 bacon 6732: If your distfile URL looks similar to https://github.com/username/example/
6733: archive/v1.0.zip, then you are packaging a tagged release.
1.88 tnn 6734:
1.189 bacon 6735: DISTNAME= example-1.0
1.90 tnn 6736: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 6737: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 6738: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 6739: EXTRACT_SUFX= .zip
6740:
1.189 bacon 6741: 21.2.3.2. Fetch based on a specific commit before the first release
6742:
6743: If your distfile looks similar to https://github.com/username/example/archive/
6744: 988881adc9fc3655077dc2d4d757d480b5ea0e11 and is from a commit before the first
6745: release, then set the package version to 0.0.0.N, where N is the number of
6746: commits to the repository, and set GITHUB_TAG to the commit hash. This will
6747: (almost) ensure that the first tagged release will have a version greater than
6748: this one so that package upgrades will function properly.
6749:
6750: DISTNAME= example-0.0.0.347
6751: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6752: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
6753: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
6754:
6755: 21.2.3.3. Fetch based on a specific commit after a release
1.88 tnn 6756:
1.189 bacon 6757: If your distfile looks similar to https://github.com/username/example/archive/
6758: 988881adc9fc3655077dc2d4d757d480b5ea0e11 and is from a commit after a release,
6759: then include the last release version and the commit count since that release
6760: in the package version and set GITHUB_TAG to the commit hash. The latest
6761: release and commit count are shown in the output of "git describe --tags":
6762:
6763: # git clone https://github.com/username/example
6764: # cd example
6765: # git describe --tags
6766: 1.2.3-5-g988881a
1.88 tnn 6767:
1.189 bacon 6768: DISTNAME= example-1.2.3.5
6769: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6770: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 6771: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.88 tnn 6772:
1.189 bacon 6773: 21.2.3.4. Fetch based on release
1.88 tnn 6774:
1.189 bacon 6775: If your distfile URL looks similar to https://github.com/username/example/
6776: releases/download/rel-1.6/offensive-1.6.zip, then you are packaging a release.
1.88 tnn 6777:
1.90 tnn 6778: DISTNAME= offensive-1.6
1.88 tnn 6779: PKGNAME= ${DISTNAME:S/offensive/proper/}
1.90 tnn 6780: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 6781: GITHUB_PROJECT= example
1.90 tnn 6782: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
6783: EXTRACT_SUFX= .zip
1.88 tnn 6784:
1.154 rillig 6785: 21.3. The configure phase
1.1 dsieger 6786:
1.154 rillig 6787: 21.3.1. Shared libraries - libtool
1.1 dsieger 6788:
6789: pkgsrc supports many different machines, with different object formats like
6790: a.out and ELF, and varying abilities to do shared library and dynamic loading
6791: at all. To accompany this, varying commands and options have to be passed to
6792: the compiler, linker, etc. to get the Right Thing, which can be pretty annoying
6793: especially if you don't have all the machines at your hand to test things. The
6794: devel/libtool pkg can help here, as it just "knows" how to build both static
6795: and dynamic libraries from a set of source files, thus being
6796: platform-independent.
6797:
6798: Here's how to use libtool in a package in seven simple steps:
6799:
6800: 1. Add USE_LIBTOOL=yes to the package Makefile.
6801:
6802: 2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of "$
6803: {CC}". You could even add it to the definition of CC, if only libraries are
6804: being built in a given Makefile. This one command will build both PIC and
6805: non-PIC library objects, so you need not have separate shared and
6806: non-shared library rules.
6807:
6808: 3. For the linking of the library, remove any "ar", "ranlib", and "ld
6809: -Bshareable" commands, and instead use:
6810:
6811: ${LIBTOOL} --mode=link \
6812: ${CC} -o ${.TARGET:.a=.la} \
6813: ${OBJS:.o=.lo} \
6814: -rpath ${PREFIX}/lib \
6815: -version-info major:minor
6816:
6817: Note that the library is changed to have a .la extension, and the objects
6818: are changed to have a .lo extension. Change OBJS as necessary. This
6819: automatically creates all of the .a, .so.major.minor, and ELF symlinks (if
6820: necessary) in the build directory. Be sure to include "-version-info",
6821: especially when major and minor are zero, as libtool will otherwise strip
6822: off the shared library version.
6823:
6824: From the libtool manual:
6825:
6826: So, libtool library versions are described by three integers:
6827:
6828: CURRENT
6829: The most recent interface number that this library implements.
6830:
6831: REVISION
6832: The implementation number of the CURRENT interface.
6833:
6834: AGE
6835: The difference between the newest and oldest interfaces that
6836: this library implements. In other words, the library implements
6837: all the interface numbers in the range from number `CURRENT -
6838: AGE' to `CURRENT'.
6839:
6840: If two libraries have identical CURRENT and AGE numbers, then the
6841: dynamic linker chooses the library with the greater REVISION number.
6842:
6843: The "-release" option will produce different results for a.out and ELF
1.25 wiz 6844: (excluding symlinks) in only one case. An ELF library of the form "
6845: libfoo-release.so.x.y" will have a symlink of "libfoo.so.x.y" on an a.out
1.1 dsieger 6846: platform. This is handled automatically.
6847:
6848: The "-rpath argument" is the install directory of the library being built.
6849:
6850: In the PLIST, include only the .la file, the other files will be added
6851: automatically.
6852:
6853: 4. When linking shared object (.so) files, i.e. files that are loaded via
6854: dlopen(3), NOT shared libraries, use "-module -avoid-version" to prevent
6855: them getting version tacked on.
6856:
6857: The PLIST file gets the foo.so entry.
6858:
6859: 5. When linking programs that depend on these libraries before they are
6860: installed, preface the cc(1) or ld(1) line with "${LIBTOOL} --mode=link",
6861: and it will find the correct libraries (static or shared), but please be
6862: aware that libtool will not allow you to specify a relative path in -L
6863: (such as "-L../somelib"), because it expects you to change that argument to
6864: be the .la file. e.g.
6865:
6866: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
6867:
6868: should be changed to:
6869:
6870: ${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
6871:
6872: and it will do the right thing with the libraries.
6873:
6874: 6. When installing libraries, preface the install(1) or cp(1) command with "$
6875: {LIBTOOL} --mode=install", and change the library name to .la. e.g.
6876:
1.23 jakllsch 6877: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 6878:
6879: This will install the static .a, shared library, any needed symlinks, and
6880: run ldconfig(8).
6881:
6882: 7. In your PLIST, include only the .la file (this is a change from previous
6883: behaviour).
6884:
1.154 rillig 6885: 21.3.2. Using libtool on GNU packages that already support libtool
1.1 dsieger 6886:
6887: Add USE_LIBTOOL=yes to the package Makefile. This will override the package's
6888: own libtool in most cases. For older libtool using packages, libtool is made by
6889: ltconfig script during the do-configure step; you can check the libtool script
6890: location by doing make configure; find work*/ -name libtool.
6891:
6892: LIBTOOL_OVERRIDE specifies which libtool scripts, relative to WRKSRC, to
6893: override. By default, it is set to "libtool */libtool */*/libtool". If this
6894: does not match the location of the package's libtool script(s), set it as
6895: appropriate.
6896:
6897: If you do not need *.a static libraries built and installed, then use
6898: SHLIBTOOL_OVERRIDE instead.
6899:
6900: If your package makes use of the platform-independent library for loading
6901: dynamic shared objects, that comes with libtool (libltdl), you should include
6902: devel/libltdl/buildlink3.mk.
6903:
6904: Some packages use libtool incorrectly so that the package may not work or build
6905: in some circumstances. Some of the more common errors are:
6906:
6907: * The inclusion of a shared object (-module) as a dependent library in an
6908: executable or library. This in itself isn't a problem if one of two things
6909: has been done:
6910:
6911: 1. The shared object is named correctly, i.e. libfoo.la, not foo.la
6912:
6913: 2. The -dlopen option is used when linking an executable.
6914:
6915: * The use of libltdl without the correct calls to initialisation routines.
6916: The function lt_dlinit() should be called and the macro
6917: LTDL_SET_PRELOADED_SYMBOLS included in executables.
6918:
1.154 rillig 6919: 21.3.3. GNU Autoconf/Automake
1.1 dsieger 6920:
6921: If a package needs GNU autoconf or automake to be executed to regenerate the
6922: configure script and Makefile.in makefile templates, then they should be
6923: executed in a pre-configure target.
6924:
6925: For packages that need only autoconf:
6926:
6927: AUTOCONF_REQD= 2.50 # if default version is not good enough
6928: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
6929: ...
6930:
6931: pre-configure:
6932: cd ${WRKSRC} && autoconf
6933:
6934: ...
6935:
6936: and for packages that need automake and autoconf:
6937:
6938: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
6939: USE_TOOLS+= automake # use "automake14" for automake-1.4
6940: ...
6941:
6942: pre-configure:
6943: set -e; cd ${WRKSRC}; \
6944: aclocal; autoheader; automake -a --foreign -i; autoconf
6945:
6946: ...
6947:
6948: Packages which use GNU Automake will almost certainly require GNU Make.
6949:
6950: There are times when the configure process makes additional changes to the
6951: generated files, which then causes the build process to try to re-execute the
6952: automake sequence. This is prevented by touching various files in the configure
6953: stage. If this causes problems with your package you can set AUTOMAKE_OVERRIDE=
6954: NO in the package Makefile.
6955:
1.154 rillig 6956: 21.4. Programming languages
1.1 dsieger 6957:
1.154 rillig 6958: 21.4.1. C, C++, and Fortran
1.1 dsieger 6959:
6960: Compilers for the C, C++, and Fortran languages comes with the NetBSD base
6961: system. By default, pkgsrc assumes that a package is written in C and will hide
1.184 rillig 6962: all other compilers (via the wrapper framework, see Chapter 18, Buildlink
1.1 dsieger 6963: methodology).
6964:
6965: To declare which language's compiler a package needs, set the USE_LANGUAGES
6966: variable. Allowed values currently are "c", "c++", and "fortran" (and any
6967: combination). The default is "c". Packages using GNU configure scripts, even if
6968: written in C++, usually need a C compiler for the configure phase.
6969:
1.154 rillig 6970: 21.4.2. Java
1.1 dsieger 6971:
6972: If a program is written in Java, use the Java framework in pkgsrc. The package
6973: must include ../../mk/java-vm.mk. This Makefile fragment provides the following
6974: variables:
6975:
6976: * USE_JAVA defines if a build dependency on the JDK is added. If USE_JAVA is
6977: set to "run", then there is only a runtime dependency on the JDK. The
6978: default is "yes", which also adds a build dependency on the JDK.
6979:
6980: * Set USE_JAVA2 to declare that a package needs a Java2 implementation. The
6981: supported values are "yes", "1.4", and "1.5". "yes" accepts any Java2
6982: implementation, "1.4" insists on versions 1.4 or above, and "1.5" only
6983: accepts versions 1.5 or above. This variable is not set by default.
6984:
1.25 wiz 6985: * PKG_JAVA_HOME is automatically set to the runtime location of the used Java
6986: implementation dependency. It may be used to set JAVA_HOME to a good value
6987: if the program needs this variable to be defined.
6988:
1.154 rillig 6989: 21.4.3. Packages containing perl scripts
1.1 dsieger 6990:
6991: If your package contains interpreted perl scripts, add "perl" to the USE_TOOLS
6992: variable and set REPLACE_PERL to ensure that the proper interpreter path is
6993: set. REPLACE_PERL should contain a list of scripts, relative to WRKSRC, that
1.74 wiz 6994: you want adjusted. Every occurrence of */bin/perl in a she-bang line will be
6995: replaced with the full path to the perl executable.
1.1 dsieger 6996:
6997: If a particular version of perl is needed, set the PERL5_REQD variable to the
6998: version number. The default is "5.0".
6999:
1.154 rillig 7000: See Section 21.6.6, "Packages installing perl modules" for information about
1.1 dsieger 7001: handling perl modules.
7002:
1.154 rillig 7003: 21.4.4. Packages containing shell scripts
1.41 wiz 7004:
7005: REPLACE_SH, REPLACE_BASH, REPLACE_CSH, and REPLACE_KSH can be used to replace
1.195 gutterid 7006: shell hash bangs in files. Please use the appropriate one, preferring
7007: REPLACE_SH in case this shell is sufficient. Each should contain a list of
7008: scripts, relative to WRKSRC, that you want adjusted. Every occurrence of the
7009: matching shell in a she-bang line will be replaced with the full path to the
7010: shell executable. When using REPLACE_BASH, don't forget to add bash to
7011: USE_TOOLS.
1.41 wiz 7012:
1.154 rillig 7013: 21.4.5. Other programming languages
1.1 dsieger 7014:
7015: Currently, there is no special handling for other languages in pkgsrc. If a
7016: compiler package provides a buildlink3.mk file, include that, otherwise just
7017: add a (build) dependency on the appropriate compiler package.
7018:
1.154 rillig 7019: 21.5. The build phase
1.1 dsieger 7020:
7021: The most common failures when building a package are that some platforms do not
7022: provide certain header files, functions or libraries, or they provide the
7023: functions in a library that the original package author didn't know. To work
7024: around this, you can rewrite the source code in most cases so that it does not
7025: use the missing functions or provides a replacement function.
7026:
1.154 rillig 7027: 21.5.1. Compiling C and C++ code conditionally
1.1 dsieger 7028:
7029: If a package already comes with a GNU configure script, the preferred way to
7030: fix the build failure is to change the configure script, not the code. In the
7031: other cases, you can utilize the C preprocessor, which defines certain macros
7032: depending on the operating system and hardware architecture it compiles for.
7033: These macros can be queried using for example #if defined(__i386). Almost every
7034: operating system, hardware architecture and compiler has its own macro. For
7035: example, if the macros __GNUC__, __i386__ and __NetBSD__ are all defined, you
7036: know that you are using NetBSD on an i386 compatible CPU, and your compiler is
7037: GCC.
7038:
7039: The list of the following macros for hardware and operating system depends on
7040: the compiler that is used. For example, if you want to conditionally compile
7041: code on Solaris, don't use __sun__, as the SunPro compiler does not define it.
7042: Use __sun instead.
7043:
1.154 rillig 7044: 21.5.1.1. C preprocessor macros to identify the operating system
1.1 dsieger 7045:
7046: To distinguish between 4.4 BSD-derived systems and the rest of the world, you
7047: should use the following code.
7048:
7049: #include <sys/param.h>
7050: #if (defined(BSD) && BSD >= 199306)
7051: /* BSD-specific code goes here */
7052: #else
7053: /* non-BSD-specific code goes here */
7054: #endif
7055:
7056: If this distinction is not fine enough, you can also test for the following
7057: macros.
7058:
1.46 obache 7059: Cygwin __CYGWIN__
7060: DragonFly __DragonFly__
1.1 dsieger 7061: FreeBSD __FreeBSD__
1.46 obache 7062: Haiku __HAIKU__
1.1 dsieger 7063: Interix __INTERIX
7064: IRIX __sgi (TODO: get a definite source for this)
7065: Linux linux, __linux, __linux__
1.83 dholland 7066: Mac OS X __APPLE__
1.46 obache 7067: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7068: Minix3 __minix
1.1 dsieger 7069: NetBSD __NetBSD__
7070: OpenBSD __OpenBSD__
7071: Solaris sun, __sun
7072:
1.154 rillig 7073: 21.5.1.2. C preprocessor macros to identify the hardware architecture
1.1 dsieger 7074:
7075: i386 i386, __i386, __i386__
7076: MIPS __mips
7077: SPARC sparc, __sparc
7078:
1.154 rillig 7079: 21.5.1.3. C preprocessor macros to identify the compiler
1.1 dsieger 7080:
7081: GCC __GNUC__ (major version), __GNUC_MINOR__
7082: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7083: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7084: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7085:
1.154 rillig 7086: 21.5.2. How to handle compiler bugs
1.1 dsieger 7087:
7088: Some source files trigger bugs in the compiler, based on combinations of
7089: compiler version and architecture and almost always relation to optimisation
7090: being enabled. Common symptoms are gcc internal errors or never finishing
7091: compiling a file.
7092:
7093: Typically, a workaround involves testing the MACHINE_ARCH and compiler version,
1.87 tnn 7094: disabling optimisation for that combination of file, MACHINE_ARCH and compiler.
7095:
7096: This used to be a big problem in the past, but is rarely needed now as compiler
7097: technology has matured. If you still need to add a compiler specific
7098: workaround, please do so in the file hacks.mk and describe the symptom and
7099: compiler version as detailed as possible.
1.1 dsieger 7100:
1.172 rillig 7101: 21.5.3. No such file or directory
7102:
7103: Compilation sometimes fails with an error message like this:
7104:
7105: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
7106: fatal error: pango/pango.h: No such file or directory
7107:
7108: The proper way to fix this problem depends on the type of the header, which is
7109: described in the following sections.
7110:
7111: 21.5.3.1. Headers from other packages
7112:
7113: If the header name looks like it comes from a different package, that other
7114: package should be included via the buildlink3 framework.
7115:
7116: First, look whether the header is somewhere in the buildlink3 directory below
7117: WRKDIR. In the above case of the missing Pango header:
7118:
7119: $ find work/.buildlink/ -print | grep -F pango/pango.h
7120:
7121: In the case of Pango, the output is:
7122:
7123: work/.buildlink/include/pango-1.0/pango/pango.h
7124:
7125: If the pango/pango.h file were placed directly in the .buildlink directory, it
7126: would have been found automatically. There is an extra pango-1.0 path component
7127: though, which means that the compiler command line must contain an option of
7128: the form -I${BUILDLINK3_PREFIX.pango}/include/pango-1.0. In most cases this
7129: option is generated by the configure script, which can be examined using:
7130:
7131: $ $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
7132: -I/usr/pkg/include/pango-1.0
7133: -I/usr/pkg/include/pango-1.0
7134: -I/usr/pkg/include/pango-1.0
7135: -I/usr/pkg/include/pango-1.0
7136: -I/usr/pkg/include/pango-1.0
7137:
7138: This looks good. These options are transformed by the buildlink wrapper to
7139: refer to the correct path inside work/.buildlink.
7140:
7141: Since the compilation fails though, examine the compiler command lines in work
7142: /.work.log to see whether the -I option is included in the particular command
7143: line.
7144:
7145: To further analyze the situation, run bmake build-env, which sets up an
7146: interactive, realistic environment including all the pkgsrc wrapper commands
7147: and environment variables. From there, try to compile some simple example
7148: programs that use the header.
7149:
7150: 21.5.3.2. Headers generated during the build
7151:
7152: If the name of the header seems to come from the package itself, and if the
7153: build is run with parallel jobs, the package may have some undeclared
7154: dependencies between the .c and the .h files, and a C file is compiled before
7155: its required header is generated.
7156:
7157: To see whether the build runs with parallel jobs, run bmake show-all-build |
7158: grep JOBS. Its output looks like this:
7159:
7160: usr MAKE_JOBS= 7
7161: pkg MAKE_JOBS_SAFE # undefined
7162: def _MAKE_JOBS_N= 7
7163:
7164: In this case the pkgsrc user has asked pkgsrc to build packages with 7 jobs in
7165: parallel (MAKE_JOBS). The package could have disabled parallel builds by
7166: setting MAKE_JOBS_SAFE to no, but in this case it hasn't.
7167:
7168: To see whether the build failure is caused by parallel builds, first save the
7169: exact error message and a bit of context, maybe you need it later for reporting
7170: a bug. Next, run:
7171:
7172: MAKE_JOBS_SAFE=no bmake clean build
7173:
7174: If that succeeds, file a bug report against the pkgsrc package, including the
7175: exact error message and the contents of your mk.conf file.
7176:
1.173 rillig 7177: 21.5.3.3. Symlinks
7178:
7179: Pkgsrc does not work reliably if any of LOCALBASE, VARBASE or WRKDIR contains a
7180: symlink. Since 2019Q2, the pkgsrc bootstrap program prevents installing pkgsrc
7181: in symlink-based directories. Existing pkgsrc installations are not checked for
7182: symlinks though.
7183:
7184: The "No such file or directory" error messages are a typical symptom of
7185: symlinks, and it's quite difficult to find out that this is the actual cause.
7186:
7187: 21.5.3.4. Stale working directories
7188:
7189: When building a hierarchy of packages, it may happen that one package is built
7190: and then pkgsrc is updated. This situation can provoke various hard to diagnose
7191: build errors. To clean up the situation:
7192:
7193: $ (cd ../../ && test -f mk/bsd.pkg.mk && rm -rf */*/work)
7194:
7195: (The test for bsd.pkg.mk just prevents running this command in the wrong
7196: directory.)
7197:
7198: If you have set WRKOBJDIR in mk.conf, remove that directory as well.
7199:
7200: 21.5.3.5. Other possible reasons
7201:
7202: On platforms other than BSD, third-party packages are installed in /usr/
7203: include, together with the base system. This means that pkgsrc cannot
7204: distinguish between headers provided by the base system (which it needs) and
7205: headers from third-party packages (which are often included in pkgsrc as well).
7206: This can lead to subtle version mismatches.
7207:
7208: In pkgsrc installations that have been active for several years, it may happen
7209: that some files are manually deleted. To exclude this unlikely reason, run
7210: pkg_admin check.
7211:
7212: It may help to run pkg_admin rebuild-tree to check/fix dependencies.
7213:
7214: If all of the above doesn't help, see Chapter 2, Getting help for contact
7215: information. Be prepared to describe what you have tried so far and what any
7216: error messages were.
7217:
1.172 rillig 7218: 21.5.4. Undefined reference to "..."
1.1 dsieger 7219:
7220: This error message often means that a package did not link to a shared library
7221: it needs. The following functions are known to cause this error message over
7222: and over.
7223:
7224: +-----------------------------------------------------+
7225: | Function |Library |Affected platforms|
7226: |-------------------------+--------+------------------|
7227: |accept, bind, connect |-lsocket|Solaris |
7228: |-------------------------+--------+------------------|
7229: |crypt |-lcrypt |DragonFly, NetBSD |
7230: |-------------------------+--------+------------------|
7231: |dlopen, dlsym |-ldl |Linux |
7232: |-------------------------+--------+------------------|
7233: |gethost* |-lnsl |Solaris |
7234: |-------------------------+--------+------------------|
7235: |inet_aton |-lresolv|Solaris |
7236: |-------------------------+--------+------------------|
7237: |nanosleep, sem_*, timer_*|-lrt |Solaris |
7238: |-------------------------+--------+------------------|
7239: |openpty |-lutil |Linux |
7240: +-----------------------------------------------------+
7241:
7242: To fix these linker errors, it is often sufficient to say LIBS.OperatingSystem+
7243: = -lfoo to the package Makefile and then say bmake clean; bmake.
7244:
1.172 rillig 7245: 21.5.4.1. Special issue: The SunPro compiler
1.1 dsieger 7246:
7247: When you are using the SunPro compiler, there is another possibility. That
7248: compiler cannot handle the following code:
7249:
7250: extern int extern_func(int);
7251:
7252: static inline int
7253: inline_func(int x)
7254: {
7255: return extern_func(x);
7256: }
7257:
7258: int main(void)
7259: {
7260: return 0;
7261: }
7262:
7263: It generates the code for inline_func even if that function is never used. This
7264: code then refers to extern_func, which can usually not be resolved. To solve
7265: this problem you can try to tell the package to disable inlining of functions.
7266:
1.172 rillig 7267: 21.5.5. Running out of memory
1.1 dsieger 7268:
7269: Sometimes packages fail to build because the compiler runs into an operating
7270: system specific soft limit. With the UNLIMIT_RESOURCES variable pkgsrc can be
1.94 wiz 7271: told to unlimit the resources. Currently, the allowed values are any
7272: combination of "cputime", "datasize", "memorysize", and "stacksize". Setting
7273: this variable is similar to running the shell builtin ulimit command to raise
7274: the maximum data segment size or maximum stack size of a process, respectively,
7275: to their hard limits.
1.1 dsieger 7276:
1.154 rillig 7277: 21.6. The install phase
1.1 dsieger 7278:
1.154 rillig 7279: 21.6.1. Creating needed directories
1.1 dsieger 7280:
7281: The BSD-compatible install supplied with some operating systems cannot create
7282: more than one directory at a time. As such, you should call ${INSTALL_*_DIR}
7283: like this:
7284:
7285: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7286: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
7287:
7288: You can also just append "dir1 dir2" to the INSTALLATION_DIRS variable, which
7289: will automatically do the right thing.
7290:
1.154 rillig 7291: 21.6.2. Where to install documentation
1.1 dsieger 7292:
7293: In general, documentation should be installed into ${PREFIX}/share/doc/$
7294: {PKGBASE} or ${PREFIX}/share/doc/${PKGNAME} (the latter includes the version
7295: number of the package).
7296:
7297: Many modern packages using GNU autoconf allow to set the directory where HTML
7298: documentation is installed with the "--with-html-dir" option. Sometimes using
7299: this flag is needed because otherwise the documentation ends up in ${PREFIX}/
7300: share/doc/html or other places.
7301:
7302: An exception to the above is that library API documentation generated with the
7303: textproc/gtk-doc tools, for use by special browsers (devhelp) should be left at
7304: their default location, which is ${PREFIX}/share/gtk-doc. Such documentation
7305: can be recognized from files ending in .devhelp or .devhelp2. (It is also
7306: acceptable to install such files in ${PREFIX}/share/doc/${PKGBASE} or ${PREFIX}
7307: /share/doc/${PKGNAME}; the .devhelp* file must be directly in that directory
7308: then, no additional subdirectory level is allowed in this case. This is usually
7309: achieved by using "--with-html-dir=${PREFIX}/share/doc". ${PREFIX}/share/
7310: gtk-doc is preferred though.)
7311:
1.154 rillig 7312: 21.6.3. Installing highscore files
1.1 dsieger 7313:
7314: Certain packages, most of them in the games category, install a score file that
7315: allows all users on the system to record their highscores. In order for this to
7316: work, the binaries need to be installed setgid and the score files owned by the
1.36 wiz 7317: appropriate group and/or owner (traditionally the "games" user/group). Set
7318: USE_GAMESGROUP to yes to support this. The following variables, documented in
7319: more detail in mk/defaults/mk.conf, control this behaviour: GAMEDATAMODE,
1.100 leot 7320: GAMEDIRMODE, GAMES_GROUP, GAMEMODE, GAME_USER. Other useful variables are:
7321: GAMEDIR_PERMS, GAMEDATA_PERMS and SETGID_GAMES_PERMS.
7322:
7323: An example that illustrates some of the variables described above is games/
7324: moon-buggy. OWN_DIRS_PERMS is used to properly set directory permissions of the
7325: directory where the scorefile is saved, REQD_FILES_PERMS is used to create a
7326: dummy scorefile (mbscore) with the proper permissions and SPECIAL_PERMS is used
7327: to install setgid the game binary:
7328:
7329: USE_GAMESGROUP= yes
7330:
7331: BUILD_DEFS+= VARBASE
7332:
7333: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
7334: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
7335: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
7336:
7337: Various INSTALL_* variables are also available: INSTALL_GAME to install setgid
7338: game binaries, INSTALL_GAME_DIR to install game directories that are needed to
7339: be accessed by setgid games and INSTALL_GAME_DATA to install scorefiles.
1.1 dsieger 7340:
1.14 jmcneill 7341: A package should therefore never hard code file ownership or access permissions
1.100 leot 7342: but rely on *_PERMS as described above or alternatively on INSTALL_GAME,
7343: INSTALL_GAME_DATA and INSTALL_GAME_DIR to set these correctly.
1.1 dsieger 7344:
1.154 rillig 7345: 21.6.4. Adding DESTDIR support to packages
1.4 rillig 7346:
1.14 jmcneill 7347: DESTDIR support means that a package installs into a staging directory, not the
7348: final location of the files. Then a binary package is created which can be used
7349: for installation as usual. There are two ways: Either the package must install
1.25 wiz 7350: as root ("destdir") or the package can install as non-root user ("user-destdir"
7351: ).
1.14 jmcneill 7352:
1.113 leot 7353: * PKG_DESTDIR_SUPPORT has to be set to "destdir" or "user-destdir". By
7354: default PKG_DESTDIR_SUPPORT is set to "user-destdir" to help catching more
7355: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
7356: PKG_DESTDIR_SUPPORT needs to be set before the inclusion.
1.14 jmcneill 7357:
1.4 rillig 7358: * All installation operations have to be prefixed with ${DESTDIR}.
7359:
7360: * automake gets this DESTDIR mostly right automatically. Many manual rules
7361: and pre/post-install often are incorrect; fix them.
7362:
1.17 imil 7363: * If files are installed with special owner/group use SPECIAL_PERMS.
1.4 rillig 7364:
7365: * In general, packages should support UNPRIVILEGED to be able to use DESTDIR.
7366:
1.154 rillig 7367: 21.6.5. Packages with hardcoded paths to other interpreters
1.1 dsieger 7368:
7369: Your package may also contain scripts with hardcoded paths to other
7370: interpreters besides (or as well as) perl. To correct the full pathname to the
7371: script interpreter, you need to set the following definitions in your Makefile
7372: (we shall use tclsh in this example):
7373:
7374: REPLACE_INTERPRETER+= tcl
7375: REPLACE.tcl.old= .*/bin/tclsh
7376: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
7377: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
7378: # relative to ${WRKSRC}, just as in REPLACE_PERL
7379:
7380: Note
7381:
7382: Before March 2006, these variables were called _REPLACE.* and _REPLACE_FILES.*.
7383:
1.154 rillig 7384: 21.6.6. Packages installing perl modules
1.1 dsieger 7385:
7386: Makefiles of packages providing perl5 modules should include the Makefile
7387: fragment ../../lang/perl5/module.mk. It provides a do-configure target for the
7388: standard perl configuration for such modules as well as various hooks to tune
7389: this configuration. See comments in this file for details.
7390:
7391: Perl5 modules will install into different places depending on the version of
7392: perl used during the build process. To address this, pkgsrc will append lines
7393: to the PLIST corresponding to the files listed in the installed .packlist file
7394: generated by most perl5 modules. This is invoked by defining PERL5_PACKLIST to
1.48 wiz 7395: a space-separated list of packlist files relative to PERL5_PACKLIST_DIR
7396: (PERL5_INSTALLVENDORARCH by default), e.g.:
1.1 dsieger 7397:
1.48 wiz 7398: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 7399:
1.48 wiz 7400: The perl5 config variables installarchlib, installscript, installvendorbin,
7401: installvendorscript, installvendorarch, installvendorlib, installvendorman1dir,
7402: and installvendorman3dir represent those locations in which components of perl5
7403: modules may be installed, provided as variable with uppercase and prefixed with
7404: PERL5_, e.g. PERL5_INSTALLARCHLIB and may be used by perl5 packages that don't
7405: have a packlist. These variables are also substituted for in the PLIST as
7406: uppercase prefixed with PERL5_SUB_.
1.1 dsieger 7407:
1.154 rillig 7408: 21.6.7. Packages installing info files
1.1 dsieger 7409:
7410: Some packages install info files or use the "makeinfo" or "install-info"
7411: commands. INFO_FILES should be defined in the package Makefile so that INSTALL
7412: and DEINSTALL scripts will be generated to handle registration of the info
7413: files in the Info directory file. The "install-info" command used for the info
7414: files registration is either provided by the system, or by a special purpose
7415: package automatically added as dependency if needed.
7416:
7417: PKGINFODIR is the directory under ${PREFIX} where info files are primarily
7418: located. PKGINFODIR defaults to "info" and can be overridden by the user.
7419:
7420: The info files for the package should be listed in the package PLIST; however
7421: any split info files need not be listed.
7422:
7423: A package which needs the "makeinfo" command at build time must add "makeinfo"
7424: to USE_TOOLS in its Makefile. If a minimum version of the "makeinfo" command is
7425: needed it should be noted with the TEXINFO_REQD variable in the package
7426: Makefile. By default, a minimum version of 3.12 is required. If the system does
7427: not provide a makeinfo command or if it does not match the required minimum, a
7428: build dependency on the devel/gtexinfo package will be added automatically.
7429:
7430: The build and installation process of the software provided by the package
7431: should not use the install-info command as the registration of info files is
1.25 wiz 7432: the task of the package INSTALL script, and it must use the appropriate
1.1 dsieger 7433: makeinfo command.
7434:
7435: To achieve this goal, the pkgsrc infrastructure creates overriding scripts for
7436: the install-info and makeinfo commands in a directory listed early in PATH.
7437:
7438: The script overriding install-info has no effect except the logging of a
7439: message. The script overriding makeinfo logs a message and according to the
7440: value of TEXINFO_REQD either runs the appropriate makeinfo command or exit on
7441: error.
7442:
1.154 rillig 7443: 21.6.8. Packages installing man pages
1.1 dsieger 7444:
7445: All packages that install manual pages should install them into the same
7446: directory, so that there is one common place to look for them. In pkgsrc, this
7447: place is ${PREFIX}/${PKGMANDIR}, and this expression should be used in
1.25 wiz 7448: packages. The default for PKGMANDIR is "man". Another often-used value is "
7449: share/man".
1.1 dsieger 7450:
7451: Note
7452:
7453: The support for a custom PKGMANDIR is far from complete.
7454:
7455: The PLIST files can just use man/ as the top level directory for the man page
7456: file entries, and the pkgsrc framework will convert as needed. In all other
7457: places, the correct PKGMANDIR must be used.
7458:
7459: Packages that are configured with GNU_CONFIGURE set as "yes", by default will
7460: use the ./configure --mandir switch to set where the man pages should be
7461: installed. The path is GNU_CONFIGURE_MANDIR which defaults to ${PREFIX}/$
7462: {PKGMANDIR}.
7463:
7464: Packages that use GNU_CONFIGURE but do not use --mandir, can set
7465: CONFIGURE_HAS_MANDIR to "no". Or if the ./configure script uses a non-standard
7466: use of --mandir, you can set GNU_CONFIGURE_MANDIR as needed.
7467:
1.184 rillig 7468: See Section 19.5, "Man page compression" for information on installation of
1.1 dsieger 7469: compressed manual pages.
7470:
1.154 rillig 7471: 21.6.9. Packages installing GConf data files
1.1 dsieger 7472:
1.7 rillig 7473: If a package installs .schemas or .entries files, used by GConf, you need to
1.1 dsieger 7474: take some extra steps to make sure they get registered in the database:
7475:
1.7 rillig 7476: 1. Include ../../devel/GConf/schemas.mk instead of its buildlink3.mk file.
7477: This takes care of rebuilding the GConf database at installation and
7478: deinstallation time, and tells the package where to install GConf data
1.1 dsieger 7479: files using some standard configure arguments. It also disallows any access
7480: to the database directly from the package.
7481:
7482: 2. Ensure that the package installs its .schemas files under ${PREFIX}/share/
7483: gconf/schemas. If they get installed under ${PREFIX}/etc, you will need to
7484: manually patch the package.
7485:
7486: 3. Check the PLIST and remove any entries under the etc/gconf directory, as
1.154 rillig 7487: they will be handled automatically. See Section 10.13, "How do I change the
1.1 dsieger 7488: location of configuration files?" for more information.
7489:
1.7 rillig 7490: 4. Define the GCONF_SCHEMAS variable in your Makefile with a list of all
1.1 dsieger 7491: .schemas files installed by the package, if any. Names must not contain any
7492: directories in them.
7493:
1.7 rillig 7494: 5. Define the GCONF_ENTRIES variable in your Makefile with a list of all
1.1 dsieger 7495: .entries files installed by the package, if any. Names must not contain any
7496: directories in them.
7497:
1.154 rillig 7498: 21.6.10. Packages installing scrollkeeper/rarian data files
1.1 dsieger 7499:
1.18 mishka 7500: If a package installs .omf files, used by scrollkeeper/rarian, you need to take
7501: some extra steps to make sure they get registered in the database:
1.1 dsieger 7502:
1.18 mishka 7503: 1. Include ../../mk/omf-scrollkeeper.mk instead of rarian's buildlink3.mk
7504: file. This takes care of rebuilding the scrollkeeper database at
7505: installation and deinstallation time, and disallows any access to it
7506: directly from the package.
1.1 dsieger 7507:
7508: 2. Check the PLIST and remove any entries under the libdata/scrollkeeper
7509: directory, as they will be handled automatically.
7510:
7511: 3. Remove the share/omf directory from the PLIST. It will be handled by
1.18 mishka 7512: rarian. (make print-PLIST does this automatically.)
1.1 dsieger 7513:
1.154 rillig 7514: 21.6.11. Packages installing X11 fonts
1.1 dsieger 7515:
7516: If a package installs font files, you will need to rebuild the fonts database
7517: in the directory where they get installed at installation and deinstallation
7518: time. This can be automatically done by using the pkginstall framework.
7519:
7520: You can list the directories where fonts are installed in the FONTS_DIRS.type
7521: variables, where type can be one of "ttf", "type1" or "x11". Also make sure
7522: that the database file fonts.dir is not listed in the PLIST.
7523:
7524: Note that you should not create new directories for fonts; instead use the
7525: standard ones to avoid that the user needs to manually configure his X server
7526: to find them.
7527:
1.154 rillig 7528: 21.6.12. Packages installing GTK2 modules
1.1 dsieger 7529:
7530: If a package installs GTK2 immodules or loaders, you need to take some extra
7531: steps to get them registered in the GTK2 database properly:
7532:
7533: 1. Include ../../x11/gtk2/modules.mk instead of its buildlink3.mk file. This
7534: takes care of rebuilding the database at installation and deinstallation
7535: time.
7536:
7537: 2. Set GTK2_IMMODULES=YES if your package installs GTK2 immodules.
7538:
7539: 3. Set GTK2_LOADERS=YES if your package installs GTK2 loaders.
7540:
7541: 4. Patch the package to not touch any of the GTK2 databases directly. These
7542: are:
7543:
1.42 asau 7544: + libdata/gtk-2.0/gdk-pixbuf.loaders
1.1 dsieger 7545:
1.42 asau 7546: + libdata/gtk-2.0/gtk.immodules
1.1 dsieger 7547:
7548: 5. Check the PLIST and remove any entries under the libdata/gtk-2.0 directory,
7549: as they will be handled automatically.
7550:
1.154 rillig 7551: 21.6.13. Packages installing SGML or XML data
1.1 dsieger 7552:
7553: If a package installs SGML or XML data files that need to be registered in
7554: system-wide catalogs (like DTDs, sub-catalogs, etc.), you need to take some
7555: extra steps:
7556:
7557: 1. Include ../../textproc/xmlcatmgr/catalogs.mk in your Makefile, which takes
7558: care of registering those files in system-wide catalogs at installation and
7559: deinstallation time.
7560:
7561: 2. Set SGML_CATALOGS to the full path of any SGML catalogs installed by the
7562: package.
7563:
7564: 3. Set XML_CATALOGS to the full path of any XML catalogs installed by the
7565: package.
7566:
7567: 4. Set SGML_ENTRIES to individual entries to be added to the SGML catalog.
7568: These come in groups of three strings; see xmlcatmgr(1) for more
7569: information (specifically, arguments recognized by the 'add' action). Note
7570: that you will normally not use this variable.
7571:
7572: 5. Set XML_ENTRIES to individual entries to be added to the XML catalog. These
7573: come in groups of three strings; see xmlcatmgr(1) for more information
7574: (specifically, arguments recognized by the 'add' action). Note that you
7575: will normally not use this variable.
7576:
1.154 rillig 7577: 21.6.14. Packages installing extensions to the MIME database
1.1 dsieger 7578:
7579: If a package provides extensions to the MIME database by installing .xml files
7580: inside ${PREFIX}/share/mime/packages, you need to take some extra steps to
7581: ensure that the database is kept consistent with respect to these new files:
7582:
7583: 1. Include ../../databases/shared-mime-info/mimedb.mk (avoid using the
7584: buildlink3.mk file from this same directory, which is reserved for
7585: inclusion from other buildlink3.mk files). It takes care of rebuilding the
7586: MIME database at installation and deinstallation time, and disallows any
7587: access to it directly from the package.
7588:
1.25 wiz 7589: 2. Check the PLIST and remove any entries under the share/mime directory,
1.1 dsieger 7590: except for files saved under share/mime/packages. The former are handled
7591: automatically by the update-mime-database program, but the latter are
7592: package-dependent and must be removed by the package that installed them in
7593: the first place.
7594:
7595: 3. Remove any share/mime/* directories from the PLIST. They will be handled by
7596: the shared-mime-info package.
7597:
1.154 rillig 7598: 21.6.15. Packages using intltool
1.1 dsieger 7599:
7600: If a package uses intltool during its build, add intltool to the USE_TOOLS,
7601: which forces it to use the intltool package provided by pkgsrc, instead of the
7602: one bundled with the distribution file.
7603:
7604: This tracks intltool's build-time dependencies and uses the latest available
7605: version; this way, the package benefits of any bug fixes that may have appeared
7606: since it was released.
7607:
1.154 rillig 7608: 21.6.16. Packages installing startup scripts
1.1 dsieger 7609:
7610: If a package contains a rc.d script, it won't be copied into the startup
7611: directory by default, but you can enable it, by adding the option
1.4 rillig 7612: PKG_RCD_SCRIPTS=YES in mk.conf. This option will copy the scripts into /etc/
7613: rc.d when a package is installed, and it will automatically remove the scripts
7614: when the package is deinstalled.
1.1 dsieger 7615:
1.154 rillig 7616: 21.6.17. Packages installing TeX modules
1.1 dsieger 7617:
7618: If a package installs TeX packages into the texmf tree, the ls-R database of
7619: the tree needs to be updated.
7620:
7621: Note
7622:
1.23 jakllsch 7623: Except the main TeX packages such as kpathsea, packages should install files
7624: into ${PREFIX}/share/texmf-dist, not ${PREFIX}/share/texmf.
1.1 dsieger 7625:
1.23 jakllsch 7626: 1. Include ../../print/kpathsea/texmf.mk. This takes care of rebuilding the
7627: ls-R database at installation and deinstallation time.
1.1 dsieger 7628:
1.23 jakllsch 7629: 2. If your package installs files into a texmf tree other than the one at $
7630: {PREFIX}/share/texmf-dist, set TEX_TEXMF_DIRS to the list of all texmf
7631: trees that need database update.
1.1 dsieger 7632:
7633: If your package also installs font map files that need to be registered
1.30 dholland 7634: using updmap, include ../../print/tex-tetex/map.mk and set TEX_MAP_FILES
7635: and/or TEX_MIXEDMAP_FILES to the list of all such font map files. Then
7636: updmap will be run automatically at installation/deinstallation to enable/
7637: disable font map files for TeX output drivers.
1.1 dsieger 7638:
7639: 3. Make sure that none of ls-R databases are included in PLIST, as they will
1.30 dholland 7640: be removed only by the kpathsea package.
1.1 dsieger 7641:
1.154 rillig 7642: 21.6.18. Packages supporting running binaries in emulation
1.1 dsieger 7643:
7644: There are some packages that provide libraries and executables for running
7645: binaries from a one operating system on a different one (if the latter supports
7646: it). One example is running Linux binaries on NetBSD.
7647:
7648: The pkgtools/rpm2pkg helps in extracting and packaging Linux rpm packages.
7649:
7650: The CHECK_SHLIBS can be set to no to avoid the check-shlibs target, which tests
7651: if all libraries for each installed executable can be found by the dynamic
7652: linker. Since the standard dynamic linker is run, this fails for emulation
7653: packages, because the libraries used by the emulation are not in the standard
7654: directories.
7655:
1.154 rillig 7656: 21.6.19. Packages installing hicolor theme icons
1.1 dsieger 7657:
7658: If a package installs images under the share/icons/hicolor and/or updates the
7659: share/icons/hicolor/icon-theme.cache database, you need to take some extra
7660: steps to make sure that the shared theme directory is handled appropriately and
7661: that the cache database is rebuilt:
7662:
7663: 1. Include ../../graphics/hicolor-icon-theme/buildlink3.mk.
7664:
7665: 2. Check the PLIST and remove the entry that refers to the theme cache.
7666:
7667: 3. Ensure that the PLIST does not remove the shared icon directories from the
7668: share/icons/hicolor hierarchy because they will be handled automatically.
7669:
7670: The best way to verify that the PLIST is correct with respect to the last two
7671: points is to regenerate it using make print-PLIST.
7672:
1.154 rillig 7673: 21.6.20. Packages installing desktop files
1.1 dsieger 7674:
7675: If a package installs .desktop files under share/applications and these include
1.54 rodent 7676: MIME information (MimeType key), you need to take extra steps to ensure that
7677: they are registered into the MIME database:
1.1 dsieger 7678:
7679: 1. Include ../../sysutils/desktop-file-utils/desktopdb.mk.
7680:
7681: 2. Check the PLIST and remove the entry that refers to the share/applications/
7682: mimeinfo.cache file. It will be handled automatically.
7683:
7684: The best way to verify that the PLIST is correct with respect to the last point
7685: is to regenerate it using make print-PLIST.
7686:
1.154 rillig 7687: 21.7. Marking packages as having problems
1.1 dsieger 7688:
1.23 jakllsch 7689: In some cases one does not have the time to solve a problem immediately. In
7690: this case, one can plainly mark a package as broken. For this, one just sets
7691: the variable BROKEN to the reason why the package is broken (similar to the
1.162 rillig 7692: PKG_FAIL_REASON variable). A user trying to build the package will immediately
7693: be shown this message, and the build will not be even tried.
1.1 dsieger 7694:
1.23 jakllsch 7695: BROKEN packages are removed from pkgsrc in irregular intervals.
1.1 dsieger 7696:
1.184 rillig 7697: Chapter 22. GNOME packaging and porting
7698:
7699: Table of Contents
7700:
7701: 22.1. Meta packages
7702: 22.2. Packaging a GNOME application
7703: 22.3. Updating GNOME to a newer version
7704: 22.4. Patching guidelines
7705:
7706: Quoting GNOME's web site:
7707:
7708: The GNOME project provides two things: The GNOME desktop environment, an
7709: intuitive and attractive desktop for users, and the GNOME development
7710: platform, an extensive framework for building applications that integrate
7711: into the rest of the desktop.
7712:
7713: pkgsrc provides a seamless way to automatically build and install a complete
7714: GNOME environment under many different platforms. We can say with confidence
7715: that pkgsrc is one of the most advanced build and packaging systems for GNOME
7716: due to its included technologies buildlink3, the wrappers and tools framework
7717: and automatic configuration file management. Lots of efforts are put into
7718: achieving a completely clean deinstallation of installed software components.
7719:
7720: Given that pkgsrc is NetBSD's official packaging system, the above also means
7721: that great efforts are put into making GNOME work under this operating system.
7722: Recently, DragonFly BSD also adopted pkgsrc as its preferred packaging system,
7723: contributing lots of portability fixes to make GNOME build and install under
7724: it.
7725:
7726: This chapter is aimed at pkgsrc developers and other people interested in
7727: helping our GNOME porting and packaging efforts. It provides instructions on
7728: how to manage the existing packages and some important information regarding
7729: their internals.
7730:
7731: We need your help!
7732:
7733: Should you have some spare cycles to devote to NetBSD, pkgsrc and GNOME and are
7734: willing to learn new exciting stuff, please jump straight to the pending work
7735: list! There is still a long way to go to get a fully-functional GNOME desktop
7736: under NetBSD and we need your help to achieve it!
7737:
7738: 22.1. Meta packages
7739:
7740: pkgsrc includes three GNOME-related meta packages:
7741:
7742: * meta-pkgs/gnome-base: Provides the core GNOME desktop environment. It only
7743: includes the necessary bits to get it to boot correctly, although it may
7744: lack important functionality for daily operation. The idea behind this
7745: package is to let end users build their own configurations on top of this
7746: one, first installing this meta package to achieve a functional setup and
7747: then adding individual applications.
7748:
7749: * meta-pkgs/gnome: Provides a complete installation of the GNOME platform and
7750: desktop as defined by the GNOME project; this is based on the components
7751: distributed in the platform/x.y/x.y.z/sources and desktop/x.y/x.y.z/sources
7752: directories of the official FTP server. Developer-only tools found in those
7753: directories are not installed unless required by some other component to
7754: work properly. Similarly, packages from the bindings set (bindings/x.y/
7755: x.y.z/sources) are not pulled in unless required as a dependency for an
7756: end-user component. This package "extends" meta-pkgs/gnome-base.
7757:
7758: * meta-pkgs/gnome-devel: Installs all the tools required to build a GNOME
7759: component when fetched from the CVS repository. These are required to let
7760: the autogen.sh scripts work appropriately.
7761:
7762: In all these packages, the DEPENDS lines are sorted in a way that eases
7763: updates: a package may depend on other packages listed before it but not on any
7764: listed after it. It is very important to keep this order to ease updates so...
7765: do not change it to alphabetical sorting!
7766:
7767: 22.2. Packaging a GNOME application
7768:
7769: Almost all GNOME applications are written in C and use a common set of tools as
7770: their build system. Things get different with the new bindings to other
7771: languages (such as Python), but the following will give you a general idea on
7772: the minimum required tools:
7773:
7774: * Almost all GNOME applications use the GNU Autotools as their build system.
7775: As a general rule you will need to tell this to your package:
7776:
7777: GNU_CONFIGURE=yes
7778: USE_LIBTOOL=yes
7779: USE_TOOLS+=gmake
7780:
7781: * If the package uses pkg-config to detect dependencies, add this tool to the
7782: list of required utilities:
7783:
7784: USE_TOOLS+=pkg-config
7785:
7786: Also use pkgtools/verifypc at the end of the build process to ensure that
7787: you did not miss to specify any dependency in your package and that the
7788: version requirements are all correct.
7789:
7790: * If the package uses intltool, be sure to add intltool to the USE_TOOLS to
7791: handle dependencies and to force the package to use the latest available
7792: version.
7793:
7794: * If the package uses gtk-doc (a documentation generation utility), do not
7795: add a dependency on it. The tool is rather big and the distfile should come
7796: with pregenerated documentation anyway; if it does not, it is a bug that
7797: you ought to report. For such packages you should disable gtk-doc (unless
7798: it is the default):
7799:
7800: CONFIGURE_ARGS+=--disable-gtk-doc
7801:
7802: The default location of installed HTML files (share/gtk-doc/<package-name>)
7803: is correct and should not be changed unless the package insists on
7804: installing them somewhere else. Otherwise programs as devhelp will not be
7805: able to open them. You can do that with an entry similar to:
1.1 dsieger 7806:
1.184 rillig 7807: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
1.1 dsieger 7808:
1.184 rillig 7809: GNOME uses multiple shared directories and files under the installation prefix
7810: to maintain databases. In this context, shared means that those exact same
7811: directories and files are used among several different packages, leading to
7812: conflicts in the PLIST. pkgsrc currently includes functionality to handle the
7813: most common cases, so you have to forget about using @unexec ${RMDIR} lines in
7814: your file lists and omitting shared files from them. If you find yourself doing
7815: those, your package is most likely incorrect.
1.1 dsieger 7816:
1.184 rillig 7817: The following table lists the common situations that result in using shared
7818: directories or files. For each of them, the appropriate solution is given.
7819: After applying the solution be sure to regenerate the package's file list with
7820: make print-PLIST and ensure it is correct.
1.1 dsieger 7821:
1.184 rillig 7822: Table 22.1. PLIST handling for GNOME packages
1.1 dsieger 7823:
1.184 rillig 7824: +-----------------------------------------------------------------------------+
7825: | If the package... | Then... |
7826: |-------------------------------------------+---------------------------------|
7827: | |See Section 21.6.10, "Packages |
7828: |Installs OMF files under share/omf. |installing scrollkeeper/rarian |
7829: | |data files". |
7830: |-------------------------------------------+---------------------------------|
7831: |Installs icons under the share/icons/ |See Section 21.6.19, "Packages |
7832: |hicolor hierarchy or updates share/icons/ |installing hicolor theme icons". |
7833: |hicolor/icon-theme.cache. | |
7834: |-------------------------------------------+---------------------------------|
7835: | |See Section 21.6.14, "Packages |
7836: |Installs files under share/mime/packages. |installing extensions to the MIME|
7837: | |database". |
7838: |-------------------------------------------+---------------------------------|
7839: |Installs .desktop files under share/ |See Section 21.6.20, "Packages |
7840: |applications and these include MIME |installing desktop files". |
7841: |information. | |
7842: +-----------------------------------------------------------------------------+
1.1 dsieger 7843:
7844:
1.184 rillig 7845: 22.3. Updating GNOME to a newer version
1.1 dsieger 7846:
1.184 rillig 7847: When seeing GNOME as a whole, there are two kinds of updates:
1.1 dsieger 7848:
1.184 rillig 7849: Major update
1.1 dsieger 7850:
1.184 rillig 7851: Given that there is still a very long way for GNOME 3 (if it ever appears),
7852: we consider a major update one that goes from a 2.X version to a 2.Y one,
7853: where Y is even and greater than X. These are hard to achieve because they
7854: introduce lots of changes in the components' code and almost all GNOME
7855: distfiles are updated to newer versions. Some of them can even break API
7856: and ABI compatibility with the previous major version series. As a result,
7857: the update needs to be done all at once to minimize breakage.
1.1 dsieger 7858:
1.184 rillig 7859: A major update typically consists of around 80 package updates and the
7860: addition of some new ones.
1.1 dsieger 7861:
1.184 rillig 7862: Minor update
1.1 dsieger 7863:
1.184 rillig 7864: We consider a minor update one that goes from a 2.A.X version to a 2.A.Y
7865: one where Y is greater than X. These are easy to achieve because they do
7866: not update all GNOME components, can be done in an incremental way and do
7867: not break API nor ABI compatibility.
1.1 dsieger 7868:
1.184 rillig 7869: A minor update typically consists of around 50 package updates, although
7870: the numbers here may vary a lot.
1.1 dsieger 7871:
1.184 rillig 7872: In order to update the GNOME components in pkgsrc to a new stable release
7873: (either major or minor), the following steps should be followed:
1.1 dsieger 7874:
1.184 rillig 7875: 1. Get a list of all the tarballs that form the new release by using the
7876: following commands. These will leave the full list of the components'
7877: distfiles into the list.txt file:
1.1 dsieger 7878:
1.184 rillig 7879: % echo ls "*.tar.bz2" | \
7880: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
7881: awk '{ print $9 }' >list.txt
7882: % echo ls "*.tar.bz2" | \
7883: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
7884: awk '{ print $9 }' >>list.txt
1.1 dsieger 7885:
1.184 rillig 7886: 2. Open each meta package's Makefile and bump their version to the release you
7887: are updating them to. The three meta packages should be always consistent
7888: with versioning. Obviously remove any PKGREVISIONs that might be in them.
1.1 dsieger 7889:
1.184 rillig 7890: 3. For each meta package, update all its DEPENDS lines to match the latest
7891: versions as shown by the above commands. Do not list any newer version
7892: (even if found in the FTP) because the meta packages are supposed to list
7893: the exact versions that form a specific GNOME release. Exceptions are
7894: permitted here if a newer version solves a serious issue in the overall
7895: desktop experience; these typically come in the form of a revision bump in
7896: pkgsrc, not in newer versions from the developers.
1.1 dsieger 7897:
1.184 rillig 7898: Packages not listed in the list.txt file should be updated to the latest
7899: version available (if found in pkgsrc). This is the case, for example, of
7900: the dependencies on the GNU Autotools in the meta-pkgs/gnome-devel meta
7901: package.
1.1 dsieger 7902:
1.184 rillig 7903: 4. Generate a patch from the modified meta packages and extract the list of
7904: "new" lines. This will provide you an outline on what packages need to be
7905: updated in pkgsrc and in what order:
1.1 dsieger 7906:
1.184 rillig 7907: % cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt
1.1 dsieger 7908:
1.184 rillig 7909: 5. For major desktop updates it is recommended to zap all your installed
7910: packages and start over from scratch at this point.
1.1 dsieger 7911:
1.184 rillig 7912: 6. Now comes the longest step by far: iterate over the contents of todo.txt
7913: and update the packages listed in it in order. For major desktop updates
7914: none of these should be committed until the entire set is completed because
7915: there are chances of breaking not-yet-updated packages.
1.1 dsieger 7916:
1.184 rillig 7917: 7. Once the packages are up to date and working, commit them to the tree one
7918: by one with appropriate log messages. At the end, commit the three meta
7919: package updates and all the corresponding changes to the doc/CHANGES-<YEAR>
7920: and pkgsrc/doc/TODO files.
1.1 dsieger 7921:
1.184 rillig 7922: 22.4. Patching guidelines
1.1 dsieger 7923:
1.184 rillig 7924: GNOME is a very big component in pkgsrc which approaches 100 packages. Please,
7925: it is very important that you always, always, always feed back any portability
7926: fixes you do to a GNOME package to the mainstream developers (see
7927: Section 12.3.5, "Feedback to the author"). This is the only way to get their
7928: attention on portability issues and to ensure that future versions can be built
7929: out-of-the box on NetBSD. The less custom patches in pkgsrc, the easier further
7930: updates are. Those developers in charge of issuing major GNOME updates will be
7931: grateful if you do that.
1.1 dsieger 7932:
1.184 rillig 7933: The most common places to report bugs are the GNOME's Bugzilla and the
7934: freedesktop.org's Bugzilla. Not all components use these to track bugs, but
7935: most of them do. Do not be short on your reports: always provide detailed
7936: explanations of the current failure, how it can be improved to achieve maximum
7937: portability and, if at all possible, provide a patch against CVS head. The more
7938: verbose you are, the higher chances of your patch being accepted.
1.1 dsieger 7939:
1.184 rillig 7940: Also, please avoid using preprocessor magic to fix portability issues. While
7941: the FreeBSD GNOME people are doing a great job in porting GNOME to their
7942: operating system, the official GNOME sources are now plagued by conditionals
7943: that check for __FreeBSD__ and similar macros. This hurts portability. Please
7944: see our patching guidelines (Section 12.3.4, "Patching guidelines") for more
7945: details.
1.1 dsieger 7946:
1.154 rillig 7947: Chapter 23. Submitting and Committing
1.1 dsieger 7948:
7949: Table of Contents
7950:
1.154 rillig 7951: 23.1. Submitting binary packages
7952: 23.2. Submitting source packages (for non-NetBSD-developers)
7953: 23.3. General notes when adding, updating, or removing packages
7954: 23.4. Commit Messages
7955: 23.5. Committing: Adding a package to CVS
7956: 23.6. Updating a package to a newer version
7957: 23.7. Renaming a package in pkgsrc
7958: 23.8. Moving a package in pkgsrc
1.1 dsieger 7959:
1.154 rillig 7960: 23.1. Submitting binary packages
1.1 dsieger 7961:
7962: Our policy is that we accept binaries only from pkgsrc developers to guarantee
7963: that the packages don't contain any trojan horses etc. This is not to annoy
7964: anyone but rather to protect our users! You're still free to put up your
7965: home-made binary packages and tell the world where to get them. NetBSD
1.154 rillig 7966: developers doing bulk builds and wanting to upload them please see Chapter 8,
1.66 asau 7967: Creating binary packages for everything in pkgsrc (bulk builds).
1.1 dsieger 7968:
1.154 rillig 7969: 23.2. Submitting source packages (for non-NetBSD-developers)
1.1 dsieger 7970:
7971: First, check that your package is complete, compiles and runs well; see
1.184 rillig 7972: Chapter 14, Creating a new pkgsrc package from scratch and the rest of this
7973: document. Next, generate an uuencoded gzipped tar(1) archive that contains all
7974: files that make up the package. Finally, send this package to the pkgsrc bug
7975: tracking system, either with the send-pr(1) command, or if you don't have that,
7976: go to the web page https://www.NetBSD.org/support/send-pr.html, which contains
7977: some instructions and a link to a form where you can submit packages. The
7978: sysutils/gtk-send-pr package is also available as a substitute for either of
7979: the above two tools.
1.1 dsieger 7980:
7981: In the form of the problem report, the category should be "pkg", the synopsis
7982: should include the package name and version number, and the description field
7983: should contain a short description of your package (contents of the COMMENT
1.25 wiz 7984: variable or DESCR file are OK). The uuencoded package data should go into the "
7985: fix" field.
1.1 dsieger 7986:
7987: If you want to submit several packages, please send a separate PR for each one,
7988: it's easier for us to track things that way.
7989:
7990: Alternatively, you can also import new packages into pkgsrc-wip ("pkgsrc
1.174 leot 7991: work-in-progress"); see the homepage at https://pkgsrc.org/wip/ for details.
1.1 dsieger 7992:
1.154 rillig 7993: 23.3. General notes when adding, updating, or removing packages
1.1 dsieger 7994:
7995: Please note all package additions, updates, moves, and removals in pkgsrc/doc/
7996: CHANGES-YYYY. It's very important to keep this file up to date and conforming
7997: to the existing format, because it will be used by scripts to automatically
7998: update pages on www.NetBSD.org and other sites. Additionally, check the pkgsrc/
7999: doc/TODO file and remove the entry for the package you updated or removed, in
8000: case it was mentioned there.
8001:
8002: When the PKGREVISION of a package is bumped, the change should appear in pkgsrc
8003: /doc/CHANGES-YYYY if it is security related or otherwise relevant. Mass bumps
8004: that result from a dependency being updated should not be mentioned. In all
8005: other cases it's the developer's decision.
8006:
8007: There is a make target that helps in creating proper CHANGES-YYYY entries: make
8008: changes-entry. It uses the optional CTYPE and NETBSD_LOGIN_NAME variables. The
8009: general usage is to first make sure that your CHANGES-YYYY file is up-to-date
8010: (to avoid having to resolve conflicts later-on) and then to cd to the package
8011: directory. For package updates, make changes-entry is enough. For new packages,
8012: or package moves or removals, set the CTYPE variable on the command line to
1.4 rillig 8013: "Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in mk.conf if
1.23 jakllsch 8014: your local login name is not the same as your NetBSD login name. The target
8015: also automatically removes possibly existing entries for the package in the
8016: TODO file. Don't forget to commit the changes, e.g. by using make
1.66 asau 8017: commit-changes-entry! If you are not using a checkout directly from
1.23 jakllsch 8018: cvs.NetBSD.org, but e.g. a local copy of the repository, you can set
8019: USE_NETBSD_REPO=yes. This makes the cvs commands use the main repository.
1.1 dsieger 8020:
1.154 rillig 8021: 23.4. Commit Messages
1.130 wiz 8022:
8023: For several years, there have been mirrors of pkgsrc in fossil, git, and hg.
8024: Standard practise when using these tools is to make the first line of a commit
8025: message function as a summary that can be read without the rest, such as is
8026: commonly done with "git log --oneline". For this reason, we have the following
8027: guidelines for pkgsrc commit messages:
8028:
1.131 wiz 8029: * Start the commit message with a line that explains the big picture in 65
1.130 wiz 8030: characters or less. When a commit is for one package, include the name of
8031: the package. For updates, include the version to which it is updated.
8032:
8033: * Leave the next line empty.
8034:
8035: * Then come the details for the commit (changes in that package, reason for a
8036: change) and any relevant PRs. Wrap this section.
8037:
8038: Here is an example:
8039:
8040: libxslt: update to 1.0.30
8041:
8042: Changes since 1.0.29:
8043: ...
8044:
8045:
8046: Here is another example:
8047:
8048: mk/bsd.pkg.mk: enable SSP by default on NetBSD
8049:
8050: (rationale)
8051:
8052:
8053: Commit messages are final: no "cvs admin" is allowed on the pkgsrc repository
8054: to change commit messages.
8055:
1.154 rillig 8056: 23.5. Committing: Adding a package to CVS
1.1 dsieger 8057:
8058: This section is only of interest for pkgsrc developers with write access to the
1.34 wiz 8059: pkgsrc repository.
8060:
8061: When the package is finished, "cvs add" the files. Start by adding the
8062: directory and then files in the directory. Don't forget to add the new package
8063: to the category's Makefile. Make sure you don't forget any files; you can check
8064: by running "cvs status". An example:
8065:
8066: $ cd .../pkgsrc/category
8067: $ cvs add pkgname
8068: $ cd pkgname
8069: $ cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8070: $ cvs add patches/p*
8071: $ cvs status | less
1.35 wiz 8072: $ cvs commit
1.34 wiz 8073: $ cd ..
8074: $ vi Makefile # add SUBDIRS+=pkgname line
1.35 wiz 8075: $ cvs commit Makefile
1.66 asau 8076: $ cd pkgname
1.73 jnemeth 8077: $ make CTYPE=Added commit-changes-entry
1.1 dsieger 8078:
8079: The commit message of the initial import should include part of the DESCR file,
8080: so people reading the mailing lists know what the package is/does.
8081:
1.34 wiz 8082: Also mention the new package in pkgsrc/doc/CHANGES-20xx.
8083:
8084: Previously, "cvs import" was suggested, but it was much easier to get wrong
8085: than "cvs add".
1.1 dsieger 8086:
1.154 rillig 8087: 23.6. Updating a package to a newer version
1.1 dsieger 8088:
8089: Please always put a concise, appropriate and relevant summary of the changes
8090: between old and new versions into the commit log when updating a package. There
8091: are various reasons for this:
8092:
8093: * A URL is volatile, and can change over time. It may go away completely or
8094: its information may be overwritten by newer information.
8095:
8096: * Having the change information between old and new versions in our CVS
8097: repository is very useful for people who use either cvs or anoncvs.
8098:
8099: * Having the change information between old and new versions in our CVS
8100: repository is very useful for people who read the pkgsrc-changes mailing
8101: list, so that they can make tactical decisions about when to upgrade the
8102: package.
8103:
8104: Please also recognize that, just because a new version of a package has been
8105: released, it should not automatically be upgraded in the CVS repository. We
8106: prefer to be conservative in the packages that are included in pkgsrc -
8107: development or beta packages are not really the best thing for most places in
8108: which pkgsrc is used. Please use your judgement about what should go into
8109: pkgsrc, and bear in mind that stability is to be preferred above new and
8110: possibly untested features.
8111:
1.154 rillig 8112: 23.7. Renaming a package in pkgsrc
1.21 snj 8113:
8114: Renaming packages is not recommended.
8115:
1.175 gutterid 8116: When renaming packages, be sure to fix any references to the old name in other
1.21 snj 8117: Makefiles, options, buildlink files, etc.
8118:
1.175 gutterid 8119: Also, when renaming a package, please add the package name and version pattern
1.167 leot 8120: (s) of the previous package to SUPERSEDES. This may be repeated for multiple
8121: renames. The new package would be an exact replacement. Example:
8122:
8123: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
8124: SUPERSEDES+= optcomp-[0-9]*
1.21 snj 8125:
8126: Note that "successor" in the CHANGES-YYYY file doesn't necessarily mean that it
8127: supersedes, as that successor may not be an exact replacement but is a
8128: suggestion for the replaced functionality.
8129:
1.154 rillig 8130: 23.8. Moving a package in pkgsrc
1.21 snj 8131:
8132: It is preferred that packages are not renamed or moved, but if needed please
8133: follow these steps.
1.1 dsieger 8134:
8135: 1. Make a copy of the directory somewhere else.
8136:
8137: 2. Remove all CVS dirs.
8138:
8139: Alternatively to the first two steps you can also do:
8140:
8141: % cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package
8142:
8143: and use that for further work.
8144:
1.25 wiz 8145: 3. Fix CATEGORIES and any DEPENDS paths that just did "../package" instead of
1.1 dsieger 8146: "../../category/package".
8147:
1.21 snj 8148: 4. In the modified package's Makefile, consider setting PREV_PKGPATH to the
8149: previous category/package pathname. The PREV_PKGPATH can be used by tools
8150: for doing an update using pkgsrc building; for example, it can search the
8151: pkg_summary(5) database for PREV_PKGPATH (if no SUPERSEDES) and then use
8152: the corresponding new PKGPATH for that moved package. Note that it may have
8153: multiple matches, so the tool should also check on the PKGBASE too. The
8154: PREV_PKGPATH probably has no value unless SUPERSEDES is not set, i.e.
8155: PKGBASE stays the same.
8156:
8157: 5. cvs import the modified package in the new place.
1.1 dsieger 8158:
1.21 snj 8159: 6. Check if any package depends on it:
1.1 dsieger 8160:
8161: % cd /usr/pkgsrc
8162: % grep /package */*/Makefile* */*/buildlink*
8163:
1.21 snj 8164: 7. Fix paths in packages from step 5 to point to new location.
1.1 dsieger 8165:
1.21 snj 8166: 8. cvs rm (-f) the package at the old location.
1.1 dsieger 8167:
1.21 snj 8168: 9. Remove from oldcategory/Makefile.
1.1 dsieger 8169:
1.21 snj 8170: 10. Add to newcategory/Makefile.
1.1 dsieger 8171:
1.21 snj 8172: 11. Commit the changed and removed files:
1.1 dsieger 8173:
8174: % cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile
8175:
8176: (and any packages from step 5, of course).
8177:
1.154 rillig 8178: Chapter 24. Frequently Asked Questions
1.1 dsieger 8179:
8180: This section contains the answers to questions that may arise when you are
8181: writing a package. If you don't find your question answered here, first have a
8182: look in the other chapters, and if you still don't have the answer, ask on the
8183: pkgsrc-users mailing list.
8184:
1.154 rillig 8185: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
8186: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
8187: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
8188: 24.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
1.1 dsieger 8189: BUILDLINK_LIBS?
1.154 rillig 8190: 24.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
8191: 24.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 8192: the := inside it.
1.154 rillig 8193: 24.7. Which mailing lists are there for package developers?
8194: 24.8. Where is the pkgsrc documentation?
8195: 24.9. I have a little time to kill. What shall I do?
1.1 dsieger 8196:
1.154 rillig 8197: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
1.1 dsieger 8198:
8199: MAKEFLAGS are the flags passed to the pkgsrc-internal invocations of make
8200: (1), while MAKE_FLAGS are the flags that are passed to the MAKE_PROGRAM
8201: when building the package. [FIXME: What is .MAKEFLAGS for?]
8202:
1.154 rillig 8203: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
1.1 dsieger 8204:
8205: MAKE is the path to the make(1) program that is used in the pkgsrc
8206: infrastructure. GMAKE is the path to GNU Make, but you need to say
8207: USE_TOOLS+=gmake to use that. MAKE_PROGRAM is the path to the Make
8208: program that is used for building the package.
8209:
1.154 rillig 8210: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
1.1 dsieger 8211:
8212: CC is the path to the real C compiler, which can be configured by the
8213: pkgsrc user. PKG_CC is the path to the compiler wrapper. PKGSRC_COMPILER
8214: is not a path to a compiler, but the type of compiler that should be
8215: used. See mk/compiler.mk for more information about the latter variable.
8216:
1.154 rillig 8217: 24.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
1.1 dsieger 8218: BUILDLINK_LIBS?
8219:
8220: [FIXME]
8221:
1.154 rillig 8222: 24.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
1.1 dsieger 8223:
1.25 wiz 8224: For optimization reasons, some variables are only available in the "
8225: wrapper" phase and later. To "simulate" the wrapper phase, append
1.1 dsieger 8226: PKG_PHASE=wrapper to the above command.
8227:
1.154 rillig 8228: 24.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 8229: the := inside it.
8230:
1.108 rillig 8231: The := is not really an assignment operator, although it looks like it.
8232: Instead, it is a degenerate form of ${LIST:old_string=new_string}, which
8233: is documented in the make(1) man page and which is commonly used in the
8234: form ${SRCS:.c=.o}. In the case of MASTER_SITE_*, old_string is the empty
8235: string and new_string is package/. That's where the : and the = fall
8236: together.
1.1 dsieger 8237:
1.154 rillig 8238: 24.7. Which mailing lists are there for package developers?
1.1 dsieger 8239:
8240: tech-pkg
8241:
8242: This is a list for technical discussions related to pkgsrc
8243: development, e.g. soliciting feedback for changes to pkgsrc
8244: infrastructure, proposed new features, questions related to porting
8245: pkgsrc to a new platform, advice for maintaining a package, patches
8246: that affect many packages, help requests moved from pkgsrc-users when
8247: an infrastructure bug is found, etc.
8248:
8249: pkgsrc-bugs
8250:
8251: All bug reports in category "pkg" sent with send-pr(1) appear here.
8252: Please do not report your bugs here directly; use one of the other
8253: mailing lists.
8254:
1.154 rillig 8255: 24.8. Where is the pkgsrc documentation?
1.1 dsieger 8256:
8257: There are many places where you can find documentation about pkgsrc:
8258:
8259: * The pkgsrc guide (this document) is a collection of chapters that
8260: explain large parts of pkgsrc, but some chapters tend to be outdated.
8261: Which ones they are is hard to say.
8262:
1.174 leot 8263: * On the mailing list archives (see https://mail-index.NetBSD.org/),
8264: you can find discussions about certain features, announcements of new
1.1 dsieger 8265: parts of the pkgsrc infrastructure and sometimes even announcements
8266: that a certain feature has been marked as obsolete. The benefit here
8267: is that each message has a date appended to it.
8268:
8269: * Many of the files in the mk/ directory start with a comment that
8270: describes the purpose of the file and how it can be used by the
8271: pkgsrc user and package authors. An easy way to find this
8272: documentation is to run bmake help.
8273:
8274: * The CVS log messages are a rich source of information, but they tend
8275: to be highly abbreviated, especially for actions that occur often.
8276: Some contain a detailed description of what has changed, but they are
8277: geared towards the other pkgsrc developers, not towards an average
8278: pkgsrc user. They also only document changes, so if you don't know
8279: what has been before, these messages may not be worth too much to
8280: you.
8281:
8282: * Some parts of pkgsrc are only "implicitly documented", that is the
8283: documentation exists only in the mind of the developer who wrote the
8284: code. To get this information, use the cvs annotate command to see
8285: who has written it and ask on the tech-pkg mailing list, so that
8286: others can find your questions later (see above). To be sure that the
8287: developer in charge reads the mail, you may CC him or her.
8288:
1.154 rillig 8289: 24.9. I have a little time to kill. What shall I do?
1.1 dsieger 8290:
8291: This is not really an FAQ yet, but here's the answer anyway.
8292:
8293: * Run pkg_chk -N (from the pkgtools/pkg_chk package). It will tell you
8294: about newer versions of installed packages that are available, but
8295: not yet updated in pkgsrc.
8296:
8297: * Browse pkgsrc/doc/TODO ? it contains a list of suggested new packages
8298: and a list of cleanups and enhancements for pkgsrc that would be nice
8299: to have.
8300:
1.71 wiz 8301: * Review packages for which review was requested on the tech-pkg
8302: mailing list.
1.1 dsieger 8303:
8304: Part III. The pkgsrc infrastructure internals
8305:
8306: This part of the guide deals with everything from the infrastructure that is
8307: behind the interfaces described in the developer's guide. A casual package
8308: maintainer should not need anything from this part.
8309:
8310: Table of Contents
8311:
1.184 rillig 8312: 25. Design of the pkgsrc infrastructure
1.1 dsieger 8313:
1.184 rillig 8314: 25.1. The meaning of variable definitions
8315: 25.2. Avoiding problems before they arise
8316: 25.3. Variable evaluation
1.1 dsieger 8317:
1.184 rillig 8318: 25.3.1. At load time
8319: 25.3.2. At runtime
1.1 dsieger 8320:
1.184 rillig 8321: 25.4. How can variables be specified?
8322: 25.5. Designing interfaces for Makefile fragments
1.1 dsieger 8323:
1.184 rillig 8324: 25.5.1. Procedures with parameters
8325: 25.5.2. Actions taken on behalf of parameters
1.1 dsieger 8326:
1.184 rillig 8327: 25.6. The order in which files are loaded
1.1 dsieger 8328:
1.184 rillig 8329: 25.6.1. The order in bsd.prefs.mk
8330: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 8331:
1.184 rillig 8332: 26. Regression tests
1.1 dsieger 8333:
1.184 rillig 8334: 26.1. Running the regression tests
8335: 26.2. Adding a new regression test
1.1 dsieger 8336:
1.184 rillig 8337: 26.2.1. Overridable functions
8338: 26.2.2. Helper functions
1.1 dsieger 8339:
1.184 rillig 8340: 27. Porting pkgsrc
1.1 dsieger 8341:
1.184 rillig 8342: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8343:
1.184 rillig 8344: Chapter 25. Design of the pkgsrc infrastructure
1.1 dsieger 8345:
8346: Table of Contents
8347:
1.184 rillig 8348: 25.1. The meaning of variable definitions
8349: 25.2. Avoiding problems before they arise
8350: 25.3. Variable evaluation
1.1 dsieger 8351:
1.184 rillig 8352: 25.3.1. At load time
8353: 25.3.2. At runtime
1.1 dsieger 8354:
1.184 rillig 8355: 25.4. How can variables be specified?
8356: 25.5. Designing interfaces for Makefile fragments
1.1 dsieger 8357:
1.184 rillig 8358: 25.5.1. Procedures with parameters
8359: 25.5.2. Actions taken on behalf of parameters
1.1 dsieger 8360:
1.184 rillig 8361: 25.6. The order in which files are loaded
1.1 dsieger 8362:
1.184 rillig 8363: 25.6.1. The order in bsd.prefs.mk
8364: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 8365:
8366: The pkgsrc infrastructure consists of many small Makefile fragments. Each such
8367: fragment needs a properly specified interface. This chapter explains how such
8368: an interface looks like.
8369:
1.184 rillig 8370: 25.1. The meaning of variable definitions
1.1 dsieger 8371:
8372: Whenever a variable is defined in the pkgsrc infrastructure, the location and
8373: the way of definition provide much information about the intended use of that
8374: variable. Additionally, more documentation may be found in a header comment or
8375: in this pkgsrc guide.
8376:
8377: A special file is mk/defaults/mk.conf, which lists all variables that are
8378: intended to be user-defined. They are either defined using the ?= operator or
8379: they are left undefined because defining them to anything would effectively
8380: mean "yes". All these variables may be overridden by the pkgsrc user in the
8381: MAKECONF file.
8382:
8383: Outside this file, the following conventions apply: Variables that are defined
8384: using the ?= operator may be overridden by a package.
8385:
8386: Variables that are defined using the = operator may be used read-only at
8387: run-time.
8388:
8389: Variables whose name starts with an underscore must not be accessed outside the
8390: pkgsrc infrastructure at all. They may change without further notice.
8391:
8392: Note
8393:
8394: These conventions are currently not applied consistently to the complete pkgsrc
8395: infrastructure.
8396:
1.184 rillig 8397: 25.2. Avoiding problems before they arise
1.1 dsieger 8398:
8399: All variables that contain lists of things should default to being empty. Two
8400: examples that do not follow this rule are USE_LANGUAGES and DISTFILES. These
8401: variables cannot simply be modified using the += operator in package Makefiles
8402: (or other files included by them), since there is no guarantee whether the
8403: variable is already set or not, and what its value is. In the case of
8404: DISTFILES, the packages "know" the default value and just define it as in the
8405: following example.
8406:
8407: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
8408:
8409: Because of the selection of this default value, the same value appears in many
8410: package Makefiles. Similarly for USE_LANGUAGES, but in this case the default
8411: value ("c") is so short that it doesn't stand out. Nevertheless it is mentioned
8412: in many files.
8413:
1.184 rillig 8414: 25.3. Variable evaluation
1.1 dsieger 8415:
1.184 rillig 8416: 25.3.1. At load time
1.1 dsieger 8417:
8418: Variable evaluation takes place either at load time or at runtime, depending on
8419: the context in which they occur. The contexts where variables are evaluated at
8420: load time are:
8421:
8422: * The right hand side of the := and != operators,
8423:
8424: * Make directives like .if or .for,
8425:
8426: * Dependency lines.
8427:
8428: A special exception are references to the iteration variables of .for loops,
8429: which are expanded inline, no matter in which context they appear.
8430:
8431: As the values of variables may change during load time, care must be taken not
8432: to evaluate them by accident. Typical examples for variables that should not be
8433: evaluated at load time are DEPENDS and CONFIGURE_ARGS. To make the effect more
8434: clear, here is an example:
8435:
8436: CONFIGURE_ARGS= # none
8437: CFLAGS= -O
8438: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
8439:
8440: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
8441:
8442: CFLAGS+= -Wall
8443:
8444: This code shows how the use of the := operator can quickly lead to unexpected
8445: results. The first paragraph is fairly common code. The second paragraph
8446: evaluates the CONFIGURE_ARGS variable, which results in CFLAGS=-O. In the third
8447: paragraph, the -Wall is appended to the CFLAGS, but this addition will not
8448: appear in CONFIGURE_ARGS. In actual code, the three paragraphs from above
8449: typically occur in completely unrelated files.
8450:
1.184 rillig 8451: 25.3.2. At runtime
1.1 dsieger 8452:
8453: After all the files have been loaded, the values of the variables cannot be
8454: changed anymore. Variables that are used in the shell commands are expanded at
8455: this point.
8456:
1.184 rillig 8457: 25.4. How can variables be specified?
1.1 dsieger 8458:
8459: There are many ways in which the definition and use of a variable can be
8460: restricted in order to detect bugs and violations of the (mostly unwritten)
1.108 rillig 8461: policies. A package can be checked with pkglint -Wall to see whether it meets
8462: these rules.
1.1 dsieger 8463:
1.184 rillig 8464: 25.5. Designing interfaces for Makefile fragments
1.1 dsieger 8465:
8466: Most of the .mk files fall into one of the following classes. Cases where a
8467: file falls into more than one class should be avoided as it often leads to
8468: subtle bugs.
8469:
1.184 rillig 8470: 25.5.1. Procedures with parameters
1.1 dsieger 8471:
8472: In a traditional imperative programming language some of the .mk files could be
1.23 jakllsch 8473: described as procedures. They take some input parameters and?after
8474: inclusion?provide a result in output parameters. Since all variables in
8475: Makefiles have global scope care must be taken not to use parameter names that
8476: have already another meaning. For example, PKGNAME is a bad choice for a
8477: parameter name.
1.1 dsieger 8478:
8479: Procedures are completely evaluated at preprocessing time. That is, when
8480: calling a procedure all input parameters must be completely resolvable. For
8481: example, CONFIGURE_ARGS should never be an input parameter since it is very
8482: likely that further text will be added after calling the procedure, which would
8483: effectively apply the procedure to only a part of the variable. Also,
1.108 rillig 8484: references to other variables will be modified after calling the procedure.
1.1 dsieger 8485:
8486: A procedure can declare its output parameters either as suitable for use in
8487: preprocessing directives or as only available at runtime. The latter
8488: alternative is for variables that contain references to other runtime
8489: variables.
8490:
8491: Procedures shall be written such that it is possible to call the procedure more
8492: than once. That is, the file must not contain multiple-inclusion guards.
8493:
8494: Examples for procedures are mk/bsd.options.mk and mk/buildlink3/bsd.builtin.mk.
8495: To express that the parameters are evaluated at load time, they should be
8496: assigned using the := operator, which should be used only for this purpose.
8497:
1.184 rillig 8498: 25.5.2. Actions taken on behalf of parameters
1.1 dsieger 8499:
8500: Action files take some input parameters and may define runtime variables. They
8501: shall not define loadtime variables. There are action files that are included
8502: implicitly by the pkgsrc infrastructure, while other must be included
8503: explicitly.
8504:
8505: An example for action files is mk/subst.mk.
8506:
1.184 rillig 8507: 25.6. The order in which files are loaded
1.1 dsieger 8508:
8509: Package Makefiles usually consist of a set of variable definitions, and include
8510: the file ../../mk/bsd.pkg.mk in the very last line. Before that, they may also
8511: include various other *.mk files if they need to query the availability of
8512: certain features like the type of compiler or the X11 implementation. Due to
8513: the heavy use of preprocessor directives like .if and .for, the order in which
8514: the files are loaded matters.
8515:
8516: This section describes at which point the various files are loaded and gives
8517: reasons for that order.
8518:
1.184 rillig 8519: 25.6.1. The order in bsd.prefs.mk
1.1 dsieger 8520:
8521: The very first action in bsd.prefs.mk is to define some essential variables
8522: like OPSYS, OS_VERSION and MACHINE_ARCH.
8523:
1.4 rillig 8524: Then, the user settings are loaded from the file specified in MAKECONF, which
8525: is usually mk.conf. After that, those variables that have not been overridden
8526: by the user are loaded from mk/defaults/mk.conf.
1.1 dsieger 8527:
8528: After the user settings, the system settings and platform settings are loaded,
8529: which may override the user settings.
8530:
8531: Then, the tool definitions are loaded. The tool wrappers are not yet in effect.
8532: This only happens when building a package, so the proper variables must be used
8533: instead of the direct tool names.
8534:
8535: As the last steps, some essential variables from the wrapper and the package
8536: system flavor are loaded, as well as the variables that have been cached in
8537: earlier phases of a package build.
8538:
1.184 rillig 8539: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 8540:
8541: First, bsd.prefs.mk is loaded.
8542:
8543: Then, the various *-vars.mk files are loaded, which fill default values for
8544: those variables that have not been defined by the package. These variables may
8545: later be used even in unrelated files.
8546:
8547: Then, the file bsd.pkg.error.mk provides the target error-check that is added
8548: as a special dependency to all other targets that use DELAYED_ERROR_MSG or
8549: DELAYED_WARNING_MSG.
8550:
8551: Then, the package-specific hacks from hacks.mk are included.
8552:
8553: Then, various other files follow. Most of them don't have any dependencies on
8554: what they need to have included before or after them, though some do.
8555:
8556: The code to check PKG_FAIL_REASON and PKG_SKIP_REASON is then executed, which
8557: restricts the use of these variables to all the files that have been included
8558: before. Appearances in later files will be silently ignored.
8559:
8560: Then, the files for the main targets are included, in the order of later
8561: execution, though the actual order should not matter.
8562:
8563: At last, some more files are included that don't set any interesting variables
8564: but rather just define make targets to be executed.
8565:
1.184 rillig 8566: Chapter 26. Regression tests
1.1 dsieger 8567:
8568: Table of Contents
8569:
1.184 rillig 8570: 26.1. Running the regression tests
8571: 26.2. Adding a new regression test
1.1 dsieger 8572:
1.184 rillig 8573: 26.2.1. Overridable functions
8574: 26.2.2. Helper functions
1.1 dsieger 8575:
8576: The pkgsrc infrastructure consists of a large codebase, and there are many
8577: corners where every little bit of a file is well thought out, making pkgsrc
8578: likely to fail as soon as anything is changed near those parts. To prevent most
8579: changes from breaking anything, a suite of regression tests should go along
8580: with every important part of the pkgsrc infrastructure. This chapter describes
8581: how regression tests work in pkgsrc and how you can add new tests.
8582:
1.184 rillig 8583: 26.1. Running the regression tests
1.1 dsieger 8584:
1.25 wiz 8585: You first need to install the pkgtools/pkg_regress package, which provides the
1.1 dsieger 8586: pkg_regress command. Then you can simply run that command, which will run all
1.168 rillig 8587: tests in the regress/ directory.
1.1 dsieger 8588:
1.184 rillig 8589: 26.2. Adding a new regression test
1.1 dsieger 8590:
1.168 rillig 8591: Every directory in the regress/ directory that contains a file called spec is
1.1 dsieger 8592: considered a regression test. This file is a shell program that is included by
8593: the pkg_regress command. The following functions can be overridden to suit your
8594: needs.
8595:
1.184 rillig 8596: 26.2.1. Overridable functions
1.1 dsieger 8597:
1.108 rillig 8598: These functions do not take any parameters. Although they are called in "set -e
1.168 rillig 8599: " mode, they don't stop at the first failing command. See this Stack Overflow
1.108 rillig 8600: question for details.
1.1 dsieger 8601:
1.108 rillig 8602: do_setup
1.1 dsieger 8603:
8604: This function prepares the environment for the test. By default it does
8605: nothing.
8606:
1.108 rillig 8607: do_test
1.1 dsieger 8608:
8609: This function runs the actual test. By default, it calls TEST_MAKE with the
8610: arguments MAKEARGS_TEST and writes its output including error messages into
8611: the file TEST_OUTFILE.
8612:
1.108 rillig 8613: When defining this function, make sure that all output that needs to be
8614: checked is written to the correct output file. Example:
8615:
8616: do_test() {
8617: echo "Example output"
8618: } 1>$TEST_OUTFILE 2>&1
8619:
8620: check_result
1.1 dsieger 8621:
8622: This function is run after the test and is typically used to compare the
8623: actual output from the one that is expected. It can make use of the various
1.108 rillig 8624: helper functions from the next section. Example:
8625:
8626: check_result() {
8627: exit_status 0
8628: output_require "Example"
8629: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
8630: output_prohibit "no such file or directory"
1.169 rillig 8631: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 8632: }
1.1 dsieger 8633:
1.108 rillig 8634: do_cleanup
1.1 dsieger 8635:
8636: This function cleans everything up after the test has been run. By default
8637: it does nothing.
8638:
1.184 rillig 8639: 26.2.2. Helper functions
1.1 dsieger 8640:
1.168 rillig 8641: regress_fail message...
8642:
8643: This function makes the test fail with the given error message.
8644:
1.108 rillig 8645: exit_status expected
1.1 dsieger 8646:
1.108 rillig 8647: This function compares the exitcode of the do_test function with its first
8648: parameter. If they differ, the test will fail.
1.1 dsieger 8649:
1.108 rillig 8650: output_require regex...
1.1 dsieger 8651:
8652: This function checks for each of its parameters if the output from do_test
1.108 rillig 8653: matches the extended regular expression. If it does not, the test will
8654: fail. Example:
8655:
8656: output_require "looks fine"
8657: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.1 dsieger 8658:
1.177 leot 8659: output_prohibit regex...
1.1 dsieger 8660:
8661: This function checks for each of its parameters if the output from do_test
8662: () does not match the extended regular expression. If any of the regular
8663: expressions matches, the test will fail.
8664:
1.184 rillig 8665: Chapter 27. Porting pkgsrc
1.1 dsieger 8666:
8667: Table of Contents
8668:
1.184 rillig 8669: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8670:
8671: The pkgsrc system has already been ported to many operating systems, hardware
8672: architectures and compilers. This chapter explains the necessary steps to make
8673: pkgsrc even more portable.
8674:
1.184 rillig 8675: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8676:
8677: To port pkgsrc to a new operating system (called MyOS in this example), you
8678: need to touch the following files:
8679:
8680: pkgtools/bootstrap-mk-files/files/mods/MyOS.sys.mk
8681:
8682: This file contains some basic definitions, for example the name of the C
8683: compiler.
8684:
8685: mk/bsd.prefs.mk
8686:
8687: Insert code that defines the variables OPSYS, OS_VERSION, LOWER_OS_VERSION,
8688: LOWER_VENDOR, MACHINE_ARCH, OBJECT_FMT, APPEND_ELF, and the other variables
8689: that appear in this file.
8690:
8691: mk/platform/MyOS.mk
8692:
8693: This file contains the platform-specific definitions that are used by
8694: pkgsrc. Start by copying one of the other files and edit it to your needs.
8695:
8696: mk/tools/tools.MyOS.mk
8697:
8698: This file defines the paths to all the tools that are needed by one or the
8699: other package in pkgsrc, as well as by pkgsrc itself. Find out where these
8700: tools are on your platform and add them.
8701:
8702: Now, you should be able to build some basic packages, like lang/perl5, shells/
8703: bash.
8704:
8705: Appendix A. A simple example package: bison
8706:
8707: Table of Contents
8708:
8709: A.1. files
8710:
8711: A.1.1. Makefile
8712: A.1.2. DESCR
8713: A.1.3. PLIST
8714: A.1.4. Checking a package with pkglint
8715:
8716: A.2. Steps for building, installing, packaging
8717:
8718: We checked to find a piece of software that wasn't in the packages collection,
1.25 wiz 8719: and picked GNU bison. Quite why someone would want to have bison when Berkeley
1.1 dsieger 8720: yacc is already present in the tree is beyond us, but it's useful for the
8721: purposes of this exercise.
8722:
8723: A.1. files
8724:
8725: A.1.1. Makefile
8726:
1.2 rillig 8727: # $NetBSD$
1.1 dsieger 8728: #
8729:
8730: DISTNAME= bison-1.25
8731: CATEGORIES= devel
1.171 rillig 8732: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 8733:
1.30 dholland 8734: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 8735: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 8736: COMMENT= GNU yacc clone
8737:
8738: GNU_CONFIGURE= yes
1.47 wiz 8739: INFO_FILES= yes
1.1 dsieger 8740:
8741: .include "../../mk/bsd.pkg.mk"
8742:
8743: A.1.2. DESCR
8744:
8745: GNU version of yacc. Can make re-entrant parsers, and numerous other
8746: improvements. Why you would want this when Berkeley yacc(1) is part
8747: of the NetBSD source tree is beyond me.
8748:
8749: A.1.3. PLIST
8750:
1.2 rillig 8751: @comment $NetBSD$
1.1 dsieger 8752: bin/bison
8753: man/man1/bison.1.gz
8754: share/bison.simple
8755: share/bison.hairy
8756:
8757: A.1.4. Checking a package with pkglint
8758:
8759: The NetBSD package system comes with pkgtools/pkglint which helps to check the
8760: contents of these files. After installation it is quite easy to use, just
1.171 rillig 8761: change to the directory of the package you wish to examine and run pkglint:
1.1 dsieger 8762:
8763: $ pkglint
1.171 rillig 8764: ERROR: Makefile: Each package must define its LICENSE.
8765: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
8766: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
8767: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
8768: 1 error, 2 warnings and 1 note found.
8769: (Run "pkglint -e" to show explanations.)
8770: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 8771: (Run "pkglint -F" to automatically fix some issues.)
1.1 dsieger 8772:
8773: Depending on the supplied command line arguments (see pkglint(1)), more checks
1.170 rillig 8774: will be performed. Use e.g. pkglint -Wall for a very thorough check.
1.1 dsieger 8775:
8776: A.2. Steps for building, installing, packaging
8777:
8778: Create the directory where the package lives, plus any auxiliary directories:
8779:
8780: # cd /usr/pkgsrc/lang
8781: # mkdir bison
8782: # cd bison
8783: # mkdir patches
8784:
1.184 rillig 8785: Create Makefile, DESCR and PLIST (see Chapter 12, Package components - files,
1.1 dsieger 8786: directories and contents) then continue with fetching the distfile:
8787:
8788: # make fetch
8789: >> bison-1.25.tar.gz doesn't seem to exist on this system.
8790: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
8791: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8792: ftp: Error retrieving file: 500 Internal error
8793:
8794: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
8795: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8796: ftp: Error retrieving file: 500 Internal error
8797:
8798: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
8799: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8800: Successfully retrieved file.
8801:
8802: Generate the checksum of the distfile into distinfo:
8803:
8804: # make makedistinfo
8805:
8806: Now compile:
8807:
8808: # make
8809: >> Checksum OK for bison-1.25.tar.gz.
8810: ===> Extracting for bison-1.25
8811: ===> Patching for bison-1.25
8812: ===> Ignoring empty patch directory
8813: ===> Configuring for bison-1.25
8814: creating cache ./config.cache
8815: checking for gcc... cc
8816: checking whether we are using GNU C... yes
8817: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
8818: checking how to run the C preprocessor... cc -E
8819: checking for minix/config.h... no
8820: checking for POSIXized ISC... no
8821: checking whether cross-compiling... no
8822: checking for ANSI C header files... yes
8823: checking for string.h... yes
8824: checking for stdlib.h... yes
8825: checking for memory.h... yes
8826: checking for working const... yes
8827: checking for working alloca.h... no
8828: checking for alloca... yes
8829: checking for strerror... yes
8830: updating cache ./config.cache
8831: creating ./config.status
8832: creating Makefile
8833: ===> Building for bison-1.25
8834: 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
8835: 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
8836: 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
8837: 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
8838: 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
8839: 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
8840: 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
8841: 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
8842: 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
8843: 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
8844: 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
8845: 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
8846: 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
8847: 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
8848: 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
8849: 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
8850: 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
8851: 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
8852: 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
8853: 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
8854: 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
8855: 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
8856: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
8857: rm -f bison.s1
8858: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1
8859:
8860: Everything seems OK, so install the files:
8861:
8862: # make install
8863: >> Checksum OK for bison-1.25.tar.gz.
8864: ===> Installing for bison-1.25
8865: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
8866: rm -f /usr/pkg/bin/bison
8867: cd /usr/pkg/share; rm -f bison.simple bison.hairy
8868: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
8869: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
8870: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
8871: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
8872: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
8873: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
8874: ===> Registering installation for bison-1.25
8875:
8876: You can now use bison, and also - if you decide so - remove it with pkg_delete
8877: bison. Should you decide that you want a binary package, do this now:
8878:
8879: # make package
8880: >> Checksum OK for bison-1.25.tar.gz.
8881: ===> Building package for bison-1.25
8882: Creating package bison-1.25.tgz
8883: Registering depends:.
8884: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
8885:
8886: Now that you don't need the source and object files any more, clean up:
8887:
8888: # make clean
8889: ===> Cleaning for bison-1.25
8890:
8891: Appendix B. Build logs
8892:
8893: Table of Contents
8894:
8895: B.1. Building figlet
8896: B.2. Packaging figlet
8897:
8898: B.1. Building figlet
8899:
8900: # make
8901: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8902: => figlet221.tar.gz doesn't seem to exist on this system.
8903: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
8904: => [172219 bytes]
8905: Connected to ftp.plig.net.
8906: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
8907: 331 Guest login ok, send your complete e-mail address as password.
8908: 230-You are user #5 of 500 simultaneous users allowed.
8909: 230-
8910: 230- ___ _ _ _
8911: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
8912: 230- | _| _| . |_| . | | | . |_| . | _| . |
8913: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
8914: 230- |_| |_| |___| |___|
8915: 230-
8916: 230-** Welcome to ftp.plig.org **
8917: 230-
8918: 230-Please note that all transfers from this FTP site are logged. If you
8919: 230-do not like this, please disconnect now.
8920: 230-
1.19 snj 8921: 230-This archive is available via
1.1 dsieger 8922: 230-
8923: 230-HTTP: http://ftp.plig.org/
8924: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
8925: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
8926: 230-
8927: 230-Please email comments, bug reports and requests for packages to be
8928: 230-mirrored to ftp-admin@plig.org.
8929: 230-
8930: 230-
8931: 230 Logged in anonymously.
8932: Remote system type is UNIX.
8933: Using binary mode to transfer files.
8934: 200 Type okay.
8935: 250 "/pub" is new cwd.
8936: 250-"/pub/figlet" is new cwd.
8937: 250-
8938: 250-Welcome to the figlet archive at ftp.figlet.org
8939: 250-
8940: 250- ftp://ftp.figlet.org/pub/figlet/
8941: 250-
8942: 250-The official FIGlet web page is:
8943: 250- http://www.figlet.org/
8944: 250-
8945: 250-If you have questions, please mailto:info@figlet.org. If you want to
8946: 250-contribute a font or something else, you can email us.
8947: 250
8948: 250 "/pub/figlet/program" is new cwd.
8949: 250 "/pub/figlet/program/unix" is new cwd.
8950: local: figlet221.tar.gz remote: figlet221.tar.gz
8951: 502 Unimplemented command.
8952: 227 Entering Passive Mode (195,40,6,41,246,104)
8953: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
8954: 38% |************** | 65800 64.16 KB/s 00:01 ETA
8955: 226 Transfer completed.
8956: 172219 bytes received in 00:02 (75.99 KB/s)
8957: 221 Goodbye.
8958: => Checksum OK for figlet221.tar.gz.
8959: ===> Extracting for figlet-2.2.1nb2
8960: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
8961: ===> Patching for figlet-2.2.1nb2
8962: ===> Applying pkgsrc patches for figlet-2.2.1nb2
8963: ===> Overriding tools for figlet-2.2.1nb2
8964: ===> Creating toolchain wrappers for figlet-2.2.1nb2
8965: ===> Configuring for figlet-2.2.1nb2
8966: ===> Building for figlet-2.2.1nb2
8967: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
8968: chmod a+x figlet
8969: gcc -O2 -o chkfont chkfont.c
8970: => Unwrapping files-to-be-installed.
8971: #
8972: # make install
8973: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8974: ===> Installing for figlet-2.2.1nb2
8975: install -d -o root -g wheel -m 755 /usr/pkg/bin
8976: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
8977: mkdir -p /usr/pkg/share/figlet
8978: cp figlet /usr/pkg/bin
8979: cp chkfont /usr/pkg/bin
8980: chmod 555 figlist showfigfonts
8981: cp figlist /usr/pkg/bin
8982: cp showfigfonts /usr/pkg/bin
8983: cp fonts/*.flf /usr/pkg/share/figlet
8984: cp fonts/*.flc /usr/pkg/share/figlet
8985: cp figlet.6 /usr/pkg/man/man6
8986: ===> Registering installation for figlet-2.2.1nb2
8987: #
8988:
8989: B.2. Packaging figlet
8990:
8991: # make package
8992: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8993: ===> Packaging figlet-2.2.1nb2
8994: ===> Building binary package for figlet-2.2.1nb2
8995: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
8996: Using SrcDir value of /usr/pkg
8997: Registering depends:.
8998: #
8999:
9000: Appendix C. Directory layout of the pkgsrc FTP server
9001:
9002: Table of Contents
9003:
1.23 jakllsch 9004: C.1. distfiles: The distributed source files
9005: C.2. misc: Miscellaneous things
9006: C.3. packages: Binary packages
9007: C.4. reports: Bulk build reports
1.148 leot 9008: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 9009:
9010: As in other big projects, the directory layout of pkgsrc is quite complex for
9011: newbies. This chapter explains where you find things on the FTP server. The
9012: base directory on ftp.NetBSD.org is /pub/pkgsrc/. On other servers it may be
9013: different, but inside this directory, everything should look the same, no
9014: matter on which server you are. This directory contains some subdirectories,
9015: which are explained below.
9016:
1.23 jakllsch 9017: C.1. distfiles: The distributed source files
1.1 dsieger 9018:
9019: The directory distfiles contains lots of archive files from all pkgsrc
9020: packages, which are mirrored here. The subdirectories are called after their
9021: package names and are used when the distributed files have names that don't
9022: explicitly contain a version number or are otherwise too generic (for example
9023: release.tar.gz).
9024:
1.23 jakllsch 9025: C.2. misc: Miscellaneous things
1.1 dsieger 9026:
9027: This directory contains things that individual pkgsrc developers find worth
9028: publishing.
9029:
1.23 jakllsch 9030: C.3. packages: Binary packages
1.1 dsieger 9031:
1.3 rillig 9032: This directory contains binary packages for the various platforms that are
9033: supported by pkgsrc. Each subdirectory is of the form OPSYS/ARCH/OSVERSION_TAG.
9034: The meaning of these variables is:
9035:
9036: * OPSYS is the name of the operating system for which the packages have been
1.9 rillig 9037: built. The name is taken from the output of the uname command, so it may
9038: differ from the one you are used to hear.
1.3 rillig 9039:
1.8 rillig 9040: * ARCH is the hardware architecture of the platform for which the packages
1.10 hubertf 9041: have been built. It also includes the ABI (Application Binary Interface)
9042: for platforms that have several of them.
1.3 rillig 9043:
1.8 rillig 9044: * OSVERSION is the version of the operating system. For version numbers that
9045: change often (for example NetBSD-current), the often-changing part should
9046: be replaced with an x, for example 4.99.x.
1.3 rillig 9047:
1.23 jakllsch 9048: * TAG is either 20xxQy for a stable branch, or head for packages built from
1.8 rillig 9049: the HEAD branch. The latter should only be used when the packages are
9050: updated on a regular basis. Otherwise the date from checking out pkgsrc
9051: should be appended, for example head_20071015.
1.3 rillig 9052:
9053: The rationale for exactly this scheme is that the pkgsrc users looking for
9054: binary packages can quickly click through the directories on the server and
9055: find the best binary packages for their machines. Since they usually know the
9056: operating system and the hardware architecture, OPSYS and ARCH are placed
9057: first. After these choices, they can select the best combination of OSVERSION
9058: and TAG together, since it is usually the case that packages stay compatible
9059: between different version of the operating system.
9060:
9061: In each of these directories, there is a whole binary packages collection for a
9062: specific platform. It has a directory called All which contains all binary
9063: packages. Besides that, there are various category directories that contain
9064: symbolic links to the real binary packages.
1.1 dsieger 9065:
1.23 jakllsch 9066: C.4. reports: Bulk build reports
1.8 rillig 9067:
9068: Here are the reports from bulk builds, for those who want to fix packages that
9069: didn't build on some of the platforms. The structure of subdirectories should
1.23 jakllsch 9070: look like the one in Section C.3, "packages: Binary packages".
1.8 rillig 9071:
1.148 leot 9072: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 9073:
9074: These directories contain the "real" pkgsrc, that is the files that define how
9075: to create binary packages from source archives.
9076:
1.149 leot 9077: Each of the current, stable and pkgsrc-20xxQy directories share the same
9078: structure. They each contain a pkgsrc directory and pkgsrc.tar.{bz,gz,xz} file.
9079:
1.1 dsieger 9080: The directory pkgsrc contains a snapshot of the CVS repository, which is
1.149 leot 9081: updated regularly. The file pkgsrc.tar.{bz,gz,xz} contains the same as the
9082: directory, ready to be downloaded as a whole.
1.1 dsieger 9083:
1.149 leot 9084: The current directory contains files related to the HEAD branch of the CVS
9085: repository. In this directory there is an additional file called
9086: pkgsrc-readmes.tar.{bz,gz,xz} that contains all pkgsrc READMEs with information
9087: about categories and packages.
9088:
9089: The stable directory is a symlink to the latest pkgsrc-20xxQy.
9090:
9091: The pkgsrc-20xxQy. directories contain files related to the -20xxQy stable
9092: branch of the CVS repository. In these directories there is an additional file
9093: called pkgsrc-20xxQy.tar.{bz,gz,xz}, which contains the state of pkgsrc when it
9094: was branched.
1.148 leot 9095:
1.154 rillig 9096: Appendix D. Help topics
9097:
9098: The following list contains all help topics that are available when running
9099: bmake help topic=:index.
9100:
1.196 ! jnemeth 9101: #! -lintl
! 9102: 64bit ABI
! 9103: ACCEPTABLE_LICENSES ACROREAD_FONTPATH
! 9104: ADDITIONAL AFAIK
! 9105: AIX ALLOW_VULNERABLE_PACKAGES
! 9106: ALL_ENV ALTERNATIVES_SRC
! 9107: AMANDA_TMP AMANDA_USER
! 9108: AMANDA_VAR APACHE_GROUP
! 9109: APACHE_MODULE_NAME APACHE_MODULE_SRC
! 9110: APACHE_MODULE_SRCDIR APACHE_PKG_PREFIX
! 9111: APACHE_SUEXEC_CONFIGURE_ARGS APACHE_SUEXEC_DOCROOT
! 9112: APACHE_USER APPEND_ABI
! 9113: APPEND_ELF ARLA_CACHE
! 9114: AUDIT_PACKAGES_FLAGS AUTOCONF_REQD
! 9115: AUTOMAKE_OVERRIDE AUTOMAKE_REQD
! 9116: AUTO_MKDIRS BDB185_DEFAULT
! 9117: BDBBASE BDB_ACCEPTED
! 9118: BDB_DEFAULT BDB_LIBS
! 9119: BDB_TYPE BIND_DIR
! 9120: BIND_GROUP BIND_USER
! 9121: BINOWN BINPKG_SITES
! 9122: BIN_INSTALL_FLAGS BISON_PKGDATADIR
! 9123: BLAS_ACCEPTED BLAS_LIBS
! 9124: BLAS_TYPE BOOTSTRAP_DEPENDS
! 9125: BOOTSTRAP_SETUPTOOLS BROKEN
! 9126: BROKEN_EXCEPT_ON_PLATFORM BROKEN_ON_PLATFORM
! 9127: BSDSRCDIR BSDXSRCDIR
! 9128: BSD_MAKE_ENV BUILDLINK_AUTO_DIRS
! 9129: BUILDLINK_AUTO_VARS BUILDLINK_CFLAGS
! 9130: BUILDLINK_CONTENTS_FILTER BUILDLINK_CPPFLAGS
! 9131: BUILDLINK_FILES BUILDLINK_FILES_CMD
! 9132: BUILDLINK_FNAME_TRANSFORM BUILDLINK_LDFLAGS
! 9133: BUILDLINK_LIBS BUILDLINK_OPSYS_SUPPORT_PTHREAD
! 9134: BUILDLINK_PKGNAME BUILDLINK_PREFIX
! 9135: BUILDLINK_RPATHDIRS BUILDLINK_TREE
! 9136: BUILD_DEFS BUILD_DEFS_EFFECTS
! 9137: BUILD_DEPENDS BUILD_DIRS
! 9138: BUILD_ENV_SHELL BUILD_MAKE_CMD
! 9139: BUILD_MAKE_FLAGS BUILD_TARGET
! 9140: BUILTIN_FIND_FILES BUILTIN_FIND_FILES_VAR
! 9141: BUILTIN_FIND_GREP BUILTIN_FIND_HEADERS
! 9142: BUILTIN_FIND_HEADERS_VAR BUILTIN_FIND_PKGCONFIG
! 9143: BUILTIN_FIND_PKGCONFIG_VAR BUILTIN_PKG
! 9144: BUILTIN_TEST_CURSES_DEFINES BUILTIN_TEST_CURSES_FUNCS
! 9145: BUILTIN_VERSION_SCRIPT BUILTIN_X11_TYPE
! 9146: BUILTIN_X11_VERSION CACTI_GROUP
! 9147: CACTI_USER CANNA_GROUP
! 9148: CANNA_USER CAT
! 9149: CCACHE_BASE CCACHE_DIR
! 9150: CCACHE_LOGFILE CC_VERSION
! 9151: CC_VERSION_STRING CDRECORD_CONF
! 9152: CDROM_PKG_URL_DIR CDROM_PKG_URL_HOST
! 9153: CHECK_COMPILER CHECK_FAKEHOME
! 9154: CHECK_FILES CHECK_FILES_SKIP
! 9155: CHECK_FILES_STRICT CHECK_HEADERS
! 9156: CHECK_HEADERS_SKIP CHECK_INTERPRETER
! 9157: CHECK_INTERPRETER_SKIP CHECK_PERMS
! 9158: CHECK_PERMS_AUTOFIX CHECK_PERMS_SKIP
! 9159: CHECK_PORTABILITY CHECK_PORTABILITY_EXPERIMENTAL
! 9160: CHECK_PORTABILITY_SKIP CHECK_RELRO
! 9161: CHECK_RELRO_SKIP CHECK_RELRO_SUPPORTED
! 9162: CHECK_SHLIBS CHECK_SHLIBS_BLACKLIST
! 9163: CHECK_SHLIBS_SKIP CHECK_SHLIBS_SUPPORTED
! 9164: CHECK_SSP CHECK_SSP_SKIP
! 9165: CHECK_SSP_SUPPORTED CHECK_STRIPPED
! 9166: CHECK_STRIPPED_SKIP CHECK_WRKREF
! 9167: CHECK_WRKREF_EXTRA_DIRS CHECK_WRKREF_SKIP
! 9168: CLAMAV_DBDIR CLAMAV_GROUP
! 9169: CLAMAV_USER CLANGBASE
! 9170: CLEANDEPENDS CMAKE_DEPENDENCIES_REWRITE
! 9171: CMAKE_INSTALL_NAME_DIR CMAKE_INSTALL_PREFIX
! 9172: CMAKE_MODULE_PATH_OVERRIDE CMAKE_PKGSRC_BUILD_FLAGS
! 9173: CMAKE_PREFIX_PATH CMAKE_USE_GNU_INSTALL_DIRS
! 9174: COMPILER_RPATH_FLAG COMPILER_USE_SYMLINKS
! 9175: CONFIGURE_ARGS CONFIGURE_DIRS
! 9176: CONFIGURE_ENV CONFIGURE_ENV_SHELL
! 9177: CONFIGURE_HAS_INFODIR CONFIGURE_HAS_MANDIR
! 9178: CONFIGURE_SCRIPT CONFIG_SHELL
! 9179: CONFIG_SHELL_FLAGS CONF_FILES
! 9180: CONF_FILES_MODE CONF_FILES_PERMS
! 9181: CONSERVER_DEFAULTHOST CONSERVER_DEFAULTPORT
! 9182: CP CPP
! 9183: CPP_PRECOMP_FLAGS CREATE_WRKDIR_SYMLINK
! 9184: CROSSBASE CTFCONVERT
! 9185: CTF_FILES_SKIP CTF_SUPPORTED
! 9186: CTYPE CUPS_GROUP
! 9187: CUPS_SYSTEM_GROUPS CUPS_USER
! 9188: CURSES_DEFAULT CURSES_TYPE
! 9189: CXX CYRUS_GROUP
! 9190: CYRUS_IDLE CYRUS_USER
! 9191: DAEMONTOOLS_GROUP DAEMONTOOLS_LOG_USER
! 9192: DARWIN_NO_SYSTEM_LIBS DARWIN_REQUIRES_FILTER
! 9193: DBUS_GROUP DBUS_USER
! 9194: DEFANG_GROUP DEFANG_USER
! 9195: DEFAULT_ACCEPTABLE_LICENSES DEFAULT_DISTFILES
! 9196: DEFAULT_IRC_SERVER DEFAULT_SERIAL_DEVICE
! 9197: DEF_UMASK DEINSTALLDEPENDS
! 9198: DEINSTALL_SRC DEINSTALL_TEMPLATES
! 9199: DELAYED_ERROR_MSG DELAYED_WARNING_MSG
! 9200: DEPENDS DEPENDS_TARGET
! 9201: DEPENDS_TYPE DESTDIR
! 9202: DESTDIR_VARNAME DIALER_GROUP
! 9203: DIGEST_REQD DISTDIR
! 9204: DISTFILES DISTINFO_FILE
! 9205: DISTNAME DIST_PATH
! 9206: DIST_SUBDIR DJBDNS_AXFR_USER
! 9207: DJBDNS_CACHE_USER DJBDNS_DJBDNS_GROUP
! 9208: DJBDNS_LOG_USER DJBDNS_RBL_USER
! 9209: DJBDNS_TINY_USER DLOPEN_REQUIRE_PTHREADS
! 9210: DL_AUTO_VARS DL_CFLAGS
! 9211: DL_LDFLAGS DL_LIBS
! 9212: DNS DOCOWN
! 9213: DOWNLOADED_DISTFILE DT_LAYOUT
! 9214: DYNAMIC_SITES_CMD DYNAMIC_SITES_SCRIPT
! 9215: ECHO ECHO_N
! 9216: ELK_GUI EMACS_TYPE
! 9217: EMULDIR EMULSUBDIR
! 9218: EMULSUBDIRSLASH EMUL_ARCH
! 9219: EMUL_DISTRO EMUL_EXEC_FMT
! 9220: EMUL_IS_NATIVE EMUL_MODULES
! 9221: EMUL_OPSYS EMUL_PKG_FMT
! 9222: EMUL_PLATFORM EMUL_PLATFORMS
! 9223: EMUL_PREFER EMUL_REQD
! 9224: EMUL_TYPE ERROR_MSG
! 9225: EXIM_GROUP EXIM_USER
! 9226: EXPORT_SYMBOLS_LDFLAGS EXTRACTOR
! 9227: EXTRACT_CMD EXTRACT_CMD_DEFAULT
! 9228: EXTRACT_DIR EXTRACT_ELEMENTS
! 9229: EXTRACT_ENV EXTRACT_ONLY
! 9230: EXTRACT_OPTS EXTRACT_SUFX
! 9231: EXTRACT_USING FAIL
! 9232: FAILOVER_FETCH FAIL_MSG
! 9233: FAKE_NCURSES FAM
! 9234: FAM_ACCEPTED FAM_DEFAULT
! 9235: FAM_SERVER FCPATH
! 9236: FEATURE_CPPFLAGS FEATURE_LDFLAGS
! 9237: FEATURE_LIBS FETCH_AFTER_ARGS
! 9238: FETCH_BEFORE_ARGS FETCH_CMD
! 9239: FETCH_OUTPUT_ARGS FETCH_PROXY
! 9240: FETCH_RESUME_ARGS FETCH_TIMEOUT
! 9241: FETCH_USE_IPV4_ONLY FETCH_USING
! 9242: FILES_SUBST FILES_SUBST_SED
! 9243: FIX_SYSTEM_HEADERS FLUXBOX_USE_GNOME
! 9244: FLUXBOX_USE_KDE FLUXBOX_USE_XFT
! 9245: FLUXBOX_USE_XINERAMA FONTS_DIRS
! 9246: FONTS_VERBOSE FOO_HACKS_MK
! 9247: FOX_USE_XUNICODE FREEWNN_GROUP
! 9248: FREEWNN_USER FTP_PKG_URL_DIR
! 9249: FTP_PKG_URL_HOST GAMEDATAMODE
! 9250: GAMEDATA_PERMS GAMEDIRMODE
! 9251: GAMEDIR_PERMS GAMEGRP
! 9252: GAMEMODE GAMEOWN
! 9253: GAMES_GROUP GAMES_USER
! 9254: GCC GCCBASE
! 9255: GCC_REQD GCC_VERSION_SUFFIX
! 9256: GEM_BUILD GEM_CLEANBUILD
! 9257: GEM_CLEANBUILD_EXTENSIONS GEM_DOCDIR
! 9258: GEM_EXTSDIR GEM_HOME
! 9259: GEM_KEEPBUILD GEM_LIBDIR
! 9260: GEM_NAME GEM_PATH
! 9261: GEM_SPECFILE GENERATE_PLIST
! 9262: GHOSTSCRIPT_REQD GITHUB_PROJECT
! 9263: GITHUB_RELEASE GITHUB_TAG
! 9264: GITHUB_TYPE GNU
! 9265: GNU_CONFIGURE GNU_CONFIGURE_INFODIR
! 9266: GNU_CONFIGURE_MANDIR GNU_CONFIGURE_QUIET
! 9267: GNU_CONFIGURE_STRICT GODEP_REDIRECTS
! 9268: GO_BUILD_PATTERN GO_DEPS
! 9269: GO_DIST_BASE GO_MODULE_FILES
! 9270: GO_SRCPATH GO_VERSION_DEFAULT
! 9271: GROUP_SPECIFIC_PKGS GRUB_NETWORK_CARDS
! 9272: GRUB_PRESET_COMMAND GRUB_SCAN_ARGS
! 9273: GZIP HASKELL_ENABLE_HADDOCK_DOCUMENTATION
! 9274: HASKELL_ENABLE_LIBRARY_PROFILING HASKELL_ENABLE_SHARED_LIBRARY
! 9275: HASKELL_OPTIMIZATION_LEVEL HAS_CONFIGURE
! 9276: HEADER_TEMPLATES HOMEPAGE
! 9277: HOST_PKGTOOLS_ARGS HOST_SPECIFIC_PKGS
! 9278: HOWL_GROUP HOWL_USER
! 9279: ICCBASE ICECAST_CHROOTDIR
! 9280: ICON_THEMES IDOBASE
! 9281: IGNORE_CCACHE IGNORE_INFO_DIRS
! 9282: IGNORE_INTERACTIVE_FETCH IMAKE
! 9283: IMAKEOPTS IMAKE_MAKE
! 9284: IMAKE_MANINSTALL IMAP_UW_CCLIENT_MBOX_FMT
! 9285: IMDICTDIR INCOMPAT_CURSES
! 9286: INFO_DIR INFO_FILES
! 9287: INFO_FILES_VERBOSE INFO_MSG
! 9288: INIT_SYSTEM INN_DATA_DIR
! 9289: INN_GROUP INN_USER
! 9290: INSTALLATION_DIRS INSTALLATION_DIRS_FROM_PLIST
! 9291: INSTALL_ENV INSTALL_SH_OVERRIDE
! 9292: INSTALL_SRC INSTALL_TEMPLATES
! 9293: INSTALL_UNSTRIPPED IRCD_HYBRID_IRC_GROUP
! 9294: IRCD_HYBRID_IRC_USER IRCD_HYBRID_MAXCONN
! 9295: IRCD_HYBRID_NICLEN IRCD_HYBRID_SYSLOG_EVENTS
! 9296: IRCD_HYBRID_SYSLOG_FACILITY IRCD_HYBRID_TOPICLEN
! 9297: IRIX IRRD_USE_PGP
! 9298: JABBERD_GROUP JABBERD_LOGDIR
! 9299: JABBERD_PIDDIR JABBERD_SPOOLDIR
! 9300: JABBERD_USER JAKARTA_HOME
! 9301: JAVA_BINPREFIX JAVA_CLASSPATH
! 9302: JAVA_HOME JAVA_LD_LIBRARY_PATH
! 9303: JAVA_NAME JAVA_UNLIMIT
! 9304: JAVA_WRAPPERS JPEG_ACCEPTED
! 9305: JPEG_DEFAULT KERBEROS
! 9306: KERMIT_SUID_UUCP KJS_USE_PCRE
! 9307: KNEWS_DOMAIN_FILE KNEWS_DOMAIN_NAME
! 9308: KRB5_ACCEPTED KRB5_DEFAULT
! 9309: LANGUAGES LAPACK_LIBS
! 9310: LATEX2HTML_ICONPATH LDCONFIG_ADD_CMD
! 9311: LDCONFIG_REMOVE_CMD LEAFNODE_DATA_DIR
! 9312: LEAFNODE_GROUP LEAFNODE_USER
! 9313: LIBDVDCSS_HOMEPAGE LIBDVDCSS_MASTER_SITES
! 9314: LIBRSVG_TYPE LIBTOOL
! 9315: LIBTOOLIZE_PLIST LIBTOOL_M4_OVERRIDE
! 9316: LIBUSB_TYPE LICENSE
! 9317: LINKER_RPATH_FLAG LINK_RPATH_FLAG
! 9318: LINUX_LOCALES LOCALBASE
! 9319: LOCALBASE_LOCKTYPE LOCALPATCHES
! 9320: LOVE_DATA LOVE_GAME
! 9321: LOVE_VERSION LP64PLATFORMS
! 9322: MACHINE_PLATFORM MAILAGENT_DOMAIN
! 9323: MAILAGENT_EMAIL MAILAGENT_FQDN
! 9324: MAILAGENT_ORGANIZATION MAJORDOMO_HOMEDIR
! 9325: MAKEINFO_ARGS MAKE_DIRS
! 9326: MAKE_DIRS_PERMS MAKE_ENV
! 9327: MAKE_FILE MAKE_FLAGS
! 9328: MAKE_JOBS MAKE_JOBS_SAFE
! 9329: MAKE_PROGRAM MANCOMPRESSED_IF_MANZ
! 9330: MANINSTALL MANZ
! 9331: MASTER_SITES MASTER_SITE_BACKUP
! 9332: MASTER_SITE_LOCAL MASTER_SITE_MOZILLA
! 9333: MASTER_SITE_OVERRIDE MASTER_SITE_PERL_CPAN
! 9334: MASTER_SORT MASTER_SORT_RANDOM
! 9335: MASTER_SORT_REGEX MECAB_CHARSET
! 9336: MEDIATOMB_GROUP MEDIATOMB_USER
! 9337: MIPSPROBASE MIREDO_GROUP
! 9338: MIREDO_USER MISSING_FEATURES
! 9339: MKDIR MLDONKEY_GROUP
! 9340: MLDONKEY_HOME MLDONKEY_USER
! 9341: MONOTONE_GROUP MONOTONE_USER
! 9342: MOTIFBASE MOTIF_TYPE
! 9343: MOTIF_TYPE_DEFAULT MPI_TYPE
! 9344: MSGFMT_STRIP_MSGCTXT MSGFMT_STRIP_MSGID_PLURAL
! 9345: MTOOLS_ENABLE_FLOPPYD MV
! 9346: MYSQL_CHARSET MYSQL_DATADIR
! 9347: MYSQL_EXTRA_CHARSET MYSQL_GROUP
! 9348: MYSQL_PKGSRCDIR MYSQL_USER
! 9349: MYSQL_VERSION MYSQL_VERSIONS_ACCEPTED
! 9350: MYSQL_VERSION_DEFAULT NAGIOSCMD_GROUP
! 9351: NAGIOSDIR NAGIOS_GROUP
! 9352: NAGIOS_USER NATIVE_APPEND_ABI
! 9353: NATIVE_APPEND_ELF NATIVE_EXEC_FMT
! 9354: NATIVE_MACHINE_PLATFORM NATIVE_OBJECT_FMT
! 9355: NBPAX_PROGRAM_PREFIX NETBSD_LOGIN_NAME
! 9356: NMH_EDITOR NMH_MTA
! 9357: NMH_PAGER NOLOGIN
! 9358: NOTE NOT_FOR_PLATFORM
! 9359: NOT_PAX_ASLR_SAFE NOT_PAX_MPROTECT_SAFE
! 9360: NO_BUILD NO_CHECKSUM
! 9361: NO_CONFIGURE NO_SKIP
! 9362: NS_PREFERRED NULLMAILER_GROUP
! 9363: NULLMAILER_USER OASIS
! 9364: OASIS_BUILD_ARGS OBJHOSTNAME
! 9365: OBJMACHINE OCAML_FINDLIB_DIRS
! 9366: OCAML_FINDLIB_REGISTER OCAML_FINDLIB_REGISTER_VERBOSE
! 9367: OCAML_SITELIBDIR OCAML_TOPKG_DOCDIR
! 9368: OCAML_USE_DUNE OCAML_USE_FINDLIB
! 9369: OCAML_USE_JBUILDER OCAML_USE_OASIS
! 9370: OCAML_USE_OASIS_DYNRUN OCAML_USE_OPAM
! 9371: OCAML_USE_OPT_COMPILER OCAML_USE_TOPKG
! 9372: OMF ONLY_FOR_COMPILER
! 9373: ONLY_FOR_PLATFORM OPENSSH_CHROOT
! 9374: OPENSSH_GROUP OPENSSH_USER
! 9375: OPSYS OPSYS_EMULDIR
! 9376: OS OSS_TYPE
! 9377: OSX OSX_TOLERATE_SDK_SKEW
! 9378: OS_VARIANT OS_VERSION
! 9379: OTF_FONTS_DIR OVERRIDE_DIRDEPTH
! 9380: OVERRIDE_GEMSPEC OVERRIDE_GNU_CONFIG_SCRIPTS
! 9381: OWN_DIRS OWN_DIRS_PERMS
! 9382: P4GROUP P4PORT
! 9383: P4ROOT P4USER
! 9384: PACKAGES PALMOS_DEFAULT_SDK
! 9385: PAMBASE PAM_DEFAULT
! 9386: PAPERSIZE PASSIVE_FETCH
! 9387: PATCHDIR PATCHFILES
! 9388: PATCH_ARGS PATCH_DEBUG
! 9389: PATCH_DIST_ARGS PATCH_DIST_CAT
! 9390: PATCH_DIST_STRIP PATCH_FUZZ_FACTOR
! 9391: PATCH_STRIP PATH
! 9392: PCCBASE PEAR_CMD
! 9393: PEAR_LIB PEAR_PACKAGE_XML
! 9394: PERL5 PERL5_CONFIGURE
! 9395: PERL5_CONFIGURE_DIRS PERL5_LDFLAGS
! 9396: PERL5_LICENSE PERL5_MODULE_TYPE
! 9397: PERL5_PACKLIST PERL5_PACKLIST_DIR
! 9398: PERL5_PERLBASE PERL5_SITEBASE
! 9399: PERL5_USE_PACKLIST PERL5_VENDORBASE
! 9400: PFCTL PFVAR_H
! 9401: PF_VERSION PGGROUP
! 9402: PGHOME PGPKGSRCDIR
! 9403: PGSQL_TYPE PGSQL_VERSION
! 9404: PGSQL_VERSIONS_ACCEPTED PGSQL_VERSION_DEFAULT
! 9405: PGUSER PG_LIB_EXT
! 9406: PHP PHPCOMMON_MK
! 9407: PHPPKGSRCDIR PHP_BASE_VERS
! 9408: PHP_CHECK_INSTALLED PHP_EXTENSION_DIR
! 9409: PHP_INITIAL_TEENY PHP_PKG_PREFIX
! 9410: PHP_VERSION PHP_VERSIONS_ACCEPTED
! 9411: PHP_VERSIONS_INCOMPATIBLE PHP_VERSION_DEFAULT
! 9412: PHP_VERSION_REQD PILRC_USE_GTK
! 9413: PKGCONFIG_BASE PKGCONFIG_FILE
! 9414: PKGCONFIG_OVERRIDE PKGCONFIG_OVERRIDE_STAGE
! 9415: PKGDIR PKGGNUDIR
! 9416: PKGINFODIR PKGLOCALEDIR
! 9417: PKGMANDIR PKGNAME
! 9418: PKGNAME_REQD PKGPATH
! 9419: PKGREVISION PKGSRC_BLAS_TYPES
! 9420: PKGSRC_CHANGES PKGSRC_COMPILER
! 9421: PKGSRC_KEEP_BIN_PKGS PKGSRC_LOCKTYPE
! 9422: PKGSRC_MAKE_ENV PKGSRC_MESSAGE_RECIPIENTS
! 9423: PKGSRC_MKPIE PKGSRC_MKREPRO
! 9424: PKGSRC_RUN_TEST PKGSRC_SETENV
! 9425: PKGSRC_SLEEPSECS PKGSRC_TODO
! 9426: PKGSRC_USE_CTF PKGSRC_USE_FORTIFY
! 9427: PKGSRC_USE_RELRO PKGSRC_USE_SSP
! 9428: PKGSRC_USE_STACK_CHECK PKGTASKS_DATAFILE
! 9429: PKGTOOLS_ARGS PKGTOOLS_ENV
! 9430: PKG_ALTERNATIVES PKG_APACHE
! 9431: PKG_APACHE_ACCEPTED PKG_APACHE_DEFAULT
! 9432: PKG_BEST_EXISTS PKG_BUILD_OPTIONS
! 9433: PKG_COMPRESSION PKG_CONFIG
! 9434: PKG_CONFIG_PERMS PKG_CREATE_USERGROUP
! 9435: PKG_DB_TMPDIR PKG_DEBUG_LEVEL
! 9436: PKG_DEFAULT_OPTIONS PKG_DESTDIR_SUPPORT
! 9437: PKG_DEVELOPER PKG_DISABLED_OPTIONS
! 9438: PKG_FATAL_ERRORS PKG_FC
! 9439: PKG_FILELIST_CMD PKG_GECOS
! 9440: PKG_GID PKG_GROUPS
! 9441: PKG_GROUPS_VARS PKG_HOME
! 9442: PKG_INIT_SCRIPTS PKG_JAVA_HOME
! 9443: PKG_JVM PKG_JVMS_ACCEPTED
! 9444: PKG_JVM_DEFAULT PKG_LEGACY_OPTIONS
! 9445: PKG_LIBTOOL PKG_OPTIONS
! 9446: PKG_OPTIONS_DEPRECATED_WARNINGS PKG_OPTIONS_LEGACY_OPTS
! 9447: PKG_OPTIONS_LEGACY_VARS PKG_OPTIONS_NONEMPTY_SETS
! 9448: PKG_OPTIONS_OPTIONAL_GROUPS PKG_OPTIONS_REQUIRED_GROUPS
! 9449: PKG_OPTIONS_VAR PKG_PHP
! 9450: PKG_PHP_MAJOR_VERS PKG_PHP_VERSION
! 9451: PKG_RCD_SCRIPTS PKG_REFCOUNT_DBDIR
! 9452: PKG_REGISTER_SHELLS PKG_RESUME_TRANSFERS
! 9453: PKG_SHELL PKG_SUGGESTED_OPTIONS
! 9454: PKG_SUPPORTED_OPTIONS PKG_SYSCONFBASE
! 9455: PKG_SYSCONFBASEDIR PKG_SYSCONFDIR
! 9456: PKG_SYSCONFDIR_PERMS PKG_SYSCONFSUBDIR
! 9457: PKG_SYSCONFVAR PKG_TOOLS_BIN
! 9458: PKG_UID PKG_UPDATE_FONTS_DB
! 9459: PKG_USERS PKG_USERS_VARS
! 9460: PKG_VERBOSE PLIST
! 9461: PLIST_AWK PLIST_AWK_ENV
! 9462: PLIST_SRC PLIST_SUBST
! 9463: PLIST_TYPE PLIST_VARS
! 9464: POPTOP_USE_MPPE POSSIBLE_GFORTRAN_VERSION
! 9465: POST_FETCH_HOOK PREFER
! 9466: PREFER_NATIVE PREFER_NATIVE_PTHREADS
! 9467: PREFER_PKGSRC PREFIX
! 9468: PREPEND_PATH PRE_ROOT_CMD
! 9469: PRIVILEGED_STAGES PS
! 9470: PTHREAD_AUTO_VARS PTHREAD_CFLAGS
! 9471: PTHREAD_LDFLAGS PTHREAD_LIBS
! 9472: PTHREAD_OPTS PTHREAD_TYPE
! 9473: PVM_SSH PYPKGPREFIX
! 9474: PYTHON_FOR_BUILD_ONLY PYTHON_SELF_CONFLICT
! 9475: PYTHON_VERSIONED_DEPENDENCIES PYTHON_VERSIONS_ACCEPTED
! 9476: PYTHON_VERSIONS_INCOMPATIBLE PYTHON_VERSION_DEFAULT
! 9477: PYTHON_VERSION_REQD PYVERSSUFFIX
! 9478: PY_NO_EGG QMAILDIR
! 9479: QMAIL_ALIAS_USER QMAIL_DAEMON_USER
! 9480: QMAIL_LOG_USER QMAIL_NOFILES_GROUP
! 9481: QMAIL_PASSWD_USER QMAIL_QMAIL_GROUP
! 9482: QMAIL_QUEUE_DIR QMAIL_QUEUE_EXTRA
! 9483: QMAIL_QUEUE_USER QMAIL_REMOTE_USER
! 9484: QMAIL_ROOT_USER QMAIL_SEND_USER
! 9485: QPOPPER_FAC QPOPPER_SPOOL_DIR
! 9486: QPOPPER_USER RAKE_NAME
! 9487: RASMOL_DEPTH RCD_SCRIPTS
! 9488: RCD_SCRIPTS_DIR RCD_SCRIPTS_EXAMPLEDIR
! 9489: RCD_SCRIPTS_MODE RCD_SCRIPTS_SHELL
! 9490: RCD_SCRIPT_SRC RDOC
! 9491: READLINE_DEFAULT READLINE_TYPE
! 9492: REAL_ROOT_GROUP REAL_ROOT_USER
! 9493: RECURSIVE_MAKE RELAY_CTRL_DIR
! 9494: RELRO_SUPPORTED REPLACE_AWK
! 9495: REPLACE_BASH REPLACE_CSH
! 9496: REPLACE_KSH REPLACE_PERL
! 9497: REPLACE_PERL6 REPLACE_PHP
! 9498: REPLACE_PYTHON REPLACE_RUBY
! 9499: REPLACE_RUBY_DIRS REPLACE_RUBY_PAT
! 9500: REPLACE_SH REPLACE_TEXLUA
! 9501: REQD_DIRS REQD_DIRS_PERMS
! 9502: REQD_FILES REQD_FILES_MODE
! 9503: REQD_FILES_PERMS RESOLV_AUTO_VARS
! 9504: RESOLV_LDFLAGS RESOLV_LIBS
! 9505: RM ROOT_CMD
! 9506: ROOT_GROUP ROOT_USER
! 9507: RPCGEN RPM
! 9508: RPM2PKG_PLIST RPM2PKG_PREFIX
! 9509: RPM2PKG_STAGE RPM2PKG_STRIP
! 9510: RPM2PKG_SUBPREFIX RPMFILES
! 9511: RPMIGNOREPATH RPM_DB_PREFIX
! 9512: RSSH_CVS_PATH RSSH_RDIST_PATH
! 9513: RSSH_RSYNC_PATH RSSH_SCP_PATH
! 9514: RSSH_SFTP_SERVER_PATH RUBY
! 9515: RUBYGEM RUBYGEM_NAME
! 9516: RUBYGEM_OPTIONS RUBY_ABI_VERSION
! 9517: RUBY_ARCH RUBY_ARCHINC
! 9518: RUBY_ARCHLIB RUBY_BASE
! 9519: RUBY_BASERIDIR RUBY_BUILD_DOCUMENT
! 9520: RUBY_DLEXT RUBY_DOC
! 9521: RUBY_DYNAMIC_DIRS RUBY_EG
! 9522: RUBY_ENCODING_ARG RUBY_EXTCONF
! 9523: RUBY_EXTCONF_CHECK RUBY_EXTCONF_DEBUG
! 9524: RUBY_EXTCONF_MAKEFILE RUBY_GEM_BASE
! 9525: RUBY_INC RUBY_LIB
! 9526: RUBY_LIB_BASE RUBY_NAME
! 9527: RUBY_NOVERSION RUBY_PKGPREFIX
! 9528: RUBY_RAILS RUBY_RAILS52_VERSION
! 9529: RUBY_RAILS60_VERSION RUBY_RAILS_ACCEPTED
! 9530: RUBY_RAILS_DEFAULT RUBY_RAILS_REQD
! 9531: RUBY_RAILS_STRICT_DEP RUBY_RIDIR
! 9532: RUBY_SETUP RUBY_SHLIB
! 9533: RUBY_SHLIBALIAS RUBY_SHLIBVER
! 9534: RUBY_SIMPLE_INSTALL RUBY_SITEARCHLIB
! 9535: RUBY_SITELIB RUBY_SITELIB_BASE
! 9536: RUBY_SITERIDIR RUBY_SLEXT
! 9537: RUBY_SRCDIR RUBY_STATICLIB
! 9538: RUBY_SUFFIX RUBY_SYSRIDIR
! 9539: RUBY_USE_PTHREAD RUBY_VENDORARCHLIB
! 9540: RUBY_VENDORLIB RUBY_VENDORLIB_BASE
! 9541: RUBY_VER RUBY_VERSION
! 9542: RUBY_VERSIONS_ACCEPTED RUBY_VERSIONS_INCOMPATIBLE
! 9543: RUBY_VERSION_DEFAULT RUBY_VERSION_REQD
! 9544: RUBY_VER_DIR RUN
! 9545: RUN_LDCONFIG SAWFISH_THEMES
! 9546: SCO SCREWS_GROUP
! 9547: SCREWS_USER SCRIPTS_ENV
! 9548: SCROLLKEEPER_DATADIR SCROLLKEEPER_REBUILDDB
! 9549: SCROLLKEEPER_UPDATEDB SDIST_PAWD
! 9550: SERIAL_DEVICES SETGIDGAME
! 9551: SETGID_GAMES_PERMS SETUID_ROOT_PERMS
! 9552: SH SHLIB
! 9553: SIGN_PACKAGES SILC_CLIENT_WITH_PERL
! 9554: SITE_SPECIFIC_PKGS SKIP_DEPENDS
! 9555: SMF_INSTANCES SMF_MANIFEST
! 9556: SMF_METHODS SMF_METHOD_SHELL
! 9557: SMF_METHOD_SRC SMF_NAME
! 9558: SMF_PREFIX SMF_SRCDIR
! 9559: SNIPROXY_GROUP SNIPROXY_USER
! 9560: SOURCE_BUFFSIZE SPECIAL_PERMS
! 9561: SPECIFIC_PKGS SSH_SUID
! 9562: SSP_SUPPORTED SSYNC_PAWD
! 9563: STEP_MSG STRIP
! 9564: STRIP_DBG STRIP_DEBUG
! 9565: STRIP_DEBUG_SUPPORTED STRIP_FILES_SKIP
! 9566: SU SUBDIR
! 9567: SUBST SUBST_CLASSES
! 9568: SUBST_FILES SUBST_FILTER_CMD
! 9569: SUBST_MESSAGE SUBST_NOOP_OK
! 9570: SUBST_SED SUBST_SHOW_DIFF
! 9571: SUBST_SKIP_TEXT_CHECK SUBST_STAGE
! 9572: SUBST_VARS SUNWSPROBASE
! 9573: SUSE_PREFER SU_CMD
! 9574: TBL TERMCAP_TYPE
! 9575: TERMINFO_DEFAULT TERMINFO_TYPE
! 9576: TEST TEST_DEPENDS
! 9577: TEST_DIRS TEST_ENV
! 9578: TEST_ENV_SHELL TEST_MAKE_CMD
! 9579: TEST_MAKE_FLAGS TEST_TARGET
! 9580: TEXLIVE_IGNORE_PATTERNS TEXLIVE_REV
! 9581: TEXLIVE_UNVERSIONED TEXMFSITE
! 9582: TEX_FORMATS TEX_HYPHEN_DAT
! 9583: TEX_HYPHEN_DEF TEX_TEXMF_DIRS
! 9584: THTTPD_LOG_FACILITY TINYDYN_USER
! 9585: TO TOOLS_ALIASES
! 9586: TOOLS_ALWAYS_WRAP TOOLS_ARGS
! 9587: TOOLS_BROKEN TOOLS_CMD
! 9588: TOOLS_CMDLINE_SED TOOLS_CREATE
! 9589: TOOLS_DIR TOOLS_FAIL
! 9590: TOOLS_GNU_MISSING TOOLS_LDCONFIG
! 9591: TOOLS_NOOP TOOLS_PATH
! 9592: TOOLS_SCRIPT TOOL_DEPENDS
! 9593: TTF_FONTS_DIR TYPE
! 9594: UAC_REQD_EXECS UCSPI_SSL_GROUP
! 9595: UCSPI_SSL_USER UNLIMIT_RESOURCES
! 9596: UNPRIVILEGED UNPRIVILEGED_GROUP
! 9597: UNPRIVILEGED_GROUPS UNPRIVILEGED_USER
! 9598: UNWRAP_FILES UNWRAP_PATTERNS
! 9599: UPDATE_GEMSPEC UPDATE_TARGET
! 9600: URI USERGROUP_PHASE
! 9601: USERPPP_GROUP USER_SPECIFIC_PKGS
! 9602: USE_ABI_DEPENDS USE_APR
! 9603: USE_BSD_MAKEFILE USE_BUILTIN
! 9604: USE_CROSS_COMPILE USE_CURSES
! 9605: USE_CWRAPPERS USE_DB185
! 9606: USE_FEATURES USE_GAMESGROUP
! 9607: USE_GCC_RUNTIME USE_IMAKE
! 9608: USE_JAVA USE_JAVA2
! 9609: USE_LANGUAGES USE_LIBTOOL
! 9610: USE_NATIVE_GCC USE_NETBSD_REPO
! 9611: USE_PKGSRC_GCC USE_PKGSRC_GCC_RUNTIME
! 9612: USE_PKGTASKS USE_PKG_ADMIN_DIGEST
! 9613: USE_RUBY_EXTCONF USE_RUBY_INSTALL
! 9614: USE_RUBY_SETUP USE_RUBY_SETUP_PKG
! 9615: USE_TOOLS UUCP_GROUP
! 9616: UUCP_USER VARBASE
! 9617: VARNAME VIM_EXTRA_OPTS
! 9618: WARNING_MSG WCALC_CGIDIR
! 9619: WCALC_CGIPATH WCALC_HTMLDIR
! 9620: WCALC_HTMLPATH WDM_MANAGERS
! 9621: WRAPPER_CC WRAPPER_REORDER_CMDS
! 9622: WRKDIR WRKDIR_BASENAME
! 9623: WRKDIR_LOCKTYPE WRKLOG
! 9624: WRKOBJDIR WRKSRC
! 9625: X10_PORT X11
! 9626: X11BASE X11_PKGSRCDIR
! 9627: X11_TYPE X509_CERTIFICATE
! 9628: X509_KEY XAW_TYPE
! 9629: XLOCK_DEFAULT_MODE XMKMF
! 9630: XMKMF_FLAGS XXX
! 9631: YES ZSH_STATIC
! 9632: __stdc__ _vargroups
! 9633: accept acquire-localbase-lock
! 9634: acquire-lock add
! 9635: administrator alloca
! 9636: alternatives aslr
! 9637: asprintf atlas
! 9638: autoconf automake
! 9639: autoreconf awk
! 9640: bash big-endian
! 9641: bin-install bind
! 9642: binpkg-list blas
! 9643: bootstrap-depends broken
! 9644: broken_on_platform bsd
! 9645: bsd.prog.mk build
! 9646: build-env buildlink-directories
! 9647: buildlink-oss-soundcard-h c
! 9648: c++ ccache
! 9649: cce cdefs
! 9650: ceil changes
! 9651: changes-entry changes-entry-noupdate
! 9652: check check-clean
! 9653: check-files check-files-clean
! 9654: check-vulnerable checksum
! 9655: checksum-phase clean
! 9656: clean-depends cleandir
! 9657: commit commit-changes-entry
! 9658: compact compiler
! 9659: conf config.guess
! 9660: config.sub configuration
! 9661: configure configure-env
! 9662: configure-help configure_args
! 9663: connect cos
! 9664: cputime create-usergroup
! 9665: csh ctf
! 9666: debug declaration
! 9667: declare defined
! 9668: depend dependencies
! 9669: depends depends-checksum
! 9670: depends-fetch deps
! 9671: describe destdir
! 9672: disable distclean
! 9673: distinfo dl
! 9674: dlopen do-build
! 9675: do-buildlink do-clean
! 9676: do-configure do-configure-post-hook
! 9677: do-extract do-fetch
! 9678: emul emul-distinfo
! 9679: emul-fetch emulation
! 9680: emulator enable
! 9681: endian enomem
! 9682: err errx
! 9683: etc exp
! 9684: extract-rpm fabs
! 9685: feature features
! 9686: fetch fetch-list
! 9687: follows forbids
! 9688: form format
! 9689: fortify fortify_source
! 9690: friend fts
! 9691: fts_close fts_open
! 9692: fts_read fts_set
! 9693: gcc gethostbyaddr
! 9694: gethostbyname gethostbyname2
! 9695: getopt_long getprogname
! 9696: getservbyname getservbyport
! 9697: getservent gettext
! 9698: github glob
! 9699: gnu gnu_configure_strict
! 9700: go go-deps
! 9701: golang guess-license
! 9702: hashbang heimdal
! 9703: help imake
! 9704: increment inet_aton
! 9705: interp interpreter
! 9706: intl ip4
! 9707: ip6 ipv4
! 9708: ipv6 iso
! 9709: kerberos krb
! 9710: krb5 ksh
! 9711: lapack latex
! 9712: libintl_bindtextdomain libintl_gettext
! 9713: libintl_textdomain libnbcompat
! 9714: libs libtool
! 9715: licence license
! 9716: lintl little-endian
! 9717: lock locking
! 9718: lvalue make
! 9719: makesum memory
! 9720: meta meta-package
! 9721: meta_package mit-krb5
! 9722: mk.conf mkl
! 9723: mount mprotect
! 9724: mremap nb
! 9725: nbcompat obstack
! 9726: obstack_ptr_grow occurs
! 9727: only openblas
! 9728: options options.mk
! 9729: order override
! 9730: override-intltool override-message-intltool
! 9731: package parallel
! 9732: path pax
! 9733: paxctl pbulk-index
! 9734: pc perl
! 9735: perl5 perms
! 9736: php pkg-build-options
! 9737: pkg-config pkg_build_options
! 9738: platform plist
! 9739: post-extract post-fetch
! 9740: post-wrapper pre-build-checks-hook
! 9741: pre-configure pre-configure-checks-hook
! 9742: pre-extract pre-fetch
! 9743: print-go-deps print-plist
! 9744: print-summary-data privileged-install-hook
! 9745: pypi python
! 9746: readme-all recv
! 9747: recvfrom regcomp
! 9748: release-localbase-lock release-lock
! 9749: relro rename
! 9750: reorder replace
! 9751: replace_interpreter reproducible
! 9752: resolv root
! 9753: ruby send
! 9754: sendfile sendto
! 9755: setenv setgid
! 9756: setprogname setuid
! 9757: sh shebang
! 9758: show show-all
! 9759: show-build-defs show-depends
! 9760: show-deps show-distfiles
! 9761: show-downlevel show-subdir-var
! 9762: show-tools show-var
! 9763: show-vars snprintf
! 9764: socket ssp
! 9765: st_mode stage-install
! 9766: strcasestr strict
! 9767: strip strndup
! 9768: strnlen strsep
! 9769: subst substitutions
! 9770: sun sunpro
! 9771: sunwspro symlink
! 9772: test test-env
! 9773: tex texlive
! 9774: tmp tool
! 9775: tools tools-libtool-m4-override
! 9776: type ulimit
! 9777: undefined undo-replace
! 9778: unlimit unprivileged
! 9779: unprivileged-install-hook unstripped
! 9780: update upload
! 9781: upload-distfiles use_tools
! 9782: user utimes
! 9783: vasprintf verbose
! 9784: vsnprintf warn
! 9785: warning warnings
! 9786: warnx wattr_off
! 9787: wattr_on work
! 9788: wrapper wrkdir
1.154 rillig 9789:
9790: Appendix E. Editing guidelines for the pkgsrc guide
1.1 dsieger 9791:
9792: Table of Contents
9793:
1.154 rillig 9794: E.1. Make targets
9795: E.2. Procedure
1.1 dsieger 9796:
9797: This section contains information on editing the pkgsrc guide itself.
9798:
1.154 rillig 9799: E.1. Make targets
1.1 dsieger 9800:
9801: The pkgsrc guide's source code is stored in pkgsrc/doc/guide/files, and several
9802: files are created from it:
9803:
9804: * pkgsrc/doc/pkgsrc.txt
9805:
9806: * pkgsrc/doc/pkgsrc.html
9807:
1.174 leot 9808: * https://www.NetBSD.org/docs/pkgsrc/
1.1 dsieger 9809:
1.174 leot 9810: * https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf: The PDF version of the
9811: pkgsrc guide.
1.1 dsieger 9812:
1.174 leot 9813: * https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps: PostScript version of the
1.2 rillig 9814: pkgsrc guide.
1.1 dsieger 9815:
1.154 rillig 9816: E.2. Procedure
1.1 dsieger 9817:
9818: The procedure to edit the pkgsrc guide is:
9819:
1.190 bacon 9820: 1. Make sure you have checked out the htdocs repository into a sibling
9821: directory of your pkgsrc directory. You will need the ability to commit
9822: from both pkgsrc and htdocs.
9823:
9824: 2. Make sure you have the packages needed to regenerate the pkgsrc guide (and
1.46 obache 9825: other XML-based NetBSD documentation) installed. These are automatically
9826: installed when you install the meta-pkgs/pkgsrc-guide-tools package.
1.1 dsieger 9827:
1.190 bacon 9828: 3. Run cd doc/guide to get to the right directory. All further steps will take
1.1 dsieger 9829: place here.
9830:
1.190 bacon 9831: 4. Edit the XML file(s) in files/.
1.1 dsieger 9832:
1.190 bacon 9833: 5. Run bmake to check the pkgsrc guide for valid XML and to build the final
1.1 dsieger 9834: output files. If you get any errors at this stage, you can just edit the
9835: files, as there are only symbolic links in the working directory, pointing
9836: to the files in files/.
9837:
1.190 bacon 9838: 6. (cd files && cvs commit)
1.1 dsieger 9839:
1.190 bacon 9840: 7. Run bmake clean && bmake to regenerate the output files with the proper RCS
1.1 dsieger 9841: Ids.
9842:
1.190 bacon 9843: 8. Run bmake regen to install and commit the files in both pkgsrc/doc and
1.1 dsieger 9844: htdocs.
9845:
9846: Note
9847:
9848: If you have added, removed or renamed some chapters, you need to
9849: synchronize them using cvs add or cvs delete in the htdocs directory.
9850:
CVSweb <webmaster@jp.NetBSD.org>