Annotation of htdocs/docs/pkgsrc/pkgsrc.txt, revision 1.205
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
1.202 nia 70: 5.1.3. Updating packages
71: 5.1.4. Deinstalling packages
72: 5.1.5. Getting information about installed packages
73: 5.1.6. Checking for security vulnerabilities in installed packages
74: 5.1.7. Finding if newer versions of your installed packages are in
1.1 dsieger 75: pkgsrc
1.202 nia 76: 5.1.8. Other administrative functions
1.1 dsieger 77:
1.154 rillig 78: 5.2. Building packages from source
1.1 dsieger 79:
1.154 rillig 80: 5.2.1. Requirements
81: 5.2.2. Fetching distfiles
82: 5.2.3. How to build and install
1.1 dsieger 83:
1.154 rillig 84: 6. Configuring pkgsrc
1.1 dsieger 85:
1.154 rillig 86: 6.1. General configuration
87: 6.2. Variables affecting the build process
88: 6.3. Variables affecting the installation process
89: 6.4. Selecting and configuring the compiler
1.1 dsieger 90:
1.154 rillig 91: 6.4.1. Selecting the compiler
92: 6.4.2. Additional flags to the compiler (CFLAGS)
93: 6.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 94:
1.154 rillig 95: 6.5. Developer/advanced settings
96: 6.6. Selecting Build Options
1.1 dsieger 97:
1.154 rillig 98: 7. Creating binary packages
1.1 dsieger 99:
1.154 rillig 100: 7.1. Building a single binary package
101: 7.2. Settings for creation of binary packages
1.1 dsieger 102:
1.154 rillig 103: 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6 rillig 104:
1.154 rillig 105: 8.1. Preparations
1.180 rillig 106: 8.2. Running a bulk build
1.6 rillig 107:
1.154 rillig 108: 8.2.1. Configuration
1.6 rillig 109:
1.154 rillig 110: 8.3. Requirements of a full bulk build
1.178 rillig 111: 8.4. Bulk build variants
1.6 rillig 112:
1.179 rillig 113: 8.4.1. Detect unknown configure options
114: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 115: 8.4.3. Force compiler options only in the build phase
116: 8.4.4. Use custom directories
117: 8.4.5. Turn warnings into errors
118: 8.4.6. Reject packages for which pkglint reports errors
119: 8.4.7. Reject packages that contain forbidden strings
120: 8.4.8. Reject packages whose self-test fails
121: 8.4.9. Reject packages that use undefined shell variables
122: 8.4.10. Turn off verbose logging
1.178 rillig 123:
124: 8.5. Creating a multiple CD-ROM packages collection
125:
126: 8.5.1. Example of cdpack
1.6 rillig 127:
1.154 rillig 128: 9. Directory layout of the installed files
1.6 rillig 129:
1.154 rillig 130: 9.1. File system layout in ${LOCALBASE}
131: 9.2. File system layout in ${VARBASE}
1.6 rillig 132:
1.154 rillig 133: 10. Frequently Asked Questions
1.6 rillig 134:
1.154 rillig 135: 10.1. Are there any mailing lists for pkg-related discussion?
136: 10.2. Utilities for package management (pkgtools)
137: 10.3. How to use pkgsrc as non-root
138: 10.4. How to resume transfers when fetching distfiles?
139: 10.5. How can I install/use modular X.org from pkgsrc?
140: 10.6. How to fetch files from behind a firewall
141: 10.7. How to fetch files from HTTPS sites
142: 10.8. How do I tell make fetch to do passive FTP?
143: 10.9. How to fetch all distfiles at once
144: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc"
1.24 wiz 145: mean?
1.154 rillig 146: 10.11. What does "Could not find bsd.own.mk" mean?
147: 10.12. Using 'sudo' with pkgsrc
148: 10.13. How do I change the location of configuration files?
149: 10.14. Automated security checks
150: 10.15. Why do some packages ignore my CFLAGS?
151: 10.16. A package does not build. What shall I do?
152: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/???
1.24 wiz 153: merge conflicts" mean?
1.1 dsieger 154:
155: II. The pkgsrc developer's guide
156:
1.154 rillig 157: 11. Getting help
1.184 rillig 158: 12. Package components - files, directories and contents
1.1 dsieger 159:
1.184 rillig 160: 12.1. Makefile
161: 12.2. distinfo
162: 12.3. patches/*
1.1 dsieger 163:
1.184 rillig 164: 12.3.1. Structure of a single patch file
165: 12.3.2. Creating patch files
166: 12.3.3. Sources where the patch files come from
167: 12.3.4. Patching guidelines
168: 12.3.5. Feedback to the author
1.1 dsieger 169:
1.184 rillig 170: 12.4. Other mandatory files
171: 12.5. Optional files
1.1 dsieger 172:
1.184 rillig 173: 12.5.1. Files affecting the binary package
174: 12.5.2. Files affecting the build process
175: 12.5.3. Files affecting nothing at all
1.1 dsieger 176:
1.184 rillig 177: 12.6. work*
178: 12.7. files/*
1.1 dsieger 179:
1.184 rillig 180: 13. The build process
1.1 dsieger 181:
1.184 rillig 182: 13.1. Introduction
183: 13.2. Program location
184: 13.3. Directories used during the build process
185: 13.4. Running a phase
186: 13.5. The fetch phase
1.1 dsieger 187:
1.184 rillig 188: 13.5.1. What to fetch and where to get it from
189: 13.5.2. How are the files fetched?
1.1 dsieger 190:
1.184 rillig 191: 13.6. The checksum phase
192: 13.7. The extract phase
193: 13.8. The patch phase
194: 13.9. The tools phase
195: 13.10. The wrapper phase
196: 13.11. The configure phase
197: 13.12. The build phase
198: 13.13. The test phase
199: 13.14. The install phase
200: 13.15. The package phase
201: 13.16. Cleaning up
202: 13.17. Other helpful targets
1.1 dsieger 203:
1.184 rillig 204: 14. Creating a new pkgsrc package from scratch
1.1 dsieger 205:
1.184 rillig 206: 14.1. Common types of packages
1.1 dsieger 207:
1.184 rillig 208: 14.1.1. Perl modules
209: 14.1.2. Python modules and programs
210: 14.1.3. R packages
211: 14.1.4. TeXlive packages
1.1 dsieger 212:
1.184 rillig 213: 14.2. Examples
1.1 dsieger 214:
1.184 rillig 215: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 216:
1.184 rillig 217: 15. Programming in Makefiles
1.1 dsieger 218:
1.184 rillig 219: 15.1. Caveats
220: 15.2. Makefile variables
1.1 dsieger 221:
1.184 rillig 222: 15.2.1. Naming conventions
1.1 dsieger 223:
1.184 rillig 224: 15.3. Code snippets
1.1 dsieger 225:
1.184 rillig 226: 15.3.1. Adding things to a list
227: 15.3.2. Echoing a string exactly as-is
228: 15.3.3. Passing CFLAGS to GNU configure scripts
229: 15.3.4. Handling possibly empty variables
1.1 dsieger 230:
1.184 rillig 231: 16. Options handling
1.1 dsieger 232:
1.184 rillig 233: 16.1. Global default options
234: 16.2. Converting packages to use bsd.options.mk
235: 16.3. Option Names
236: 16.4. Determining the options of dependencies
1.1 dsieger 237:
1.184 rillig 238: 17. Tools needed for building or running
1.1 dsieger 239:
1.184 rillig 240: 17.1. Tools for pkgsrc builds
241: 17.2. Tools needed by packages
242: 17.3. Tools provided by platforms
1.1 dsieger 243:
1.184 rillig 244: 18. Buildlink methodology
1.1 dsieger 245:
1.184 rillig 246: 18.1. Converting packages to use buildlink3
247: 18.2. Writing buildlink3.mk files
1.1 dsieger 248:
1.184 rillig 249: 18.2.1. Anatomy of a buildlink3.mk file
250: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and
251: BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files
1.1 dsieger 252:
1.184 rillig 253: 18.3. Writing builtin.mk files
1.1 dsieger 254:
1.184 rillig 255: 18.3.1. Anatomy of a builtin.mk file
256: 18.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 257:
1.184 rillig 258: 19. PLIST issues
1.1 dsieger 259:
1.184 rillig 260: 19.1. RCS ID
261: 19.2. Semi-automatic PLIST generation
262: 19.3. Tweaking output of make print-PLIST
263: 19.4. Variable substitution in PLIST
264: 19.5. Man page compression
265: 19.6. Changing PLIST source with PLIST_SRC
266: 19.7. Platform-specific and differing PLISTs
267: 19.8. Build-specific PLISTs
268: 19.9. Sharing directories between packages
1.1 dsieger 269:
1.184 rillig 270: 20. The pkginstall framework
1.1 dsieger 271:
1.184 rillig 272: 20.1. Files and directories outside the installation prefix
1.1 dsieger 273:
1.184 rillig 274: 20.1.1. Directory manipulation
275: 20.1.2. File manipulation
1.1 dsieger 276:
1.184 rillig 277: 20.2. Configuration files
1.1 dsieger 278:
1.184 rillig 279: 20.2.1. How PKG_SYSCONFDIR is set
280: 20.2.2. Telling the software where configuration files are
281: 20.2.3. Patching installations
282: 20.2.4. Disabling handling of configuration files
1.1 dsieger 283:
1.184 rillig 284: 20.3. System startup scripts
1.1 dsieger 285:
1.184 rillig 286: 20.3.1. Disabling handling of system startup scripts
1.1 dsieger 287:
1.184 rillig 288: 20.4. System users and groups
289: 20.5. System shells
1.1 dsieger 290:
1.184 rillig 291: 20.5.1. Disabling shell registration
1.1 dsieger 292:
1.184 rillig 293: 20.6. Fonts
1.1 dsieger 294:
1.184 rillig 295: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 296:
1.154 rillig 297: 21. Making your package work
1.1 dsieger 298:
1.154 rillig 299: 21.1. General operation
1.1 dsieger 300:
1.154 rillig 301: 21.1.1. How to pull in user-settable variables from mk.conf
302: 21.1.2. User interaction
303: 21.1.3. Handling licenses
304: 21.1.4. Restricted packages
305: 21.1.5. Handling dependencies
306: 21.1.6. Handling conflicts with other packages
307: 21.1.7. Packages that cannot or should not be built
308: 21.1.8. Packages which should not be deleted, once installed
309: 21.1.9. Handling packages with security problems
310: 21.1.10. How to handle incrementing versions when fixing an
1.1 dsieger 311: existing package
1.154 rillig 312: 21.1.11. Substituting variable text in the package files (the SUBST
1.1 dsieger 313: framework)
314:
1.154 rillig 315: 21.2. The fetch phase
1.1 dsieger 316:
1.154 rillig 317: 21.2.1. Packages whose distfiles aren't available for plain
1.1 dsieger 318: downloading
1.154 rillig 319: 21.2.2. How to handle modified distfiles with the 'old' name
320: 21.2.3. Packages hosted on github.com
1.1 dsieger 321:
1.154 rillig 322: 21.3. The configure phase
1.1 dsieger 323:
1.154 rillig 324: 21.3.1. Shared libraries - libtool
325: 21.3.2. Using libtool on GNU packages that already support libtool
326: 21.3.3. GNU Autoconf/Automake
327:
328: 21.4. Programming languages
329:
330: 21.4.1. C, C++, and Fortran
331: 21.4.2. Java
1.205 ! wiz 332: 21.4.3. Go
! 333: 21.4.4. Packages containing Perl scripts
! 334: 21.4.5. Packages containing shell scripts
! 335: 21.4.6. Other programming languages
1.154 rillig 336:
337: 21.5. The build phase
338:
339: 21.5.1. Compiling C and C++ code conditionally
340: 21.5.2. How to handle compiler bugs
1.172 rillig 341: 21.5.3. No such file or directory
342: 21.5.4. Undefined reference to "..."
343: 21.5.5. Running out of memory
1.154 rillig 344:
345: 21.6. The install phase
346:
347: 21.6.1. Creating needed directories
348: 21.6.2. Where to install documentation
349: 21.6.3. Installing highscore files
350: 21.6.4. Adding DESTDIR support to packages
351: 21.6.5. Packages with hardcoded paths to other interpreters
1.203 nia 352: 21.6.6. Packages installing Perl modules
1.154 rillig 353: 21.6.7. Packages installing info files
354: 21.6.8. Packages installing man pages
1.203 nia 355: 21.6.9. Packages installing X11 fonts
356: 21.6.10. Packages installing SGML or XML data
357: 21.6.11. Packages installing extensions to the MIME database
358: 21.6.12. Packages using intltool
359: 21.6.13. Packages installing startup scripts
360: 21.6.14. Packages installing TeX modules
361: 21.6.15. Packages supporting running binaries in emulation
362: 21.6.16. Packages installing hicolor icons
363: 21.6.17. Packages installing desktop files
1.154 rillig 364:
365: 21.7. Marking packages as having problems
366:
1.184 rillig 367: 22. GNOME packaging and porting
368:
369: 22.1. Meta packages
370: 22.2. Packaging a GNOME application
371: 22.3. Updating GNOME to a newer version
372: 22.4. Patching guidelines
373:
1.154 rillig 374: 23. Submitting and Committing
375:
376: 23.1. Submitting binary packages
377: 23.2. Submitting source packages (for non-NetBSD-developers)
378: 23.3. General notes when adding, updating, or removing packages
379: 23.4. Commit Messages
380: 23.5. Committing: Adding a package to CVS
381: 23.6. Updating a package to a newer version
382: 23.7. Renaming a package in pkgsrc
383: 23.8. Moving a package in pkgsrc
384:
385: 24. Frequently Asked Questions
1.1 dsieger 386:
387: III. The pkgsrc infrastructure internals
388:
1.184 rillig 389: 25. Design of the pkgsrc infrastructure
1.1 dsieger 390:
1.184 rillig 391: 25.1. The meaning of variable definitions
392: 25.2. Avoiding problems before they arise
393: 25.3. Variable evaluation
1.1 dsieger 394:
1.184 rillig 395: 25.3.1. At load time
396: 25.3.2. At runtime
1.1 dsieger 397:
1.184 rillig 398: 25.4. How can variables be specified?
399: 25.5. Designing interfaces for Makefile fragments
1.1 dsieger 400:
1.184 rillig 401: 25.5.1. Procedures with parameters
402: 25.5.2. Actions taken on behalf of parameters
1.1 dsieger 403:
1.184 rillig 404: 25.6. The order in which files are loaded
1.1 dsieger 405:
1.184 rillig 406: 25.6.1. The order in bsd.prefs.mk
407: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 408:
1.184 rillig 409: 26. Regression tests
1.1 dsieger 410:
1.184 rillig 411: 26.1. Running the regression tests
412: 26.2. Adding a new regression test
1.1 dsieger 413:
1.184 rillig 414: 26.2.1. Overridable functions
415: 26.2.2. Helper functions
1.1 dsieger 416:
1.184 rillig 417: 27. Porting pkgsrc
1.1 dsieger 418:
1.184 rillig 419: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 420:
421: A. A simple example package: bison
422:
423: A.1. files
424:
425: A.1.1. Makefile
426: A.1.2. DESCR
427: A.1.3. PLIST
428: A.1.4. Checking a package with pkglint
429:
430: A.2. Steps for building, installing, packaging
431:
432: B. Build logs
433:
434: B.1. Building figlet
435: B.2. Packaging figlet
436:
437: C. Directory layout of the pkgsrc FTP server
438:
1.23 jakllsch 439: C.1. distfiles: The distributed source files
440: C.2. misc: Miscellaneous things
441: C.3. packages: Binary packages
442: C.4. reports: Bulk build reports
1.148 leot 443: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 444:
1.154 rillig 445: D. Help topics
446: E. Editing guidelines for the pkgsrc guide
1.1 dsieger 447:
1.154 rillig 448: E.1. Make targets
449: E.2. Procedure
1.1 dsieger 450:
451: List of Tables
452:
453: 1.1. Platforms supported by pkgsrc
1.184 rillig 454: 12.1. Patching examples
455: 22.1. PLIST handling for GNOME packages
1.1 dsieger 456:
457: Chapter 1. What is pkgsrc?
458:
459: Table of Contents
460:
461: 1.1. Introduction
462:
463: 1.1.1. Why pkgsrc?
464: 1.1.2. Supported platforms
465:
466: 1.2. Overview
467: 1.3. Terminology
468:
469: 1.3.1. Roles involved in pkgsrc
470:
471: 1.4. Typography
472:
473: 1.1. Introduction
474:
475: There is a lot of software freely available for Unix-based systems, which is
476: usually available in form of the source code. Before such software can be used,
477: it needs to be configured to the local system, compiled and installed, and this
478: is exactly what The NetBSD Packages Collection (pkgsrc) does. pkgsrc also has
479: some basic commands to handle binary packages, so that not every user has to
480: build the packages for himself, which is a time-costly task.
481:
482: pkgsrc currently contains several thousand packages, including:
483:
1.104 sevan 484: * www/apache24 - The Apache web server
1.1 dsieger 485:
486: * www/firefox - The Firefox web browser
487:
488: * meta-pkgs/gnome - The GNOME Desktop Environment
489:
1.102 ryoon 490: * meta-pkgs/kde4 - The K Desktop Environment
1.1 dsieger 491:
1.108 rillig 492: ? just to name a few.
1.1 dsieger 493:
494: pkgsrc has built-in support for handling varying dependencies, such as pthreads
495: and X11, and extended features such as IPv6 support on a range of platforms.
496:
497: 1.1.1. Why pkgsrc?
498:
499: pkgsrc provides the following key features:
500:
501: * Easy building of software from source as well as the creation and
502: installation of binary packages. The source and latest patches are
503: retrieved from a master or mirror download site, checksum verified, then
504: built on your system. Support for binary-only distributions is available
505: for both native platforms and NetBSD emulated platforms.
506:
507: * All packages are installed in a consistent directory tree, including
508: binaries, libraries, man pages and other documentation.
509:
1.104 sevan 510: * Tracking of package dependencies automatically, including when performing
511: updates, to ensure required packages are installed. The configuration files
512: of various packages are handled automatically during updates, so local
513: changes are preserved.
1.1 dsieger 514:
515: * Like NetBSD, pkgsrc is designed with portability in mind and consists of
516: highly portable code. This allows the greatest speed of development when
1.26 spz 517: porting to a new platform. This portability also ensures that pkgsrc is
1.1 dsieger 518: consistent across all platforms.
519:
520: * The installation prefix, acceptable software licenses, international
521: encryption requirements and build-time options for a large number of
522: packages are all set in a simple, central configuration file.
523:
524: * The entire source (not including the distribution files) is freely
525: available under a BSD license, so you may extend and adapt pkgsrc to your
526: needs. Support for local packages and patches is available right out of the
527: box, so you can configure it specifically for your environment.
528:
529: The following principles are basic to pkgsrc:
530:
1.198 leot 531: * "It should only work if it's right." -- That means, if a package contains
1.1 dsieger 532: bugs, it's better to find them and to complain about them rather than to
533: just install the package and hope that it works. There are numerous checks
1.175 gutterid 534: in pkgsrc that try to find such bugs: static analysis tools (pkgtools/
1.1 dsieger 535: pkglint), build-time checks (portability of shell scripts), and
536: post-installation checks (installed files, references to shared libraries,
537: script interpreters).
538:
1.198 leot 539: * "If it works, it should work everywhere" -- Like NetBSD has been ported to
1.1 dsieger 540: many hardware architectures, pkgsrc has been ported to many operating
541: systems. Care is taken that packages behave the same on all platforms.
542:
543: 1.1.2. Supported platforms
544:
545: pkgsrc consists of both a source distribution and a binary distribution for
546: these operating systems. After retrieving the required source or binaries, you
547: can be up and running with pkgsrc in just minutes!
548:
549: pkgsrc was derived from FreeBSD's ports system, and initially developed for
550: NetBSD only. Since then, pkgsrc has grown a lot, and now supports the following
551: platforms:
552:
553: Table 1.1. Platforms supported by pkgsrc
554:
1.92 sevan 555: +-----------------------------------------------------------------------------+
556: | Platform | Date Support | Notes |
557: | | Added | |
558: |--------------------------------------+---------------+----------------------|
559: |NetBSD | Aug 1997 | |
560: |--------------------------------------+---------------+----------------------|
561: |Solaris | Mar 1999 |README.Solaris |
562: |--------------------------------------+---------------+----------------------|
563: |Linux | Jun 1999 |README.Linux |
564: |--------------------------------------+---------------+----------------------|
1.191 bacon 565: |Darwin / Mac OS X / OS X / macOS | Oct 2001 |README.macOS |
1.92 sevan 566: |--------------------------------------+---------------+----------------------|
567: |FreeBSD | Nov 2002 |README.FreeBSD |
568: |--------------------------------------+---------------+----------------------|
569: |OpenBSD | Nov 2002 |README.OpenBSD |
570: |--------------------------------------+---------------+----------------------|
571: |IRIX | Dec 2002 |README.IRIX |
572: | | |README.IRIX5.3 |
573: |--------------------------------------+---------------+----------------------|
574: |BSD/OS | Dec 2003 | |
575: |--------------------------------------+---------------+----------------------|
576: |AIX | Dec 2003 |README.AIX |
577: |--------------------------------------+---------------+----------------------|
578: |Interix (Microsoft Windows Services | Mar 2004 |README.Interix |
579: |for Unix) | | |
580: |--------------------------------------+---------------+----------------------|
581: |DragonFlyBSD | Oct 2004 | |
582: |--------------------------------------+---------------+----------------------|
583: |OSF/1 | Nov 2004 |README.OSF1 |
584: |--------------------------------------+---------------+----------------------|
585: |HP-UX | Apr 2007 |README.HPUX |
586: |--------------------------------------+---------------+----------------------|
587: |Haiku | Sep 2010 |README.Haiku |
588: |--------------------------------------+---------------+----------------------|
589: |MirBSD | Jan 2011 | |
590: |--------------------------------------+---------------+----------------------|
591: |Minix3 | Nov 2011 |README.Minix3 |
592: |--------------------------------------+---------------+----------------------|
593: |Cygwin | Mar 2013 |README.Cygwin |
594: |--------------------------------------+---------------+----------------------|
595: |GNU/kFreeBSD | Jul 2013 |README.GNUkFreeBSD |
1.104 sevan 596: |--------------------------------------+---------------+----------------------|
597: |Bitrig | Jun 2014 |README.Bitrig |
1.92 sevan 598: +-----------------------------------------------------------------------------+
1.1 dsieger 599:
600:
601: 1.2. Overview
602:
603: This document is divided into three parts. The first, The pkgsrc user's guide,
604: describes how one can use one of the packages in the Package Collection, either
605: by installing a precompiled binary package, or by building one's own copy using
606: the NetBSD package system. The second part, The pkgsrc developer's guide,
607: explains how to prepare a package so it can be easily built by other NetBSD
608: users without knowing about the package's building details. The third part, The
609: pkgsrc infrastructure internals is intended for those who want to understand
610: how pkgsrc is implemented.
611:
612: This document is available in various formats: HTML, PDF, PS, TXT.
613:
614: 1.3. Terminology
615:
616: There has been a lot of talk about "ports", "packages", etc. so far. Here is a
617: description of all the terminology used within this document.
618:
619: Package
620:
621: A set of files and building instructions that describe what's necessary to
622: build a certain piece of software using pkgsrc. Packages are traditionally
1.123 wiz 623: stored under /usr/pkgsrc, but may be stored in any location, referred to as
624: PKGSRCDIR.
1.1 dsieger 625:
626: The NetBSD package system
627:
628: This is the former name of "pkgsrc". It is part of the NetBSD operating
629: system and can be bootstrapped to run on non-NetBSD operating systems as
630: well. It handles building (compiling), installing, and removing of
631: packages.
632:
633: Distfile
634:
635: This term describes the file or files that are provided by the author of
636: the piece of software to distribute his work. All the changes necessary to
637: build on NetBSD are reflected in the corresponding package. Usually the
638: distfile is in the form of a compressed tar-archive, but other types are
639: possible, too. Distfiles are usually stored below /usr/pkgsrc/distfiles.
640:
641: Port
642:
643: This is the term used by FreeBSD and OpenBSD people for what we call a
644: package. In NetBSD terminology, "port" refers to a different architecture.
645:
646: Precompiled/binary package
647:
648: A set of binaries built with pkgsrc from a distfile and stuffed together in
649: a single .tgz file so it can be installed on machines of the same machine
650: architecture without the need to recompile. Packages are usually generated
651: in /usr/pkgsrc/packages; there is also an archive on ftp.NetBSD.org.
652:
653: Sometimes, this is referred to by the term "package" too, especially in the
654: context of precompiled packages.
655:
656: Program
657:
658: The piece of software to be installed which will be constructed from all
659: the files in the distfile by the actions defined in the corresponding
660: package.
661:
662: 1.3.1. Roles involved in pkgsrc
663:
664: pkgsrc users
665:
666: The pkgsrc users are people who use the packages provided by pkgsrc.
667: Typically they are system administrators. The people using the software
668: that is inside the packages (maybe called "end users") are not covered by
669: the pkgsrc guide.
670:
671: There are two kinds of pkgsrc users: Some only want to install pre-built
672: binary packages. Others build the pkgsrc packages from source, either for
673: installing them directly or for building binary packages themselves. For
674: pkgsrc users Part I, "The pkgsrc user's guide" should provide all necessary
675: documentation.
676:
677: package maintainers
678:
679: A package maintainer creates packages as described in Part II, "The pkgsrc
680: developer's guide".
681:
682: infrastructure developers
683:
684: These people are involved in all those files that live in the mk/ directory
685: and below. Only these people should need to read through Part III, "The
686: pkgsrc infrastructure internals", though others might be curious, too.
687:
688: 1.4. Typography
689:
690: When giving examples for commands, shell prompts are used to show if the
691: command should/can be issued as root, or if "normal" user privileges are
1.115 sevan 692: sufficient. We use a # for root's shell prompt, a % for users' shell prompt,
693: assuming they use the C-shell or tcsh and a $ for bourne shell and derivatives.
1.1 dsieger 694:
695: Part I. The pkgsrc user's guide
696:
697: Table of Contents
698:
1.154 rillig 699: 2. Getting help
700: 3. Where to get pkgsrc and how to keep it up-to-date
1.1 dsieger 701:
1.154 rillig 702: 3.1. Getting pkgsrc for the first time
1.1 dsieger 703:
1.154 rillig 704: 3.1.1. As tar archive
705: 3.1.2. Via anonymous CVS
1.1 dsieger 706:
1.154 rillig 707: 3.2. Keeping pkgsrc up-to-date
1.1 dsieger 708:
1.154 rillig 709: 3.2.1. Via tar files
710: 3.2.2. Via CVS
1.1 dsieger 711:
1.154 rillig 712: 4. Using pkgsrc on systems other than NetBSD
1.1 dsieger 713:
1.154 rillig 714: 4.1. Binary distribution
715: 4.2. Bootstrapping pkgsrc
1.1 dsieger 716:
1.154 rillig 717: 5. Using pkgsrc
1.1 dsieger 718:
1.154 rillig 719: 5.1. Using binary packages
1.1 dsieger 720:
1.154 rillig 721: 5.1.1. Finding binary packages
722: 5.1.2. Installing binary packages
1.202 nia 723: 5.1.3. Updating packages
724: 5.1.4. Deinstalling packages
725: 5.1.5. Getting information about installed packages
726: 5.1.6. Checking for security vulnerabilities in installed packages
727: 5.1.7. Finding if newer versions of your installed packages are in
1.1 dsieger 728: pkgsrc
1.202 nia 729: 5.1.8. 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.198 leot 860: 2021Q1.
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.198 leot 884: The tar file for the stable branch 2021Q1 is in the directory pkgsrc-2021Q1 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.198 leot 889: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q1/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.198 leot 908: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2021Q1 -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.198 leot 990: -rpkgsrc-2021Q1" 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
1.202 nia 1056: 5.1.3. Updating packages
1057: 5.1.4. Deinstalling packages
1058: 5.1.5. Getting information about installed packages
1059: 5.1.6. Checking for security vulnerabilities in installed packages
1060: 5.1.7. Finding if newer versions of your installed packages are in pkgsrc
1061: 5.1.8. Other administrative functions
1.154 rillig 1062:
1063: 5.2. Building packages from source
1064:
1065: 5.2.1. Requirements
1066: 5.2.2. Fetching distfiles
1067: 5.2.3. How to build and install
1.1 dsieger 1068:
1069: Basically, there are two ways of using pkgsrc. The first is to only install the
1070: package tools and to use binary packages that someone else has prepared. This
1071: is the "pkg" in pkgsrc. The second way is to install the "src" of pkgsrc, too.
1072: Then you are able to build your own packages, and you can still use binary
1073: packages from someone else.
1074:
1.154 rillig 1075: 5.1. Using binary packages
1.1 dsieger 1076:
1.151 sevan 1077: On the cdn.NetBSD.org site and mirrors, there are collections of binary
1.9 rillig 1078: packages, ready to be installed. These binary packages have been built using
1079: the default settings for the directories, that is:
1080:
1081: * /usr/pkg for LOCALBASE, where most of the files are installed,
1082:
1083: * /usr/pkg/etc for configuration files,
1084:
1085: * /var for VARBASE, where those files are installed that may change after
1086: installation.
1087:
1088: If you cannot use these directories for whatever reasons (maybe because you're
1089: not root), you cannot use these binary packages, but have to build the packages
1.154 rillig 1090: yourself, which is explained in Section 4.2, "Bootstrapping pkgsrc".
1.1 dsieger 1091:
1.154 rillig 1092: 5.1.1. Finding binary packages
1.1 dsieger 1093:
1.5 weinem 1094: To install binary packages, you first need to know from where to get them. The
1.202 nia 1095: first place where you should look is on the main pkgsrc CDN in the directory /
1096: pub/pkgsrc/packages.
1.5 weinem 1097:
1098: This directory contains binary packages for multiple platforms. First, select
1099: your operating system. (Ignore the directories with version numbers attached to
1100: it, they just exist for legacy reasons.) Then, select your hardware
1101: architecture, and in the third step, the OS version and the "version" of
1.9 rillig 1102: pkgsrc.
1103:
1104: In this directory, you often find a file called bootstrap.tar.gz which contains
1105: the package management tools. If the file is missing, it is likely that your
1106: operating system already provides those tools. Download the file and extract it
1107: in the / directory. It will create the directories /usr/pkg (containing the
1.118 sevan 1108: tools for managing binary packages and the database of installed packages).
1.1 dsieger 1109:
1.154 rillig 1110: 5.1.2. Installing binary packages
1.1 dsieger 1111:
1.85 wiz 1112: In the directory from the last section, there is a subdirectory called All/,
1.9 rillig 1113: which contains all the binary packages that are available for the platform,
1.202 nia 1114: excluding those that may not be distributed via HTTP or FTP.
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:
1.202 nia 1119: # PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"
1120: # PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"
1.169 rillig 1121: # PKG_PATH="$PKG_PATH/OPSYS/ARCH/VERSIONS/All/"
1.9 rillig 1122: # export PATH PKG_PATH
1.202 nia 1123: # pkg_add pkgin
1.9 rillig 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.202 nia 1132: # pkgin search nginx
1133: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1134: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1135: # pkgin install zsh nginx-1.19.6 vim
1.1 dsieger 1136:
1.202 nia 1137: Note that pkgin is a user-friendly frontend to the pkg_* tools.
1.1 dsieger 1138:
1.202 nia 1139: Any prerequisite packages needed to run the package in question will be
1140: installed, too, assuming they are present in the repository.
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.202 nia 1145: 5.1.3. Updating packages
1.1 dsieger 1146:
1.202 nia 1147: To update binary packages, it is recommended that you use pkgin upgrade. This
1148: will compare the remote package repository to your locally installed packages
1149: and safely replace any older packages.
1.1 dsieger 1150:
1.202 nia 1151: Note that pkgsrc is released as quarterly branches. If you are updating to a
1152: newer quarterly branch of pkgsrc, you may need to adjust the repository in /usr
1153: /pkg/etc/pkgin/repositories.conf.
1.1 dsieger 1154:
1.202 nia 1155: 5.1.4. Deinstalling packages
1.1 dsieger 1156:
1.202 nia 1157: To deinstall a package, it does not matter whether it was installed from source
1158: code or from a binary package. Neither the pkgin or the pkg_delete command need
1159: to know.
1.1 dsieger 1160:
1.202 nia 1161: To delete a package, you can just run pkgin remove package-name. The package
1162: name can be given with or without version number.
1.1 dsieger 1163:
1.202 nia 1164: 5.1.5. Getting information about installed packages
1.1 dsieger 1165:
1166: The pkg_info shows information about installed packages or binary package
1.202 nia 1167: files. As with other management tools, it works with packages installed from
1168: source or binaries.
1.1 dsieger 1169:
1.202 nia 1170: 5.1.6. Checking for security vulnerabilities in installed packages
1.1 dsieger 1171:
1.202 nia 1172: The pkgsrc Security Team and Packages Groups maintain a list of known
1.164 leot 1173: vulnerabilities to packages which are (or have been) included in pkgsrc. The
1.202 nia 1174: list is available from the NetBSD CDN at https://cdn.NetBSD.org/pub/NetBSD/
1.179 rillig 1175: packages/vulns/pkg-vulnerabilities.
1.1 dsieger 1176:
1.202 nia 1177: Please note that not every "vulnerability" with a CVE assignment is exploitable
1178: in every configuration. Some bugs are marked as active simply because an fix
1179: was not marked as such. Operating system specific hardening and mitigation
1180: features may also reduce the impact of bugs.
1181:
1.23 jakllsch 1182: Through pkg_admin fetch-pkg-vulnerabilities, this list can be downloaded
1183: automatically, and a security audit of all packages installed on a system can
1184: take place.
1185:
1186: There are two components to auditing. The first step, pkg_admin
1187: fetch-pkg-vulnerabilities, is for downloading the list of vulnerabilities from
1188: the NetBSD FTP site. The second step, pkg_admin audit, checks to see if any of
1189: your installed packages are vulnerable. If a package is vulnerable, you will
1190: see output similar to the following:
1.1 dsieger 1191:
1192: Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1193: https://www.samba.org/samba/whatsnew/macroexploit.html
1.1 dsieger 1194:
1.23 jakllsch 1195: You may wish to have the vulnerabilities file downloaded daily so that it
1196: remains current. This may be done by adding an appropriate entry to the root
1197: users crontab(5) entry. For example the entry
1198:
1.121 sevan 1199: # Download vulnerabilities file
1.118 sevan 1200: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1201: # Audit the installed packages and email results to root
1202: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1203: root >/dev/null 2>&1
1.118 sevan 1204:
1205:
1206: will update the vulnerability list every day at 3AM, followed by an audit at
1207: 3:09AM. The result of the audit are then emailed to root. On NetBSD this may be
1208: accomplished instead by adding the following line to /etc/daily.conf:
1209:
1210: fetch_pkg_vulnerabilities=YES
1211:
1.23 jakllsch 1212:
1.118 sevan 1213: to fetch the vulnerability list from the daily security script. The system is
1214: set to audit the packages by default but can be set explicitly, if desired (not
1.123 wiz 1215: required), by adding the following line to /etc/security.conf:
1.23 jakllsch 1216:
1.118 sevan 1217: check_pkg_vulnerabilities=YES
1.23 jakllsch 1218:
1219:
1.118 sevan 1220: see daily.conf(5) and security.conf(5) for more details.
1.1 dsieger 1221:
1.202 nia 1222: 5.1.7. Finding if newer versions of your installed packages are in pkgsrc
1.1 dsieger 1223:
1.12 weinem 1224: Install pkgtools/lintpkgsrc and run lintpkgsrc with the "-i" argument to check
1.202 nia 1225: if any packages are stale, e.g.
1.1 dsieger 1226:
1227: % lintpkgsrc -i
1228: ...
1229: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1230:
1231:
1.202 nia 1232: 5.1.8. Other administrative functions
1.1 dsieger 1233:
1234: The pkg_admin executes various administrative functions on the package system.
1235:
1.154 rillig 1236: 5.2. Building packages from source
1.1 dsieger 1237:
1238: After obtaining pkgsrc, the pkgsrc directory now contains a set of packages,
1.25 wiz 1239: organized into categories. You can browse the online index of packages, or run
1.1 dsieger 1240: make readme from the pkgsrc directory to build local README.html files for all
1241: packages, viewable with any web browser such as www/lynx or www/firefox.
1242:
1243: The default prefix for installed packages is /usr/pkg. If you wish to change
1244: this, you should do so by setting LOCALBASE in mk.conf. You should not try to
1245: use multiple different LOCALBASE definitions on the same system (inside a
1246: chroot is an exception).
1247:
1248: The rest of this chapter assumes that the package is already in pkgsrc. If it
1249: is not, see Part II, "The pkgsrc developer's guide" for instructions how to
1250: create your own packages.
1251:
1.154 rillig 1252: 5.2.1. Requirements
1.1 dsieger 1253:
1254: To build packages from source, you need a working C compiler. On NetBSD, you
1255: need to install the "comp" and the "text" distribution sets. If you want to
1256: build X11-related packages, the "xbase" and "xcomp" distribution sets are
1257: required, too.
1258:
1.154 rillig 1259: 5.2.2. Fetching distfiles
1.1 dsieger 1260:
1261: The first step for building a package is downloading the distfiles (i.e. the
1262: unmodified source). If they have not yet been downloaded, pkgsrc will fetch
1263: them automatically.
1264:
1265: If you have all files that you need in the distfiles directory, you don't need
1266: to connect. If the distfiles are on CD-ROM, you can mount the CD-ROM on /cdrom
1267: and add:
1268:
1269: DISTDIR=/cdrom/pkgsrc/distfiles
1270:
1271: to your mk.conf.
1272:
1273: By default a list of distribution sites will be randomly intermixed to prevent
1274: huge load on servers which holding popular packages (for example,
1275: SourceForge.net mirrors). Thus, every time when you need to fetch yet another
1276: distfile all the mirrors will be tried in new (random) order. You can turn this
1277: feature off by setting MASTER_SORT_RANDOM=NO (for PKG_DEVELOPERs it's already
1278: disabled).
1279:
1280: You can overwrite some of the major distribution sites to fit to sites that are
1281: close to your own. By setting one or two variables you can modify the order in
1282: which the master sites are accessed. MASTER_SORT contains a whitespace
1283: delimited list of domain suffixes. MASTER_SORT_REGEX is even more flexible, it
1284: contains a whitespace delimited list of regular expressions. It has higher
1285: priority than MASTER_SORT. Have a look at pkgsrc/mk/defaults/mk.conf to find
1286: some examples. This may save some of your bandwidth and time.
1287:
1288: You can change these settings either in your shell's environment, or, if you
1.4 rillig 1289: want to keep the settings, by editing the mk.conf file, and adding the
1.1 dsieger 1290: definitions there.
1291:
1.132 wiz 1292: If a package depends on many other packages (such as meta-pkgs/kde4), the build
1.1 dsieger 1293: process may alternate between periods of downloading source, and compiling. To
1294: ensure you have all the source downloaded initially you can run the command:
1295:
1296: % make fetch-list | sh
1297:
1298: which will output and run a set of shell commands to fetch the necessary files
1299: into the distfiles directory. You can also choose to download the files
1300: manually.
1301:
1.154 rillig 1302: 5.2.3. How to build and install
1.1 dsieger 1303:
1304: Once the software has downloaded, any patches will be applied, then it will be
1305: compiled for you. This may take some time depending on your computer, and how
1306: many other packages the software depends on and their compile time.
1307:
1308: Note
1309:
1310: If using bootstrap or pkgsrc on a non-NetBSD system, use the pkgsrc bmake
1311: command instead of "make" in the examples in this guide.
1312:
1313: For example, type
1314:
1315: % cd misc/figlet
1316: % make
1317:
1318:
1319: at the shell prompt to build the various components of the package.
1320:
1321: The next stage is to actually install the newly compiled program onto your
1322: system. Do this by entering:
1323:
1324: % make install
1325:
1326:
1327: while you are still in the directory for whatever package you are installing.
1328:
1329: Installing the package on your system may require you to be root. However,
1330: pkgsrc has a just-in-time-su feature, which allows you to only become root for
1331: the actual installation step.
1332:
1333: That's it, the software should now be installed and setup for use. You can now
1334: enter:
1335:
1336: % make clean
1337:
1338:
1339: to remove the compiled files in the work directory, as you shouldn't need them
1340: any more. If other packages were also added to your system (dependencies) to
1341: allow your program to compile, you can tidy these up also with the command:
1342:
1343: % make clean-depends
1344:
1345:
1346: Taking the figlet utility as an example, we can install it on our system by
1347: building as shown in Appendix B, Build logs.
1348:
1349: The program is installed under the default root of the packages tree - /usr/
1350: pkg. Should this not conform to your tastes, set the LOCALBASE variable in your
1351: environment, and it will use that value as the root of your packages tree. So,
1352: to use /usr/local, set LOCALBASE=/usr/local in your environment. Please note
1353: that you should use a directory which is dedicated to packages and not shared
1354: with other programs (i.e., do not try and use LOCALBASE=/usr). Also, you should
1355: not try to add any of your own files or directories (such as src/, obj/, or
1356: pkgsrc/) below the LOCALBASE tree. This is to prevent possible conflicts
1357: between programs and other files installed by the package system and whatever
1358: else may have been installed there.
1359:
1.4 rillig 1360: Some packages look in mk.conf to alter some configuration options at build
1.1 dsieger 1361: time. Have a look at pkgsrc/mk/defaults/mk.conf to get an overview of what will
1362: be set there by default. Environment variables such as LOCALBASE can be set in
1.4 rillig 1363: mk.conf to save having to remember to set them each time you want to use
1.1 dsieger 1364: pkgsrc.
1365:
1366: Occasionally, people want to "look under the covers" to see what is going on
1367: when a package is building or being installed. This may be for debugging
1368: purposes, or out of simple curiosity. A number of utility values have been
1369: added to help with this.
1370:
1371: 1. If you invoke the make(1) command with PKG_DEBUG_LEVEL=2, then a huge
1372: amount of information will be displayed. For example,
1373:
1374: make patch PKG_DEBUG_LEVEL=2
1375:
1.25 wiz 1376: will show all the commands that are invoked, up to and including the "patch
1377: " stage.
1.1 dsieger 1378:
1379: 2. If you want to know the value of a certain make(1) definition, then the
1380: VARNAME definition should be used, in conjunction with the show-var target.
1381: e.g. to show the expansion of the make(1) variable LOCALBASE:
1382:
1383: % make show-var VARNAME=LOCALBASE
1384: /usr/pkg
1385: %
1386:
1387:
1388: If you want to install a binary package that you've either created yourself
1389: (see next section), that you put into pkgsrc/packages manually or that is
1390: located on a remote FTP server, you can use the "bin-install" target. This
1391: target will install a binary package - if available - via pkg_add(1), else do a
1392: make package. The list of remote FTP sites searched is kept in the variable
1393: BINPKG_SITES, which defaults to ftp.NetBSD.org. Any flags that should be added
1394: to pkg_add(1) can be put into BIN_INSTALL_FLAGS. See pkgsrc/mk/defaults/mk.conf
1395: for more details.
1396:
1397: A final word of warning: If you set up a system that has a non-standard setting
1398: for LOCALBASE, be sure to set that before any packages are installed, as you
1399: cannot use several directories for the same purpose. Doing so will result in
1400: pkgsrc not being able to properly detect your installed packages, and fail
1401: miserably. Note also that precompiled binary packages are usually built with
1402: the default LOCALBASE of /usr/pkg, and that you should not install any if you
1403: use a non-standard LOCALBASE.
1404:
1.154 rillig 1405: Chapter 6. Configuring pkgsrc
1.1 dsieger 1406:
1407: Table of Contents
1408:
1.154 rillig 1409: 6.1. General configuration
1410: 6.2. Variables affecting the build process
1411: 6.3. Variables affecting the installation process
1412: 6.4. Selecting and configuring the compiler
1413:
1414: 6.4.1. Selecting the compiler
1415: 6.4.2. Additional flags to the compiler (CFLAGS)
1416: 6.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 1417:
1.154 rillig 1418: 6.5. Developer/advanced settings
1419: 6.6. Selecting Build Options
1.1 dsieger 1420:
1421: The whole pkgsrc system is configured in a single file, usually called mk.conf.
1422: In which directory pkgsrc looks for that file depends on the installation. On
1423: NetBSD, when you use make(1) from the base system, it is in the directory /etc
1424: /. In all other cases the default location is ${PREFIX}/etc/, depending on
1425: where you told the bootstrap program to install the binary packages.
1426:
1427: The format of the configuration file is that of the usual BSD-style Makefiles.
1428: The whole pkgsrc configuration is done by setting variables in this file. Note
1429: that you can define all kinds of variables, and no special error checking (for
1.112 rillig 1430: example for spelling mistakes) takes place.
1.1 dsieger 1431:
1.154 rillig 1432: 6.1. General configuration
1.1 dsieger 1433:
1.112 rillig 1434: The following variables apply to all pkgsrc packages. A complete list of the
1435: variables that can be configured by the user is available in mk/defaults/
1436: mk.conf, together with some comments that describe each variable's intent.
1.1 dsieger 1437:
1438: * LOCALBASE: Where packages will be installed. The default is /usr/pkg. Do
1439: not mix binary packages with different LOCALBASEs!
1440:
1441: * CROSSBASE: Where "cross" category packages will be installed. The default
1442: is ${LOCALBASE}/cross.
1443:
1.84 wiz 1444: * X11BASE: Where X11 is installed on the system. The default is /usr/X11R7.
1.1 dsieger 1445:
1446: * DISTDIR: Where to store the downloaded copies of the original source
1447: distributions used for building pkgsrc packages. The default is $
1448: {PKGSRCDIR}/distfiles.
1449:
1450: * PKG_DBDIR: Where the database about installed packages is stored. The
1.118 sevan 1451: default is /usr/pkg/pkgdb.
1.1 dsieger 1452:
1453: * MASTER_SITE_OVERRIDE: If set, override the packages' MASTER_SITES with this
1454: value.
1455:
1456: * MASTER_SITE_BACKUP: Backup location(s) for distribution files and patch
1457: files if not found locally or in ${MASTER_SITES} or ${PATCH_SITES}
1.118 sevan 1458: respectively. The defaults is ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/$
1.1 dsieger 1459: {DIST_SUBDIR}/.
1460:
1461: * BINPKG_SITES: List of sites carrying binary pkgs. rel and arch are replaced
1462: with OS release ("2.0", etc.) and architecture ("mipsel", etc.).
1463:
1.23 jakllsch 1464: * ACCEPTABLE_LICENSES: List of acceptable licenses. License names are
1465: case-sensitive. Whenever you try to build a package whose license is not in
1466: this list, you will get an error message. If the license condition is
1467: simple enough, the error message will include specific instructions on how
1468: to change this variable.
1.1 dsieger 1469:
1.154 rillig 1470: 6.2. Variables affecting the build process
1.1 dsieger 1471:
1472: * PACKAGES: The top level directory for the binary packages. The default is $
1473: {PKGSRCDIR}/packages.
1474:
1475: * WRKOBJDIR: The top level directory where, if defined, the separate working
1476: directories will get created, and symbolically linked to from ${WRKDIR}
1477: (see below). This is useful for building packages on several architectures,
1478: then ${PKGSRCDIR} can be NFS-mounted while ${WRKOBJDIR} is local to every
1479: architecture. (It should be noted that PKGSRCDIR should not be set by the
1.198 leot 1480: user -- it is an internal definition which refers to the root of the pkgsrc
1.1 dsieger 1481: tree. It is possible to have many pkgsrc tree instances.)
1482:
1483: * LOCALPATCHES: Directory for local patches that aren't part of pkgsrc. See
1.184 rillig 1484: Section 12.3, "patches/*" for more information.
1.1 dsieger 1485:
1486: * PKGMAKECONF: Location of the mk.conf file used by a package's BSD-style
1487: Makefile. If this is not set, MAKECONF is set to /dev/null to avoid picking
1488: up settings used by builds in /usr/src.
1489:
1.154 rillig 1490: 6.3. Variables affecting the installation process
1.1 dsieger 1491:
1.198 leot 1492: * PKGSRC_KEEP_BIN_PKGS: By default, binary packages of built packages are
1.150 leot 1493: preserved in ${PACKAGES}/All. Setting this variable to "no" prevents this.
1.1 dsieger 1494:
1.107 jnemeth 1495: Packages have to support installation into a subdirectory of WRKDIR. This
1496: allows a package to be built, before the actual filesystem is touched. DESTDIR
1497: support exists in two variations:
1.4 rillig 1498:
1499: * Basic DESTDIR support means that the package installation and packaging is
1500: still run as root.
1501:
1502: * Full DESTDIR support can run the complete build, installation and packaging
1503: as normal user. Root privileges are only needed to add packages.
1504:
1505: With basic DESTDIR support, make clean needs to be run as root.
1506:
1.17 imil 1507: Considering the foo/bar package, DESTDIR full support can be tested using the
1508: following commands
1509:
1510: $ id
1511: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1512: $ mkdir $HOME/packages
1513: $ cd $PKGSRCDIR/foo/bar
1514:
1515: Verify DESTDIR full support, no root privileges should be needed
1516:
1.66 asau 1517: $ make stage-install
1.17 imil 1518:
1519: Create a package without root privileges
1520:
1.66 asau 1521: $ make PACKAGES=$HOME/packages package
1.17 imil 1522:
1523: For the following command, you must be able to gain root privileges using su(1)
1524:
1.66 asau 1525: $ make PACKAGES=$HOME/packages install
1.17 imil 1526:
1527: Then, as a simple user
1528:
1529: $ make clean
1530:
1.154 rillig 1531: 6.4. Selecting and configuring the compiler
1.4 rillig 1532:
1.154 rillig 1533: 6.4.1. Selecting the compiler
1.1 dsieger 1534:
1535: By default, pkgsrc will use GCC to build packages. This may be overridden by
1536: setting the following variables in /etc/mk.conf:
1537:
1538: PKGSRC_COMPILER:
1539:
1540: This is a list of values specifying the chain of compilers to invoke when
1541: building packages. Valid values are:
1542:
1.66 asau 1543: + ccc: Compaq C Compilers (Tru64)
1544:
1545: + ccache: compiler cache (chainable)
1546:
1547: + clang: Clang C and Objective-C compiler
1548:
1.42 asau 1549: + distcc: distributed C/C++ (chainable)
1.1 dsieger 1550:
1.66 asau 1551: + f2c: Fortran 77 to C compiler (chainable)
1552:
1553: + icc: Intel C++ Compiler (Linux)
1554:
1555: + ido: SGI IRIS Development Option cc (IRIX 5)
1.1 dsieger 1556:
1.42 asau 1557: + gcc: GNU C/C++ Compiler
1.1 dsieger 1558:
1.66 asau 1559: + hp: HP-UX C/aC++ compilers
1560:
1.42 asau 1561: + mipspro: Silicon Graphics, Inc. MIPSpro (n32/n64)
1.1 dsieger 1562:
1.66 asau 1563: + mipspro-ucode: Silicon Graphics, Inc. MIPSpro (o32)
1.1 dsieger 1564:
1.42 asau 1565: + sunpro: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio
1.1 dsieger 1566:
1.118 sevan 1567: + xlc: IBM's XL C/C++ compiler suite
1.66 asau 1568:
1.1 dsieger 1569: The default is "gcc". You can use ccache and/or distcc with an appropriate
1570: PKGSRC_COMPILER setting, e.g. "ccache gcc". This variable should always be
1571: terminated with a value for a real compiler. Note that only one real
1572: compiler should be listed (e.g. "sunpro gcc" is not allowed).
1573:
1574: GCC_REQD:
1575:
1576: This specifies the minimum version of GCC to use when building packages. If
1577: the system GCC doesn't satisfy this requirement, then pkgsrc will build and
1578: install one of the GCC packages to use instead.
1579:
1.153 leot 1580: PYTHON_VERSION_DEFAULT:
1.114 maya 1581:
1582: Specifies which version of python to use when several options are
1583: available.
1584:
1585: PKGSRC_FORTRAN:
1586:
1.176 gutterid 1587: Specifies the Fortran compiler to use. The default is gfortran.
1.114 maya 1588:
1589: GFORTRAN_VERSION:
1590:
1591: If PKGSRC_FORTRAN= gfortran is used, this option specifies which version to
1592: use.
1593:
1.154 rillig 1594: 6.4.2. Additional flags to the compiler (CFLAGS)
1.1 dsieger 1595:
1596: If you wish to set the CFLAGS variable, please make sure to use the += operator
1597: instead of the = operator:
1598:
1599: CFLAGS+= -your -flags
1600:
1601: Using CFLAGS= (i.e. without the "+") may lead to problems with packages that
1.16 jnemeth 1602: need to add their own flags. You may want to take a look at the devel/cpuflags
1.24 wiz 1603: package if you're interested in optimization specifically for the current CPU.
1.1 dsieger 1604:
1.154 rillig 1605: 6.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 1606:
1607: If you want to pass flags to the linker, both in the configure step and the
1608: build step, you can do this in two ways. Either set LDFLAGS or LIBS. The
1609: difference between the two is that LIBS will be appended to the command line,
1610: while LDFLAGS come earlier. LDFLAGS is pre-loaded with rpath settings for ELF
1611: machines depending on the setting of USE_IMAKE or the inclusion of mk/
1612: x11.buildlink3.mk. As with CFLAGS, if you do not wish to override these
1613: settings, use the += operator:
1614:
1615: LDFLAGS+= -your -linkerflags
1616:
1.154 rillig 1617: 6.5. Developer/advanced settings
1.1 dsieger 1618:
1619: * PKG_DEVELOPER: Run some sanity checks that package developers want:
1620:
1.42 asau 1621: + make sure patches apply with zero fuzz
1.1 dsieger 1622:
1.42 asau 1623: + run check-shlibs to see that all binaries will find their shared libs.
1.1 dsieger 1624:
1625: * PKG_DEBUG_LEVEL: The level of debugging output which is displayed whilst
1626: making and installing the package. The default value for this is 0, which
1627: will not display the commands as they are executed (normal, default, quiet
1628: operation); the value 1 will display all shell commands before their
1629: invocation, and the value 2 will display both the shell commands before
1.112 rillig 1630: their invocation, as well as their actual execution progress with set -x.
1.1 dsieger 1631:
1.154 rillig 1632: 6.6. Selecting Build Options
1.1 dsieger 1633:
1634: Some packages have build time options, usually to select between different
1635: dependencies, enable optional support for big dependencies or enable
1636: experimental features.
1637:
1638: To see which options, if any, a package supports, and which options are
1639: mutually exclusive, run make show-options, for example:
1640:
1641: The following options are supported by this package:
1642: ssl Enable SSL support.
1643: Exactly one of the following gecko options is required:
1644: firefox Use firefox as gecko rendering engine.
1645: mozilla Use mozilla as gecko rendering engine.
1646: At most one of the following database options may be selected:
1647: mysql Enable support for MySQL database.
1648: pgsql Enable support for PostgreSQL database.
1649:
1650: These options are enabled by default: firefox
1651: These options are currently enabled: mozilla ssl
1652:
1.4 rillig 1653: The following variables can be defined in mk.conf to select which options to
1654: enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
1.1 dsieger 1655: disable options for all packages that support them, and PKG_OPTIONS.pkgbase,
1656: which can be used to select or disable options specifically for package pkgbase
1657: . Options listed in these variables are selected, options preceded by "-" are
1658: disabled. A few examples:
1659:
1.4 rillig 1660: $ grep "PKG.*OPTION" mk.conf
1.1 dsieger 1661: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1662: PKG_OPTIONS.kdebase= debug -sasl
1663: PKG_OPTIONS.apache= suexec
1664:
1.11 rillig 1665: It is important to note that options that were specifically suggested by the
1.19 snj 1666: package maintainer must be explicitly removed if you do not wish to include the
1667: option. If you are unsure you can view the current state with make show-options
1668: .
1.11 rillig 1669:
1.1 dsieger 1670: The following settings are consulted in the order given, and the last setting
1671: that selects or disables an option is used:
1672:
1673: 1. the default options as suggested by the package maintainer
1674:
1675: 2. the options implied by the settings of legacy variables (see below)
1676:
1677: 3. PKG_DEFAULT_OPTIONS
1678:
1679: 4. PKG_OPTIONS.pkgbase
1680:
1681: For groups of mutually exclusive options, the last option selected is used, all
1682: others are automatically disabled. If an option of the group is explicitly
1683: disabled, the previously selected option, if any, is used. It is an error if no
1684: option from a required group of options is selected, and building the package
1685: will fail.
1686:
1687: Before the options framework was introduced, build options were selected by
1.4 rillig 1688: setting a variable (often named USE_FOO) in mk.conf for each option. To ease
1689: transition to the options framework for the user, these legacy variables are
1690: converted to the appropriate options setting (PKG_OPTIONS.pkgbase)
1691: automatically. A warning is issued to prompt the user to update mk.conf to use
1692: the options framework directly. Support for the legacy variables will be
1.1 dsieger 1693: removed eventually.
1694:
1.154 rillig 1695: Chapter 7. Creating binary packages
1.1 dsieger 1696:
1697: Table of Contents
1698:
1.154 rillig 1699: 7.1. Building a single binary package
1700: 7.2. Settings for creation of binary packages
1.1 dsieger 1701:
1.154 rillig 1702: 7.1. Building a single binary package
1.1 dsieger 1703:
1704: Once you have built and installed a package, you can create a binary package
1705: which can be installed on another system with pkg_add(1). This saves having to
1706: build the same package on a group of hosts and wasting CPU time. It also
1707: provides a simple means for others to install your package, should you
1708: distribute it.
1709:
1710: To create a binary package, change into the appropriate directory in pkgsrc,
1711: and run make package:
1712:
1.112 rillig 1713: $ cd misc/figlet
1714: $ make package
1.1 dsieger 1715:
1716: This will build and install your package (if not already done), and then build
1717: a binary package from what was installed. You can then use the pkg_* tools to
1718: manipulate it. Binary packages are created by default in /usr/pkgsrc/packages,
1719: in the form of a gzipped tar file. See Section B.2, "Packaging figlet" for a
1720: continuation of the above misc/figlet example.
1721:
1.154 rillig 1722: See Chapter 23, Submitting and Committing for information on how to submit such
1.1 dsieger 1723: a binary package.
1724:
1.154 rillig 1725: 7.2. Settings for creation of binary packages
1.1 dsieger 1726:
1.184 rillig 1727: See Section 13.17, "Other helpful targets".
1.6 rillig 1728:
1.154 rillig 1729: Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6 rillig 1730:
1731: Table of Contents
1732:
1.154 rillig 1733: 8.1. Preparations
1.180 rillig 1734: 8.2. Running a bulk build
1.6 rillig 1735:
1.154 rillig 1736: 8.2.1. Configuration
1.6 rillig 1737:
1.154 rillig 1738: 8.3. Requirements of a full bulk build
1.178 rillig 1739: 8.4. Bulk build variants
1740:
1.179 rillig 1741: 8.4.1. Detect unknown configure options
1742: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 1743: 8.4.3. Force compiler options only in the build phase
1744: 8.4.4. Use custom directories
1745: 8.4.5. Turn warnings into errors
1746: 8.4.6. Reject packages for which pkglint reports errors
1747: 8.4.7. Reject packages that contain forbidden strings
1748: 8.4.8. Reject packages whose self-test fails
1749: 8.4.9. Reject packages that use undefined shell variables
1750: 8.4.10. Turn off verbose logging
1.6 rillig 1751:
1.178 rillig 1752: 8.5. Creating a multiple CD-ROM packages collection
1753:
1754: 8.5.1. Example of cdpack
1.6 rillig 1755:
1.175 gutterid 1756: For a number of reasons, you may want to build binary packages for a large
1757: selected set of packages in pkgsrc, or even for all pkgsrc packages. For
1.71 wiz 1758: instance, when you have multiple machines that should run the same software, it
1759: is wasted time if they all build their packages themselves from source. Or you
1760: may want to build a list of packages you want and check them before deploying
1.175 gutterid 1761: onto production systems. There is a way of getting a set of binary packages:
1762: the bulk build system, or pbulk ("p" stands for "parallel"). This chapter
1763: describes how to set it up.
1.71 wiz 1764:
1.154 rillig 1765: 8.1. Preparations
1.71 wiz 1766:
1767: First of all, you have to decide whether you build all packages or a limited
1768: set of them. Full bulk builds usually consume a lot more resources, both space
1.175 gutterid 1769: and time, than builds for some practical sets of packages. A number of
1770: particularly heavy packages exist that are not actually interesting to a wide
1771: audience. (The approximate resource consumption for a full bulk build is given
1772: in section Section 8.3, "Requirements of a full bulk build".) For limited bulk
1773: builds you need to make a list of packages you want to build. Note that all
1774: their dependencies will be built, so you don't need to track them manually.
1.71 wiz 1775:
1776: During bulk builds various packages are installed and deinstalled in /usr/pkg
1777: (or whatever LOCALBASE is), so make sure that you don't need any package during
1.112 rillig 1778: the builds. Essentially, you should provide a fresh system, either a chroot
1.71 wiz 1779: environment or something even more restrictive, depending on what the operating
1780: system provides, or dedicate the whole physical machine. As a useful side
1781: effect this makes sure that bulk builds cannot break anything in your system.
1782: There have been numerous cases where certain packages tried to install files
1783: outside the LOCALBASE or wanted to edit some files in /etc.
1.6 rillig 1784:
1.180 rillig 1785: 8.2. Running a bulk build
1.6 rillig 1786:
1.180 rillig 1787: Running a bulk build works roughly as follows:
1.15 rillig 1788:
1789: * First, build the pbulk infrastructure in a fresh pkgsrc location.
1790:
1791: * Then, build each of the packages from a clean installation directory using
1792: the infrastructure.
1793:
1.154 rillig 1794: 8.2.1. Configuration
1.6 rillig 1795:
1.112 rillig 1796: To simplify configuration, we provide the helper script mk/pbulk/pbulk.sh.
1.6 rillig 1797:
1.68 asau 1798: In order to use it, prepare a clear system (real one, chroot environment, jail,
1799: zone, virtual machine). Configure network access to fetch distribution files.
1.112 rillig 1800: Create a user with name "pbulk".
1.68 asau 1801:
1802: Fetch and extract pkgsrc. Use a command like one of these:
1803:
1.151 sevan 1804: # (cd /usr && ftp -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1805: # (cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1.72 wiz 1806: # (cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)
1.68 asau 1807:
1808: Or any other way that fits (e.g., curl, wget).
1809:
1810: Deploy and configure pbulk tools, e.g.:
1811:
1.118 sevan 1812: # sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)
1.68 asau 1813: # sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment
1814: # sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build
1815:
1816: Note
1817:
1818: mk.conf.frag is a fragment of mk.conf that contains settings you want to apply
1819: to packages you build. For instance,
1820:
1.112 rillig 1821: PKG_DEVELOPER= yes # perform more checks
1822: X11_TYPE= modular # use pkgsrc X11
1823: SKIP_LICENSE_CHECK= yes # accept all licences (useful
1824: # when building all packages)
1.68 asau 1825:
1826: If configured for limited list, replace the list in /usr/pbulk/etc/pbulk.list
1.112 rillig 1827: with your list of packages, one per line without empty lines or comments. E.g.:
1.68 asau 1828:
1829: www/firefox
1830: mail/thunderbird
1831: misc/libreoffice4
1832:
1.69 asau 1833: At this point you can also review configuration in /usr/pbulk/etc and make
1834: final amendments, if wanted.
1835:
1.68 asau 1836: Start it:
1837:
1838: # /usr/pbulk/bin/bulkbuild
1839:
1840: After it finishes, you'll have /mnt filled with distribution files, binary
1841: packages, and reports, plain text summary in /mnt/bulklog/meta/report.txt
1842:
1843: Note
1844:
1845: The pbulk.sh script does not cover all possible use cases. While being ready to
1846: run, it serves as a good starting point to understand and build more complex
1847: setups. The script is kept small enough for better understanding.
1848:
1849: Note
1850:
1851: The pbulk.sh script supports running unprivileged bulk build and helps
1.205 ! wiz 1852: configuring distributed bulk builds. Distributed bulk builds support either
! 1853: building in worker chroots (each node is a path to a different chroot) that
! 1854: replicate the target system, including the pbulk prefix, or remote machines
! 1855: (each node is an IP address that must be accessible over SSH without a
! 1856: password).
1.15 rillig 1857:
1.154 rillig 1858: 8.3. Requirements of a full bulk build
1.71 wiz 1859:
1860: A complete bulk build requires lots of disk space. Some of the disk space can
1861: be read-only, some other must be writable. Some can be on remote filesystems
1862: (such as NFS) and some should be local. Some can be temporary filesystems,
1863: others must survive a sudden reboot.
1864:
1.205 ! wiz 1865: * 70 GB for the distfiles (read-write, remote, temporary)
1.71 wiz 1866:
1.205 ! wiz 1867: * 60 GB for the binary packages (read-write, remote, permanent)
1.71 wiz 1868:
1869: * 1 GB for the pkgsrc tree (read-only, remote, permanent)
1870:
1871: * 5 GB for LOCALBASE (read-write, local, temporary)
1872:
1873: * 10 GB for the log files (read-write, remote, permanent)
1874:
1875: * 5 GB for temporary files (read-write, local, temporary)
1876:
1.178 rillig 1877: 8.4. Bulk build variants
1878:
1879: To ensure that pkgsrc packages work in different configurations, it makes sense
1880: to run non-default bulk builds from time to time. This section lists some ideas
1881: for bulk builds that intentionally let packages fail if they don't follow the
1882: pkgsrc style.
1883:
1.179 rillig 1884: 8.4.1. Detect unknown configure options
1.178 rillig 1885:
1886: Add the following line to mk.conf.
1887:
1888: GNU_CONFIGURE_STRICT= yes
1889:
1890: When a package fails this additional check, the most common cause is that the
1891: configure option was valid for an older version of the package but does not
1892: apply anymore. In that case, just remove it.
1893:
1.179 rillig 1894: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.178 rillig 1895:
1896: The job of a compiler is not restricted to producing executable code, most
1.179 rillig 1897: compilers also detect typical programming mistakes. The pkgsrc compiler
1898: wrappers make it easy to force compiler options when the package is built. This
1899: can be used to find typical bugs across all packages that are in pkgsrc. By
1900: reporting these bugs upstream, the packages will be more reliable with the next
1901: updates.
1.178 rillig 1902:
1.179 rillig 1903: Add some of the following lines to mk.conf:
1.178 rillig 1904:
1905: CFLAGS+= -Werror=char-subscripts
1.179 rillig 1906: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 1907:
1.179 rillig 1908: When a package fails to build using these stricter compiler options, document
1909: the circumstances in which the compiler produced the error message. This
1910: includes:
1.178 rillig 1911:
1912: * The platform (MACHINE_PLATFORM)
1913:
1914: * The source file
1915:
1916: * An excerpt of the code. GCC and Clang already do this as part of the
1917: diagnostic.
1918:
1.179 rillig 1919: * The exact error message from the compiler.
1.178 rillig 1920:
1.179 rillig 1921: If a package produces these error messages, but the package is fine, record
1922: this in your local mk.conf, like this, to skip this check in the next builds:
1.178 rillig 1923:
1.179 rillig 1924: .if ${PKGPATH} == category/package
1.178 rillig 1925: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
1926: # error message
1927: # code
1.179 rillig 1928: # Reason why the code does not need to be fixed.
1.178 rillig 1929: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 1930: .endif
1.178 rillig 1931:
1932: If the error messages from the compiler are valid and the code needs to be
1.179 rillig 1933: fixed, prepare a local patch (see LOCALPATCHES) and report the bug to the
1934: upstream authors of the package, providing them with the information you
1935: collected above.
1.178 rillig 1936:
1.179 rillig 1937: Patches that are not essential for the package to work should only be reported
1938: upstream but not committed to pkgsrc, to make future updates easier.
1939:
1.181 rillig 1940: 8.4.3. Force compiler options only in the build phase
1941:
1942: When adding custom compiler flags via CFLAGS, these apply to all phases of the
1943: package build process. Especially in the configure phase, adding -Werror leads
1944: to wrong decisions. The GNU configure scripts feed many small test programs to
1945: the C compiler to see whether certain headers are available, functions are
1946: defined in a library and programs can be run. In many cases these programs
1947: would not survive a strict compiler run with -Wall -Wextra -Werror.
1948:
1949: The pkgsrc infrastructure is flexible enough to support compiler options being
1950: added between the configure and build phases. It's a little more complicated
1951: than the other examples in this section but still easy enough.
1952:
1953: The basic idea is to use the pkgsrc compiler wrapper to inject the desired
1954: compiler options. The compiler wrapper's original task is to hide unwanted
1955: directories of include files and to normalize compiler options. It does this by
1956: wrapping the compiler command and rewriting the command line. To see this in
1957: action, run bmake patch in a package directory and examine the work/.cwrappers/
1958: config directory. It contains individual configurations for the C compiler and
1959: the related tools. The plan is to find a hook between the configure and build
1960: phases, and to modify these configuration files at that point.
1961:
1962: To find this hook, have a look at mk/build/build.mk, which contains among
1963: others the pre-build-checks-hook. The word checks doesn't quite fit, but the
1964: pre-build-hook sounds good enough.
1965:
1966: The code to be included in mk.conf is:
1967:
1968: # Just a few example options.
1969: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
1970:
1971: .if ${BUILD_ONLY_CFLAGS:U:M*}
1972: pre-build-checks-hook: add-build-only-cflags
1973:
1974: add-build-only-cflags: .PHONY
1975: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
1976: ${TEST} ! -f ${.TARGET} || exit 0; \
1977: for flag in ${BUILD_ONLY_CFLAGS}; do \
1978: ${ECHO} "append=$$flag" >> cc; \
1979: done; \
1980: > ${.TARGET}
1981: .endif
1982:
1983: (When editing the mk.conf, make sure that the commands of the
1984: add-build-only-cflags target are indented with a tab, not with spaces.)
1985:
1986: The condition in the .if statement contains the :U modifier to prevent parse
1987: errors if the variable should be undefined, possibly because it is only defined
1988: for a subset of the packages. The :M* modifier ensures that there is at least
1989: one compiler option, to prevent a syntax error in the shell parser.
1990:
1991: The code around the ${.TARGET} variable ensures that the additional compiler
1992: options are only appended once, even if bmake build is run multiple times. To
1993: do this, it creates a marker file.
1994:
1995: To verify that this setup works, run bmake configure in a package directory. Up
1996: to now, everything works as usual. Examine the directory work/.cwrappers/config
1997: to see that the compiler options from BUILD_ONLY_CFLAGS are not yet added to
1998: the file cc. Examine the tail of the work/.work.log file to see that the normal
1999: compiler options are used.
2000:
2001: Now run bmake build. This will append the options to the file cc and will
2002: create the marker file in the same directory. After that, the build starts as
2003: usual, but with the added compiler options. Examine the tail of the file work
2004: /.work.log to see that the lines starting with [*] don't contain the compiler
2005: options, but the corresponding lines starting with <.> do end with these
2006: options.
2007:
2008: Building packages using this setup variant and fixing the resulting bugs is the
2009: same as in Section 8.4.2, "Detect classes of bugs by forcing compiler warnings"
2010: .
2011:
2012: 8.4.4. Use custom directories
1.178 rillig 2013:
2014: Some directories like PREFIX, VARBASE, PKG_SYSCONFDIR, PKGMANDIR, PKG_INFODIR
2015: can be configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2016: afterwards in mk.conf.
2017:
2018: PREFIX= /a-random-uuid
2019: PKG_SYSCONFDIR= /a-random-uuid
2020: VARBASE= /a-random-uuid
2021: PKGMANDIR= a-random-uuid
2022: PKG_INFODIR= a-random-uuid
2023:
1.181 rillig 2024: 8.4.5. Turn warnings into errors
1.178 rillig 2025:
2026: When building a package, warnings are typically ignored since they just flow by
2027: and do not cause the build to fail immediately. To find these warnings,
2028: redefine them to errors in mk.conf.
2029:
2030: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2031: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2032:
2033: (There are many more classes of warnings in pkgsrc, and most of them can be
2034: redefined with a simple definition like above.
2035:
1.179 rillig 2036: If a package suggests to add USE_TOOLS+=perl to the package Makefile, research
1.178 rillig 2037: whether the package actually needs Perl. If it does, add USE_TOOLS+=perl to the
2038: package Makefile, and if it doesn't, add TOOLS_BROKEN+=perl.
2039:
1.181 rillig 2040: 8.4.6. Reject packages for which pkglint reports errors
1.178 rillig 2041:
2042: Using pkglint as part of the regular build process is mostly a waste of time.
2043: If you want to fix some of the warnings, just run pkglint recursively on the
2044: whole pkgsrc tree. This will take a few minutes (up to 10), which is much
2045: faster than a complete bulk build.
2046:
1.181 rillig 2047: 8.4.7. Reject packages that contain forbidden strings
1.178 rillig 2048:
2049: To ensure that the binary packages don't contain references to the build
2050: directory, there is already CHECK_WRKREF. If that variable includes the item
2051: extra, it is possible to define additional patterns that must not appear in any
2052: installed file. This is specified in mk.conf.
2053:
2054: CHECK_WRKREF= extra
2055: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2056: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2057: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2058:
2059: The above patterns will probably generate many false positives, therefore the
2060: results need to be taken with a grain of salt.
2061:
1.181 rillig 2062: 8.4.8. Reject packages whose self-test fails
1.178 rillig 2063:
2064: To run the test suites that come with each package, add this line to mk.conf.
2065:
2066: PKGSRC_RUN_TEST= yes
2067:
2068: Be prepared that even the most basic packages fail this test. When doing a bulk
2069: build with this, it will often abort in the early phase where the packages are
2070: scanned for their dependencies since there are cyclic dependencies. There is
2071: still a lot to do in this area.
2072:
1.181 rillig 2073: 8.4.9. Reject packages that use undefined shell variables
1.178 rillig 2074:
2075: To catch typos in the shell snippets from the Makefile fragments, add the -u
2076: flag to most of the commands by adding this line to mk.conf.
2077:
2078: RUN= @set -eu;
2079:
1.181 rillig 2080: After that, ensure that none of the bulk build log files (even those for
2081: successfully built packages) contains the string parameter not set or whatever
2082: error message the command sh -ceu '$undefined' outputs.
2083:
1.178 rillig 2084: See mk/misc/common.mk for the existing definition.
2085:
1.181 rillig 2086: 8.4.10. Turn off verbose logging
1.178 rillig 2087:
2088: The build logs of a package are often quite long. This allows error messages or
2089: other interesting details to hide between the noise. To make the actual error
2090: message stand out more, add these lines to mk.conf.
2091:
2092: GNU_CONFIGURE_QUIET= yes
2093: MAKE_FLAGS+= -s
2094:
2095: The -s option works for both GNU Make and BSD Make. On exotic platforms with
2096: their own make, it may be a little different.
2097:
2098: 8.5. Creating a multiple CD-ROM packages collection
1.1 dsieger 2099:
2100: After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set
2101: of the resulting binary packages to assist in installing packages on other
2102: machines. The pkgtools/cdpack package provides a simple tool for creating the
2103: ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a way that
2104: keeps all the dependencies for a given package on the same CD as that package.
2105:
1.178 rillig 2106: 8.5.1. Example of cdpack
1.1 dsieger 2107:
2108: Complete documentation for cdpack is found in the cdpack(1) man page. The
2109: following short example assumes that the binary packages are left in /usr/
2110: pkgsrc/packages/All and that sufficient disk space exists in /u2 to hold the
2111: ISO 9660 images.
2112:
2113: # mkdir /u2/images
2114: # pkg_add /usr/pkgsrc/packages/All/cdpack
2115: # cdpack /usr/pkgsrc/packages/All /u2/images
2116:
2117:
2118: If you wish to include a common set of files (COPYRIGHT, README, etc.) on each
2119: CD in the collection, then you need to create a directory which contains these
1.175 gutterid 2120: files, e.g.:
1.1 dsieger 2121:
2122: # mkdir /tmp/common
2123: # echo "This is a README" > /tmp/common/README
2124: # echo "Another file" > /tmp/common/COPYING
2125: # mkdir /tmp/common/bin
2126: # echo "#!/bin/sh" > /tmp/common/bin/myscript
2127: # echo "echo Hello world" >> /tmp/common/bin/myscript
2128: # chmod 755 /tmp/common/bin/myscript
2129:
2130:
2131: Now create the images:
2132:
2133: # cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images
2134:
2135: Each image will contain README, COPYING, and bin/myscript in their root
2136: directories.
2137:
1.154 rillig 2138: Chapter 9. Directory layout of the installed files
1.1 dsieger 2139:
2140: Table of Contents
2141:
1.154 rillig 2142: 9.1. File system layout in ${LOCALBASE}
2143: 9.2. File system layout in ${VARBASE}
1.1 dsieger 2144:
2145: The files that are installed by pkgsrc are organized in a way that is similar
2146: to what you find in the /usr directory of the base system. But some details are
2147: different. This is because pkgsrc initially came from FreeBSD and had adopted
2148: its file system hierarchy. Later it was largely influenced by NetBSD. But no
2149: matter which operating system you are using pkgsrc with, you can expect the
2150: same layout for pkgsrc.
2151:
2152: There are mainly four root directories for pkgsrc, which are all configurable
2153: in the bootstrap/bootstrap script. When pkgsrc has been installed as root, the
2154: default locations are:
2155:
2156: LOCALBASE= /usr/pkg
2157: PKG_SYSCONFBASE= /usr/pkg/etc
2158: VARBASE= /var
1.119 sevan 2159: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2160:
2161: In unprivileged mode (when pkgsrc has been installed as any other user), the
2162: default locations are:
2163:
2164: LOCALBASE= ${HOME}/pkg
2165: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2166: VARBASE= ${HOME}/pkg/var
1.119 sevan 2167: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2168:
2169: What these four directories are for, and what they look like is explained
2170: below.
2171:
1.25 wiz 2172: * LOCALBASE corresponds to the /usr directory in the base system. It is the "
2173: main" directory where the files are installed and contains the well-known
1.1 dsieger 2174: subdirectories like bin, include, lib, share and sbin.
2175:
2176: * VARBASE corresponds to /var in the base system. Some programs (especially
2177: games, network daemons) need write access to it during normal operation.
2178:
2179: * PKG_SYSCONFDIR corresponds to /etc in the base system. It contains
2180: configuration files of the packages, as well as pkgsrc's mk.conf itself.
2181:
1.154 rillig 2182: 9.1. File system layout in ${LOCALBASE}
1.1 dsieger 2183:
2184: The following directories exist in a typical pkgsrc installation in $
2185: {LOCALBASE}.
2186:
2187: bin
2188:
2189: Contains executable programs that are intended to be directly used by the
2190: end user.
2191:
2192: emul
2193:
2194: Contains files for the emulation layers of various other operating systems,
2195: especially for NetBSD.
2196:
2197: etc (the usual location of ${PKG_SYSCONFDIR})
2198:
2199: Contains the configuration files.
2200:
2201: include
2202:
2203: Contains headers for the C and C++ programming languages.
2204:
2205: info
2206:
2207: Contains GNU info files of various packages.
2208:
2209: lib
2210:
2211: Contains shared and static libraries.
2212:
2213: libdata
2214:
2215: Contains data files that don't change after installation. Other data files
2216: belong into ${VARBASE}.
2217:
2218: libexec
2219:
2220: Contains programs that are not intended to be used by end users, such as
2221: helper programs or network daemons.
2222:
2223: libexec/cgi-bin
2224:
2225: Contains programs that are intended to be executed as CGI scripts by a web
2226: server.
2227:
2228: man (the usual value of ${PKGMANDIR})
2229:
2230: Contains brief documentation in form of manual pages.
2231:
2232: sbin
2233:
2234: Contains programs that are intended to be used only by the super-user.
2235:
2236: share
2237:
2238: Contains platform-independent data files that don't change after
2239: installation.
2240:
2241: share/doc
2242:
2243: Contains documentation files provided by the packages.
2244:
2245: share/examples
2246:
2247: Contains example files provided by the packages. Among others, the original
2248: configuration files are saved here and copied to ${PKG_SYSCONFDIR} during
2249: installation.
2250:
2251: share/examples/rc.d
2252:
2253: Contains the original files for rc.d scripts.
2254:
2255: var (the usual location of ${VARBASE})
2256:
2257: Contains files that may be modified after installation.
2258:
1.154 rillig 2259: 9.2. File system layout in ${VARBASE}
1.1 dsieger 2260:
2261: db/pkg (the usual location of ${PKG_DBDIR})
2262:
2263: Contains information about the currently installed packages.
2264:
2265: games
2266:
2267: Contains highscore files.
2268:
2269: log
2270:
2271: Contains log files.
2272:
2273: run
2274:
2275: Contains informational files about daemons that are currently running.
2276:
1.154 rillig 2277: Chapter 10. Frequently Asked Questions
1.1 dsieger 2278:
2279: Table of Contents
2280:
1.154 rillig 2281: 10.1. Are there any mailing lists for pkg-related discussion?
2282: 10.2. Utilities for package management (pkgtools)
2283: 10.3. How to use pkgsrc as non-root
2284: 10.4. How to resume transfers when fetching distfiles?
2285: 10.5. How can I install/use modular X.org from pkgsrc?
2286: 10.6. How to fetch files from behind a firewall
2287: 10.7. How to fetch files from HTTPS sites
2288: 10.8. How do I tell make fetch to do passive FTP?
2289: 10.9. How to fetch all distfiles at once
2290: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
2291: 10.11. What does "Could not find bsd.own.mk" mean?
2292: 10.12. Using 'sudo' with pkgsrc
2293: 10.13. How do I change the location of configuration files?
2294: 10.14. Automated security checks
2295: 10.15. Why do some packages ignore my CFLAGS?
2296: 10.16. A package does not build. What shall I do?
2297: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.24 wiz 2298: conflicts" mean?
1.1 dsieger 2299:
2300: This section contains hints, tips & tricks on special things in pkgsrc that we
2301: didn't find a better place for in the previous chapters, and it contains items
2302: for both pkgsrc users and developers.
2303:
1.154 rillig 2304: 10.1. Are there any mailing lists for pkg-related discussion?
1.1 dsieger 2305:
2306: The following mailing lists may be of interest to pkgsrc users:
2307:
2308: * pkgsrc-users: This is a general purpose list for most issues regarding
2309: pkgsrc, regardless of platform, e.g. soliciting user help for pkgsrc
2310: configuration, unexpected build failures, using particular packages,
2311: upgrading pkgsrc installations, questions regarding the pkgsrc release
2312: branches, etc. General announcements or proposals for changes that impact
2313: the pkgsrc user community, e.g. major infrastructure changes, new features,
2314: package removals, etc., may also be posted.
2315:
2316: * pkgsrc-bulk: A list where the results of pkgsrc bulk builds are sent and
2317: discussed.
2318:
2319: * pkgsrc-changes: This list is for those who are interested in getting a
2320: commit message for every change committed to pkgsrc. It is also available
2321: in digest form, meaning one daily message containing all commit messages
2322: for changes to the package source tree in that 24 hour period.
2323:
2324: To subscribe, do:
2325:
2326: % echo subscribe listname | mail majordomo@NetBSD.org
2327:
1.174 leot 2328: Archives for all these mailing lists are available from https://
1.1 dsieger 2329: mail-index.NetBSD.org/.
2330:
1.154 rillig 2331: 10.2. Utilities for package management (pkgtools)
1.1 dsieger 2332:
2333: The directory pkgsrc/pkgtools contains a number of useful utilities for both
2334: users and developers of pkgsrc. This section attempts only to make the reader
1.121 sevan 2335: aware of some of the utilities and when they might be useful, and not to
2336: duplicate the documentation that comes with each package.
1.1 dsieger 2337:
2338: Utilities used by pkgsrc (automatically installed when needed):
2339:
2340: * pkgtools/x11-links: Symlinks for use by buildlink.
2341:
2342: OS tool augmentation (automatically installed when needed):
2343:
1.121 sevan 2344: * pkgtools/digest: Calculates various kinds of checksums (including SHA3).
1.1 dsieger 2345:
2346: * pkgtools/libnbcompat: Compatibility library for pkgsrc tools.
2347:
2348: * pkgtools/mtree: Installed on non-BSD systems due to lack of native mtree.
2349:
2350: * pkgtools/pkg_install: Up-to-date replacement for /usr/sbin/pkg_install, or
2351: for use on operating systems where pkg_install is not present.
2352:
2353: Utilities used by pkgsrc (not automatically installed):
2354:
2355: * pkgtools/pkg_tarup: Create a binary package from an already-installed
2356: package. Used by make replace to save the old package.
2357:
2358: * pkgtools/dfdisk: Adds extra functionality to pkgsrc, allowing it to fetch
2359: distfiles from multiple locations. It currently supports the following
2360: methods: multiple CD-ROMs and network FTP/HTTP connections.
2361:
2362: * devel/cpuflags: Determine the best compiler flags to optimise code for your
1.24 wiz 2363: current CPU and compiler.
1.1 dsieger 2364:
2365: Utilities for keeping track of installed packages, being up to date, etc:
2366:
1.65 wiz 2367: * pkgtools/pkgin: A package update tool similar to apt(1). Download, install,
2368: and upgrade binary packages easily.
2369:
1.1 dsieger 2370: * pkgtools/pkg_chk: Reports on packages whose installed versions do not match
2371: the latest pkgsrc entries.
2372:
2373: * pkgtools/pkgdep: Makes dependency graphs of packages, to aid in choosing a
2374: strategy for updating.
2375:
2376: * pkgtools/pkgdepgraph: Makes graphs from the output of pkgtools/pkgdep (uses
2377: graphviz).
2378:
1.12 weinem 2379: * pkgtools/pkglint: The pkglint(1) program checks a pkgsrc entry for errors.
2380:
2381: * pkgtools/lintpkgsrc: The lintpkgsrc(1) program does various checks on the
2382: complete pkgsrc system.
1.1 dsieger 2383:
2384: * pkgtools/pkgsurvey: Report what packages you have installed.
2385:
2386: Utilities for people maintaining or creating individual packages:
2387:
2388: * pkgtools/pkgdiff: Automate making and maintaining patches for a package
2389: (includes pkgdiff, pkgvi, mkpatches, etc.).
2390:
1.65 wiz 2391: * pkgtools/url2pkg: Aids in converting to pkgsrc.
1.1 dsieger 2392:
2393: Utilities for people maintaining pkgsrc (or: more obscure pkg utilities)
2394:
2395: * pkgtools/pkg_comp: Build packages in a chrooted area.
2396:
2397: * pkgtools/libkver: Spoof kernel version for chrooted cross builds.
2398:
1.154 rillig 2399: 10.3. How to use pkgsrc as non-root
1.1 dsieger 2400:
1.108 rillig 2401: To install packages from source as a non-root user, download pkgsrc as
1.154 rillig 2402: described in Chapter 3, Where to get pkgsrc and how to keep it up-to-date, cd
1.108 rillig 2403: into that directory and run the command ./bootstrap/bootstrap --unprivileged.
2404:
2405: This will install the binary part of pkgsrc to ~/pkg and put the pkgsrc
2406: configuration mk.conf into ~/pkg/etc.
2407:
2408: For more details, see mk/unprivileged.mk.
1.1 dsieger 2409:
1.154 rillig 2410: 10.4. How to resume transfers when fetching distfiles?
1.1 dsieger 2411:
2412: By default, resuming transfers in pkgsrc is disabled, but you can enable this
1.4 rillig 2413: feature by adding the option PKG_RESUME_TRANSFERS=YES into mk.conf. If, during
2414: a fetch step, an incomplete distfile is found, pkgsrc will try to resume it.
1.1 dsieger 2415:
1.61 wiz 2416: You can also use a different program than the platform default program by
2417: changing the FETCH_USING variable. You can specify the program by using of ftp,
2418: fetch, wget or curl. Alternatively, fetching can be disabled by using the value
2419: manual. A value of custom disables the system defaults and dependency tracking
2420: for the fetch program. In that case you have to provide FETCH_CMD,
2421: FETCH_BEFORE_ARGS, FETCH_RESUME_ARGS, FETCH_OUTPUT_ARGS, FETCH_AFTER_ARGS.
1.1 dsieger 2422:
1.16 jnemeth 2423: For example, if you want to use wget to download, you'll have to use something
2424: like:
1.1 dsieger 2425:
1.16 jnemeth 2426: FETCH_USING= wget
1.1 dsieger 2427:
1.154 rillig 2428: 10.5. How can I install/use modular X.org from pkgsrc?
1.1 dsieger 2429:
1.4 rillig 2430: If you want to use modular X.org from pkgsrc instead of your system's own X11
2431: (/usr/X11R6, /usr/openwin, ...) you will have to add the following line into
1.1 dsieger 2432: mk.conf:
2433:
1.4 rillig 2434: X11_TYPE=modular
1.1 dsieger 2435:
1.154 rillig 2436: 10.6. How to fetch files from behind a firewall
1.1 dsieger 2437:
2438: If you are sitting behind a firewall which does not allow direct connections to
2439: Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This
2440: is done using an environment variable in the form of a URL, e.g. in Amdahl, the
2441: machine "orpheus.amdahl.com" is one of the firewalls, and it uses port 80 as
2442: the proxy port number. So the proxy environment variables are:
2443:
2444: ftp_proxy=ftp://orpheus.amdahl.com:80/
2445: http_proxy=http://orpheus.amdahl.com:80/
2446:
1.154 rillig 2447: 10.7. How to fetch files from HTTPS sites
1.65 wiz 2448:
2449: Some fetch tools are not prepared to support HTTPS by default (for example, the
2450: one in NetBSD 6.0), or the one installed by the pkgsrc bootstrap (to avoid an
2451: openssl dependency that low in the dependency graph).
2452:
2453: Usually you won't notice, because distribution files are mirrored weekly to "
2454: ftp.NetBSD.org", but that might not be often enough if you are following
2455: pkgsrc-current. In that case, set FETCH_USING in your mk.conf file to "curl" or
2456: "wget", which are both compiled with HTTPS support by default. Of course, these
2457: tools need to be installed before you can use them this way.
2458:
1.154 rillig 2459: 10.8. How do I tell make fetch to do passive FTP?
1.1 dsieger 2460:
2461: This depends on which utility is used to retrieve distfiles. From bsd.pkg.mk,
2462: FETCH_CMD is assigned the first available command from the following list:
2463:
2464: * ${LOCALBASE}/bin/ftp
2465:
2466: * /usr/bin/ftp
2467:
2468: On a default NetBSD installation, this will be /usr/bin/ftp, which
2469: automatically tries passive connections first, and falls back to active
2470: connections if the server refuses to do passive. For the other tools, add the
1.4 rillig 2471: following to your mk.conf file: PASSIVE_FETCH=1.
1.1 dsieger 2472:
2473: Having that option present will prevent /usr/bin/ftp from falling back to
2474: active transfers.
2475:
1.154 rillig 2476: 10.9. How to fetch all distfiles at once
1.1 dsieger 2477:
2478: You would like to download all the distfiles in a single batch from work or
2479: university, where you can't run a make fetch. There is an archive of distfiles
2480: on ftp.NetBSD.org, but downloading the entire directory may not be appropriate.
2481:
2482: The answer here is to do a make fetch-list in /usr/pkgsrc or one of its
2483: subdirectories, carry the resulting list to your machine at work/school and use
2484: it there. If you don't have a NetBSD-compatible ftp(1) (like tnftp) at work,
2485: don't forget to set FETCH_CMD to something that fetches a URL:
2486:
2487: At home:
2488:
2489: % cd /usr/pkgsrc
2490: % make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh
2491: % scp /tmp/fetch.sh work:/tmp
2492:
2493: At work:
2494:
2495: % sh /tmp/fetch.sh
2496:
2497: then tar up /tmp/distfiles and take it home.
2498:
2499: If you have a machine running NetBSD, and you want to get all distfiles (even
2500: ones that aren't for your machine architecture), you can do so by using the
2501: above-mentioned make fetch-list approach, or fetch the distfiles directly by
2502: running:
2503:
2504: % make mirror-distfiles
2505:
2506: If you even decide to ignore NO_{SRC,BIN}_ON_{FTP,CDROM}, then you can get
2507: everything by running:
2508:
2509: % make fetch NO_SKIP=yes
2510:
1.154 rillig 2511: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
1.1 dsieger 2512:
2513: When compiling the pkgtools/pkg_install package, you get the error from make
2514: that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates
2515: that you don't have installed the "text" set (nroff, ...) from the NetBSD base
2516: distribution on your machine. It is recommended to do that to format man pages.
2517:
2518: In the case of the pkgtools/pkg_install package, you can get away with setting
1.4 rillig 2519: NOMAN=YES either in the environment or in mk.conf.
1.1 dsieger 2520:
1.154 rillig 2521: 10.11. What does "Could not find bsd.own.mk" mean?
1.1 dsieger 2522:
2523: You didn't install the compiler set, comp.tgz, when you installed your NetBSD
2524: machine. Please get and install it, by extracting it in /:
2525:
2526: # cd /
2527: # tar --unlink -zxvpf .../comp.tgz
2528:
2529: comp.tgz is part of every NetBSD release. Get the one that corresponds to your
2530: release (determine via uname -r).
2531:
1.154 rillig 2532: 10.12. Using 'sudo' with pkgsrc
1.1 dsieger 2533:
2534: When installing packages as non-root user and using the just-in-time su(1)
2535: feature of pkgsrc, it can become annoying to type in the root password for each
2536: required package installed. To avoid this, the sudo package can be used, which
2537: does password caching over a limited time. To use it, install sudo (either as
1.4 rillig 2538: binary package or from security/sudo) and then put the following into your
2539: mk.conf, somewhere after the definition of the LOCALBASE variable:
1.1 dsieger 2540:
2541: .if exists(${LOCALBASE}/bin/sudo)
2542: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2543: .endif
2544:
1.154 rillig 2545: 10.13. How do I change the location of configuration files?
1.1 dsieger 2546:
2547: As the system administrator, you can choose where configuration files are
2548: installed. The default settings make all these files go into ${PREFIX}/etc or
2549: some of its subdirectories; this may be suboptimal depending on your
2550: expectations (e.g., a read-only, NFS-exported PREFIX with a need of per-machine
2551: configuration of the provided packages).
2552:
2553: In order to change the defaults, you can modify the PKG_SYSCONFBASE variable
1.4 rillig 2554: (in mk.conf) to point to your preferred configuration directory; some common
2555: examples include /etc or /etc/pkg.
1.1 dsieger 2556:
2557: Furthermore, you can change this value on a per-package basis by setting the
2558: PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. PKG_SYSCONFVAR's value usually
2559: matches the name of the package you would like to modify, that is, the contents
2560: of PKGBASE.
2561:
2562: Note that after changing these settings, you must rebuild and reinstall any
2563: affected packages.
2564:
1.154 rillig 2565: 10.14. Automated security checks
1.1 dsieger 2566:
2567: Please be aware that there can often be bugs in third-party software, and some
2568: of these bugs can leave a machine vulnerable to exploitation by attackers. In
2569: an effort to lessen the exposure, the NetBSD packages team maintains a database
2570: of known-exploits to packages which have at one time been included in pkgsrc.
2571: The database can be downloaded automatically, and a security audit of all
1.14 jmcneill 2572: packages installed on a system can take place. To do this, refer to the
2573: following two tools (installed as part of the pkgtools/pkg_install package):
1.1 dsieger 2574:
1.21 snj 2575: 1. pkg_admin fetch-pkg-vulnerabilities, an easy way to download a list of the
2576: security vulnerabilities information. This list is kept up to date by the
1.26 spz 2577: pkgsrc security team, and is distributed from the NetBSD ftp server:
1.1 dsieger 2578:
1.177 leot 2579: https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities
1.1 dsieger 2580:
1.21 snj 2581: 2. pkg_admin audit, an easy way to audit the current machine, checking each
1.24 wiz 2582: known vulnerability. If a vulnerable package is installed, it will be shown
2583: by output to stdout, including a description of the type of vulnerability,
2584: and a URL containing more information.
1.1 dsieger 2585:
1.202 nia 2586: Use of these tools is strongly recommended! See Section 5.1.6, "Checking for
1.121 sevan 2587: security vulnerabilities in installed packages" for instructions on how to
2588: automate checking and reporting.
2589:
2590: If this database is installed, pkgsrc builds will use it to perform a security
2591: check before building any package.
1.1 dsieger 2592:
1.154 rillig 2593: 10.15. Why do some packages ignore my CFLAGS?
1.1 dsieger 2594:
2595: When you add your own preferences to the CFLAGS variable in your mk.conf, these
2596: flags are passed in environment variables to the ./configure scripts and to
2597: make(1). Some package authors ignore the CFLAGS from the environment variable
2598: by overriding them in the Makefiles of their package.
2599:
2600: Currently there is no solution to this problem. If you really need the package
2601: to use your CFLAGS you should run make patch in the package directory and then
2602: inspect any Makefile and Makefile.in for whether they define CFLAGS explicitly.
2603: Usually you can remove these lines. But be aware that some "smart" programmers
2604: write so bad code that it only works for the specific combination of CFLAGS
2605: they have chosen.
2606:
1.172 rillig 2607: To find out where the CFLAGS are ignored, add the following lines to mk.conf:
2608:
2609: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
2610: CFLAGS+= -Dpkgsrc___CFLAGS
2611: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
2612:
2613: Then run bmake show-all-configure show-all-build to see whether the above flags
2614: are passed to the actual build commands in general.
2615:
2616: To find out whether the flags are passed to individual compiler commands, have
2617: a look at the file work/.work.log. In most cases, the flags from the original
2618: command lines (the lines starting with [*]) are passed unmodified to the actual
2619: compiler (the lines starting with <.>). If the flag is missing from the actual
2620: compiler command, it must have been removed by the pkgsrc compiler wrappers.
2621:
1.154 rillig 2622: 10.16. A package does not build. What shall I do?
1.1 dsieger 2623:
2624: 1. Make sure that your copy of pkgsrc is consistent. A case that occurs often
2625: is that people only update pkgsrc in parts, because of performance reasons.
2626: Since pkgsrc is one large system, not a collection of many small systems,
2627: there are sometimes changes that only work when the whole pkgsrc tree is
2628: updated.
2629:
1.25 wiz 2630: 2. Make sure that you don't have any CVS conflicts. Search for "<<<<<<" or "
2631: >>>>>>" in all your pkgsrc files.
1.1 dsieger 2632:
1.25 wiz 2633: 3. Make sure that you don't have old copies of the packages extracted. Run
1.1 dsieger 2634: make clean clean-depends to verify this.
2635:
1.108 rillig 2636: 4. If you are a package developer who wants to invest some work, have a look
1.154 rillig 2637: at Chapter 21, Making your package work.
1.108 rillig 2638:
2639: 5. If the problem still exists, write a mail to the pkgsrc-users mailing list.
1.1 dsieger 2640:
1.154 rillig 2641: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.1 dsieger 2642: conflicts" mean?
2643:
2644: You have modified a file from pkgsrc, and someone else has modified that same
2645: file afterwards in the CVS repository. Both changes are in the same region of
2646: the file, so when you updated pkgsrc, the cvs command marked the conflicting
2647: changes in the file. Because of these markers, the file is no longer a valid
2648: Makefile.
2649:
2650: Have a look at that file, and if you don't need your local changes anymore, you
2651: can remove that file and run cvs -q update -dP in that directory to download
2652: the current version.
2653:
2654: Part II. The pkgsrc developer's guide
2655:
2656: This part of the book deals with creating and modifying packages. It starts
2657: with a "HOWTO"-like guide on creating a new package. The remaining chapters are
2658: more like a reference manual for pkgsrc.
2659:
2660: Table of Contents
2661:
1.154 rillig 2662: 11. Getting help
1.184 rillig 2663: 12. Package components - files, directories and contents
1.1 dsieger 2664:
1.184 rillig 2665: 12.1. Makefile
2666: 12.2. distinfo
2667: 12.3. patches/*
1.1 dsieger 2668:
1.184 rillig 2669: 12.3.1. Structure of a single patch file
2670: 12.3.2. Creating patch files
2671: 12.3.3. Sources where the patch files come from
2672: 12.3.4. Patching guidelines
2673: 12.3.5. Feedback to the author
1.1 dsieger 2674:
1.184 rillig 2675: 12.4. Other mandatory files
2676: 12.5. Optional files
1.1 dsieger 2677:
1.184 rillig 2678: 12.5.1. Files affecting the binary package
2679: 12.5.2. Files affecting the build process
2680: 12.5.3. Files affecting nothing at all
1.1 dsieger 2681:
1.184 rillig 2682: 12.6. work*
2683: 12.7. files/*
1.1 dsieger 2684:
1.184 rillig 2685: 13. The build process
1.1 dsieger 2686:
1.184 rillig 2687: 13.1. Introduction
2688: 13.2. Program location
2689: 13.3. Directories used during the build process
2690: 13.4. Running a phase
2691: 13.5. The fetch phase
1.1 dsieger 2692:
1.184 rillig 2693: 13.5.1. What to fetch and where to get it from
2694: 13.5.2. How are the files fetched?
1.1 dsieger 2695:
1.184 rillig 2696: 13.6. The checksum phase
2697: 13.7. The extract phase
2698: 13.8. The patch phase
2699: 13.9. The tools phase
2700: 13.10. The wrapper phase
2701: 13.11. The configure phase
2702: 13.12. The build phase
2703: 13.13. The test phase
2704: 13.14. The install phase
2705: 13.15. The package phase
2706: 13.16. Cleaning up
2707: 13.17. Other helpful targets
1.1 dsieger 2708:
1.184 rillig 2709: 14. Creating a new pkgsrc package from scratch
1.1 dsieger 2710:
1.184 rillig 2711: 14.1. Common types of packages
1.1 dsieger 2712:
1.184 rillig 2713: 14.1.1. Perl modules
2714: 14.1.2. Python modules and programs
2715: 14.1.3. R packages
2716: 14.1.4. TeXlive packages
1.1 dsieger 2717:
1.184 rillig 2718: 14.2. Examples
1.1 dsieger 2719:
1.184 rillig 2720: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 2721:
1.184 rillig 2722: 15. Programming in Makefiles
1.1 dsieger 2723:
1.184 rillig 2724: 15.1. Caveats
2725: 15.2. Makefile variables
1.1 dsieger 2726:
1.184 rillig 2727: 15.2.1. Naming conventions
1.1 dsieger 2728:
1.184 rillig 2729: 15.3. Code snippets
1.1 dsieger 2730:
1.184 rillig 2731: 15.3.1. Adding things to a list
2732: 15.3.2. Echoing a string exactly as-is
2733: 15.3.3. Passing CFLAGS to GNU configure scripts
2734: 15.3.4. Handling possibly empty variables
1.1 dsieger 2735:
1.184 rillig 2736: 16. Options handling
1.1 dsieger 2737:
1.184 rillig 2738: 16.1. Global default options
2739: 16.2. Converting packages to use bsd.options.mk
2740: 16.3. Option Names
2741: 16.4. Determining the options of dependencies
1.1 dsieger 2742:
1.184 rillig 2743: 17. Tools needed for building or running
1.1 dsieger 2744:
1.184 rillig 2745: 17.1. Tools for pkgsrc builds
2746: 17.2. Tools needed by packages
2747: 17.3. Tools provided by platforms
1.1 dsieger 2748:
1.184 rillig 2749: 18. Buildlink methodology
1.1 dsieger 2750:
1.184 rillig 2751: 18.1. Converting packages to use buildlink3
2752: 18.2. Writing buildlink3.mk files
1.1 dsieger 2753:
1.184 rillig 2754: 18.2.1. Anatomy of a buildlink3.mk file
2755: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.
2756: pkg in buildlink3.mk files
1.1 dsieger 2757:
1.184 rillig 2758: 18.3. Writing builtin.mk files
1.1 dsieger 2759:
1.184 rillig 2760: 18.3.1. Anatomy of a builtin.mk file
2761: 18.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 2762:
1.184 rillig 2763: 19. PLIST issues
1.1 dsieger 2764:
1.184 rillig 2765: 19.1. RCS ID
2766: 19.2. Semi-automatic PLIST generation
2767: 19.3. Tweaking output of make print-PLIST
2768: 19.4. Variable substitution in PLIST
2769: 19.5. Man page compression
2770: 19.6. Changing PLIST source with PLIST_SRC
2771: 19.7. Platform-specific and differing PLISTs
2772: 19.8. Build-specific PLISTs
2773: 19.9. Sharing directories between packages
1.1 dsieger 2774:
1.184 rillig 2775: 20. The pkginstall framework
1.1 dsieger 2776:
1.184 rillig 2777: 20.1. Files and directories outside the installation prefix
1.1 dsieger 2778:
1.184 rillig 2779: 20.1.1. Directory manipulation
2780: 20.1.2. File manipulation
1.1 dsieger 2781:
1.184 rillig 2782: 20.2. Configuration files
1.1 dsieger 2783:
1.184 rillig 2784: 20.2.1. How PKG_SYSCONFDIR is set
2785: 20.2.2. Telling the software where configuration files are
2786: 20.2.3. Patching installations
2787: 20.2.4. Disabling handling of configuration files
1.1 dsieger 2788:
1.184 rillig 2789: 20.3. System startup scripts
1.1 dsieger 2790:
1.184 rillig 2791: 20.3.1. Disabling handling of system startup scripts
1.1 dsieger 2792:
1.184 rillig 2793: 20.4. System users and groups
2794: 20.5. System shells
1.1 dsieger 2795:
1.184 rillig 2796: 20.5.1. Disabling shell registration
1.1 dsieger 2797:
1.184 rillig 2798: 20.6. Fonts
1.1 dsieger 2799:
1.184 rillig 2800: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 2801:
1.154 rillig 2802: 21. Making your package work
1.1 dsieger 2803:
1.154 rillig 2804: 21.1. General operation
1.1 dsieger 2805:
1.154 rillig 2806: 21.1.1. How to pull in user-settable variables from mk.conf
2807: 21.1.2. User interaction
2808: 21.1.3. Handling licenses
2809: 21.1.4. Restricted packages
2810: 21.1.5. Handling dependencies
2811: 21.1.6. Handling conflicts with other packages
2812: 21.1.7. Packages that cannot or should not be built
2813: 21.1.8. Packages which should not be deleted, once installed
2814: 21.1.9. Handling packages with security problems
2815: 21.1.10. How to handle incrementing versions when fixing an existing
1.1 dsieger 2816: package
1.154 rillig 2817: 21.1.11. Substituting variable text in the package files (the SUBST
1.1 dsieger 2818: framework)
2819:
1.154 rillig 2820: 21.2. The fetch phase
1.1 dsieger 2821:
1.154 rillig 2822: 21.2.1. Packages whose distfiles aren't available for plain downloading
2823: 21.2.2. How to handle modified distfiles with the 'old' name
2824: 21.2.3. Packages hosted on github.com
2825:
2826: 21.3. The configure phase
2827:
2828: 21.3.1. Shared libraries - libtool
2829: 21.3.2. Using libtool on GNU packages that already support libtool
2830: 21.3.3. GNU Autoconf/Automake
2831:
2832: 21.4. Programming languages
2833:
2834: 21.4.1. C, C++, and Fortran
2835: 21.4.2. Java
1.205 ! wiz 2836: 21.4.3. Go
! 2837: 21.4.4. Packages containing Perl scripts
! 2838: 21.4.5. Packages containing shell scripts
! 2839: 21.4.6. Other programming languages
1.154 rillig 2840:
2841: 21.5. The build phase
2842:
2843: 21.5.1. Compiling C and C++ code conditionally
2844: 21.5.2. How to handle compiler bugs
1.172 rillig 2845: 21.5.3. No such file or directory
2846: 21.5.4. Undefined reference to "..."
2847: 21.5.5. Running out of memory
1.154 rillig 2848:
2849: 21.6. The install phase
2850:
2851: 21.6.1. Creating needed directories
2852: 21.6.2. Where to install documentation
2853: 21.6.3. Installing highscore files
2854: 21.6.4. Adding DESTDIR support to packages
2855: 21.6.5. Packages with hardcoded paths to other interpreters
1.203 nia 2856: 21.6.6. Packages installing Perl modules
1.154 rillig 2857: 21.6.7. Packages installing info files
2858: 21.6.8. Packages installing man pages
1.203 nia 2859: 21.6.9. Packages installing X11 fonts
2860: 21.6.10. Packages installing SGML or XML data
2861: 21.6.11. Packages installing extensions to the MIME database
2862: 21.6.12. Packages using intltool
2863: 21.6.13. Packages installing startup scripts
2864: 21.6.14. Packages installing TeX modules
2865: 21.6.15. Packages supporting running binaries in emulation
2866: 21.6.16. Packages installing hicolor icons
2867: 21.6.17. Packages installing desktop files
1.154 rillig 2868:
2869: 21.7. Marking packages as having problems
2870:
1.184 rillig 2871: 22. GNOME packaging and porting
2872:
2873: 22.1. Meta packages
2874: 22.2. Packaging a GNOME application
2875: 22.3. Updating GNOME to a newer version
2876: 22.4. Patching guidelines
2877:
1.154 rillig 2878: 23. Submitting and Committing
2879:
2880: 23.1. Submitting binary packages
2881: 23.2. Submitting source packages (for non-NetBSD-developers)
2882: 23.3. General notes when adding, updating, or removing packages
2883: 23.4. Commit Messages
2884: 23.5. Committing: Adding a package to CVS
2885: 23.6. Updating a package to a newer version
2886: 23.7. Renaming a package in pkgsrc
2887: 23.8. Moving a package in pkgsrc
2888:
2889: 24. Frequently Asked Questions
2890:
2891: Chapter 11. Getting help
2892:
2893: To get help when developing pkgsrc, the definitive source is this document, the
2894: pkgsrc guide. If you don't find anything here, there are alternatives:
2895:
2896: * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
2897: Run bmake help topic=? to get help for any topic, such as a variable name
2898: like BUILD_DEFS, a make target like do-build, a missing C or C++ function
2899: like strcasecmp or any other topic.
2900:
2901: The available help topics are listed in Appendix D, Help topics.
2902:
1.163 rillig 2903: * To see the value of a single variable, run bmake show-var VARNAME=X.
2904:
2905: * To see the values of the most common variables, run bmake show-all. These
2906: variables are grouped by topic. To see the variables for a single topic,
2907: run bmake show-all-topic, for example bmake show-all-fetch.
2908:
1.154 rillig 2909: * The tech-pkg mailing list, to which you can subscribe and then ask your
2910: questions.
2911:
2912: * The #pkgsrc IRC channel, which is accessible via a web browser or by using
2913: a specialized chat program such as XChat. Pick any user name and join the
2914: channel #pkgsrc.
1.1 dsieger 2915:
1.184 rillig 2916: Chapter 12. Package components - files, directories and contents
1.1 dsieger 2917:
2918: Table of Contents
2919:
1.184 rillig 2920: 12.1. Makefile
2921: 12.2. distinfo
2922: 12.3. patches/*
2923:
2924: 12.3.1. Structure of a single patch file
2925: 12.3.2. Creating patch files
2926: 12.3.3. Sources where the patch files come from
2927: 12.3.4. Patching guidelines
2928: 12.3.5. Feedback to the author
2929:
2930: 12.4. Other mandatory files
2931: 12.5. Optional files
2932:
2933: 12.5.1. Files affecting the binary package
2934: 12.5.2. Files affecting the build process
2935: 12.5.3. Files affecting nothing at all
1.1 dsieger 2936:
1.184 rillig 2937: 12.6. work*
2938: 12.7. files/*
1.1 dsieger 2939:
1.184 rillig 2940: Whenever you're preparing a package, there are a number of files involved which
2941: are described in the following sections.
1.1 dsieger 2942:
1.184 rillig 2943: 12.1. Makefile
1.1 dsieger 2944:
1.184 rillig 2945: Building, installation and creation of a binary package are all controlled by
2946: the package's Makefile. The Makefile describes various things about a package,
2947: for example from where to get it, how to configure, build, and install it.
1.1 dsieger 2948:
1.184 rillig 2949: A package Makefile contains several sections that describe the package.
1.1 dsieger 2950:
1.184 rillig 2951: In the first section there are the following variables, which should appear
2952: exactly in the order given here. The order and grouping of the variables is
2953: mostly historical and has no further meaning.
1.1 dsieger 2954:
1.184 rillig 2955: * DISTNAME is the basename of the distribution file to be downloaded from the
2956: package's website.
1.1 dsieger 2957:
1.184 rillig 2958: * PKGNAME is the name of the package, as used by pkgsrc. You need to provide
2959: it if DISTNAME (which is the default) is not a good name for the package in
2960: pkgsrc or DISTNAME is not provided (no distribution file is required).
2961: Usually it is the pkgsrc directory name together with the version number.
2962: It must match the regular expression ^[A-Za-z0-9][A-Za-z0-9-_.+]*$, that
2963: is, it starts with a letter or digit, and contains only letters, digits,
1.204 nia 2964: dashes, underscores, dots and plus signs. New packages should have entirely
2965: lower-case names, with the exception of some that must follow pre-existing
2966: conventions (e.g. R packages begin with R-). You can use the :tl variable
2967: modifier to lower-case the package name.
1.26 spz 2968:
1.184 rillig 2969: * CATEGORIES is a list of categories which the package fits in. You can
2970: choose any of the top-level directories of pkgsrc for it.
1.1 dsieger 2971:
1.184 rillig 2972: Currently the following values are available for CATEGORIES. If more than
2973: one is used, they need to be separated by spaces:
1.1 dsieger 2974:
1.184 rillig 2975: archivers cross geography meta-pkgs security
2976: audio databases graphics misc shells
2977: benchmarks devel ham multimedia sysutils
2978: biology editors inputmethod net textproc
2979: cad emulators lang news time
2980: chat finance mail parallel wm
2981: comms fonts math pkgtools www
2982: converters games mbone print x11
1.1 dsieger 2983:
1.184 rillig 2984: * MASTER_SITES, DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES
2985: are discussed in detail in Section 13.5, "The fetch phase".
1.1 dsieger 2986:
1.184 rillig 2987: The second section contains information about separately downloaded patches, if
2988: any.
1.1 dsieger 2989:
1.184 rillig 2990: * PATCHFILES: Name(s) of additional files that contain distribution patches.
2991: There is no default. pkgsrc will look for them at PATCH_SITES. They will
2992: automatically be uncompressed before patching if the names end with .gz or
2993: .Z.
1.1 dsieger 2994:
1.184 rillig 2995: * PATCH_SITES: Primary location(s) for distribution patch files (see
2996: PATCHFILES above) if not found locally.
1.1 dsieger 2997:
1.184 rillig 2998: * PATCH_DIST_STRIP: an argument to patch(1) that sets the pathname strip
2999: count to help find the correct files to patch. It defaults to -p0.
1.1 dsieger 3000:
1.184 rillig 3001: The third section contains the following variables.
1.1 dsieger 3002:
1.184 rillig 3003: * MAINTAINER is the email address of the person who feels responsible for
3004: this package, and who is most likely to look at problems or questions
3005: regarding this package which have been reported with send-pr(1). Other
3006: developers may contact the MAINTAINER before making changes to the package,
3007: but are not required to do so. When packaging a new program, set MAINTAINER
3008: to yourself. If you really can't maintain the package for future updates,
3009: set it to <pkgsrc-users@NetBSD.org>.
1.1 dsieger 3010:
1.184 rillig 3011: * OWNER should be used instead of MAINTAINER when you do not want other
3012: developers to update or change the package without contacting you first. A
3013: package Makefile should contain one of MAINTAINER or OWNER, but not both.
1.1 dsieger 3014:
1.184 rillig 3015: * HOMEPAGE is a URL where users can find more information about the package.
1.1 dsieger 3016:
1.184 rillig 3017: * COMMENT is a one-line description of the package (should not include the
3018: package name).
1.1 dsieger 3019:
1.184 rillig 3020: * LICENSE indicates the license(s) applicable for the package. See
3021: Section 21.1.3, "Handling licenses" for further details.
1.1 dsieger 3022:
1.184 rillig 3023: Other variables that affect the build:
1.1 dsieger 3024:
1.184 rillig 3025: * WRKSRC: The directory where the interesting distribution files of the
3026: package are found. The default is ${WRKDIR}/${DISTNAME}, which works for
3027: most packages.
1.1 dsieger 3028:
1.184 rillig 3029: If a package doesn't create a subdirectory for itself (most GNU software
3030: does, for instance), but extracts itself in the current directory, you
3031: should set WRKSRC=${WRKDIR}.
1.1 dsieger 3032:
1.184 rillig 3033: If a package doesn't create a subdirectory with the name of DISTNAME but
3034: some different name, set WRKSRC to point to the proper name in ${WRKDIR},
3035: for example WRKSRC=${WRKDIR}/${DISTNAME}/unix. See lang/tcl and x11/tk for
3036: other examples.
1.17 imil 3037:
1.184 rillig 3038: The name of the working directory created by pkgsrc is taken from the
3039: WRKDIR_BASENAME variable. By default, its value is work. If you want to use
3040: the same pkgsrc tree for building different kinds of binary packages, you
3041: can change the variable according to your needs. Two other variables handle
3042: common cases of setting WRKDIR_BASENAME individually. If OBJHOSTNAME is
3043: defined in mk.conf, the first component of the host's name is attached to
3044: the directory name. If OBJMACHINE is defined, the platform name is
3045: attached, which might look like work.i386 or work.sparc.
1.17 imil 3046:
1.184 rillig 3047: Please pay attention to the following gotchas:
1.17 imil 3048:
1.184 rillig 3049: * Add MANCOMPRESSED if man pages are installed in compressed form by the
3050: package. For packages using BSD-style makefiles which honor MANZ, there is
3051: MANCOMPRESSED_IF_MANZ.
1.17 imil 3052:
1.184 rillig 3053: * Replace /usr/local with "${PREFIX}" in all files (see patches, below).
1.103 wiz 3054:
1.184 rillig 3055: * If the package installs any info files, see Section 21.6.7, "Packages
3056: installing info files".
1.103 wiz 3057:
1.184 rillig 3058: 12.2. distinfo
1.17 imil 3059:
1.184 rillig 3060: The distinfo file contains the message digest, or checksum, of each distfile
3061: needed for the package. This ensures that the distfiles retrieved from the
3062: Internet have not been corrupted during transfer or altered by a malign force
3063: to introduce a security hole. To provide maximum security, all distfiles are
3064: protected using three different message digest algorithms (SHA1, RMD160,
3065: SHA512), as well as the file size.
1.17 imil 3066:
1.184 rillig 3067: The distinfo file also contains the checksums for all the patches found in the
3068: patches directory (see Section 12.3, "patches/*"). These checksums ensure that
3069: patches are only applied intentionally and that they don't accidentally change,
3070: e.g. when merging different changes together. They also make sure that new
3071: patches are actually added to CVS and old ones are removed. Too see whether the
3072: patches and the distinfo file match, run pkglint after changing the patches.
1.17 imil 3073:
1.184 rillig 3074: To regenerate the distinfo file, use the make distinfo command.
1.17 imil 3075:
1.184 rillig 3076: Some packages have different sets of distfiles depending on the platform, for
3077: example lang/openjdk8. These are kept in the same distinfo file and care should
3078: be taken when upgrading such a package to ensure distfile information is not
3079: lost.
1.17 imil 3080:
1.184 rillig 3081: 12.3. patches/*
1.63 wiz 3082:
1.184 rillig 3083: Some packages don't work out-of-the box on the various platforms that are
3084: supported by pkgsrc. These packages need to be patched to make them work. The
3085: patch files can be found in the patches/ directory.
1.17 imil 3086:
1.184 rillig 3087: In the patch phase, these patches are applied to the files in WRKSRC directory
3088: after extracting them, in alphabetic order.
1.160 brook 3089:
1.184 rillig 3090: 12.3.1. Structure of a single patch file
1.160 brook 3091:
1.184 rillig 3092: The patch-* files should be in diff -bu format, and apply without a fuzz to
3093: avoid problems. (To force patches to apply with fuzz you can set
3094: PATCH_FUZZ_FACTOR=-F2). Furthermore, each patch should contain only changes for
3095: a single file, and no file should be patched by more than one patch file. This
3096: helps to keep future modifications simple.
1.160 brook 3097:
1.184 rillig 3098: Each patch file is structured as follows: In the first line, there is the RCS
3099: Id of the patch itself. The second line should be empty for aesthetic reasons.
3100: After that, there should be a comment for each change that the patch does.
3101: There are a number of standard cases:
1.160 brook 3102:
1.184 rillig 3103: * Patches for commonly known vulnerabilities should mention the vulnerability
3104: ID (CAN, CVE).
1.160 brook 3105:
1.184 rillig 3106: * Patches that change source code should mention the platform and other
3107: environment (for example, the compiler) that the patch is needed for.
1.160 brook 3108:
1.184 rillig 3109: The patch should be commented so that any developer who knows the code of the
3110: application can make some use of the patch. Special care should be taken for
3111: the upstream developers, since we generally want that they accept our patches,
3112: so we have less work in the future.
1.160 brook 3113:
1.184 rillig 3114: 12.3.2. Creating patch files
1.160 brook 3115:
1.184 rillig 3116: One important thing to mention is to pay attention that no RCS IDs get stored
3117: in the patch files, as these will cause problems when later checked into the
3118: NetBSD CVS tree. Use the pkgdiff command from the pkgtools/pkgdiff package to
3119: avoid these problems.
1.160 brook 3120:
1.184 rillig 3121: For even more automation, we recommend using mkpatches from the same package to
3122: make a whole set of patches. You just have to backup files before you edit them
3123: to filename.orig, e.g. with cp -p filename filename.orig or, easier, by using
3124: pkgvi again from the same package. If you upgrade a package this way, you can
3125: easily compare the new set of patches with the previously existing one with
3126: patchdiff. The files in patches are replaced by new files, so carefully check
3127: if you want to take all the changes.
1.160 brook 3128:
1.184 rillig 3129: When you have finished a package, remember to generate the checksums for the
3130: patch files by using the make makepatchsum command, see Section 12.2,
3131: "distinfo".
1.1 dsieger 3132:
1.184 rillig 3133: When adding a patch that corrects a problem in the distfile (rather than e.g.
3134: enforcing pkgsrc's view of where man pages should go), send the patch as a bug
3135: report to the maintainer. This benefits non-pkgsrc users of the package, and
3136: usually makes it possible to remove the patch in future version.
1.1 dsieger 3137:
1.184 rillig 3138: The file names of the patch files are usually of the form patch-
3139: path_to_file__with__underscores.c. Many packages still use the previous
3140: convention patch-[a-z][a-z], but new patches should be of the form containing
3141: the filename. mkpatches included in pkgtools/pkgdiff takes care of the name
3142: automatically.
1.1 dsieger 3143:
1.184 rillig 3144: 12.3.3. Sources where the patch files come from
1.1 dsieger 3145:
1.184 rillig 3146: If you want to share patches between multiple packages in pkgsrc, e.g. because
3147: they use the same distfiles, set PATCHDIR to the path where the patch files can
3148: be found, e.g.:
1.1 dsieger 3149:
1.184 rillig 3150: PATCHDIR= ../../editors/xemacs/patches
1.1 dsieger 3151:
1.184 rillig 3152: Patch files that are distributed by the author or other maintainers can be
3153: listed in PATCHFILES.
1.1 dsieger 3154:
1.184 rillig 3155: If it is desired to store any patches that should not be committed into pkgsrc,
3156: they can be kept outside the pkgsrc tree in the $LOCALPATCHES directory. The
3157: directory tree there is expected to have the same "category/package" structure
3158: as pkgsrc, and patches are expected to be stored inside these dirs (also known
3159: as $LOCALPATCHES/$PKGPATH). For example, if you want to keep a private patch
3160: for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All
3161: files in the named directory are expected to be patch files, and they are
3162: applied after pkgsrc patches are applied.
1.1 dsieger 3163:
1.184 rillig 3164: 12.3.4. Patching guidelines
1.1 dsieger 3165:
1.184 rillig 3166: When fixing a portability issue in the code do not use preprocessor magic to
3167: check for the current operating system nor platform. Doing so hurts portability
3168: to other platforms because the OS-specific details are not abstracted
3169: appropriately.
1.1 dsieger 3170:
1.184 rillig 3171: The general rule to follow is: instead of checking for the operating system the
3172: application is being built on, check for the specific features you need. For
3173: example, instead of assuming that kqueue is available under NetBSD and using
3174: the __NetBSD__ macro to conditionalize kqueue support, add a check that detects
1.198 leot 3175: kqueue itself -- yes, this generally involves patching the configure script.
1.184 rillig 3176: There is absolutely nothing that prevents some OSes from adopting interfaces
3177: from other OSes (e.g. Linux implementing kqueue), something that the above
3178: checks cannot take into account.
1.1 dsieger 3179:
1.184 rillig 3180: Of course, checking for features generally involves more work on the
3181: developer's side, but the resulting changes are cleaner and there are chances
3182: they will work on many other platforms. Not to mention that there are higher
3183: chances of being later integrated into the mainstream sources. Remember: It
3184: doesn't work unless it is right!
1.1 dsieger 3185:
1.184 rillig 3186: Some typical examples:
1.121 sevan 3187:
1.184 rillig 3188: Table 12.1. Patching examples
1.1 dsieger 3189:
1.184 rillig 3190: +-------------------------------------------------------------------------------------------+
3191: | Where | Incorrect | Correct |
3192: |---------+--------------------------+------------------------------------------------------|
3193: | |case ${target_os} in | |
3194: |configure|netbsd*) have_kvm=yes ;; |AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)|
3195: |script |*) have_kvm=no ;; | |
3196: | |esac | |
3197: |---------+--------------------------+------------------------------------------------------|
3198: |C source |#if defined(__NetBSD__) |#if defined(HAVE_SYS_EVENT_H) |
3199: |file |# include <sys/event.h> |# include <sys/event.h> |
3200: | |#endif |#endif |
3201: |---------+--------------------------+------------------------------------------------------|
3202: | |int |int |
3203: | |monitor_file(...) |monitor_file(...) |
3204: | |{ |{ |
3205: | |#if defined(__NetBSD__) |#if defined(HAVE_KQUEUE) |
3206: |C source | int fd = kqueue();| int fd = kqueue(); |
3207: |file | ... | ... |
3208: | |#else |#else |
3209: | | ... | ... |
3210: | |#endif |#endif |
3211: | |} |} |
3212: +-------------------------------------------------------------------------------------------+
1.1 dsieger 3213:
3214:
1.184 rillig 3215: 12.3.5. Feedback to the author
1.1 dsieger 3216:
1.184 rillig 3217: Always, always, always feed back any portability fixes or improvements you do
3218: to a package to the mainstream developers. This is the only way to get their
3219: attention on portability issues and to ensure that future versions can be built
3220: out-of-the box on NetBSD. Furthermore, any user that gets newer distfiles will
3221: get the fixes straight from the packaged code.
1.1 dsieger 3222:
1.184 rillig 3223: This generally involves cleaning up the patches (because sometimes the patches
3224: that are added to pkgsrc are quick hacks), filing bug reports in the
3225: appropriate trackers for the projects and working with the mainstream authors
3226: to accept your changes. It is extremely important that you do it so that the
3227: packages in pkgsrc are kept simple and thus further changes can be done without
3228: much hassle.
1.1 dsieger 3229:
1.184 rillig 3230: When you have done this, please add a URL to the upstream bug report to the
3231: patch comment.
1.1 dsieger 3232:
1.184 rillig 3233: Support the idea of free software!
1.1 dsieger 3234:
1.184 rillig 3235: 12.4. Other mandatory files
1.1 dsieger 3236:
1.184 rillig 3237: DESCR
1.1 dsieger 3238:
1.184 rillig 3239: A multi-line description of the piece of software. This should include any
3240: credits where they are due. Please bear in mind that others do not share
3241: your sense of humour (or spelling idiosyncrasies), and that others will
3242: read everything that you write here.
1.1 dsieger 3243:
1.184 rillig 3244: PLIST
1.1 dsieger 3245:
1.184 rillig 3246: This file governs the files that are installed on your system: all the
3247: binaries, manual pages, etc. There are other directives which may be
3248: entered in this file, to control the creation and deletion of directories,
3249: and the location of inserted files. See Chapter 19, PLIST issues for more
3250: information.
1.1 dsieger 3251:
1.184 rillig 3252: 12.5. Optional files
1.1 dsieger 3253:
1.184 rillig 3254: 12.5.1. Files affecting the binary package
1.1 dsieger 3255:
1.184 rillig 3256: INSTALL
1.1 dsieger 3257:
1.184 rillig 3258: This shell script is invoked twice by pkg_add(1). First time after package
3259: extraction and before files are moved in place, the second time after the
3260: files to install are moved in place. This can be used to do any custom
3261: procedures not possible with @exec commands in PLIST. See pkg_add(1) and
3262: pkg_create(1) for more information. See also Section 20.1, "Files and
3263: directories outside the installation prefix". Please note that you can
3264: modify variables in it easily by using FILES_SUBST in the package's
3265: Makefile:
1.1 dsieger 3266:
1.184 rillig 3267: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3268:
1.184 rillig 3269: replaces "@SOMEVAR@" with "somevalue" in the INSTALL. By default,
3270: substitution is performed for PREFIX, LOCALBASE, X11BASE, VARBASE, and a
3271: few others, type make help topic=FILES_SUBST for a complete list.
1.1 dsieger 3272:
1.184 rillig 3273: DEINSTALL
1.1 dsieger 3274:
1.184 rillig 3275: This script is executed before and after any files are removed. It is this
3276: script's responsibility to clean up any additional messy details around the
3277: package's installation, since all pkg_delete knows is how to delete the
3278: files created in the original distribution. See pkg_delete(1) and
3279: pkg_create(1) for more information. The same methods to replace variables
3280: can be used as for the INSTALL file.
1.1 dsieger 3281:
1.184 rillig 3282: MESSAGE
1.1 dsieger 3283:
1.198 leot 3284: This file is displayed after installation of the package. While this was
3285: used often in the past, it has two problems: the display will be missed if
3286: many packages are intalled at once, and the person installing the package
3287: and the one using or configuring it may be different. It should therefore
3288: be used only in exceptional circumstances where lasting negative
3289: consequences would result from someone not reading it.
3290:
3291: MESSAGE should not be used for:
3292:
3293: + exhortations to read the documentation
3294:
3295: + reminders to install rc.d files and set variables
3296:
3297: + anything that should be explained in the installation/configuration
3298: documentation that should come with the package
3299:
3300: If the documentation provided by upstream needs enhancing, create e.g.
3301: files/README.pkgsrc and install it in the package's documentation
3302: directory.
3303:
3304: Note that MESSAGE is shown for all operating systems and all init systems.
3305: If a MESSAGE is necessary, it should be narrowed to only those operating
3306: systems and init systems to which it applies.
3307:
3308: Note that you can modify variables in it easily by using MESSAGE_SUBST in
3309: the package's Makefile:
1.1 dsieger 3310:
1.184 rillig 3311: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3312:
1.184 rillig 3313: replaces "${SOMEVAR}" with "somevalue" in MESSAGE. By default, substitution
3314: is performed for PKGNAME, PKGBASE, PREFIX, LOCALBASE, X11BASE,
3315: PKG_SYSCONFDIR, ROOT_GROUP, and ROOT_USER.
1.1 dsieger 3316:
1.184 rillig 3317: You can display a different or additional files by setting the MESSAGE_SRC
3318: variable. Its default is MESSAGE, if the file exists.
1.1 dsieger 3319:
1.184 rillig 3320: ALTERNATIVES
1.1 dsieger 3321:
1.184 rillig 3322: This file is used by the alternatives framework. It creates, configures,
3323: and destroys generic wrappers used to run programs with similar interfaces.
3324: See pkg_alternatives(8) from pkgtools/pkg_alternatives for more
3325: information.
1.1 dsieger 3326:
1.184 rillig 3327: Each line of the file contains two filenames, first the wrapper and then
3328: the alternative provided by the package. Both paths are relative to PREFIX.
1.1 dsieger 3329:
1.184 rillig 3330: 12.5.2. Files affecting the build process
1.1 dsieger 3331:
1.184 rillig 3332: Makefile.common
1.1 dsieger 3333:
1.184 rillig 3334: This file contains arbitrary things that could also go into a Makefile, but
3335: its purpose is to be used by more than one package. This file should only
3336: be used when the packages that will use the file are known in advance. For
3337: other purposes it is often better to write a *.mk file and give it a good
3338: name that describes what it does.
1.1 dsieger 3339:
1.184 rillig 3340: buildlink3.mk
1.1 dsieger 3341:
1.184 rillig 3342: This file contains the dependency information for the buildlink3 framework
3343: (see Chapter 18, Buildlink methodology).
1.1 dsieger 3344:
1.184 rillig 3345: hacks.mk
1.1 dsieger 3346:
1.184 rillig 3347: This file contains workarounds for compiler bugs and similar things. It is
3348: included automatically by the pkgsrc infrastructure, so you don't need an
3349: extra .include line for it.
1.1 dsieger 3350:
1.184 rillig 3351: options.mk
1.1 dsieger 3352:
1.184 rillig 3353: This file contains the code for the package-specific options (see
3354: Chapter 16, Options handling) that can be selected by the user. If a
3355: package has only one or two options, it is equally acceptable to put the
3356: code directly into the Makefile.
1.1 dsieger 3357:
1.184 rillig 3358: 12.5.3. Files affecting nothing at all
1.1 dsieger 3359:
1.184 rillig 3360: README*
1.1 dsieger 3361:
1.184 rillig 3362: These files do not take place in the creation of a package and thus are
3363: purely informative to the package developer.
1.1 dsieger 3364:
1.184 rillig 3365: TODO
1.1 dsieger 3366:
1.184 rillig 3367: This file contains things that need to be done to make the package even
3368: better.
1.1 dsieger 3369:
1.184 rillig 3370: 12.6. work*
1.1 dsieger 3371:
1.184 rillig 3372: When you type make, the distribution files are unpacked into the directory
3373: denoted by WRKDIR. It can be removed by running make clean. Besides the
3374: sources, this directory is also used to keep various timestamp files. The
3375: directory gets removed completely on clean. The default is ${.CURDIR}/work or $
3376: {.CURDIR}/work.${MACHINE_ARCH} if OBJMACHINE is set.
1.1 dsieger 3377:
1.184 rillig 3378: 12.7. files/*
1.80 wiz 3379:
1.184 rillig 3380: If you have any files that you wish to be placed in the package prior to
3381: configuration or building, you can place these files here and use a ${CP}
3382: command in the "post-extract" target to achieve this.
1.1 dsieger 3383:
1.184 rillig 3384: If you want to share files in this way with other packages, set the FILESDIR
3385: variable to point to the other package's files directory, e.g.:
1.1 dsieger 3386:
1.184 rillig 3387: FILESDIR= ../../editors/xemacs/files
1.14 jmcneill 3388:
1.184 rillig 3389: Chapter 13. The build process
1.1 dsieger 3390:
1.184 rillig 3391: Table of Contents
1.1 dsieger 3392:
1.184 rillig 3393: 13.1. Introduction
3394: 13.2. Program location
3395: 13.3. Directories used during the build process
3396: 13.4. Running a phase
3397: 13.5. The fetch phase
3398:
3399: 13.5.1. What to fetch and where to get it from
3400: 13.5.2. How are the files fetched?
3401:
3402: 13.6. The checksum phase
3403: 13.7. The extract phase
3404: 13.8. The patch phase
3405: 13.9. The tools phase
3406: 13.10. The wrapper phase
3407: 13.11. The configure phase
3408: 13.12. The build phase
3409: 13.13. The test phase
3410: 13.14. The install phase
3411: 13.15. The package phase
3412: 13.16. Cleaning up
3413: 13.17. Other helpful targets
1.1 dsieger 3414:
1.184 rillig 3415: 13.1. Introduction
1.122 leot 3416:
1.184 rillig 3417: This chapter gives a detailed description on how a package is built. Building a
3418: package is separated into different phases (for example fetch, build, install),
3419: all of which are described in the following sections. Each phase is split into
3420: so-called stages, which take the name of the containing phase, prefixed by one
3421: of pre-, do- or post-. (Examples are pre-configure, post-build.) Most of the
3422: actual work is done in the do-* stages.
1.1 dsieger 3423:
1.184 rillig 3424: Never override the regular targets (like fetch), if you have to, override the
3425: do-* ones instead.
1.1 dsieger 3426:
1.184 rillig 3427: The basic steps for building a program are always the same. First the program's
3428: source (distfile) must be brought to the local system and then extracted. After
3429: any pkgsrc-specific patches to compile properly are applied, the software can
3430: be configured, then built (usually by compiling), and finally the generated
3431: binaries, etc. can be put into place on the system.
1.1 dsieger 3432:
1.184 rillig 3433: To get more details about what is happening at each step, you can set the
3434: PKG_VERBOSE variable, or the PATCH_DEBUG variable if you are just interested in
3435: more details about the patch step.
1.1 dsieger 3436:
1.184 rillig 3437: 13.2. Program location
1.1 dsieger 3438:
1.184 rillig 3439: Before outlining the process performed by the NetBSD package system in the next
3440: section, here's a brief discussion on where programs are installed, and which
3441: variables influence this.
1.1 dsieger 3442:
1.184 rillig 3443: The automatic variable PREFIX indicates where all files of the final program
3444: shall be installed. It is usually set to LOCALBASE (/usr/pkg), or CROSSBASE for
3445: pkgs in the cross category. The value of PREFIX needs to be put into the
3446: various places in the program's source where paths to these files are encoded.
3447: See Section 12.3, "patches/*" and Section 21.3.1, "Shared libraries - libtool"
3448: for more details.
1.1 dsieger 3449:
1.184 rillig 3450: When choosing which of these variables to use, follow the following rules:
1.1 dsieger 3451:
1.184 rillig 3452: * PREFIX always points to the location where the current pkg will be
3453: installed. When referring to a pkg's own installation path, use "${PREFIX}"
3454: .
1.1 dsieger 3455:
1.184 rillig 3456: * LOCALBASE is where all non-X11 pkgs are installed. If you need to construct
3457: a -I or -L argument to the compiler to find includes and libraries
3458: installed by another non-X11 pkg, use "${LOCALBASE}". The name LOCALBASE
3459: stems from FreeBSD, which installed all packages in /usr/local. As pkgsrc
3460: leaves /usr/local for the system administrator, this variable is a
3461: misnomer.
1.1 dsieger 3462:
1.184 rillig 3463: * X11BASE is where the actual X11 distribution (from xsrc, etc.) is
3464: installed. When looking for standard X11 includes (not those installed by a
3465: package), use "${X11BASE}".
1.1 dsieger 3466:
1.184 rillig 3467: * X11-based packages using imake must set USE_IMAKE to be installed correctly
3468: under LOCALBASE.
1.1 dsieger 3469:
1.184 rillig 3470: * Within ${PREFIX}, packages should install files according to hier(7), with
3471: the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/
3472: man.
1.1 dsieger 3473:
1.184 rillig 3474: 13.3. Directories used during the build process
1.2 rillig 3475:
1.184 rillig 3476: When building a package, various directories are used to store source files,
3477: temporary files, pkgsrc-internal files, and so on. These directories are
3478: explained here.
1.1 dsieger 3479:
1.184 rillig 3480: Some of the directory variables contain relative pathnames. There are two
3481: common base directories for these relative directories: PKGSRCDIR/PKGPATH is
3482: used for directories that are pkgsrc-specific. WRKSRC is used for directories
3483: inside the package itself.
1.1 dsieger 3484:
1.184 rillig 3485: PKGSRCDIR
1.1 dsieger 3486:
1.184 rillig 3487: This is an absolute pathname that points to the pkgsrc root directory.
3488: Generally, you don't need it.
1.1 dsieger 3489:
1.184 rillig 3490: PKGDIR
1.1 dsieger 3491:
1.184 rillig 3492: This is an absolute pathname that points to the current package.
1.1 dsieger 3493:
1.184 rillig 3494: PKGPATH
1.1 dsieger 3495:
1.184 rillig 3496: This is a pathname relative to PKGSRCDIR that points to the current
3497: package.
1.1 dsieger 3498:
1.184 rillig 3499: WRKDIR
1.1 dsieger 3500:
1.184 rillig 3501: This is an absolute pathname pointing to the directory where all work takes
3502: place. The distfiles are extracted to this directory. It also contains
3503: temporary directories and log files used by the various pkgsrc frameworks,
3504: like buildlink or the wrappers.
1.1 dsieger 3505:
1.184 rillig 3506: WRKSRC
1.1 dsieger 3507:
1.184 rillig 3508: This is an absolute pathname pointing to the directory where the distfiles
3509: are extracted. It is usually a direct subdirectory of WRKDIR, and often
3510: it's the only directory entry that isn't hidden. This variable may be
3511: changed by a package Makefile.
1.1 dsieger 3512:
1.184 rillig 3513: The CREATE_WRKDIR_SYMLINK definition takes either the value yes or no and
3514: defaults to no. It indicates whether a symbolic link to the WRKDIR is to be
3515: created in the pkgsrc entry's directory. If users would like to have their
3516: pkgsrc trees behave in a read-only manner, then the value of
3517: CREATE_WRKDIR_SYMLINK should be set to no.
1.1 dsieger 3518:
1.184 rillig 3519: 13.4. Running a phase
1.1 dsieger 3520:
1.184 rillig 3521: You can run a particular phase by typing make phase, where phase is the name of
3522: the phase. This will automatically run all phases that are required for this
3523: phase. The default phase is build, that is, when you run make without
3524: parameters in a package directory, the package will be built, but not
3525: installed.
1.1 dsieger 3526:
1.184 rillig 3527: 13.5. The fetch phase
1.1 dsieger 3528:
1.184 rillig 3529: The first step in building a package is to fetch the distribution files
3530: (distfiles) from the sites that are providing them. This is the task of the
3531: fetch phase.
1.25 wiz 3532:
1.184 rillig 3533: 13.5.1. What to fetch and where to get it from
1.1 dsieger 3534:
1.184 rillig 3535: In simple cases, MASTER_SITES defines all URLs from where the distfile, whose
3536: name is derived from the DISTNAME variable, is fetched. The more complicated
3537: cases are described below.
1.1 dsieger 3538:
1.184 rillig 3539: The variable DISTFILES specifies the list of distfiles that have to be fetched.
3540: Its value defaults to ${DEFAULT_DISTFILES} and its value is ${DISTNAME}$
3541: {EXTRACT_SUFX}, so that most packages don't need to define it at all.
3542: EXTRACT_SUFX is .tar.gz by default, but can be changed freely. Note that if
3543: your package requires additional distfiles to the default one, you cannot just
3544: append the additional filenames using the += operator, but you have write for
3545: example:
1.1 dsieger 3546:
1.184 rillig 3547: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 3548:
1.184 rillig 3549: Each distfile is fetched from a list of sites, usually MASTER_SITES. If the
3550: package has multiple DISTFILES or multiple PATCHFILES from different sites, you
3551: can set SITES.distfile to the list of URLs where the file distfile (including
3552: the suffix) can be found.
1.1 dsieger 3553:
1.184 rillig 3554: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
3555: DISTFILES+= foo-file.tar.gz
3556: SITES.foo-file.tar.gz= \
3557: https://www.somewhere.com/somehow/ \
3558: https://www.somewhereelse.com/mirror/somehow/
1.1 dsieger 3559:
1.184 rillig 3560: When actually fetching the distfiles, each item from MASTER_SITES or SITES.*
3561: gets the name of each distfile appended to it, without an intermediate slash.
3562: Therefore, all site values have to end with a slash or other separator
3563: character. This allows for example to set MASTER_SITES to a URL of a CGI script
3564: that gets the name of the distfile as a parameter. In this case, the definition
3565: would look like:
1.1 dsieger 3566:
1.184 rillig 3567: MASTER_SITES= https://www.example.com/download.cgi?file=
1.1 dsieger 3568:
1.184 rillig 3569: The exception to this rule are URLs starting with a dash. In that case the URL
3570: is taken as is, fetched and the result stored under the name of the distfile.
3571: You can use this style for the case when the download URL style does not match
3572: the above common case. For example, if permanent download URL is a redirector
3573: to the real download URL, or the download file name is offered by an HTTP
3574: Content-Disposition header. In the following example, foo-1.0.0.tar.gz will be
3575: created instead of the default v1.0.0.tar.gz.
1.1 dsieger 3576:
1.184 rillig 3577: DISTNAME= foo-1.0.0
3578: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
1.29 wiz 3579:
1.184 rillig 3580: There are some predefined values for MASTER_SITES, which can be used in
3581: packages. The names of the variables should speak for themselves.
1.29 wiz 3582:
1.184 rillig 3583: MASTER_SITE_APACHE MASTER_SITE_BACKUP
3584: MASTER_SITE_CRATESIO MASTER_SITE_CYGWIN
3585: MASTER_SITE_DEBIAN MASTER_SITE_FREEBSD
3586: MASTER_SITE_FREEBSD_LOCAL MASTER_SITE_GENTOO
3587: MASTER_SITE_GITHUB MASTER_SITE_GNOME
3588: MASTER_SITE_GNU MASTER_SITE_GNUSTEP
3589: MASTER_SITE_HASKELL_HACKAGE MASTER_SITE_IFARCHIVE
3590: MASTER_SITE_KDE MASTER_SITE_MOZILLA
3591: MASTER_SITE_MOZILLA_ALL MASTER_SITE_MYSQL
3592: MASTER_SITE_NETLIB MASTER_SITE_OPENBSD
3593: MASTER_SITE_OPENOFFICE MASTER_SITE_OSDN
3594: MASTER_SITE_PERL_CPAN MASTER_SITE_PGSQL
3595: MASTER_SITE_PYPI MASTER_SITE_RUBYGEMS
3596: MASTER_SITE_R_CRAN MASTER_SITE_SOURCEFORGE
3597: MASTER_SITE_SUNSITE MASTER_SITE_SUSE
3598: MASTER_SITE_TEX_CTAN MASTER_SITE_XCONTRIB
3599: MASTER_SITE_XEMACS MASTER_SITE_XORG
1.1 dsieger 3600:
1.184 rillig 3601: Some explanations for the less self-explaining ones: MASTER_SITE_BACKUP
3602: contains backup sites for packages that are maintained in ftp://ftp.NetBSD.org/
3603: pub/pkgsrc/distfiles/${DIST_SUBDIR}. MASTER_SITE_LOCAL contains local package
3604: source distributions that are maintained in ftp://ftp.NetBSD.org/pub/pkgsrc/
3605: distfiles/LOCAL_PORTS/.
1.1 dsieger 3606:
1.184 rillig 3607: If you choose one of these predefined sites, you may want to specify a
3608: subdirectory of that site. Since these macros may expand to more than one
3609: actual site, you must use the following construct to specify a subdirectory:
1.1 dsieger 3610:
1.184 rillig 3611: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
3612: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 3613:
1.184 rillig 3614: Note the trailing slash after the subdirectory name.
1.1 dsieger 3615:
1.184 rillig 3616: 13.5.2. How are the files fetched?
1.1 dsieger 3617:
1.184 rillig 3618: The fetch phase makes sure that all the distfiles exist in a local directory
3619: (DISTDIR, which can be set by the pkgsrc user). If the files do not exist, they
3620: are fetched using commands of the form
1.1 dsieger 3621:
1.184 rillig 3622: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
1.1 dsieger 3623:
1.184 rillig 3624: where ${site} varies through several possibilities in turn: first,
3625: MASTER_SITE_OVERRIDE is tried, then the sites specified in either SITES.file if
3626: defined, else MASTER_SITES or PATCH_SITES, as applies, then finally the value
3627: of MASTER_SITE_BACKUP. The order of all except the first and the last can be
3628: optionally sorted by the user, via setting either MASTER_SORT_RANDOM, and
3629: MASTER_SORT_AWK or MASTER_SORT_REGEX.
1.1 dsieger 3630:
1.184 rillig 3631: The specific command and arguments used depend on the FETCH_USING parameter.
3632: The example above is for FETCH_USING=custom.
1.66 asau 3633:
1.184 rillig 3634: The distfiles mirror run by the NetBSD Foundation uses the mirror-distfiles
3635: target to mirror the distfiles, if they are freely distributable. Packages
3636: setting NO_SRC_ON_FTP (usually to "${RESTRICTED}") will not have their
3637: distfiles mirrored.
1.1 dsieger 3638:
1.184 rillig 3639: 13.6. The checksum phase
1.1 dsieger 3640:
1.184 rillig 3641: After the distfile(s) are fetched, their checksum is generated and compared
3642: with the checksums stored in the distinfo file. If the checksums don't match,
3643: the build is aborted. This is to ensure the same distfile is used for building,
3644: and that the distfile wasn't changed, e.g. by some malign force, deliberately
3645: changed distfiles on the master distribution site or network lossage.
1.1 dsieger 3646:
1.184 rillig 3647: 13.7. The extract phase
1.1 dsieger 3648:
1.184 rillig 3649: When the distfiles are present on the local system, they need to be extracted,
3650: as they usually come in the form of some compressed archive format.
1.1 dsieger 3651:
1.184 rillig 3652: By default, all DISTFILES are extracted. If you only need some of them, you can
3653: set the EXTRACT_ONLY variable to the list of those files.
1.1 dsieger 3654:
1.184 rillig 3655: Extracting the files is usually done by a little program, mk/extract/extract,
3656: which already knows how to extract various archive formats, so most likely you
3657: will not need to change anything here. But if you need, the following variables
3658: may help you:
1.1 dsieger 3659:
1.184 rillig 3660: EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}
1.1 dsieger 3661:
1.184 rillig 3662: Use these variables to override the default options for an extract command,
3663: which are defined in mk/extract/extract.
1.1 dsieger 3664:
1.184 rillig 3665: EXTRACT_USING
1.1 dsieger 3666:
1.184 rillig 3667: This variable can be set to bsdtar, gtar, nbtar (which is the default
3668: value), pax, or an absolute pathname pointing to the command with which tar
3669: archives should be extracted. It is preferred to choose bsdtar over gtar if
3670: NetBSD's pax-as-tar is not good enough.
1.1 dsieger 3671:
1.184 rillig 3672: If the extract program doesn't serve your needs, you can also override the
3673: EXTRACT_CMD variable, which holds the command used for extracting the files.
3674: This command is executed in the ${WRKSRC} directory. During execution of this
3675: command, the shell variable extract_file holds the absolute pathname of the
3676: file that is going to be extracted.
1.1 dsieger 3677:
1.184 rillig 3678: And if that still does not suffice, you can override the do-extract target in
3679: the package Makefile.
1.1 dsieger 3680:
1.184 rillig 3681: 13.8. The patch phase
1.1 dsieger 3682:
1.184 rillig 3683: After extraction, all the patches named by the PATCHFILES, those present in the
3684: patches subdirectory of the package as well as in $LOCALPATCHES/$PKGPATH (e.g.
3685: /usr/local/patches/graphics/png) are applied. Patchfiles ending in .Z or .gz
3686: are uncompressed before they are applied, files ending in .orig or .rej are
3687: ignored. Any special options to patch(1) can be handed in PATCH_DIST_ARGS. See
3688: Section 12.3, "patches/*" for more details.
1.1 dsieger 3689:
1.184 rillig 3690: By default patch(1) is given special arguments to make it fail if the expected
3691: text from the patch context is not found in the patched file. If that happens,
3692: fix the patch file by comparing it with the actual text in the file to be
3693: patched.
1.1 dsieger 3694:
1.184 rillig 3695: 13.9. The tools phase
1.1 dsieger 3696:
1.184 rillig 3697: This is covered in Chapter 17, Tools needed for building or running.
1.1 dsieger 3698:
1.184 rillig 3699: 13.10. The wrapper phase
1.1 dsieger 3700:
1.184 rillig 3701: This phase creates wrapper programs for the compilers and linkers. The
3702: following variables can be used to tweak the wrappers.
1.1 dsieger 3703:
1.184 rillig 3704: ECHO_WRAPPER_MSG
1.1 dsieger 3705:
1.184 rillig 3706: The command used to print progress messages. Does nothing by default. Set
3707: to ${ECHO} to see the progress messages.
1.1 dsieger 3708:
1.184 rillig 3709: WRAPPER_DEBUG
1.1 dsieger 3710:
1.184 rillig 3711: This variable can be set to yes (default) or no, depending on whether you
3712: want additional information in the wrapper log file.
1.1 dsieger 3713:
1.184 rillig 3714: WRAPPER_UPDATE_CACHE
1.1 dsieger 3715:
1.184 rillig 3716: This variable can be set to yes or no, depending on whether the wrapper
3717: should use its cache, which will improve the speed. The default value is
3718: yes, but is forced to no if the platform does not support it.
1.1 dsieger 3719:
1.184 rillig 3720: WRAPPER_REORDER_CMDS
1.1 dsieger 3721:
1.184 rillig 3722: A list of reordering commands. A reordering command has the form reorder:l:
3723: lib1:lib2. It ensures that that -llib1 occurs before -llib2.
1.1 dsieger 3724:
1.184 rillig 3725: 13.11. The configure phase
1.1 dsieger 3726:
1.184 rillig 3727: Most pieces of software need information on the header files, system calls, and
3728: library routines which are available on the platform they run on. The process
3729: of determining this information is known as configuration, and is usually
3730: automated. In most cases, a script is supplied with the distfiles, and its
3731: invocation results in generation of header files, Makefiles, etc.
1.1 dsieger 3732:
1.184 rillig 3733: If the package contains a configure script, this can be invoked by setting
3734: HAS_CONFIGURE to "yes". If the configure script is a GNU autoconf script, you
1.187 rillig 3735: should set GNU_CONFIGURE to "yes" instead.
1.1 dsieger 3736:
1.187 rillig 3737: In the do-configure stage, a rough equivalent of the following command is run.
3738: See mk/configure/configure.mk, target do-configure-script for the exact
3739: definition.
3740:
3741: .for dir in ${CONFIGURE_DIRS}
3742: cd ${WRKSRC} && cd ${dir} \
3743: && env ${CONFIGURE_ENV} \
3744: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 3745: .endfor
1.1 dsieger 3746:
1.184 rillig 3747: CONFIGURE_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In
3748: each of these directories, the configure script is run with the environment
3749: CONFIGURE_ENV and arguments CONFIGURE_ARGS. The variables CONFIGURE_ENV,
3750: CONFIGURE_SCRIPT (default: "./configure") and CONFIGURE_ARGS may all be changed
3751: by the package.
1.1 dsieger 3752:
1.184 rillig 3753: If the program uses the Perl way of configuration (mainly Perl modules, but not
3754: only), i.e. a file called Makefile.PL, it should include ../../lang/perl5/
3755: module.mk. To set any parameter for Makefile.PL use the MAKE_PARAMS variable
3756: (e.g., MAKE_PARAMS+=foo=bar
1.1 dsieger 3757:
1.184 rillig 3758: If the program uses an Imakefile for configuration, the appropriate steps can
3759: be invoked by setting USE_IMAKE to "yes". If you only need xmkmf, add it to
3760: USE_TOOLS. You can add variables to xmkmf's environment by adding them to the
3761: SCRIPTS_ENV variable.
1.1 dsieger 3762:
1.184 rillig 3763: If the program uses cmake for configuration, the appropriate steps can be
3764: invoked by setting USE_CMAKE to "yes". You can add variables to cmake's
3765: environment by adding them to the CONFIGURE_ENV variable and arguments to cmake
3766: by adding them to the CMAKE_ARGS variable. The top directory argument is given
3767: by the CMAKE_ARG_PATH variable, that defaults to "." (relative to
3768: CONFIGURE_DIRS)
1.1 dsieger 3769:
1.184 rillig 3770: If there is no configure step at all, set NO_CONFIGURE to "yes".
1.1 dsieger 3771:
1.184 rillig 3772: 13.12. The build phase
1.1 dsieger 3773:
1.187 rillig 3774: For building a package, a rough equivalent of the following code is executed;
3775: see mk/build/build.mk, target do-build for the exact definition.
1.154 rillig 3776:
1.187 rillig 3777: .for dir in ${BUILD_DIRS}
3778: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 3779: && env ${MAKE_ENV} \
1.187 rillig 3780: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 3781: -f ${MAKE_FILE} \
3782: ${BUILD_TARGET}
3783: .endfor
1.1 dsieger 3784:
1.184 rillig 3785: BUILD_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In each of
3786: these directories, MAKE_PROGRAM is run with the environment MAKE_ENV and
3787: arguments BUILD_MAKE_FLAGS. The variables MAKE_ENV, BUILD_MAKE_FLAGS, MAKE_FILE
3788: and BUILD_TARGET may all be changed by the package.
1.1 dsieger 3789:
1.184 rillig 3790: The default value of MAKE_PROGRAM is "gmake" if USE_TOOLS contains "gmake", "
3791: make" otherwise. The default value of MAKE_FILE is "Makefile", and BUILD_TARGET
3792: defaults to "all".
1.1 dsieger 3793:
1.184 rillig 3794: If there is no build step at all, set NO_BUILD to "yes".
1.1 dsieger 3795:
1.184 rillig 3796: 13.13. The test phase
1.1 dsieger 3797:
1.184 rillig 3798: [TODO]
1.1 dsieger 3799:
1.184 rillig 3800: 13.14. The install phase
1.1 dsieger 3801:
1.184 rillig 3802: Once the build stage has completed, the final step is to install the software
3803: in public directories, so users can access the programs and files.
1.1 dsieger 3804:
1.187 rillig 3805: In the install phase, a rough equivalent of the following code is executed; see
3806: mk/install/install.mk, target do-install for the exact definition.
3807: Additionally, before and after this code, several consistency checks are run
3808: against the files-to-be-installed, see mk/check/*.mk for details.
3809:
3810: .for dir in ${INSTALL_DIRS}
3811: cd ${WRKSRC} && cd ${dir} \
3812: && env ${INSTALL_ENV} ${MAKE_ENV} \
3813: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
3814: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 3815: .endfor
1.1 dsieger 3816:
1.184 rillig 3817: The variable's meanings are analogous to the ones in the build phase.
3818: INSTALL_DIRS defaults to BUILD_DIRS. INSTALL_TARGET is "install" by default,
3819: plus "install.man" if USE_IMAKE is defined and NO_INSTALL_MANPAGES is not
3820: defined.
1.1 dsieger 3821:
1.184 rillig 3822: In the install phase, the following variables are useful. They are all
3823: variations of the install(1) command that have the owner, group and permissions
3824: preset. INSTALL is the plain install command. The specialized variants,
3825: together with their intended use, are:
1.1 dsieger 3826:
1.184 rillig 3827: INSTALL_PROGRAM_DIR
1.1 dsieger 3828:
1.184 rillig 3829: directories that contain binaries
1.1 dsieger 3830:
1.184 rillig 3831: INSTALL_SCRIPT_DIR
1.1 dsieger 3832:
1.184 rillig 3833: directories that contain scripts
1.1 dsieger 3834:
1.184 rillig 3835: INSTALL_LIB_DIR
1.1 dsieger 3836:
1.184 rillig 3837: directories that contain shared and static libraries
1.1 dsieger 3838:
1.184 rillig 3839: INSTALL_DATA_DIR
1.108 rillig 3840:
1.184 rillig 3841: directories that contain data files
1.108 rillig 3842:
1.184 rillig 3843: INSTALL_MAN_DIR
1.108 rillig 3844:
1.184 rillig 3845: directories that contain man pages
1.108 rillig 3846:
1.184 rillig 3847: INSTALL_GAME_DIR
1.108 rillig 3848:
1.184 rillig 3849: directories that contain data files for games
1.108 rillig 3850:
1.184 rillig 3851: INSTALL_PROGRAM
1.108 rillig 3852:
1.184 rillig 3853: binaries that can be stripped from debugging symbols
1.108 rillig 3854:
1.184 rillig 3855: INSTALL_SCRIPT
1.108 rillig 3856:
1.184 rillig 3857: binaries that cannot be stripped
1.108 rillig 3858:
1.184 rillig 3859: INSTALL_GAME
1.108 rillig 3860:
1.184 rillig 3861: game binaries
1.108 rillig 3862:
1.184 rillig 3863: INSTALL_LIB
1.108 rillig 3864:
1.184 rillig 3865: shared and static libraries
1.108 rillig 3866:
1.184 rillig 3867: INSTALL_DATA
1.108 rillig 3868:
1.184 rillig 3869: data files
1.1 dsieger 3870:
1.184 rillig 3871: INSTALL_GAME_DATA
1.1 dsieger 3872:
1.184 rillig 3873: data files for games
1.108 rillig 3874:
1.184 rillig 3875: INSTALL_MAN
1.108 rillig 3876:
1.184 rillig 3877: man pages
1.1 dsieger 3878:
1.184 rillig 3879: Some other variables are:
1.1 dsieger 3880:
1.184 rillig 3881: INSTALL_UNSTRIPPED
1.1 dsieger 3882:
1.184 rillig 3883: If set to yes, do not run strip(1) when installing binaries. Any debugging
3884: sections and symbols present in binaries will be preserved.
1.1 dsieger 3885:
1.184 rillig 3886: INSTALLATION_DIRS
1.1 dsieger 3887:
1.184 rillig 3888: A list of directories relative to PREFIX that are created by pkgsrc at the
3889: beginning of the install phase. The package is supposed to create all
3890: needed directories itself before installing files to it and list all other
3891: directories here.
1.1 dsieger 3892:
1.184 rillig 3893: In the rare cases that a package shouldn't install anything, set NO_INSTALL to
3894: "yes". This is mostly relevant for packages in the regress category.
1.1 dsieger 3895:
1.184 rillig 3896: 13.15. The package phase
1.121 sevan 3897:
1.184 rillig 3898: Once the install stage has completed, a binary package of the installed files
3899: can be built. These binary packages can be used for quick installation without
3900: previous compilation, e.g. by the make bin-install or by using pkg_add.
1.1 dsieger 3901:
1.184 rillig 3902: By default, the binary packages are created in ${PACKAGES}/All and symlinks are
3903: created in ${PACKAGES}/category, one for each category in the CATEGORIES
3904: variable. PACKAGES defaults to pkgsrc/packages.
1.1 dsieger 3905:
1.184 rillig 3906: 13.16. Cleaning up
1.1 dsieger 3907:
1.184 rillig 3908: Once you're finished with a package, you can clean the work directory by
3909: running make clean. If you want to clean the work directories of all
3910: dependencies too, use make clean-depends.
1.1 dsieger 3911:
1.184 rillig 3912: 13.17. Other helpful targets
1.1 dsieger 3913:
1.184 rillig 3914: pre/post-*
1.1 dsieger 3915:
1.184 rillig 3916: For any of the main targets described in the previous section (configure,
3917: build, install, etc.), two auxiliary targets exist with "pre-" and "post-"
3918: used as a prefix for the main target's name. These targets are invoked
3919: before and after the main target is called, allowing extra configuration or
3920: installation steps be performed from a package's Makefile, for example,
3921: which a program's configure script or install target omitted.
3922:
3923: About 5% of the pkgsrc packages define their custom post-extract target,
3924: another 5% define pre-configure, and 10% define post-install. The other pre
3925: /post-* targets are defined even less often.
1.1 dsieger 3926:
1.184 rillig 3927: do-*
1.182 leot 3928:
1.184 rillig 3929: Should one of the main targets do the wrong thing, and should there be no
3930: variable to fix this, you can redefine it with the do-* target. (Note that
3931: redefining the target itself instead of the do-* target is a bad idea, as
3932: the pre-* and post-* targets won't be called anymore, etc.)
1.1 dsieger 3933:
1.184 rillig 3934: About 15% of the pkgsrc packages override the default do-install, the other
3935: do-* targets are overridden even less often.
1.1 dsieger 3936:
1.184 rillig 3937: reinstall
1.1 dsieger 3938:
1.184 rillig 3939: If you did a make install and you noticed some file was not installed
3940: properly, you can repeat the installation with this target, which will
3941: ignore the "already installed" flag.
1.1 dsieger 3942:
1.184 rillig 3943: This is the default value of DEPENDS_TARGET except in the case of make
3944: update and make package, where the defaults are "package" and "update",
3945: respectively.
1.1 dsieger 3946:
1.184 rillig 3947: deinstall
1.1 dsieger 3948:
1.184 rillig 3949: This target does a pkg_delete(1) in the current directory, effectively
3950: de-installing the package. The following variables can be used to tune the
3951: behaviour:
1.1 dsieger 3952:
1.184 rillig 3953: PKG_VERBOSE
1.1 dsieger 3954:
1.184 rillig 3955: Add a "-v" to the pkg_delete(1) command.
1.1 dsieger 3956:
1.184 rillig 3957: DEINSTALLDEPENDS
1.1 dsieger 3958:
1.184 rillig 3959: Remove all packages that require (depend on) the given package. This
3960: can be used to remove any packages that may have been pulled in by a
3961: given package, e.g. if make deinstall DEINSTALLDEPENDS=1 is done in
3962: pkgsrc/x11/kde, this is likely to remove whole KDE. Works by adding "-R
3963: " to the pkg_delete(1) command line.
1.1 dsieger 3964:
1.184 rillig 3965: bin-install
1.1 dsieger 3966:
1.184 rillig 3967: Install a binary package from local disk and via FTP from a list of sites
3968: (see the BINPKG_SITES variable), and do a make package if no binary package
3969: is available anywhere. The arguments given to pkg_add can be set via
3970: BIN_INSTALL_FLAGS e.g., to do verbose operation, etc.
1.1 dsieger 3971:
1.184 rillig 3972: install-clean
1.1 dsieger 3973:
1.184 rillig 3974: This target removes the state files for the "install" and later phases so
3975: that the "install" target may be re-invoked. This can be used after editing
3976: the PLIST to install the package without rebuilding it.
1.1 dsieger 3977:
1.184 rillig 3978: build-clean
1.18 mishka 3979:
1.184 rillig 3980: This target removes the state files for the "build" and later phases so
3981: that the "build" target may be re-invoked.
1.18 mishka 3982:
1.184 rillig 3983: update
1.18 mishka 3984:
1.184 rillig 3985: This target causes the current package to be updated to the latest version.
3986: The package and all depending packages first get de-installed, then current
3987: versions of the corresponding packages get compiled and installed. This is
3988: similar to manually noting which packages are currently installed, then
3989: performing a series of make deinstall and make install (or whatever
3990: UPDATE_TARGET is set to) for these packages.
1.18 mishka 3991:
1.184 rillig 3992: You can use the "update" target to resume package updating in case a
3993: previous make update was interrupted for some reason. However, in this
3994: case, make sure you don't call make clean or otherwise remove the list of
3995: dependent packages in WRKDIR. Otherwise, you lose the ability to
3996: automatically update the current package along with the dependent packages
3997: you have installed.
1.121 sevan 3998:
1.184 rillig 3999: Resuming an interrupted make update will only work as long as the package
4000: tree remains unchanged. If the source code for one of the packages to be
4001: updated has been changed, resuming make update will most certainly fail!
1.1 dsieger 4002:
1.184 rillig 4003: The following variables can be used either on the command line or in
4004: mk.conf to alter the behaviour of make update:
1.1 dsieger 4005:
1.184 rillig 4006: UPDATE_TARGET
1.1 dsieger 4007:
1.184 rillig 4008: Install target to recursively use for the updated package and the
4009: dependent packages. Defaults to DEPENDS_TARGET if set, "install"
4010: otherwise for make update. Other good targets are "package" or "
4011: bin-install". Do not set this to "update" or you will get stuck in an
4012: endless loop!
1.1 dsieger 4013:
1.184 rillig 4014: NOCLEAN
1.1 dsieger 4015:
1.184 rillig 4016: Don't clean up after updating. Useful if you want to leave the work
4017: sources of the updated packages around for inspection or other
4018: purposes. Be sure you eventually clean up the source tree (see the "
4019: clean-update" target below) or you may run into troubles with old
4020: source code still lying around on your next make or make update.
1.1 dsieger 4021:
1.184 rillig 4022: REINSTALL
1.1 dsieger 4023:
1.184 rillig 4024: Deinstall each package before installing (making DEPENDS_TARGET). This
4025: may be necessary if the "clean-update" target (see below) was called
4026: after interrupting a running make update.
1.1 dsieger 4027:
1.184 rillig 4028: DEPENDS_TARGET
1.1 dsieger 4029:
1.184 rillig 4030: Allows you to disable recursion and hardcode the target for packages.
4031: The default is "update" for the update target, facilitating a recursive
4032: update of prerequisite packages. Only set DEPENDS_TARGET if you want to
4033: disable recursive updates. Use UPDATE_TARGET instead to just set a
4034: specific target for each package to be installed during make update
4035: (see above).
1.1 dsieger 4036:
1.184 rillig 4037: clean-update
1.1 dsieger 4038:
1.184 rillig 4039: Clean the source tree for all packages that would get updated if make
4040: update was called from the current directory. This target should not be
4041: used if the current package (or any of its depending packages) have already
4042: been de-installed (e.g., after calling make update) or you may lose some
4043: packages you intended to update. As a rule of thumb: only use this target
4044: before the first time you run make update and only if you have a dirty
4045: package tree (e.g., if you used NOCLEAN).
1.86 wiz 4046:
1.184 rillig 4047: If you are unsure about whether your tree is clean, you can either perform
4048: a make clean at the top of the tree, or use the following sequence of
4049: commands from the directory of the package you want to update (before
4050: running make update for the first time, otherwise you lose all the packages
4051: you wanted to update!):
1.86 wiz 4052:
1.184 rillig 4053: # make clean-update
4054: # make clean CLEANDEPENDS=YES
4055: # make update
1.86 wiz 4056:
4057:
1.184 rillig 4058: The following variables can be used either on the command line or in
4059: mk.conf to alter the behaviour of make clean-update:
1.86 wiz 4060:
1.184 rillig 4061: CLEAR_DIRLIST
1.86 wiz 4062:
1.184 rillig 4063: After make clean, do not reconstruct the list of directories to update
4064: for this package. Only use this if make update successfully installed
4065: all packages you wanted to update. Normally, this is done automatically
4066: on make update, but may have been suppressed by the NOCLEAN variable
4067: (see above).
1.1 dsieger 4068:
1.184 rillig 4069: replace
1.1 dsieger 4070:
1.184 rillig 4071: Update the installation of the current package. This differs from update in
4072: that it does not replace dependent packages. You will need to install
4073: pkgtools/pkg_tarup for this target to work.
1.1 dsieger 4074:
1.184 rillig 4075: Be careful when using this target! There are no guarantees that dependent
4076: packages will still work, in particular they will most certainly break if
4077: you make replace a library package whose shared library major version
4078: changed between your installed version and the new one. For this reason,
4079: this target is not officially supported and only recommended for advanced
4080: users.
1.1 dsieger 4081:
1.184 rillig 4082: info
1.1 dsieger 4083:
1.184 rillig 4084: This target invokes pkg_info(1) for the current package. You can use this
4085: to check which version of a package is installed.
1.86 wiz 4086:
1.184 rillig 4087: index
1.1 dsieger 4088:
1.184 rillig 4089: This is a top-level command, i.e. it should be used in the pkgsrc
4090: directory. It creates a database of all packages in the local pkgsrc tree,
4091: including dependencies, comment, maintainer, and some other useful
4092: information. Individual entries are created by running make describe in the
4093: packages' directories. This index file is saved as pkgsrc/INDEX. It can be
4094: displayed in verbose format by running make print-index. You can search in
4095: it with make search key=something. You can extract a list of all packages
4096: that depend on a particular one by running make show-deps PKG=somepackage.
1.1 dsieger 4097:
1.184 rillig 4098: Running this command takes a very long time, some hours even on fast
4099: machines!
1.1 dsieger 4100:
1.184 rillig 4101: readme
1.1 dsieger 4102:
1.199 nia 4103: This target generates a index.html file, which can be viewed using a
1.184 rillig 4104: browser such as www/firefox or www/links. The generated files contain
4105: references to any packages which are in the PACKAGES directory on the local
4106: host. The generated files can be made to refer to URLs based on
4107: FTP_PKG_URL_HOST and FTP_PKG_URL_DIR. For example, if I wanted to generate
1.199 nia 4108: index.html files which pointed to binary packages on the local machine, in
1.184 rillig 4109: the directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
4110: FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
4111: subdirectories will be searched for all the binary packages.
1.1 dsieger 4112:
1.184 rillig 4113: The target can be run at the toplevel or in category directories, in which
4114: case it descends recursively.
1.1 dsieger 4115:
1.184 rillig 4116: readme-all
1.1 dsieger 4117:
1.184 rillig 4118: This is a top-level command, run it in pkgsrc. Use this target to create a
4119: file README-all.html which contains a list of all packages currently
4120: available in the NetBSD Packages Collection, together with the category
4121: they belong to and a short description. This file is compiled from the
1.199 nia 4122: pkgsrc/*/index.html files, so be sure to run this after a make readme.
1.1 dsieger 4123:
1.184 rillig 4124: cdrom-readme
1.1 dsieger 4125:
1.184 rillig 4126: This is very much the same as the "readme" target (see above), but is to be
4127: used when generating a pkgsrc tree to be written to a CD-ROM. This target
1.199 nia 4128: also produces index.html files, and can be made to refer to URLs based on
1.184 rillig 4129: CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
1.1 dsieger 4130:
1.184 rillig 4131: show-distfiles
1.1 dsieger 4132:
1.184 rillig 4133: This target shows which distfiles and patchfiles are needed to build the
4134: package (ALLFILES, which contains all DISTFILES and PATCHFILES, but not
4135: patches/*).
1.1 dsieger 4136:
1.184 rillig 4137: show-downlevel
1.1 dsieger 4138:
1.184 rillig 4139: This target shows nothing if the package is not installed. If a version of
4140: this package is installed, but is not the version provided in this version
4141: of pkgsrc, then a warning message is displayed. This target can be used to
4142: show which of your installed packages are downlevel, and so the old
4143: versions can be deleted, and the current ones added.
1.1 dsieger 4144:
1.184 rillig 4145: show-pkgsrc-dir
1.1 dsieger 4146:
1.184 rillig 4147: This target shows the directory in the pkgsrc hierarchy from which the
4148: package can be built and installed. This may not be the same directory as
4149: the one from which the package was installed. This target is intended to be
4150: used by people who may wish to upgrade many packages on a single host, and
4151: can be invoked from the top-level pkgsrc Makefile by using the "
4152: show-host-specific-pkgs" target.
1.1 dsieger 4153:
1.184 rillig 4154: show-installed-depends
1.1 dsieger 4155:
1.184 rillig 4156: This target shows which installed packages match the current package's
4157: DEPENDS. Useful if out of date dependencies are causing build problems.
1.1 dsieger 4158:
1.184 rillig 4159: print-build-depends-list
1.1 dsieger 4160:
1.184 rillig 4161: This target shows the list of packages that the current package depends on
4162: for building.
1.1 dsieger 4163:
1.184 rillig 4164: print-run-depends-list
1.1 dsieger 4165:
1.184 rillig 4166: This target shows the list of packages that the current package depends on
4167: for running.
1.1 dsieger 4168:
1.184 rillig 4169: check-shlibs
1.1 dsieger 4170:
1.184 rillig 4171: After a package is installed, check all its binaries and (on ELF platforms)
4172: shared libraries to see if they find the shared libs they need. Run by
4173: default if PKG_DEVELOPER is set in mk.conf.
1.1 dsieger 4174:
1.184 rillig 4175: print-PLIST
1.1 dsieger 4176:
1.184 rillig 4177: After a "make install" from a new or upgraded pkg, this prints out an
4178: attempt to generate a new PLIST from a find -newer work/.extract_done. An
4179: attempt is made to care for shared libs etc., but it is strongly
4180: recommended to review the result before putting it into PLIST. On upgrades,
4181: it's useful to diff the output of this command against an already existing
4182: PLIST file.
1.1 dsieger 4183:
1.184 rillig 4184: If the package installs files via tar(1) or other methods that don't update
4185: file access times, be sure to add these files manually to your PLIST, as
4186: the "find -newer" command used by this target won't catch them!
1.56 ryoon 4187:
1.184 rillig 4188: See Section 19.3, "Tweaking output of make print-PLIST" for more
4189: information on this target.
1.1 dsieger 4190:
1.184 rillig 4191: Chapter 14. Creating a new pkgsrc package from scratch
1.1 dsieger 4192:
1.184 rillig 4193: Table of Contents
1.1 dsieger 4194:
1.184 rillig 4195: 14.1. Common types of packages
1.1 dsieger 4196:
1.184 rillig 4197: 14.1.1. Perl modules
4198: 14.1.2. Python modules and programs
4199: 14.1.3. R packages
4200: 14.1.4. TeXlive packages
1.1 dsieger 4201:
1.184 rillig 4202: 14.2. Examples
1.1 dsieger 4203:
1.184 rillig 4204: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 4205:
1.184 rillig 4206: When you find a package that is not yet in pkgsrc, you most likely have a URL
4207: from where you can download the source code. Starting with this URL, creating a
4208: package involves only a few steps.
1.1 dsieger 4209:
1.184 rillig 4210: 1. In your mk.conf, set PKG_DEVELOPER=yes to enable the basic quality checks.
1.1 dsieger 4211:
1.184 rillig 4212: 2. Install the package meta-pkgs/pkg_developer, which among others will
4213: install the utilities url2pkg, pkglint, pkgvi and mkpatches:
1.1 dsieger 4214:
1.184 rillig 4215: $ cd /usr/pkgsrc
4216: $ (cd meta-pkgs/pkg_developer && bmake update)
1.1 dsieger 4217:
1.184 rillig 4218: 3. Choose one of the top-level directories as the category in which you want
4219: to place your package. You can also create a directory of your own (maybe
4220: called local). In that category directory, create another directory for
4221: your package and change into it:
1.1 dsieger 4222:
1.184 rillig 4223: $ mkdir category/package
4224: $ cd category/package
1.1 dsieger 4225:
1.184 rillig 4226: 4. Run the program url2pkg, which will ask you for a URL. Enter the URL of the
4227: distribution file (in most cases a .tar.gz file) and watch how the basic
4228: ingredients of your package are created automatically. The distribution
4229: file is extracted automatically to fill in some details in the Makefile
4230: that would otherwise have to be done manually:
1.1 dsieger 4231:
1.184 rillig 4232: $ url2pkg https://www.example.org/packages/package-1.0.tar.gz
1.1 dsieger 4233:
1.184 rillig 4234: 5. Examine the extracted files to determine the dependencies of your package.
4235: Ideally, this is mentioned in some README file, but things may differ. For
4236: each of these dependencies, look where it exists in pkgsrc, and if there is
4237: a file called buildlink3.mk in that directory, add a line to your package
4238: Makefile which includes that file just before the last line. If the
4239: buildlink3.mk file does not exist, it must be created first. The
4240: buildlink3.mk file makes sure that the package's include files and
4241: libraries are provided.
1.1 dsieger 4242:
1.184 rillig 4243: If you just need binaries from a package, add a DEPENDS line to the
4244: Makefile, which specifies the version of the dependency and where it can be
4245: found in pkgsrc. This line should be placed in the third paragraph. If the
4246: dependency is only needed for building the package, but not when using it,
4247: use TOOL_DEPENDS or BUILD_DEPENDS instead of DEPENDS. The difference
4248: between TOOL_DEPENDS and BUILD_DEPENDS occurs when cross-compiling:
4249: TOOL_DEPENDS are native packages, i.e. packages for the architecture where
4250: the package is built; BUILD_DEPENDS are target packages, i.e. packages for
4251: the architecture for which the package is built. There is also
4252: TEST_DEPENDS, which is used to specify a dependency used only for testing
4253: the resulting package built, using the upstream project's included test
4254: suite. Your package may then look like this:
1.1 dsieger 4255:
1.184 rillig 4256: [...]
1.1 dsieger 4257:
1.184 rillig 4258: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
4259: DEPENDS+= screen-[0-9]*:../../misc/screen
4260: DEPENDS+= screen>=4.0:../../misc/screen
1.1 dsieger 4261:
1.184 rillig 4262: [...]
1.1 dsieger 4263:
1.184 rillig 4264: .include "../../category/package/buildlink3.mk"
4265: .include "../../devel/glib2/buildlink3.mk"
4266: .include "../../mk/bsd.pkg.mk"
1.1 dsieger 4267:
1.184 rillig 4268: 6. Run pkglint to see what things still need to be done to make your package a
4269: "good" one. If you don't know what pkglint's warnings want to tell you, try
4270: pkglint --explain or pkglint -e, which outputs additional explanations.
1.1 dsieger 4271:
1.184 rillig 4272: 7. In many cases the package is not yet ready to build. You can find
4273: instructions for the most common cases in the next section, Section 14.1,
4274: "Common types of packages". After you have followed the instructions over
4275: there, you can hopefully continue here.
1.1 dsieger 4276:
1.184 rillig 4277: 8. Run bmake clean to clean the working directory from the extracted files.
4278: Besides these files, a lot of cache files and other system information has
4279: been saved in the working directory, which may become wrong after you
4280: edited the Makefile.
1.1 dsieger 4281:
1.184 rillig 4282: 9. Now, run bmake to build the package. For the various things that can go
4283: wrong in this phase, consult Chapter 21, Making your package work.
1.1 dsieger 4284:
1.184 rillig 4285: If the extracted files from the package need to be fixed, run multiple
4286: rounds of these commands:
1.1 dsieger 4287:
1.184 rillig 4288: $ make
4289: $ pkgvi ${WRKSRC}/some/file/that/does/not/compile
4290: $ mkpatches
4291: $ make mps
4292: $ make clean
1.1 dsieger 4293:
1.184 rillig 4294: 10. When the package builds fine, the next step is to install the package. Run
4295: bmake install and hope that everything works.
1.1 dsieger 4296:
1.184 rillig 4297: 11. Up to now, the file PLIST, which contains a list of the files that are
4298: installed by the package, is nearly empty. Run bmake print-PLIST >PLIST to
4299: generate a probably correct list. Check the file using your preferred text
4300: editor to see if the list of files looks plausible.
1.1 dsieger 4301:
1.184 rillig 4302: 12. Run pkglint again to see if the generated PLIST contains garbage or not.
1.1 dsieger 4303:
1.184 rillig 4304: 13. When you ran bmake install, the package had been registered in the database
4305: of installed files, but with an empty list of files. To fix this, run bmake
4306: deinstall and bmake install again. Now the package is registered with the
4307: list of files from PLIST.
1.48 wiz 4308:
1.184 rillig 4309: 14. Run bmake package to create a binary package from the set of installed
4310: files.
1.48 wiz 4311:
1.184 rillig 4312: 15. Run bmake clean update to run everything from above again in a single step,
4313: making sure that the PLIST is correct and the whole package is created as
4314: intended.
1.48 wiz 4315:
1.184 rillig 4316: 16. Run pkglint to see if there's anything left to do.
1.48 wiz 4317:
1.184 rillig 4318: 17. Commit the package to pkgsrc-wip or main pkgsrc; see Chapter 23, Submitting
4319: and Committing.
1.50 wiz 4320:
1.184 rillig 4321: 14.1. Common types of packages
1.1 dsieger 4322:
1.184 rillig 4323: 14.1.1. Perl modules
1.1 dsieger 4324:
1.184 rillig 4325: Simple Perl modules are handled automatically by url2pkg, including
4326: dependencies.
1.1 dsieger 4327:
1.184 rillig 4328: 14.1.2. Python modules and programs
1.1 dsieger 4329:
1.184 rillig 4330: Python modules and programs packages are easily created using a set of
4331: predefined variables.
1.1 dsieger 4332:
1.184 rillig 4333: If some Python versions are not supported by the software, set the
4334: PYTHON_VERSIONS_INCOMPATIBLE variable to the Python versions that are not
4335: supported, e.g.
1.1 dsieger 4336:
1.184 rillig 4337: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.1 dsieger 4338:
1.184 rillig 4339: If the packaged software is a Python module, include one of ../../lang/python/
4340: egg.mk, ../../lang/python/distutils.mk, or ../../lang/python/extension.mk.
1.1 dsieger 4341:
1.184 rillig 4342: Most Python packages use either "distutils" or easy-setup/setuptools ("eggs").
4343: If the packaged software is using setuptools, you only need to include "../../
4344: lang/python/egg.mk". Otherwise, if the software uses "distutils", include "..
4345: /../lang/python/distutils.mk", so pkgsrc will use this framework. "distutils"
4346: uses a script called setup.py; if the "distutils" driver is not called
4347: setup.py, set the PYSETUP variable to the name of the script.
1.1 dsieger 4348:
1.184 rillig 4349: Either way, the package directory should be called "py-software" and PKGNAME
4350: should be set to "${PYPKGPREFIX}-${DISTNAME}", e.g.
1.1 dsieger 4351:
1.184 rillig 4352: DISTNAME= foopymodule-1.2.10
4353: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
1.1 dsieger 4354:
1.184 rillig 4355: If it is an application, include "../../lang/python/application.mk". In order
4356: to correctly set the path to the Python interpreter, use the REPLACE_PYTHON
4357: variable and set it to the list of files (paths relative to WRKSRC) that must
4358: be corrected. For example:
1.1 dsieger 4359:
1.184 rillig 4360: REPLACE_PYTHON= *.py
1.1 dsieger 4361:
1.184 rillig 4362: Some Python modules have separate distributions for Python-2.x and Python-3.x
4363: support. In pkgsrc this is handled by the versioned_dependencies.mk file. Set
4364: PYTHON_VERSIONED_DEPENDENCIES to the list of packages that should be depended
4365: upon and include "../../lang/python/versioned_dependencies.mk", then the pkgsrc
4366: infrastructure will depend on the appropriate package version. For example:
1.1 dsieger 4367:
1.184 rillig 4368: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.1 dsieger 4369:
1.184 rillig 4370: Look inside versioned_dependencies.mk for a list of supported packages.
1.1 dsieger 4371:
1.184 rillig 4372: 14.1.3. R packages
1.1 dsieger 4373:
1.184 rillig 4374: Simple R packages from CRAN are handled automatically by R2pkg, which is
4375: available in pkgtools/R2pkg. Individual packages (and optionally their
4376: dependencies) may be created and updated. R packages generally follow the same
4377: form, and most of the relevant information needed is contained in a DESCRIPTION
4378: file as part of each R package on CRAN. Consequently, R2pkg downloads that
4379: information and creates or updates a package in the canonical form. The
4380: resulting package should be reviewed for correctness.
1.1 dsieger 4381:
1.184 rillig 4382: 14.1.4. TeXlive packages
1.1 dsieger 4383:
1.184 rillig 4384: TeXlive packages from CTAN are handled automatically by texlive2pkg, which is
4385: available in pkgtools/texlive2pkg.
1.1 dsieger 4386:
1.184 rillig 4387: If the TeXlive package name is not known, it may be useful to search CTAN. A "
4388: Contained in" field on the package page typically identifies the basename of
4389: the package file in the TeXlive archive.
1.1 dsieger 4390:
1.184 rillig 4391: If the TeXlive package name is known, download the files from the TeXlive
4392: archive. For package foo, you will need to download foo.tar.xz. Most TeXlive
4393: packages also have associated documentation packages, so download
4394: foo.doc.tar.xz at the same time. These files should be placed in the
4395: appropriate category directory, which is often but not always print. Then run
4396: the following command in the category directory.
1.1 dsieger 4397:
1.184 rillig 4398: texlive2pkg foo.tar.xz foo.doc.tar.xz
1.1 dsieger 4399:
1.184 rillig 4400: This will create two packages, tex-foo and tex-foo-doc. Be sure to check that
4401: both packages are correct.
1.1 dsieger 4402:
1.184 rillig 4403: Finally, CTAN currently does not include version information in package
4404: filenames and changes their contents periodically when updates occur.
4405: Consequently, pkgsrc avoids downloading distfiles directly from CTAN and
4406: instead relies on the pkgsrc archives. For each new or updated TeXlive package,
4407: e.g., the main one and the corresponding documentation, upload the distfiles
4408: with the following command in each package directory.
1.1 dsieger 4409:
1.184 rillig 4410: make upload-distfiles
1.117 sevan 4411:
1.184 rillig 4412: 14.2. Examples
1.117 sevan 4413:
1.184 rillig 4414: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 4415:
1.184 rillig 4416: 14.2.1.1. The initial package
1.1 dsieger 4417:
1.184 rillig 4418: Looking at the file pkgsrc/doc/TODO, I saw that the "nvu" package has not yet
4419: been imported into pkgsrc. As the description says it has to do with the web,
4420: the obvious choice for the category is "www".
1.1 dsieger 4421:
1.184 rillig 4422: $ mkdir www/nvu
4423: $ cd www/nvu
1.1 dsieger 4424:
1.184 rillig 4425: The web site says that the sources are available as a tar file, so I fed that
4426: URL to the url2pkg program:
1.1 dsieger 4427:
1.184 rillig 4428: $ url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.1 dsieger 4429:
1.184 rillig 4430: My editor popped up, and I added a PKGNAME line below the DISTNAME line, as the
4431: package name should not have the word "sources" in it. I also filled in the
4432: MAINTAINER, HOMEPAGE and COMMENT fields. Then the package Makefile looked like
4433: that:
1.1 dsieger 4434:
1.184 rillig 4435: # $NetBSD $
4436: #
1.1 dsieger 4437:
1.184 rillig 4438: DISTNAME= nvu-1.0-sources
4439: PKGNAME= nvu-1.0
4440: CATEGORIES= www
4441: MASTER_SITES= http://cvs.nvu.com/download/
4442: EXTRACT_SUFX= .tar.bz2
1.1 dsieger 4443:
1.184 rillig 4444: MAINTAINER= rillig@NetBSD.org
4445: HOMEPAGE= http://cvs.nvu.com/
4446: COMMENT= Web Authoring System
1.1 dsieger 4447:
1.184 rillig 4448: # url2pkg-marker (please do not remove this line.)
4449: .include "../../mk/bsd.pkg.mk"
1.1 dsieger 4450:
1.184 rillig 4451: On the first line of output above, an artificial space has been added between
4452: NetBSD and $, this is a workaround to prevent CVS expanding to the filename of
4453: the guide.
1.1 dsieger 4454:
1.184 rillig 4455: Then, I quit the editor and watched pkgsrc downloading a large source archive:
1.1 dsieger 4456:
1.184 rillig 4457: url2pkg> Running "make makesum" ...
4458: => Required installed package digest>=20010302: digest-20060826 found
4459: => Fetching nvu-1.0-sources.tar.bz2
4460: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4461: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4462: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4463: url2pkg> Running "make extract" ...
4464: => Required installed package digest>=20010302: digest-20060826 found
4465: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4466: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4467: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4468: ===> Installing dependencies for nvu-1.0
4469: ===> Overriding tools for nvu-1.0
4470: ===> Extracting for nvu-1.0
4471: url2pkg> Adjusting the Makefile.
1.1 dsieger 4472:
1.184 rillig 4473: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.1 dsieger 4474:
1.184 rillig 4475: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.1 dsieger 4476:
1.184 rillig 4477: 14.2.1.2. Fixing all kinds of problems to make the package work
1.1 dsieger 4478:
1.184 rillig 4479: Now that the package has been extracted, let's see what's inside it. The
4480: package has a README.txt, but that only says something about mozilla, so it's
4481: probably useless for seeing what dependencies this package has. But since there
4482: is a GNU configure script in the package, let's hope that it will complain
4483: about everything it needs.
1.1 dsieger 4484:
1.184 rillig 4485: $ bmake
4486: => Required installed package digest>=20010302: digest-20060826 found
4487: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4488: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4489: ===> Patching for nvu-1.0
4490: ===> Creating toolchain wrappers for nvu-1.0
4491: ===> Configuring for nvu-1.0
4492: [...]
4493: configure: error: Perl 5.004 or higher is required.
4494: [...]
4495: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4496: [...]
1.1 dsieger 4497:
1.184 rillig 4498: That worked quite well. So I opened the package Makefile in my editor, and
4499: since it already has a USE_TOOLS line, I just appended "perl" to it. Since the
4500: dependencies of the package have changed now, and since a perl wrapper is
4501: automatically installed in the "tools" phase, I need to build the package from
4502: scratch.
1.1 dsieger 4503:
1.184 rillig 4504: $ bmake clean
4505: ===> Cleaning for nvu-1.0
4506: $ bmake
4507: [...]
4508: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4509: GNU Make. You will not be able to build Mozilla without GNU Make.
4510: [...]
1.1 dsieger 4511:
1.184 rillig 4512: So I added "gmake" to the USE_TOOLS line and tried again (from scratch).
1.1 dsieger 4513:
1.184 rillig 4514: [...]
4515: checking for GTK - version >= 1.2.0... no
4516: *** Could not run GTK test program, checking why...
4517: [...]
1.1 dsieger 4518:
1.184 rillig 4519: Now to the other dependencies. The first question is: Where is the GTK package
4520: hidden in pkgsrc?
1.1 dsieger 4521:
1.184 rillig 4522: $ echo ../../*/gtk*
4523: [many packages ...]
4524: $ echo ../../*/gtk
4525: ../../x11/gtk
4526: $ echo ../../*/gtk2
4527: ../../x11/gtk2
4528: $ echo ../../*/gtk2/bui*
4529: ../../x11/gtk2/buildlink3.mk
1.1 dsieger 4530:
1.184 rillig 4531: The first try was definitely too broad. The second one had exactly one result,
4532: which is very good. But there is one pitfall with GNOME packages. Before GNOME
4533: 2 had been released, there were already many GNOME 1 packages in pkgsrc. To be
4534: able to continue to use these packages, the GNOME 2 packages were imported as
4535: separate packages, and their names usually have a "2" appended. So I checked
4536: whether this was the case here, and indeed it was.
1.1 dsieger 4537:
1.184 rillig 4538: Since the GTK2 package has a buildlink3.mk file, adding the dependency is very
4539: easy. I just inserted an .include line before the last line of the package
4540: Makefile, so that it now looks like this:
1.1 dsieger 4541:
1.184 rillig 4542: [...]
4543: .include "../../x11/gtk2/buildlink3.mk"
4544: .include "../../mk/bsd.pkg.mk
1.1 dsieger 4545:
1.184 rillig 4546: After another bmake clean && bmake, the answer was:
1.108 rillig 4547:
1.184 rillig 4548: [...]
4549: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4550: checking for GTK - version >= 1.2.0... no
4551: *** Could not run GTK test program, checking why...
4552: *** The test program failed to compile or link. See the file config.log for the
4553: *** exact error that occured. This usually means GTK was incorrectly installed
4554: *** or that you have moved GTK since it was installed. In the latter case, you
4555: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4556: configure: error: Test for GTK failed.
4557: [...]
1.1 dsieger 4558:
1.184 rillig 4559: In this particular case, the assumption that "every package prefers GNOME 2"
4560: had been wrong. The first of the lines above told me that this package really
4561: wanted to have the GNOME 1 version of GTK. If the package had looked for GTK2,
4562: it would have looked for pkg-config instead of gtk-config. So I changed the x11
4563: /gtk2 to x11/gtk in the package Makefile, and tried again.
1.1 dsieger 4564:
1.184 rillig 4565: [...]
4566: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
4567: In file included from xpidl.c:42:
4568: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4569: In file included from xpidl.c:42:
4570: xpidl.h:132: error: parse error before "IDL_ns"
4571: [...]
1.1 dsieger 4572:
1.184 rillig 4573: The package still does not find all of its dependencies. Now the question is:
4574: Which package provides the libIDL/IDL.h header file?
1.1 dsieger 4575:
1.184 rillig 4576: $ echo ../../*/*idl*
4577: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4578: $ echo ../../*/*IDL*
4579: ../../net/libIDL
1.1 dsieger 4580:
1.184 rillig 4581: Let's take the one from the second try. So I included the ../../net/libIDL/
4582: buildlink3.mk file and tried again. But the error didn't change. After digging
4583: through some of the code, I concluded that the build process of the package was
4584: broken and couldn't have ever worked, but since the Mozilla source tree is
4585: quite large, I didn't want to fix it. So I added the following to the package
4586: Makefile and tried again:
1.1 dsieger 4587:
1.184 rillig 4588: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4589: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.1 dsieger 4590:
1.184 rillig 4591: The latter line is needed because the package expects the library libIDL.so,
4592: but only libIDL-2.so is available. So I told the compiler wrapper to rewrite
4593: that on the fly.
1.1 dsieger 4594:
1.184 rillig 4595: The next problem was related to a recent change of the FreeType interface. I
4596: looked up in www/seamonkey which patch files were relevant for this issue and
4597: copied them to the patches directory. Then I retried, fixed the patches so that
4598: they applied cleanly and retried again. This time, everything worked.
1.1 dsieger 4599:
1.184 rillig 4600: 14.2.1.3. Installing the package
1.1 dsieger 4601:
1.184 rillig 4602: $ bmake CHECK_FILES=no install
4603: [...]
4604: $ bmake print-PLIST >PLIST
4605: $ bmake deinstall
4606: $ bmake install
1.1 dsieger 4607:
1.184 rillig 4608: Chapter 15. Programming in Makefiles
1.1 dsieger 4609:
1.184 rillig 4610: Table of Contents
1.1 dsieger 4611:
1.184 rillig 4612: 15.1. Caveats
4613: 15.2. Makefile variables
1.1 dsieger 4614:
1.184 rillig 4615: 15.2.1. Naming conventions
1.1 dsieger 4616:
1.184 rillig 4617: 15.3. Code snippets
1.1 dsieger 4618:
1.184 rillig 4619: 15.3.1. Adding things to a list
4620: 15.3.2. Echoing a string exactly as-is
4621: 15.3.3. Passing CFLAGS to GNU configure scripts
4622: 15.3.4. Handling possibly empty variables
1.1 dsieger 4623:
1.184 rillig 4624: Pkgsrc consists of many Makefile fragments, each of which forms a well-defined
4625: part of the pkgsrc system. Using the make(1) system as a programming language
4626: for a big system like pkgsrc requires some discipline to keep the code correct
4627: and understandable.
1.1 dsieger 4628:
1.184 rillig 4629: The basic ingredients for Makefile programming are variables and shell
4630: commands. Among these shell commands may even be more complex ones like awk(1)
4631: programs. To make sure that every shell command runs as intended it is
4632: necessary to quote all variables correctly when they are used.
1.1 dsieger 4633:
1.184 rillig 4634: This chapter describes some patterns that appear quite often in Makefiles,
4635: including the pitfalls that come along with them.
1.1 dsieger 4636:
1.184 rillig 4637: 15.1. Caveats
1.1 dsieger 4638:
1.184 rillig 4639: * When you are creating a file as a target of a rule, always write the data
4640: to a temporary file first and finally rename that file. Otherwise there
4641: might occur an error in the middle of generating the file, and when the
4642: user runs make(1) for the second time, the file exists and will not be
4643: regenerated properly. Example:
1.1 dsieger 4644:
1.184 rillig 4645: wrong:
4646: @echo "line 1" > ${.TARGET}
4647: @echo "line 2" >> ${.TARGET}
4648: @false
1.1 dsieger 4649:
1.184 rillig 4650: correct:
4651: @echo "line 1" > ${.TARGET}.tmp
4652: @echo "line 2" >> ${.TARGET}.tmp
4653: @false
4654: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 4655:
1.184 rillig 4656: When you run make wrong twice, the file wrong will exist, although there
4657: was an error message in the first run. On the other hand, running make
4658: correct gives an error message twice, as expected.
1.1 dsieger 4659:
1.184 rillig 4660: You might remember that make(1) sometimes removes ${.TARGET} in case of
4661: error, but this only happens when it is interrupted, for example by
4662: pressing Ctrl+C. This does not happen when one of the commands fails (like
4663: false(1) above).
1.1 dsieger 4664:
1.184 rillig 4665: 15.2. Makefile variables
1.1 dsieger 4666:
1.184 rillig 4667: Makefile variables contain strings that can be processed using the five
4668: operators =, +=, ?=, := and !=, which are described in the make(1) man page.
1.1 dsieger 4669:
1.184 rillig 4670: When a variable's value is parsed from a Makefile, the hash character # and the
4671: backslash character \ are handled specially. If a backslash is the last
4672: character in a line, that backslash is removed from the line and the line
4673: continues with the next line of the file.
1.1 dsieger 4674:
1.184 rillig 4675: The # character starts a comment that reaches until the end of the line. To get
4676: an actual # character, such as in a URL, write \# instead.
1.1 dsieger 4677:
1.184 rillig 4678: The evaluation of variables either happens immediately or lazy. It happens
4679: immediately when the variable occurs on the right-hand side of the := or the !=
4680: operator, in a .if condition or a .for loop. In the other cases, it is
4681: evaluated lazily.
1.1 dsieger 4682:
1.184 rillig 4683: Some of the modifiers split the string into words and then operate on the
4684: words, others operate on the string as a whole. When a string is split into
4685: words, double quotes and single quotes are interpreted as delimiters, just like
4686: in sh(1).
1.1 dsieger 4687:
1.184 rillig 4688: 15.2.1. Naming conventions
1.1 dsieger 4689:
1.184 rillig 4690: * All variable names starting with an underscore are reserved for use by the
4691: pkgsrc infrastructure. They shall not be used by packages.
1.1 dsieger 4692:
1.184 rillig 4693: * In .for loops you should use lowercase variable names for the iteration
4694: variables.
1.1 dsieger 4695:
1.184 rillig 4696: * All list variables should have a plural name, such as PKG_OPTIONS or
4697: DISTFILES.
1.1 dsieger 4698:
1.184 rillig 4699: 15.3. Code snippets
1.1 dsieger 4700:
1.184 rillig 4701: 15.3.1. Adding things to a list
1.1 dsieger 4702:
1.184 rillig 4703: When adding a string that possibly contains whitespace or quotes to a list
4704: (example 1), it must be quoted using the :Q modifier.
1.1 dsieger 4705:
1.184 rillig 4706: When adding another list to a list (example 2), it must not be quoted, since
4707: its elements are already quoted.
1.1 dsieger 4708:
1.184 rillig 4709: STRING= foo * bar `date`
4710: LIST= # empty
4711: ANOTHER_LIST= a=b c=d
1.1 dsieger 4712:
1.184 rillig 4713: LIST+= ${STRING:Q} # 1
4714: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4715:
1.184 rillig 4716: 15.3.2. Echoing a string exactly as-is
1.1 dsieger 4717:
1.184 rillig 4718: Echoing a string containing special characters needs special work.
1.1 dsieger 4719:
1.184 rillig 4720: STRING= foo bar < > * `date` $$HOME ' "
4721: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4722:
1.184 rillig 4723: all:
4724: echo ${STRING} # 1
4725: echo ${STRING:Q} # 2
4726: printf '%s\n' ${STRING:Q}'' # 3
4727: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 4728:
1.184 rillig 4729: Example 1 leads to a syntax error in the shell, as the characters are just
4730: copied.
1.1 dsieger 4731:
1.184 rillig 4732: Example 2 quotes the string so that the shell interprets it correctly. But the
4733: echo command may additionally interpret strings with a leading dash or those
4734: containing backslashes.
1.1 dsieger 4735:
1.184 rillig 4736: Example 3 can handle arbitrary strings, since printf(1) only interprets the
4737: format string, but not the next argument. The trailing single quotes handle the
4738: case when the string is empty. In that case, the :Q modifier would result in an
4739: empty string too, which would then be skipped by the shell. For printf(1) this
4740: doesn't make a difference, but other programs may care.
1.1 dsieger 4741:
1.184 rillig 4742: In example 4, the EXAMPLE_ENV does not need to be quoted because the quoting
4743: has already been done when adding elements to the list.
1.1 dsieger 4744:
1.184 rillig 4745: 15.3.3. Passing CFLAGS to GNU configure scripts
1.1 dsieger 4746:
1.184 rillig 4747: When passing CFLAGS or similar variables to a GNU-style configure script
4748: (especially those that call other configure scripts), it must not have leading
4749: or trailing whitespace, since otherwise the configure script gets confused. To
4750: trim leading and trailing whitespace, use the :M modifier, as in the following
4751: example:
1.1 dsieger 4752:
1.184 rillig 4753: CPPFLAGS= # empty
4754: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
4755: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 4756:
1.184 rillig 4757: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 4758:
1.184 rillig 4759: all:
4760: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4761: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4762:
1.184 rillig 4763: In this example, CPPFLAGS has both leading and trailing whitespace because the
4764: += operator always adds a space.
1.1 dsieger 4765:
1.184 rillig 4766: 15.3.4. Handling possibly empty variables
1.1 dsieger 4767:
1.184 rillig 4768: When a possibly empty variable is used in a shell program, it may lead to a
4769: syntax error.
1.1 dsieger 4770:
1.184 rillig 4771: EGFILES= # empty
1.1 dsieger 4772:
1.184 rillig 4773: install-examples: # produces a syntax error in the shell
4774: for egfile in ${EGFILES}; do \
4775: echo "Installing $$egfile"; \
4776: done
1.1 dsieger 4777:
1.184 rillig 4778: The shell only sees the text for egfile in ; do, since ${EGFILES} is replaced
4779: with an empty string by make(1). To fix this syntax error, use one of the
4780: snippets below.
1.1 dsieger 4781:
1.184 rillig 4782: EMPTY= # empty
1.1 dsieger 4783:
1.184 rillig 4784: install-examples:
4785: for egfile in ${EGFILES} ""; do \
4786: [ -n "$$egfile" ] || continue; \
4787: echo "Installing $$egfile"; \
4788: done
1.1 dsieger 4789:
1.184 rillig 4790: In this case, an empty string is appended to the iteration list (to prevent the
4791: syntax error) and filtered out later.
1.1 dsieger 4792:
1.184 rillig 4793: EGFILES= # empty
1.1 dsieger 4794:
1.184 rillig 4795: install-examples:
4796: .for egfile in ${EGFILES}
4797: echo "Installing ${egfile}"
4798: .endfor
1.1 dsieger 4799:
1.184 rillig 4800: If one of the filenames contains special characters, it should be enclosed in
4801: single or double quotes.
1.1 dsieger 4802:
1.184 rillig 4803: To have a shell command test whether a make variable is empty, use the
4804: following code: ${TEST} -z ${POSSIBLY_EMPTY:Q}"".
1.1 dsieger 4805:
1.184 rillig 4806: Chapter 16. Options handling
1.1 dsieger 4807:
4808: Table of Contents
4809:
1.184 rillig 4810: 16.1. Global default options
4811: 16.2. Converting packages to use bsd.options.mk
4812: 16.3. Option Names
4813: 16.4. Determining the options of dependencies
1.1 dsieger 4814:
4815: Many packages have the ability to be built to support different sets of
4816: features. bsd.options.mk is a framework in pkgsrc that provides generic
4817: handling of those options that determine different ways in which the packages
4818: can be built. It's possible for the user to specify exactly which sets of
4819: options will be built into a package or to allow a set of global default
4820: options apply.
4821:
1.7 rillig 4822: There are two broad classes of behaviors that one might want to control via
4823: options. One is whether some particular feature is enabled in a program that
4824: will be built anyway, often by including or not including a dependency on some
4825: other package. The other is whether or not an additional program will be built
4826: as part of the package. Generally, it is better to make a split package for
4827: such additional programs instead of using options, because it enables binary
4828: packages to be built which can then be added separately. For example, the foo
4829: package might have minimal dependencies (those packages without which foo
4830: doesn't make sense), and then the foo-gfoo package might include the GTK
4831: frontend program gfoo. This is better than including a gtk option to foo that
4832: adds gfoo, because either that option is default, in which case binary users
4833: can't get foo without gfoo, or not default, in which case they can't get gfoo.
4834: With split packages, they can install foo without having GTK, and later decide
4835: to install gfoo (pulling in GTK at that time). This is an advantage to source
4836: users too, avoiding the need for rebuilds.
4837:
4838: Plugins with widely varying dependencies should usually be split instead of
4839: options.
4840:
4841: It is often more work to maintain split packages, especially if the upstream
4842: package does not support this. The decision of split vs. option should be made
4843: based on the likelihood that users will want or object to the various pieces,
4844: the size of the dependencies that are included, and the amount of work.
4845:
4846: A further consideration is licensing. Non-free parts, or parts that depend on
4847: non-free dependencies (especially plugins) should almost always be split if
4848: feasible.
4849:
1.184 rillig 4850: 16.1. Global default options
1.1 dsieger 4851:
4852: Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of
4853: the options that should be built into every package if that option is
1.4 rillig 4854: supported. This variable should be set in mk.conf.
1.1 dsieger 4855:
1.184 rillig 4856: 16.2. Converting packages to use bsd.options.mk
1.1 dsieger 4857:
4858: The following example shows how bsd.options.mk should be used by the
4859: hypothetical ``wibble'' package, either in the package Makefile, or in a file,
4860: e.g. options.mk, that is included by the main package Makefile.
4861:
4862: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
4863: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
4864: PKG_OPTIONS_OPTIONAL_GROUPS= database
4865: PKG_OPTIONS_GROUP.database= mysql pgsql
4866: PKG_SUGGESTED_OPTIONS= wibble-foo
4867: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
4868: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
4869:
4870: .include "../../mk/bsd.prefs.mk"
4871:
4872: # this package was previously named wibble2
4873: .if defined(PKG_OPTIONS.wibble2)
4874: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
4875: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
4876: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
4877: .endif
4878:
4879: .include "../../mk/bsd.options.mk"
4880:
4881: # Package-specific option-handling
4882:
4883: ###
4884: ### FOO support
4885: ###
4886: .if !empty(PKG_OPTIONS:Mwibble-foo)
4887: CONFIGURE_ARGS+= --enable-foo
4888: .endif
4889:
4890: ###
4891: ### LDAP support
4892: ###
4893: .if !empty(PKG_OPTIONS:Mldap)
4894: . include "../../databases/openldap-client/buildlink3.mk"
4895: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
4896: .endif
4897:
4898: ###
4899: ### database support
4900: ###
4901: .if !empty(PKG_OPTIONS:Mmysql)
4902: . include "../../mk/mysql.buildlink3.mk"
4903: .endif
4904: .if !empty(PKG_OPTIONS:Mpgsql)
4905: . include "../../mk/pgsql.buildlink3.mk"
4906: .endif
4907:
4908: The first section contains the information about which build options are
4909: supported by the package, and any default options settings if needed.
4910:
4911: 1. PKG_OPTIONS_VAR is the name of the make(1) variable that the user can set
4912: to override the default options. It should be set to PKG_OPTIONS.pkgbase.
4913: Do not set it to PKG_OPTIONS.${PKGBASE}, since PKGBASE is not defined at
4914: the point where the options are processed.
4915:
4916: 2. PKG_SUPPORTED_OPTIONS is a list of build options supported by the package.
4917:
4918: 3. PKG_OPTIONS_OPTIONAL_GROUPS is a list of names of groups of mutually
4919: exclusive options. The options in each group are listed in
4920: PKG_OPTIONS_GROUP.groupname. The most specific setting of any option from
4921: the group takes precedence over all other options in the group. Options
4922: from the groups will be automatically added to PKG_SUPPORTED_OPTIONS.
4923:
4924: 4. PKG_OPTIONS_REQUIRED_GROUPS is like PKG_OPTIONS_OPTIONAL_GROUPS, but
4925: building the packages will fail if no option from the group is selected.
4926:
4927: 5. PKG_OPTIONS_NONEMPTY_SETS is a list of names of sets of options. At least
4928: one option from each set must be selected. The options in each set are
4929: listed in PKG_OPTIONS_SET.setname. Options from the sets will be
4930: automatically added to PKG_SUPPORTED_OPTIONS. Building the package will
4931: fail if no option from the set is selected.
4932:
4933: 6. PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
4934: default.
4935:
4936: 7. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE:option" pairs that map
1.4 rillig 4937: legacy mk.conf variables to their option counterparts. Pairs should be
1.1 dsieger 4938: added with "+=" to keep the listing of global legacy variables. A warning
4939: will be issued if the user uses a legacy variable.
4940:
4941: 8. PKG_OPTIONS_LEGACY_OPTS is a list of "old-option:new-option" pairs that map
4942: options that have been renamed to their new counterparts. Pairs should be
4943: added with "+=" to keep the listing of global legacy options. A warning
4944: will be issued if the user uses a legacy option.
4945:
4946: 9. PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
4947: used. This can be used for cases that neither PKG_OPTIONS_LEGACY_VARS nor
4948: PKG_OPTIONS_LEGACY_OPTS can handle, e. g. when PKG_OPTIONS_VAR is renamed.
4949:
4950: 10. PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
4951: variables or options used, and what to use instead.
4952:
4953: A package should never modify PKG_DEFAULT_OPTIONS or the variable named in
4954: PKG_OPTIONS_VAR. These are strictly user-settable. To suggest a default set of
4955: options, use PKG_SUGGESTED_OPTIONS.
4956:
4957: PKG_OPTIONS_VAR must be defined before including bsd.options.mk. If none of
4958: PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and
4959: PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform-specific
4960: options if none of them is supported on the current platform), PKG_OPTIONS is
4961: set to the empty list and the package is otherwise treated as not using the
4962: options framework.
4963:
4964: After the inclusion of bsd.options.mk, the variable PKG_OPTIONS contains the
4965: list of selected build options, properly filtered to remove unsupported and
4966: duplicate options.
4967:
4968: The remaining sections contain the logic that is specific to each option. The
4969: correct way to check for an option is to check whether it is listed in
4970: PKG_OPTIONS:
4971:
4972: .if !empty(PKG_OPTIONS:Moption)
4973:
1.184 rillig 4974: 16.3. Option Names
1.1 dsieger 4975:
4976: Options that enable similar features in different packages (like optional
4977: support for a library) should use a common name in all packages that support it
4978: (like the name of the library). If another package already has an option with
4979: the same meaning, use the same name.
4980:
4981: Options that enable features specific to one package, where it's unlikely that
4982: another (unrelated) package has the same (or a similar) optional feature,
4983: should use a name prefixed with pkgname-.
4984:
4985: If a group of related packages share an optional feature specific to that
4986: group, prefix it with the name of the "main" package (e. g.
4987: djbware-errno-hack).
4988:
4989: For new options, add a line to mk/defaults/options.description. Lines have two
4990: fields, separated by tab. The first field is the option name, the second its
4991: description. The description should be a whole sentence (starting with an
4992: uppercase letter and ending with a period) that describes what enabling the
4993: option does. E. g. "Enable ispell support." The file is sorted by option names.
4994:
1.184 rillig 4995: 16.4. Determining the options of dependencies
1.7 rillig 4996:
4997: When writing buildlink3.mk files, it is often necessary to list different
4998: dependencies based on the options with which the package was built. For
4999: querying these options, the file pkgsrc/mk/pkg-build-options.mk should be used.
5000: A typical example looks like this:
5001:
5002: pkgbase := libpurple
5003: .include "../../mk/pkg-build-options.mk"
5004:
5005: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5006: ...
5007: .endif
5008:
5009: Including pkg-build-options.mk here will set the variable
5010: PKG_BUILD_OPTIONS.libpurple to the build options of the libpurple package,
5011: which can then be queried like PKG_OPTIONS in the options.mk file. See the file
5012: pkg-build-options.mk for more details.
5013:
1.184 rillig 5014: Chapter 17. Tools needed for building or running
5015:
5016: Table of Contents
5017:
5018: 17.1. Tools for pkgsrc builds
5019: 17.2. Tools needed by packages
5020: 17.3. Tools provided by platforms
5021:
5022: The USE_TOOLS definition is used both internally by pkgsrc and also for
5023: individual packages to define what commands are needed for building a package
5024: (like TOOL_DEPENDS) or for later run-time of an installed packaged (such as
5025: DEPENDS). If the native system provides an adequate tool, then in many cases, a
5026: pkgsrc package will not be used.
5027:
5028: When building a package, the replacement tools are made available in a
5029: directory (as symlinks or wrapper scripts) that is early in the executable
5030: search path. Just like the buildlink system, this helps with consistent builds.
5031:
5032: A tool may be needed to help build a specific package. For example, perl, GNU
5033: make (gmake) or yacc may be needed.
5034:
5035: Also a tool may be needed, for example, because the native system's supplied
5036: tool may be inefficient for building a package with pkgsrc. For example, a
5037: package may need GNU awk, bison (instead of yacc) or a better sed.
5038:
5039: The tools used by a package can be listed by running make show-tools.
5040:
5041: 17.1. Tools for pkgsrc builds
5042:
5043: The default set of tools used by pkgsrc is defined in bsd.pkg.mk. This includes
5044: standard Unix tools, such as: cat, awk, chmod, test, and so on. These can be
5045: seen by running: make show-var VARNAME=USE_TOOLS.
5046:
5047: If a package needs a specific program to build then the USE_TOOLS variable can
5048: be used to define the tools needed.
5049:
5050: 17.2. Tools needed by packages
5051:
5052: In the following examples, the :run means that it is needed at run-time (and
5053: becomes a DEPENDS). The default is a build dependency which can be set with
5054: :build. (So in this example, it is the same as gmake:build and
5055: pkg-config:build.)
5056:
5057: USE_TOOLS+= gmake perl:run pkg-config
5058:
5059: When using the tools framework, a TOOLS_PATH.foo variable is defined which
5060: contains the full path to the appropriate tool. For example, TOOLS_PATH.bash
5061: could be "/bin/bash" on Linux systems.
5062:
5063: If you always need a pkgsrc version of the tool at run-time, then just use
5064: DEPENDS instead.
5065:
5066: 17.3. Tools provided by platforms
5067:
5068: When improving or porting pkgsrc to a new platform, have a look at (or create)
5069: the corresponding platform specific make file fragment under pkgsrc/mk/tools/
5070: tools.${OPSYS}.mk which defines the name of the common tools. For example:
5071:
5072: .if exists(/usr/bin/bzcat)
5073: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
5074: .elif exists(/usr/bin/bzip2)
5075: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
5076: .endif
5077:
5078: TOOLS_PLATFORM.true?= true # shell builtin
5079:
5080: Chapter 18. Buildlink methodology
1.1 dsieger 5081:
5082: Table of Contents
5083:
1.184 rillig 5084: 18.1. Converting packages to use buildlink3
5085: 18.2. Writing buildlink3.mk files
5086:
5087: 18.2.1. Anatomy of a buildlink3.mk file
5088: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
5089: buildlink3.mk files
5090:
5091: 18.3. Writing builtin.mk files
5092:
5093: 18.3.1. Anatomy of a builtin.mk file
5094: 18.3.2. Global preferences for native or pkgsrc software
5095:
5096: Buildlink is a framework in pkgsrc that controls what headers and libraries are
5097: seen by a package's configure and build processes. This is implemented in a two
5098: step process:
5099:
5100: 1. Symlink headers and libraries for dependencies into BUILDLINK_DIR, which by
5101: default is a subdirectory of WRKDIR.
5102:
5103: 2. Create wrapper scripts that are used in place of the normal compiler tools
5104: that translate -I${LOCALBASE}/include and -L${LOCALBASE}/lib into
5105: references to BUILDLINK_DIR. The wrapper scripts also make native compiler
5106: on some operating systems look like GCC, so that packages that expect GCC
5107: won't require modifications to build with those native compilers.
5108:
5109: This normalizes the environment in which a package is built so that the package
5110: may be built consistently despite what other software may be installed. Please
5111: note that the normal system header and library paths, e.g. /usr/include, /usr/
5112: lib, etc., are always searched -- buildlink3 is designed to insulate the
5113: package build from non-system-supplied software.
5114:
5115: 18.1. Converting packages to use buildlink3
1.1 dsieger 5116:
1.184 rillig 5117: The process of converting packages to use the buildlink3 framework ("bl3ifying"
5118: ) is fairly straightforward. The things to keep in mind are:
1.1 dsieger 5119:
1.184 rillig 5120: 1. Ensure that the build always calls the wrapper scripts instead of the
5121: actual toolchain. Some packages are tricky, and the only way to know for
5122: sure is the check ${WRKDIR}/.work.log to see if the wrappers are being
5123: invoked.
1.1 dsieger 5124:
1.184 rillig 5125: 2. Don't override PREFIX from within the package Makefile, e.g. Java VMs,
5126: standalone shells, etc., because the code to symlink files into $
5127: {BUILDLINK_DIR} looks for files relative to "pkg_info -qp pkgname".
1.1 dsieger 5128:
1.184 rillig 5129: 3. Remember that only the buildlink3.mk files that you list in a package's
5130: Makefile are added as dependencies for that package.
1.1 dsieger 5131:
1.184 rillig 5132: If a dependency on a particular package is required for its libraries and
5133: headers, then we replace:
1.1 dsieger 5134:
1.184 rillig 5135: DEPENDS+= foo>=1.1.0:../../category/foo
1.1 dsieger 5136:
1.184 rillig 5137: with
1.1 dsieger 5138:
1.184 rillig 5139: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 5140:
1.184 rillig 5141: The buildlink3.mk files usually define the required dependencies. If you need a
5142: newer version of the dependency when using buildlink3.mk files, then you can
5143: define it in your Makefile; for example:
1.1 dsieger 5144:
1.184 rillig 5145: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5146: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 5147:
1.184 rillig 5148: There are several buildlink3.mk files in pkgsrc/mk that handle special package
5149: issues:
1.1 dsieger 5150:
1.184 rillig 5151: * bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB
5152: implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT.
1.1 dsieger 5153:
1.184 rillig 5154: * curses.buildlink3.mk: If the system comes with neither Curses nor NCurses,
5155: this will take care to install the devel/ncurses package.
1.1 dsieger 5156:
1.184 rillig 5157: * krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding
5158: a dependency on Heimdal or MIT-krb5 for packages that require a Kerberos 5
5159: implementation.
1.1 dsieger 5160:
1.184 rillig 5161: * motif.buildlink3.mk checks for a system-provided Motif installation or adds
5162: a dependency on x11/lesstif or x11/motif. The user can set MOTIF_TYPE to "
5163: dt", "lesstif" or "motif" to choose which Motif version will be used.
1.1 dsieger 5164:
1.184 rillig 5165: * readline.buildlink3.mk checks for a system-provided GNU readline or
5166: editline (libedit) installation, or adds a dependency on devel/readline,
5167: devel/editline. The user can set READLINE_DEFAULT to choose readline
5168: implementation. If your package really needs GNU readline library, its
5169: Makefile should include devel/readline/buildlink3.mk instead of
5170: readline.buildlink3.mk.
1.1 dsieger 5171:
1.184 rillig 5172: * oss.buildlink3.mk defines several variables that may be used by packages
5173: that use the Open Sound System (OSS) API.
1.1 dsieger 5174:
1.184 rillig 5175: * pgsql.buildlink3.mk will accept any of the Postgres versions in the
5176: variable PGSQL_VERSIONS_ACCEPTED and default to the version
5177: PGSQL_VERSION_DEFAULT. See the file for more information.
1.1 dsieger 5178:
1.184 rillig 5179: * pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native
5180: pthreads or adds a dependency on devel/pth as needed.
1.1 dsieger 5181:
1.184 rillig 5182: * xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena
5183: widgets library.
1.1 dsieger 5184:
1.184 rillig 5185: The comments in those buildlink3.mk files provide a more complete description
5186: of how to use them properly.
1.1 dsieger 5187:
1.184 rillig 5188: 18.2. Writing buildlink3.mk files
1.1 dsieger 5189:
1.184 rillig 5190: A package's buildlink3.mk file is included by Makefiles to indicate the need to
5191: compile and link against header files and libraries provided by the package. A
5192: buildlink3.mk file should always provide enough information to add the correct
5193: type of dependency relationship and include any other buildlink3.mk files that
5194: it needs to find headers and libraries that it needs in turn.
1.1 dsieger 5195:
1.184 rillig 5196: To generate an initial buildlink3.mk file for further editing, Rene Hexel's
5197: pkgtools/createbuildlink package is highly recommended. For most packages, the
5198: following command will generate a good starting point for buildlink3.mk files:
1.1 dsieger 5199:
1.184 rillig 5200: % cd pkgsrc/category/pkgdir
5201: % createbuildlink >buildlink3.mk
1.1 dsieger 5202:
5203:
1.184 rillig 5204: 18.2.1. Anatomy of a buildlink3.mk file
1.1 dsieger 5205:
1.184 rillig 5206: The following real-life example buildlink3.mk is taken from pkgsrc/graphics/
5207: tiff:
1.14 jmcneill 5208:
1.184 rillig 5209: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 5210:
1.184 rillig 5211: BUILDLINK_TREE+= tiff
1.1 dsieger 5212:
1.184 rillig 5213: .if !defined(TIFF_BUILDLINK3_MK)
5214: TIFF_BUILDLINK3_MK:=
1.1 dsieger 5215:
1.184 rillig 5216: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5217: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5218: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 5219:
1.184 rillig 5220: .include "../../devel/zlib/buildlink3.mk"
5221: .include "../../graphics/jpeg/buildlink3.mk"
5222: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 5223:
1.184 rillig 5224: BUILDLINK_TREE+= -tiff
1.1 dsieger 5225:
1.184 rillig 5226: The header and footer manipulate BUILDLINK_TREE, which is common across all
5227: buildlink3.mk files and is used to track the dependency tree.
1.1 dsieger 5228:
1.184 rillig 5229: The main section is protected from multiple inclusion and controls how the
5230: dependency on pkg is added. Several important variables are set in the section:
1.1 dsieger 5231:
1.185 wiz 5232: * BUILDLINK_API_DEPENDS.pkg is the dependency version recorded in the
1.184 rillig 5233: installed package; this should always be set using += to ensure that we're
5234: appending to any pre-existing list of values. This variable should be set
1.185 wiz 5235: to the last version of the package that had an backwards-incompatible API
1.184 rillig 5236: change.
1.1 dsieger 5237:
1.184 rillig 5238: * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory.
1.1 dsieger 5239:
1.184 rillig 5240: * BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use
5241: BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency
5242: is selected by setting BUILDLINK_DEPMETHOD.pkg to "build". By default, the
5243: full dependency is used.
1.1 dsieger 5244:
1.184 rillig 5245: * BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS.pkg (not shown above) are lists
5246: of subdirectories of ${BUILDLINK_PREFIX.pkg} to add to the header and
5247: library search paths. These default to "include" and "lib" respectively.
1.1 dsieger 5248:
1.184 rillig 5249: * BUILDLINK_CPPFLAGS.pkg (not shown above) is the list of preprocessor flags
5250: to add to CPPFLAGS, which are passed on to the configure and build phases.
5251: The "-I" option should be avoided and instead be handled using
5252: BUILDLINK_INCDIRS.pkg as above.
1.66 asau 5253:
1.184 rillig 5254: The following variables are all optionally defined within this second section
5255: (protected against multiple inclusion) and control which package files are
5256: symlinked into ${BUILDLINK_DIR} and how their names are transformed during the
5257: symlinking:
1.23 jakllsch 5258:
1.184 rillig 5259: * BUILDLINK_FILES.pkg (not shown above) is a shell glob pattern relative to $
5260: {BUILDLINK_PREFIX.pkg} to be symlinked into ${BUILDLINK_DIR}, e.g. include/
5261: *.h.
1.1 dsieger 5262:
1.184 rillig 5263: * BUILDLINK_FILES_CMD.pkg (not shown above) is a shell pipeline that outputs
5264: to stdout a list of files relative to ${BUILDLINK_PREFIX.pkg}. The
5265: resulting files are to be symlinked into ${BUILDLINK_DIR}. By default, this
5266: takes the +CONTENTS of a pkg and filters it through $
5267: {BUILDLINK_CONTENTS_FILTER.pkg}.
1.1 dsieger 5268:
1.184 rillig 5269: * BUILDLINK_CONTENTS_FILTER.pkg (not shown above) is a filter command that
5270: filters +CONTENTS input into a list of files relative to $
5271: {BUILDLINK_PREFIX.pkg} on stdout. By default, BUILDLINK_CONTENTS_FILTER.pkg
5272: outputs the contents of the include and lib directories in the package
5273: +CONTENTS.
1.1 dsieger 5274:
1.184 rillig 5275: * BUILDLINK_FNAME_TRANSFORM.pkg (not shown above) is a list of sed arguments
5276: used to transform the name of the source filename into a destination
5277: filename, e.g. -e "s|/curses.h|/ncurses.h|g".
1.1 dsieger 5278:
1.184 rillig 5279: This section can additionally include any buildlink3.mk needed for pkg's
5280: library dependencies. Including these buildlink3.mk files means that the
5281: headers and libraries for these dependencies are also symlinked into $
5282: {BUILDLINK_DIR} whenever the pkg buildlink3.mk file is included. Dependencies
5283: are only added for directly include buildlink3.mk files.
1.1 dsieger 5284:
1.184 rillig 5285: When providing a buildlink3.mk and including other buildlink3.mk files in it,
5286: please only add necessary ones, i.e., those whose libraries or header files are
5287: automatically exposed when the package is use.
1.1 dsieger 5288:
1.184 rillig 5289: In particular, if only an executable (bin/foo) is linked against a library,
5290: that library does not need to be propagated in the buildlink3.mk file.
1.1 dsieger 5291:
1.184 rillig 5292: The following steps should help you decide if a buildlink3.mk file needs to be
5293: included:
1.1 dsieger 5294:
1.184 rillig 5295: * Look at the installed header files: What headers do they include? The
5296: packages providing these files must be buildlinked.
1.1 dsieger 5297:
1.184 rillig 5298: * Run ldd on all installed libraries and look against what other libraries
5299: they link. Some of the packages providing these probably need to be
5300: buildlinked; however, it's not automatic, since e.g. GTK on some systems
5301: pulls in the X libraries, so they will show up in the ldd output, while on
5302: others (like OS X) it won't. ldd output can thus only be used as a hint.
1.1 dsieger 5303:
1.184 rillig 5304: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
5305: buildlink3.mk files
1.16 jnemeth 5306:
1.185 wiz 5307: Both variables set lower bounds for a version of this package. The two
5308: variables differ in that one describes source compatibility (API) and the other
5309: binary compatibility (ABI). The difference is that a change in the API breaks
5310: compilation of programs while changes in the ABI stop compiled programs from
5311: running.
5312:
5313: The BUILDLINK_API_DEPENDS.pkg variable in a buildlink3.mk should be changed
5314: very rarely. (One possible scenario: If all packages using this package need a
5315: higher version than defined in the buildlink3.mk, BUILDLINK_API_DEPENDS.pkg
5316: could be updated to that higher version.)
5317:
5318: On the other hand, changes to BUILDLINK_ABI_DEPENDS.pkg are more common. The
5319: variable will need to be updated every time the major version of one of its
5320: shared libraries is changed, or any other change where a binary built against
5321: the previous version of the package will not run against the new version any
5322: longer.
5323:
5324: In such a case, the package's BUILDLINK_ABI_DEPENDS.pkg must be increased to
5325: require the new package version. Then the PKGREVISION of all packages foo that
5326: depend on this package need to be increased, and if they have buildlink3.mk
5327: files, BUILDLINK_ABI_DEPENDS.foo in their buildlink3.mk files must be increased
5328: to the new version as well. This is required so that a package will pull in the
5329: versions of the packages that use the new ABI and that the packages'
5330: PKGREVISIONs uniquely identify the packages built against the new ABI. The
5331: pkgtools/revbump package can help with these updates.
1.1 dsieger 5332:
1.184 rillig 5333: See Section 21.1.5, "Handling dependencies" for more information about
1.185 wiz 5334: dependencies on other packages, including the BUILDLINK_API_DEPENDS
5335: definitions.
1.1 dsieger 5336:
1.184 rillig 5337: Please take careful consideration before adjusting BUILDLINK_API_DEPENDS.pkg or
1.185 wiz 5338: BUILDLINK_ABI_DEPENDS.pkg in a buildlink3.mk file as we don't want to cause
5339: unneeded package deletions and rebuilds. In many cases, new versions of
5340: packages work just fine with older dependencies.
1.1 dsieger 5341:
1.184 rillig 5342: Also it is not needed to set BUILDLINK_ABI_DEPENDS.pkg when it is identical to
5343: BUILDLINK_API_DEPENDS.pkg.
1.1 dsieger 5344:
1.184 rillig 5345: 18.3. Writing builtin.mk files
1.1 dsieger 5346:
1.184 rillig 5347: Some packages in pkgsrc install headers and libraries that coincide with
5348: headers and libraries present in the base system. Aside from a buildlink3.mk
5349: file, these packages should also include a builtin.mk file that includes the
5350: necessary checks to decide whether using the built-in software or the pkgsrc
5351: software is appropriate.
1.1 dsieger 5352:
1.184 rillig 5353: The only requirements of a builtin.mk file for pkg are:
1.1 dsieger 5354:
1.184 rillig 5355: 1. It should set USE_BUILTIN.pkg to either "yes" or "no" after it is included.
1.1 dsieger 5356:
1.184 rillig 5357: 2. It should not override any USE_BUILTIN.pkg which is already set before the
5358: builtin.mk file is included.
1.1 dsieger 5359:
1.184 rillig 5360: 3. It should be written to allow multiple inclusion. This is very important
5361: and takes careful attention to Makefile coding.
1.1 dsieger 5362:
1.184 rillig 5363: 18.3.1. Anatomy of a builtin.mk file
1.1 dsieger 5364:
1.184 rillig 5365: The following is the recommended template for builtin.mk files:
1.1 dsieger 5366:
1.184 rillig 5367: .if !defined(IS_BUILTIN.foo)
5368: #
5369: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5370: # genuinely exists in the system or not.
5371: #
5372: IS_BUILTIN.foo?= no
1.1 dsieger 5373:
1.184 rillig 5374: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5375: # version can be determined.
5376: #
5377: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5378: BUILTIN_PKG.foo?= foo-1.0
5379: . endif
5380: .endif # IS_BUILTIN.foo
1.1 dsieger 5381:
1.184 rillig 5382: .if !defined(USE_BUILTIN.foo)
5383: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5384: . if defined(BUILTIN_PKG.foo)
5385: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5386: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5387: USE_BUILTIN.foo!= \
5388: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5389: && ${ECHO} "yes" || ${ECHO} "no"
5390: . endif
5391: . endfor
5392: . endif
5393: .endif # USE_BUILTIN.foo
1.1 dsieger 5394:
1.184 rillig 5395: CHECK_BUILTIN.foo?= no
5396: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5397: #
5398: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5399: # "yes" or "no".
5400: #
5401: .endif # CHECK_BUILTIN.foo
1.1 dsieger 5402:
1.184 rillig 5403: The first section sets IS_BUILTIN.pkg depending on if pkg really exists in the
5404: base system. This should not be a base system software with similar
5405: functionality to pkg; it should only be "yes" if the actual package is included
5406: as part of the base system. This variable is only used internally within the
5407: builtin.mk file.
1.1 dsieger 5408:
1.184 rillig 5409: The second section sets BUILTIN_PKG.pkg to the version of pkg in the base
5410: system if it exists (if IS_BUILTIN.pkg is "yes"). This variable is only used
5411: internally within the builtin.mk file.
1.1 dsieger 5412:
1.184 rillig 5413: The third section sets USE_BUILTIN.pkg and is required in all builtin.mk files.
5414: The code in this section must make the determination whether the built-in
5415: software is adequate to satisfy the dependencies listed in
5416: BUILDLINK_API_DEPENDS.pkg. This is typically done by comparing BUILTIN_PKG.pkg
5417: against each of the dependencies in BUILDLINK_API_DEPENDS.pkg. USE_BUILTIN.pkg
5418: must be set to the correct value by the end of the builtin.mk file. Note that
5419: USE_BUILTIN.pkg may be "yes" even if IS_BUILTIN.pkg is "no" because we may make
5420: the determination that the built-in version of the software is similar enough
5421: to be used as a replacement.
1.1 dsieger 5422:
1.184 rillig 5423: The last section is guarded by CHECK_BUILTIN.pkg, and includes code that uses
5424: the value of USE_BUILTIN.pkg set in the previous section. This typically
5425: includes, e.g., adding additional dependency restrictions and listing
5426: additional files to symlink into ${BUILDLINK_DIR} (via BUILDLINK_FILES.pkg).
1.1 dsieger 5427:
1.184 rillig 5428: 18.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 5429:
1.184 rillig 5430: When building packages, it's possible to choose whether to set a global
5431: preference for using either the built-in (native) version or the pkgsrc version
5432: of software to satisfy a dependency. This is controlled by setting
5433: PREFER_PKGSRC and PREFER_NATIVE. These variables take values of either "yes", "
5434: no", or a list of packages. PREFER_PKGSRC tells pkgsrc to use the pkgsrc
5435: versions of software, while PREFER_NATIVE tells pkgsrc to use the built-in
5436: versions. Preferences are determined by the most specific instance of the
5437: package in either PREFER_PKGSRC or PREFER_NATIVE. If a package is specified in
5438: neither or in both variables, then PREFER_PKGSRC has precedence over
5439: PREFER_NATIVE. For example, to require using pkgsrc versions of software for
5440: all but the most basic bits on a NetBSD system, you can set:
1.1 dsieger 5441:
1.184 rillig 5442: PREFER_PKGSRC= yes
5443: PREFER_NATIVE= getopt skey tcp_wrappers
1.1 dsieger 5444:
1.184 rillig 5445: A package must have a builtin.mk file to be listed in PREFER_NATIVE, otherwise
5446: it is simply ignored in that list.
1.1 dsieger 5447:
1.191 bacon 5448: PREFER_PKGSRC and PREFER_NATIVE should be set during bootstrap to ensure that
5449: the bootstrap process does not use inapropriate native tools as dependencies
5450: for core packages.
5451:
5452: # ./bootstrap --prefer-pkgsrc yes --prefer-native openssl
5453:
5454: Switching between settings globally at a later date can introduce complications
5455: with dependency resolution. This is caused by packages built with the opposite
5456: preference being installed alongside each other. Hence, any changes to these
5457: variables after bootstrap will necessitate rebuilding all packages depending on
5458: one whose preference has been changed. This is not trivial and should be
5459: avoided.
5460:
5461: When using pkgsrc on Linux systems, there is high risk of "leakage", where
5462: programs installed by pkgsrc may inadvertently use a command or library not
5463: installed by pkgsrc, e.g. those installed by yum or apt. Such foreign
5464: dependencies may be installed, removed, or upgraded to a version incompatible
5465: with the pkgsrc package at any time, causing pkgsrc packages to subsequently
5466: malfunction. Pkgsrc cannot prevent this, as it has no control over other
5467: package managers. Another potential problem is that under Redhat Enterprise and
5468: related Linux systems, yum packages are only patched and never upgraded, so
5469: eventually they may become too outdated for use by pkgsrc. Even intentionally
5470: using foreign dependencies, not considered leakage, can lead to these problems,
5471: so it is generally discouraged. In order to minimize such problems,
5472: PREFER_PKGSRC defaults to "yes" on Linux systems. This ensures that pkgsrc is
5473: aware of any changes to dependency packages and can rebuild or upgrade the
5474: entire dependency tree as needed. This default can be overridden by setting
5475: --prefer-pkgsrc to "no" or a list of packages, or by setting --prefer-native to
5476: "yes".
1.1 dsieger 5477:
1.184 rillig 5478: Chapter 19. PLIST issues
1.1 dsieger 5479:
1.184 rillig 5480: Table of Contents
1.1 dsieger 5481:
1.184 rillig 5482: 19.1. RCS ID
5483: 19.2. Semi-automatic PLIST generation
5484: 19.3. Tweaking output of make print-PLIST
5485: 19.4. Variable substitution in PLIST
5486: 19.5. Man page compression
5487: 19.6. Changing PLIST source with PLIST_SRC
5488: 19.7. Platform-specific and differing PLISTs
5489: 19.8. Build-specific PLISTs
5490: 19.9. Sharing directories between packages
1.1 dsieger 5491:
1.184 rillig 5492: The PLIST file contains a package's "packing list", i.e. a list of files that
5493: belong to the package (relative to the ${PREFIX} directory it's been installed
5494: in) plus some additional statements - see the pkg_create(1) man page for a full
5495: list. This chapter addresses some issues that need attention when dealing with
5496: the PLIST file (or files, see below!).
1.1 dsieger 5497:
1.184 rillig 5498: 19.1. RCS ID
1.1 dsieger 5499:
1.184 rillig 5500: Be sure to add a RCS ID line as the first thing in any PLIST file you write:
1.1 dsieger 5501:
1.184 rillig 5502: @comment $NetBSD $
1.1 dsieger 5503:
1.184 rillig 5504: An artificial space has been added between NetBSD and $, this is a workaround
5505: here to prevent CVS expanding to the filename of the guide. When adding the RCS
5506: ID the space should be omitted.
1.38 wiz 5507:
1.184 rillig 5508: 19.2. Semi-automatic PLIST generation
1.1 dsieger 5509:
1.184 rillig 5510: You can use the make print-PLIST command to output a PLIST that matches any new
5511: files since the package was extracted. See Section 13.17, "Other helpful
5512: targets" for more information on this target.
1.11 rillig 5513:
1.184 rillig 5514: 19.3. Tweaking output of make print-PLIST
1.1 dsieger 5515:
1.184 rillig 5516: The PRINT_PLIST_AWK variable takes a set of AWK patterns and actions that are
5517: used to filter the output of print-PLIST. You can append any chunk of AWK
5518: scripting you like to it, but be careful with quoting.
1.1 dsieger 5519:
1.184 rillig 5520: For example, to get all files inside the libdata/foo directory removed from the
5521: resulting PLIST:
1.1 dsieger 5522:
1.184 rillig 5523: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 5524:
1.185 wiz 5525: The PRINT_PLIST_AWK transformations are evaluated after the file list and
5526: directory list are sorted. EARLY_PRINT_PLIST_AWK is like PRINT_PLIST_AWK except
5527: it operates before the file list and directory list are sorted.
5528:
1.184 rillig 5529: 19.4. Variable substitution in PLIST
1.1 dsieger 5530:
1.184 rillig 5531: A number of variables are substituted automatically in PLISTs when a package is
5532: installed on a system. This includes the following variables:
1.1 dsieger 5533:
1.184 rillig 5534: ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
1.1 dsieger 5535:
1.184 rillig 5536: Some packages like emacs and perl embed information about which
5537: architecture they were built on into the pathnames where they install their
5538: files. To handle this case, PLIST will be preprocessed before actually
5539: used, and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p
5540: gives. The same is done if the string ${MACHINE_GNU_ARCH} is embedded in
5541: PLIST somewhere - use this on packages that have GNU autoconf-created
5542: configure scripts.
1.1 dsieger 5543:
1.184 rillig 5544: Legacy note
1.1 dsieger 5545:
1.184 rillig 5546: There used to be a symbol "$ARCH" that was replaced by the output of uname
5547: -m, but that's no longer supported and has been removed.
1.1 dsieger 5548:
1.184 rillig 5549: ${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}
1.1 dsieger 5550:
1.184 rillig 5551: Some packages want to embed the OS name and version into some paths. To do
5552: this, use these variables in the PLIST:
1.1 dsieger 5553:
1.184 rillig 5554: + ${OPSYS} - output of "uname -s"
1.1 dsieger 5555:
1.184 rillig 5556: + ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
1.1 dsieger 5557:
1.184 rillig 5558: + ${OS_VERSION} - "uname -r"
1.1 dsieger 5559:
1.184 rillig 5560: For a list of values which are replaced by default, the output of make help
5561: topic=PLIST_SUBST as well as searching the pkgsrc/mk directory with grep for
5562: PLIST_SUBST should help.
1.1 dsieger 5563:
1.184 rillig 5564: If you want to change other variables not listed above, you can add variables
5565: and their expansions to this variable in the following way, similar to
5566: MESSAGE_SUBST (see Section 12.5, "Optional files"):
1.1 dsieger 5567:
1.184 rillig 5568: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 5569:
1.184 rillig 5570: This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue".
1.1 dsieger 5571:
1.184 rillig 5572: The PLIST_VARS variable can be used to simplify the common case of
5573: conditionally including some PLIST entries. It can be done by adding
5574: PLIST_VARS+=foo and setting the corresponding PLIST.foo variable to yes if the
5575: entry should be included. This will substitute "${PLIST.foo}" in the PLIST with
5576: either """" or ""@comment "". For example, in Makefile:
1.1 dsieger 5577:
1.184 rillig 5578: PLIST_VARS+= foo
5579: .if condition
5580: PLIST.foo= yes
5581: .else
1.1 dsieger 5582:
1.184 rillig 5583: And then in PLIST:
1.1 dsieger 5584:
1.184 rillig 5585: @comment $NetBSD $
5586: bin/bar
5587: man/man1/bar.1
5588: ${PLIST.foo}bin/foo
5589: ${PLIST.foo}man/man1/foo.1
5590: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 5591:
1.184 rillig 5592: An artificial space has been added between NetBSD and $, this is a workaround
5593: here to prevent CVS expanding to the filename of the guide. When adding the RCS
1.195 gutterid 5594: ID the space should be omitted.
1.1 dsieger 5595:
1.184 rillig 5596: 19.5. Man page compression
1.1 dsieger 5597:
1.184 rillig 5598: Man pages should be installed in compressed form if MANZ is set (in
5599: bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the
5600: suffix ".gz" is appended/removed automatically for man pages according to MANZ
5601: and MANCOMPRESSED being set or not, see above for details. This modification of
5602: the PLIST file is done on a copy of it, not PLIST itself.
1.100 leot 5603:
1.184 rillig 5604: 19.6. Changing PLIST source with PLIST_SRC
1.100 leot 5605:
1.184 rillig 5606: To use one or more files as source for the PLIST used in generating the binary
5607: package, set the variable PLIST_SRC to the names of that file(s). The files are
5608: later concatenated using cat(1), and the order of things is important. The
5609: default for PLIST_SRC is ${PKGDIR}/PLIST.
1.1 dsieger 5610:
1.184 rillig 5611: 19.7. Platform-specific and differing PLISTs
1.1 dsieger 5612:
1.184 rillig 5613: Some packages decide to install a different set of files based on the operating
5614: system being used. These differences can be automatically handled by using the
5615: following files:
1.1 dsieger 5616:
1.184 rillig 5617: * PLIST.common
1.1 dsieger 5618:
1.184 rillig 5619: * PLIST.${OPSYS}
1.1 dsieger 5620:
1.184 rillig 5621: * PLIST.${MACHINE_ARCH}
1.1 dsieger 5622:
1.184 rillig 5623: * PLIST.${OPSYS}-${MACHINE_ARCH}
1.1 dsieger 5624:
1.184 rillig 5625: * PLIST.common_end
1.1 dsieger 5626:
1.184 rillig 5627: 19.8. Build-specific PLISTs
1.1 dsieger 5628:
1.184 rillig 5629: Some packages decide to generate hard-to-guess file names during installation
5630: that are hard to wire down.
1.1 dsieger 5631:
1.184 rillig 5632: In such cases, you can set the GENERATE_PLIST variable to shell code terminated
5633: (with a semicolon) that will output PLIST entries which will be appended to the
5634: PLIST
1.1 dsieger 5635:
1.184 rillig 5636: You can find one example in editors/xemacs:
1.1 dsieger 5637:
1.184 rillig 5638: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
1.1 dsieger 5639:
1.184 rillig 5640: which will append something like bin/xemacs-21.4.23-54e8ea71.dmp to the PLIST.
1.1 dsieger 5641:
1.184 rillig 5642: 19.9. Sharing directories between packages
1.1 dsieger 5643:
1.184 rillig 5644: A "shared directory" is a directory where multiple (and unrelated) packages
5645: install files. These directories were problematic because you had to add
5646: special tricks in the PLIST to conditionally remove them, or have some
5647: centralized package handle them.
1.106 tnn 5648:
1.184 rillig 5649: In pkgsrc, it is now easy: Each package should create directories and install
5650: files as needed; pkg_delete will remove any directories left empty after
5651: uninstalling a package.
1.106 tnn 5652:
1.184 rillig 5653: If a package needs an empty directory to work, create the directory during
5654: installation as usual, and also add an entry to the PLIST:
1.1 dsieger 5655:
1.184 rillig 5656: @pkgdir path/to/empty/directory
1.1 dsieger 5657:
1.184 rillig 5658: or take a look at MAKE_DIRS and OWN_DIRS.
1.1 dsieger 5659:
1.184 rillig 5660: Chapter 20. The pkginstall framework
1.1 dsieger 5661:
1.184 rillig 5662: Table of Contents
1.1 dsieger 5663:
1.184 rillig 5664: 20.1. Files and directories outside the installation prefix
1.1 dsieger 5665:
1.184 rillig 5666: 20.1.1. Directory manipulation
5667: 20.1.2. File manipulation
1.1 dsieger 5668:
1.184 rillig 5669: 20.2. Configuration files
1.1 dsieger 5670:
1.184 rillig 5671: 20.2.1. How PKG_SYSCONFDIR is set
5672: 20.2.2. Telling the software where configuration files are
5673: 20.2.3. Patching installations
5674: 20.2.4. Disabling handling of configuration files
1.1 dsieger 5675:
1.184 rillig 5676: 20.3. System startup scripts
1.1 dsieger 5677:
1.184 rillig 5678: 20.3.1. Disabling handling of system startup scripts
1.1 dsieger 5679:
1.184 rillig 5680: 20.4. System users and groups
5681: 20.5. System shells
1.1 dsieger 5682:
1.184 rillig 5683: 20.5.1. Disabling shell registration
1.1 dsieger 5684:
1.184 rillig 5685: 20.6. Fonts
1.1 dsieger 5686:
1.184 rillig 5687: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 5688:
1.184 rillig 5689: This chapter describes the framework known as pkginstall, whose key features
5690: are:
1.1 dsieger 5691:
1.184 rillig 5692: * Generic installation and manipulation of directories and files outside the
5693: pkgsrc-handled tree, LOCALBASE.
1.1 dsieger 5694:
1.184 rillig 5695: * Automatic handling of configuration files during installation, provided
5696: that packages are correctly designed.
1.1 dsieger 5697:
1.184 rillig 5698: * Generation and installation of system startup scripts.
1.1 dsieger 5699:
1.184 rillig 5700: * Registration of system users and groups.
1.1 dsieger 5701:
1.184 rillig 5702: * Registration of system shells.
1.1 dsieger 5703:
1.184 rillig 5704: * Automatic updating of fonts databases.
1.1 dsieger 5705:
1.184 rillig 5706: The following sections inspect each of the above points in detail.
1.1 dsieger 5707:
1.184 rillig 5708: You may be thinking that many of the things described here could be easily done
5709: with simple code in the package's post-installation target (post-install). This
5710: is incorrect, as the code in them is only executed when building from source.
5711: Machines using binary packages could not benefit from it at all (as the code
5712: itself could be unavailable). Therefore, the only way to achieve any of the
5713: items described above is by means of the installation scripts, which are
5714: automatically generated by pkginstall.
1.1 dsieger 5715:
1.184 rillig 5716: 20.1. Files and directories outside the installation prefix
1.95 wiz 5717:
1.184 rillig 5718: As you already know, the PLIST file holds a list of files and directories that
5719: belong to a package. The names used in it are relative to the installation
5720: prefix (${PREFIX}), which means that it cannot register files outside this
5721: directory (absolute path names are not allowed). Despite this restriction, some
5722: packages need to install files outside this location; e.g., under ${VARBASE} or
5723: ${PKG_SYSCONFDIR}. The only way to achieve this is to create such files during
5724: installation time by using installation scripts.
1.95 wiz 5725:
1.184 rillig 5726: The generic installation scripts are shell scripts that can contain arbitrary
5727: code. The list of scripts to execute is taken from the INSTALL_FILE variable,
5728: which defaults to INSTALL. A similar variable exists for package removal
5729: (DEINSTALL_FILE, whose default is DEINSTALL). These scripts can run arbitrary
5730: commands, so they have the potential to create and manage files anywhere in the
5731: file system.
1.95 wiz 5732:
1.184 rillig 5733: Using these general installation files is not recommended, but may be needed in
5734: some special cases. One reason for avoiding them is that the user has to trust
5735: the packager that there is no unwanted or simply erroneous code included in the
5736: installation script. Also, previously there were many similar scripts for the
5737: same functionality, and fixing a common error involved finding and changing all
5738: of them.
1.95 wiz 5739:
1.184 rillig 5740: The pkginstall framework offers another, standardized way. It provides generic
5741: scripts to abstract the manipulation of such files and directories based on
5742: variables set in the package's Makefile. The rest of this section describes
5743: these variables.
1.1 dsieger 5744:
1.184 rillig 5745: 20.1.1. Directory manipulation
1.1 dsieger 5746:
1.184 rillig 5747: The following variables can be set to request the creation of directories
5748: anywhere in the file system:
1.1 dsieger 5749:
1.184 rillig 5750: * MAKE_DIRS and OWN_DIRS contain a list of directories that should be created
5751: and should attempt to be destroyed by the installation scripts. The
5752: difference between the two is that the latter prompts the administrator to
5753: remove any directories that may be left after deinstallation (because they
5754: were not empty), while the former does not. Example:
1.1 dsieger 5755:
1.184 rillig 5756: MAKE_DIRS+= ${VARBASE}/foo/private
1.1 dsieger 5757:
1.184 rillig 5758: * MAKE_DIRS_PERMS and OWN_DIRS_PERMS contain a list of tuples describing
5759: which directories should be created and should attempt to be destroyed by
5760: the installation scripts. Each tuple holds the following values, separated
5761: by spaces: the directory name, its owner, its group and its numerical mode.
5762: For example:
1.1 dsieger 5763:
1.184 rillig 5764: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5765: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5766:
1.184 rillig 5767: The difference between the two is exactly the same as their non-PERMS
5768: counterparts.
1.1 dsieger 5769:
1.184 rillig 5770: 20.1.2. File manipulation
1.1 dsieger 5771:
1.184 rillig 5772: Creating non-empty files outside the installation prefix is tricky because the
5773: PLIST forces all files to be inside it. To overcome this problem, the only
5774: solution is to extract the file in the known place (i.e., inside the
5775: installation prefix) and copy it to the appropriate location during
5776: installation (done by the installation scripts generated by pkginstall). We
5777: will call the former the master file in the following paragraphs, which
5778: describe the variables that can be used to automatically and consistently
5779: handle files outside the installation prefix:
1.1 dsieger 5780:
1.184 rillig 5781: * CONF_FILES and REQD_FILES are pairs of master and target files. During
5782: installation time, the master file is copied to the target one if and only
5783: if the latter does not exist. Upon deinstallation, the target file is
5784: removed provided that it was not modified by the installation.
1.1 dsieger 5785:
1.184 rillig 5786: The difference between the two is that the latter prompts the administrator
5787: to remove any files that may be left after deinstallation (because they
5788: were not empty), while the former does not.
1.1 dsieger 5789:
1.184 rillig 5790: * CONF_FILES_PERMS and REQD_FILES_PERMS contain tuples describing master
5791: files as well as their target locations. For each of them, it also
5792: specifies their owner, their group and their numeric permissions, in this
5793: order. For example:
1.1 dsieger 5794:
1.184 rillig 5795: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5796: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5797:
1.184 rillig 5798: The difference between the two is exactly the same as their non-PERMS
5799: counterparts.
1.1 dsieger 5800:
1.184 rillig 5801: 20.2. Configuration files
1.1 dsieger 5802:
1.184 rillig 5803: Configuration files are special in the sense that they are installed in their
5804: own specific directory, PKG_SYSCONFDIR, and need special treatment during
5805: installation (most of which is automated by pkginstall). The main concept you
5806: must bear in mind is that files marked as configuration files are automatically
5807: copied to the right place (somewhere inside PKG_SYSCONFDIR) during installation
5808: if and only if they didn't exist before. Similarly, they will not be removed if
5809: they have local modifications. This ensures that administrators never lose any
5810: custom changes they may have made.
1.1 dsieger 5811:
1.184 rillig 5812: 20.2.1. How PKG_SYSCONFDIR is set
1.1 dsieger 5813:
1.184 rillig 5814: As said before, the PKG_SYSCONFDIR variable specifies where configuration files
5815: shall be installed. Its contents are set based upon the following variables:
1.1 dsieger 5816:
1.184 rillig 5817: * PKG_SYSCONFBASE: The configuration's root directory. Defaults to ${PREFIX}/
5818: etc although it may be overridden by the user to point to his preferred
5819: location (e.g., /etc, /etc/pkg, etc.). Packages must not use it directly.
1.1 dsieger 5820:
1.184 rillig 5821: * PKG_SYSCONFSUBDIR: A subdirectory of PKG_SYSCONFBASE under which the
5822: configuration files for the package being built shall be installed. The
5823: definition of this variable only makes sense in the package's Makefile
5824: (i.e., it is not user-customizable).
1.1 dsieger 5825:
1.184 rillig 5826: As an example, consider the Apache package, www/apache24, which places its
5827: configuration files under the httpd/ subdirectory of PKG_SYSCONFBASE. This
5828: should be set in the package Makefile.
1.1 dsieger 5829:
1.184 rillig 5830: * PKG_SYSCONFVAR: Specifies the name of the variable that holds this
5831: package's configuration directory (if different from PKG_SYSCONFBASE). It
5832: defaults to PKGBASE's value, and is always prefixed with PKG_SYSCONFDIR.
1.1 dsieger 5833:
1.184 rillig 5834: * PKG_SYSCONFDIR.${PKG_SYSCONFVAR}: Holds the directory where the
5835: configuration files for the package identified by PKG_SYSCONFVAR's shall be
5836: placed.
1.1 dsieger 5837:
1.184 rillig 5838: Based on the above variables, pkginstall determines the value of
5839: PKG_SYSCONFDIR, which is the only variable that can be used within a package to
5840: refer to its configuration directory. The algorithm used to set its value is
5841: basically the following:
1.1 dsieger 5842:
1.184 rillig 5843: 1. If PKG_SYSCONFDIR.${PKG_SYSCONFVAR} is set, its value is used.
1.1 dsieger 5844:
1.184 rillig 5845: 2. If the previous variable is not defined but PKG_SYSCONFSUBDIR is set in the
5846: package's Makefile, the resulting value is ${PKG_SYSCONFBASE}/$
5847: {PKG_SYSCONFSUBDIR}.
1.1 dsieger 5848:
1.184 rillig 5849: 3. Otherwise, it is set to ${PKG_SYSCONFBASE}.
1.1 dsieger 5850:
1.184 rillig 5851: It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to
5852: OWN_DIRS. See Section 20.1.1, "Directory manipulation" what this means. This
5853: does not apply to subdirectories of ${PKG_SYSCONFDIR}, they still have to be
5854: created with OWN_DIRS or MAKE_DIRS.
1.1 dsieger 5855:
1.184 rillig 5856: 20.2.2. Telling the software where configuration files are
1.1 dsieger 5857:
1.184 rillig 5858: Given that pkgsrc (and users!) expect configuration files to be in a known
5859: place, you need to teach each package where it shall install its files. In some
5860: cases you will have to patch the package Makefiles to achieve it. If you are
5861: lucky, though, it may be as easy as passing an extra flag to the configuration
5862: script; this is the case of GNU Autoconf- generated files:
1.1 dsieger 5863:
1.184 rillig 5864: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 5865:
1.184 rillig 5866: Note that this specifies where the package has to look for its configuration
5867: files, not where they will be originally installed (although the difference is
5868: never explicit, unfortunately).
1.1 dsieger 5869:
1.184 rillig 5870: 20.2.3. Patching installations
1.1 dsieger 5871:
1.184 rillig 5872: As said before, pkginstall automatically handles configuration files. This
5873: means that the packages themselves must not touch the contents of $
5874: {PKG_SYSCONFDIR} directly. Bad news is that many software installation scripts
5875: will, out of the box, mess with the contents of that directory. So what is the
5876: correct procedure to fix this issue?
1.1 dsieger 5877:
1.184 rillig 5878: You must teach the package (usually by manually patching it) to install any
5879: configuration files under the examples hierarchy, share/examples/${PKGBASE}/.
5880: This way, the PLIST registers them and the administrator always has the
5881: original copies available.
1.1 dsieger 5882:
1.184 rillig 5883: Once the required configuration files are in place (i.e., under the examples
5884: hierarchy), the pkginstall framework can use them as master copies during the
5885: package installation to update what is in ${PKG_SYSCONFDIR}. To achieve this,
5886: the variables CONF_FILES and CONF_FILES_PERMS are used. Check out
5887: Section 20.1.2, "File manipulation" for information about their syntax and
5888: their purpose. Here is an example, taken from the mail/mutt package:
1.1 dsieger 5889:
1.184 rillig 5890: EGDIR= ${PREFIX}/share/doc/mutt/samples
5891: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 dsieger 5892:
1.184 rillig 5893: Note that the EGDIR variable is specific to that package and has no meaning
5894: outside it.
1.1 dsieger 5895:
1.184 rillig 5896: 20.2.4. Disabling handling of configuration files
1.1 dsieger 5897:
1.184 rillig 5898: The automatic copying of config files can be toggled by setting the environment
5899: variable PKG_CONFIG prior to package installation.
1.1 dsieger 5900:
1.184 rillig 5901: 20.3. System startup scripts
1.1 dsieger 5902:
1.184 rillig 5903: System startup scripts are special files because they must be installed in a
5904: place known by the underlying OS, usually outside the installation prefix.
5905: Therefore, the same rules described in Section 20.1, "Files and directories
5906: outside the installation prefix" apply, and the same solutions can be used.
5907: However, pkginstall provides a special mechanism to handle these files.
1.1 dsieger 5908:
1.184 rillig 5909: In order to provide system startup scripts, the package has to:
1.1 dsieger 5910:
1.184 rillig 5911: 1. Store the script inside ${FILESDIR}, with the .sh suffix appended.
5912: Considering the print/cups package as an example, it has a cupsd.sh in its
5913: files directory.
1.95 wiz 5914:
1.184 rillig 5915: 2. Tell pkginstall to handle it, appending the name of the script, without its
5916: extension, to the RCD_SCRIPTS variable. Continuing the previous example:
1.95 wiz 5917:
1.184 rillig 5918: RCD_SCRIPTS+= cupsd
1.95 wiz 5919:
1.184 rillig 5920: Once this is done, pkginstall will do the following steps for each script in an
5921: automated fashion:
1.95 wiz 5922:
1.184 rillig 5923: 1. Process the file found in the files directory applying all the
5924: substitutions described in the FILES_SUBST variable.
1.1 dsieger 5925:
1.184 rillig 5926: 2. Copy the script from the files directory to the examples hierarchy, $
5927: {PREFIX}/share/examples/rc.d/. Note that this master file must be
5928: explicitly registered in the PLIST.
1.1 dsieger 5929:
1.184 rillig 5930: 3. Add code to the installation scripts to copy the startup script from the
5931: examples hierarchy into the system-wide startup scripts directory.
1.1 dsieger 5932:
1.184 rillig 5933: 20.3.1. Disabling handling of system startup scripts
1.1 dsieger 5934:
1.184 rillig 5935: The automatic copying of config files can be toggled by setting the environment
5936: variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts
5937: will be always copied inside the examples hierarchy, ${PREFIX}/share/examples/
5938: rc.d/, no matter what the value of this variable is.
1.1 dsieger 5939:
1.184 rillig 5940: 20.4. System users and groups
1.1 dsieger 5941:
1.184 rillig 5942: If a package needs to create special users and/or groups during installation,
5943: it can do so by using the pkginstall framework.
1.1 dsieger 5944:
1.184 rillig 5945: Users can be created by adding entries to the PKG_USERS variable. Each entry
5946: has the following syntax:
1.1 dsieger 5947:
1.184 rillig 5948: user:group
1.1 dsieger 5949:
1.184 rillig 5950: Further specification of user details may be done by setting per-user
5951: variables. PKG_UID.user is the numeric UID for the user. PKG_GECOS.user is the
5952: user's description or comment. PKG_HOME.user is the user's home directory, and
5953: defaults to /nonexistent if not specified. PKG_SHELL.user is the user's shell,
5954: and defaults to /sbin/nologin if not specified.
1.1 dsieger 5955:
1.184 rillig 5956: Similarly, groups can be created by adding entries to the PKG_GROUPS variable,
5957: whose syntax is:
1.1 dsieger 5958:
1.184 rillig 5959: group
1.1 dsieger 5960:
1.184 rillig 5961: The numeric GID of the group may be set by defining PKG_GID.group.
1.1 dsieger 5962:
1.184 rillig 5963: If a package needs to create the users and groups at an earlier stage, then it
5964: can set USERGROUP_PHASE to either configure,build, or pre-install to indicate
5965: the phase before which the users and groups are created. In this case, the
5966: numeric UIDs and GIDs of the created users and groups are automatically
5967: hardcoded into the final installation scripts.
1.1 dsieger 5968:
1.184 rillig 5969: 20.5. System shells
1.1 dsieger 5970:
1.184 rillig 5971: Packages that install system shells should register them in the shell database,
5972: /etc/shells, to make things easier to the administrator. This must be done from
5973: the installation scripts to keep binary packages working on any system.
5974: pkginstall provides an easy way to accomplish this task.
1.1 dsieger 5975:
1.184 rillig 5976: When a package provides a shell interpreter, it has to set the PKG_SHELL
5977: variable to its absolute file name. This will add some hooks to the
5978: installation scripts to handle it. Consider the following example, taken from
5979: shells/zsh:
1.1 dsieger 5980:
1.184 rillig 5981: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 dsieger 5982:
1.184 rillig 5983: 20.5.1. Disabling shell registration
1.1 dsieger 5984:
1.184 rillig 5985: The automatic registration of shell interpreters can be disabled by the
5986: administrator by setting the PKG_REGISTER_SHELLS environment variable to NO.
1.1 dsieger 5987:
1.184 rillig 5988: 20.6. Fonts
1.1 dsieger 5989:
1.184 rillig 5990: Packages that install X11 fonts should update the database files that index the
5991: fonts within each fonts directory. This can easily be accomplished within the
5992: pkginstall framework.
1.1 dsieger 5993:
1.184 rillig 5994: When a package installs X11 fonts, it must list the directories in which fonts
5995: are installed in the FONTS_DIRS.type variables, where type can be one of "ttf",
5996: "type1" or "x11". This will add hooks to the installation scripts to run the
5997: appropriate commands to update the fonts database files within each of those
5998: directories. For convenience, if the directory path is relative, it is taken to
5999: be relative to the package's installation prefix. Consider the following
6000: example, taken from fonts/dbz-ttf:
1.1 dsieger 6001:
1.184 rillig 6002: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 6003:
1.184 rillig 6004: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 6005:
1.184 rillig 6006: The automatic update of fonts databases can be disabled by the administrator by
6007: setting the PKG_UPDATE_FONTS_DB environment variable to NO.
1.1 dsieger 6008:
1.154 rillig 6009: Chapter 21. Making your package work
1.1 dsieger 6010:
6011: Table of Contents
6012:
1.154 rillig 6013: 21.1. General operation
1.1 dsieger 6014:
1.154 rillig 6015: 21.1.1. How to pull in user-settable variables from mk.conf
6016: 21.1.2. User interaction
6017: 21.1.3. Handling licenses
6018: 21.1.4. Restricted packages
6019: 21.1.5. Handling dependencies
6020: 21.1.6. Handling conflicts with other packages
6021: 21.1.7. Packages that cannot or should not be built
6022: 21.1.8. Packages which should not be deleted, once installed
6023: 21.1.9. Handling packages with security problems
6024: 21.1.10. How to handle incrementing versions when fixing an existing
1.1 dsieger 6025: package
1.154 rillig 6026: 21.1.11. Substituting variable text in the package files (the SUBST
1.1 dsieger 6027: framework)
6028:
1.154 rillig 6029: 21.2. The fetch phase
1.1 dsieger 6030:
1.154 rillig 6031: 21.2.1. Packages whose distfiles aren't available for plain downloading
6032: 21.2.2. How to handle modified distfiles with the 'old' name
6033: 21.2.3. Packages hosted on github.com
6034:
6035: 21.3. The configure phase
6036:
6037: 21.3.1. Shared libraries - libtool
6038: 21.3.2. Using libtool on GNU packages that already support libtool
6039: 21.3.3. GNU Autoconf/Automake
6040:
6041: 21.4. Programming languages
6042:
6043: 21.4.1. C, C++, and Fortran
6044: 21.4.2. Java
1.205 ! wiz 6045: 21.4.3. Go
! 6046: 21.4.4. Packages containing Perl scripts
! 6047: 21.4.5. Packages containing shell scripts
! 6048: 21.4.6. Other programming languages
1.154 rillig 6049:
6050: 21.5. The build phase
6051:
6052: 21.5.1. Compiling C and C++ code conditionally
6053: 21.5.2. How to handle compiler bugs
1.172 rillig 6054: 21.5.3. No such file or directory
6055: 21.5.4. Undefined reference to "..."
6056: 21.5.5. Running out of memory
1.154 rillig 6057:
6058: 21.6. The install phase
6059:
6060: 21.6.1. Creating needed directories
6061: 21.6.2. Where to install documentation
6062: 21.6.3. Installing highscore files
6063: 21.6.4. Adding DESTDIR support to packages
6064: 21.6.5. Packages with hardcoded paths to other interpreters
1.203 nia 6065: 21.6.6. Packages installing Perl modules
1.154 rillig 6066: 21.6.7. Packages installing info files
6067: 21.6.8. Packages installing man pages
1.203 nia 6068: 21.6.9. Packages installing X11 fonts
6069: 21.6.10. Packages installing SGML or XML data
6070: 21.6.11. Packages installing extensions to the MIME database
6071: 21.6.12. Packages using intltool
6072: 21.6.13. Packages installing startup scripts
6073: 21.6.14. Packages installing TeX modules
6074: 21.6.15. Packages supporting running binaries in emulation
6075: 21.6.16. Packages installing hicolor icons
6076: 21.6.17. Packages installing desktop files
1.1 dsieger 6077:
1.154 rillig 6078: 21.7. Marking packages as having problems
1.1 dsieger 6079:
1.154 rillig 6080: 21.1. General operation
1.1 dsieger 6081:
6082: One appealing feature of pkgsrc is that it runs on many different platforms. As
6083: a result, it is important to ensure, where possible, that packages in pkgsrc
6084: are portable. This chapter mentions some particular details you should pay
6085: attention to while working on pkgsrc.
6086:
1.154 rillig 6087: 21.1.1. How to pull in user-settable variables from mk.conf
1.1 dsieger 6088:
6089: The pkgsrc user can configure pkgsrc by overriding several variables in the
1.4 rillig 6090: file pointed to by MAKECONF, which is mk.conf by default. When you want to use
6091: those variables in the preprocessor directives of make(1) (for example .if or
6092: .for), you need to include the file ../../mk/bsd.prefs.mk before, which in turn
6093: loads the user preferences.
1.1 dsieger 6094:
6095: But note that some variables may not be completely defined after ../../mk/
6096: bsd.prefs.mk has been included, as they may contain references to variables
1.108 rillig 6097: that are not yet defined. In shell commands (the lines in Makefile that are
6098: indented with a tab) this is no problem, since variables are only expanded when
6099: they are used. But in the preprocessor directives mentioned above and in
6100: dependency lines (of the form target: dependencies) the variables are expanded
6101: at load time.
1.1 dsieger 6102:
6103: Note
6104:
1.108 rillig 6105: To check whether a variable can be used at load time, run pkglint -Wall on your
6106: package.
1.1 dsieger 6107:
1.154 rillig 6108: 21.1.2. User interaction
1.1 dsieger 6109:
6110: Occasionally, packages require interaction from the user, and this can be in a
6111: number of ways:
6112:
6113: * When fetching the distfiles, some packages require user interaction such as
6114: entering username/password or accepting a license on a web page.
6115:
6116: * When extracting the distfiles, some packages may ask for passwords.
6117:
6118: * help to configure the package before it is built
6119:
6120: * help during the build process
6121:
6122: * help during the installation of a package
6123:
1.108 rillig 6124: A package can set the INTERACTIVE_STAGE variable to define which stages need
6125: interaction. This should be done in the package's Makefile, e.g.:
1.1 dsieger 6126:
6127: INTERACTIVE_STAGE= configure install
6128:
6129: The user can then decide to skip this package by setting the BATCH variable.
1.108 rillig 6130: Packages that require interaction are also excluded from bulk builds.
1.1 dsieger 6131:
1.154 rillig 6132: 21.1.3. Handling licenses
1.1 dsieger 6133:
6134: Authors of software can choose the licence under which software can be copied.
1.111 sevan 6135: The Free Software Foundation has declared some licenses "Free", and the Open
6136: Source Initiative has a definition of "Open Source".
6137:
6138: By default, pkgsrc allows packages with Free or Open Source licenses to be
6139: built. To allow packages with other licenses to be built as well, the pkgsrc
6140: user needs to add these licenses to the ACCEPTABLE_LICENSES variable in mk.conf
6141: . Note that this variable only affects which packages may be built, while the
6142: license terms often also restrict the actual use of the package and its
6143: redistribution.
1.1 dsieger 6144:
6145: One might want to only install packages with a BSD license, or the GPL, and not
1.20 jnemeth 6146: the other. The free licenses are added to the default ACCEPTABLE_LICENSES
1.111 sevan 6147: variable. The pkgsrc user can override the default by setting the
6148: ACCEPTABLE_LICENSES variable with "=" instead of "+=". The licenses accepted by
6149: default are defined in the DEFAULT_ACCEPTABLE_LICENSES variable in the file
6150: pkgsrc/mk/license.mk.
1.1 dsieger 6151:
6152: The license tag mechanism is intended to address copyright-related issues
6153: surrounding building, installing and using a package, and not to address
1.20 jnemeth 6154: redistribution issues (see RESTRICTED and NO_SRC_ON_FTP, etc.). Packages with
6155: redistribution restrictions should set these tags.
1.1 dsieger 6156:
6157: Denoting that a package may be copied according to a particular license is done
6158: by placing the license in pkgsrc/licenses and setting the LICENSE variable to a
6159: string identifying the license, e.g. in graphics/xv:
6160:
6161: LICENSE= xv-license
6162:
6163: When trying to build, the user will get a notice that the package is covered by
6164: a license which has not been placed in the ACCEPTABLE_LICENSES variable:
6165:
6166: % make
6167: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6168: ===> To view the license, enter "/usr/bin/make show-license".
6169: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6170: ===> ACCEPTABLE_LICENSES+=xv-license
6171: *** Error code 1
6172:
6173: The license can be viewed with make show-license, and if the user so chooses,
1.4 rillig 6174: the line printed above can be added to mk.conf to convey to pkgsrc that it
1.1 dsieger 6175: should not in the future fail because of that license:
6176:
6177: ACCEPTABLE_LICENSES+=xv-license
6178:
1.111 sevan 6179: The use of LICENSE=shareware, LICENSE=no-commercial-use, and similar language
6180: is deprecated because it does not crisply refer to a particular license text.
6181: Another problem with such usage is that it does not enable a user to tell
6182: pkgsrc to proceed for a single package without also telling pkgsrc to proceed
6183: for all packages with that tag.
6184:
1.154 rillig 6185: 21.1.3.1. Adding a package with a new license
1.1 dsieger 6186:
1.49 rodent 6187: When adding a package with a new license, the following steps are required:
6188:
1.111 sevan 6189: 1. Check whether the license qualifies as Free or Open Source by referencing
6190: Various Licenses and Comments about Them and Licenses by Name | Open Source
6191: Initiative. If this is the case, the filename in pkgsrc/licenses/ does not
6192: need the -license suffix, and the license name should be added to:
1.49 rodent 6193:
6194: + DEFAULT_ACCEPTABLE_LICENSES in pkgsrc/mk/license.mk
6195:
6196: + default_acceptable_licenses in pkgsrc/pkgtools/pkg_install/files/lib/
6197: license.c
6198:
6199: 2. The license text should be added to pkgsrc/licenses for displaying. A list
6200: of known licenses can be seen in this directory.
1.1 dsieger 6201:
1.154 rillig 6202: 21.1.3.2. Change to the license
1.1 dsieger 6203:
1.111 sevan 6204: When the license changes (in a way other than formatting), make sure that the
6205: new license has a different name (e.g., append the version number if it exists,
6206: or the date). Just because a user told pkgsrc to build programs under a
6207: previous version of a license does not mean that pkgsrc should build programs
6208: under the new licenses. The higher-level point is that pkgsrc does not evaluate
6209: licenses for reasonableness; the only test is a mechanistic test of whether a
6210: particular text has been approved by either of two bodies (FSF or OSI).
1.1 dsieger 6211:
1.154 rillig 6212: 21.1.4. Restricted packages
1.1 dsieger 6213:
1.111 sevan 6214: Some licenses restrict how software may be re-distributed. By declaring the
6215: restrictions, package tools can automatically refrain from e.g. placing binary
6216: packages on FTP sites.
6217:
6218: There are four possible restrictions, which are the cross product of sources
6219: (distfiles) and binaries not being placed on FTP sites and CD-ROMs. Because
6220: this is rarely the exact language in any license, and because non-Free licenses
6221: tend to be different from each other, pkgsrc adopts a definition of FTP and
6222: CD-ROM. "FTP" means making the source or binary file available over the
6223: Internet at no charge. "CD-ROM" means making the source or binary available on
6224: some kind of media, together with other source and binary packages, which is
6225: sold for a distribution charge.
1.1 dsieger 6226:
6227: In order to encode these restrictions, the package system defines five make
6228: variables that can be set to note these restrictions:
6229:
6230: * RESTRICTED
6231:
6232: This variable should be set whenever a restriction exists (regardless of
6233: its kind). Set this variable to a string containing the reason for the
6234: restriction. It should be understood that those wanting to understand the
6235: restriction will have to read the license, and perhaps seek advice of
6236: counsel.
6237:
6238: * NO_BIN_ON_CDROM
6239:
6240: Binaries may not be placed on CD-ROM containing other binary packages, for
6241: which a distribution charge may be made. In this case, set this variable to
6242: ${RESTRICTED}.
6243:
6244: * NO_BIN_ON_FTP
6245:
6246: Binaries may not made available on the Internet without charge. In this
6247: case, set this variable to ${RESTRICTED}. If this variable is set, binary
6248: packages will not be included on ftp.NetBSD.org.
6249:
6250: * NO_SRC_ON_CDROM
6251:
6252: Distfiles may not be placed on CD-ROM, together with other distfiles, for
6253: which a fee may be charged. In this case, set this variable to $
6254: {RESTRICTED}.
6255:
6256: * NO_SRC_ON_FTP
6257:
6258: Distfiles may not made available via FTP at no charge. In this case, set
6259: this variable to ${RESTRICTED}. If this variable is set, the distfile(s)
6260: will not be mirrored on ftp.NetBSD.org.
6261:
1.111 sevan 6262: Please note that packages will be removed from pkgsrc when the distfiles are
1.33 wiz 6263: not distributable and cannot be obtained for a period of one full quarter
1.111 sevan 6264: branch. Packages with manual/interactive fetch must have a maintainer and it is
6265: his/her responsibility to ensure this.
1.33 wiz 6266:
1.154 rillig 6267: 21.1.5. Handling dependencies
1.1 dsieger 6268:
1.175 gutterid 6269: Your package may depend on some other package being present, and there are
6270: various ways of expressing this dependency. pkgsrc supports the DEPENDS,
6271: BUILD_DEPENDS, TOOL_DEPENDS, and TEST_DEPENDS definitions, the USE_TOOLS
6272: definition, as well as dependencies via buildlink3.mk, which is the preferred
6273: way to handle dependencies, and which uses the variables named above. See
1.184 rillig 6274: Chapter 18, Buildlink methodology for more information.
1.175 gutterid 6275:
6276: The basic difference is that the DEPENDS definition registers that
6277: pre-requisite in the binary package so it will be pulled in when the binary
6278: package is later installed, whilst the BUILD_DEPENDS, TOOL_DEPENDS, and
6279: TEST_DEPENDS definitions do not, marking a dependency that is only needed for
1.184 rillig 6280: building or testing the resulting package. See also Chapter 14, Creating a new
1.175 gutterid 6281: pkgsrc package from scratch for more information.
6282:
6283: This means that if you only need a package present whilst you are building or
6284: testing, it should be noted as a TOOL_DEPENDS, BUILD_DEPENDS, or TEST_DEPENDS.
6285: When cross-compiling, TOOL_DEPENDS are native packages, i.e. packages for the
6286: architecture where the package is built; BUILD_DEPENDS are target packages,
6287: i.e., packages for the architecture for which the package is built.
1.1 dsieger 6288:
1.175 gutterid 6289: The format for a DEPENDS, BUILD_DEPENDS, TOOL_DEPENDS, and TEST_DEPENDS
6290: definition is:
1.1 dsieger 6291:
6292: <pre-req-package-name>:../../<category>/<pre-req-package>
6293:
6294: Please note that the "pre-req-package-name" may include any of the wildcard
6295: version numbers recognized by pkg_info(1).
6296:
1.55 wiz 6297: 1. If your package needs another package's binaries or libraries to build and
1.1 dsieger 6298: run, and if that package has a buildlink3.mk file available, use it:
6299:
6300: .include "../../graphics/jpeg/buildlink3.mk"
6301:
1.55 wiz 6302: 2. If your package needs another package's binaries or libraries only for
6303: building, and if that package has a buildlink3.mk file available, use it:
6304:
6305: .include "../../graphics/jpeg/buildlink3.mk"
6306:
6307: but set BUILDLINK_DEPMETHOD.jpeg?=build to make it a build dependency only.
6308: This case is rather rare.
6309:
6310: 3. If your package needs binaries from another package to build, use the
1.156 leot 6311: TOOL_DEPENDS definition:
6312:
6313: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.1 dsieger 6314:
1.156 leot 6315: 4. If your package needs static libraries to link against, header files to
6316: include, etc. from another package to build, use the BUILD_DEPENDS
6317: definition.
1.1 dsieger 6318:
1.156 leot 6319: 5. If your package needs a library with which to link and there is no
1.26 spz 6320: buildlink3.mk file available, create one. Using DEPENDS won't be sufficient
6321: because the include files and libraries will be hidden from the compiler.
1.1 dsieger 6322:
1.156 leot 6323: 6. If your package needs some executable to be able to run correctly and if
1.26 spz 6324: there's no buildlink3.mk file, this is specified using the DEPENDS
6325: variable. The print/lyx package needs to be able to execute the latex
1.129 wiz 6326: binary from the tex-latex-bin package when it runs, and that is specified:
1.1 dsieger 6327:
1.129 wiz 6328: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.1 dsieger 6329:
1.175 gutterid 6330: 7. If your package includes a test suite that has extra dependencies only
6331: required for this purpose (frequently this can be run as a "make test"
6332: target), use the TEST_DEPENDS variable.
6333:
6334: 8. You can use wildcards in package dependencies. Note that such wildcard
1.26 spz 6335: dependencies are retained when creating binary packages. The dependency is
6336: checked when installing the binary package and any package which matches
6337: the pattern will be used. Wildcard dependencies should be used with care.
1.1 dsieger 6338:
6339: The "-[0-9]*" should be used instead of "-*" to avoid potentially ambiguous
6340: matches such as "tk-postgresql" matching a "tk-*" DEPENDS.
6341:
6342: Wildcards can also be used to specify that a package will only build
6343: against a certain minimum version of a pre-requisite:
6344:
1.26 spz 6345: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 6346:
1.26 spz 6347: This means that the package will build using version 6.0 of ImageMagick or
6348: newer. Such a dependency may be warranted if, for example, the command line
6349: options of an executable have changed.
6350:
1.183 wiz 6351: If you need to depend on minimum versions of libraries, set
6352: BUILDLINK_API_DEPENDS.pkg to the appropriate pattern before including its
6353: buildlink3.mk file, e.g.
6354:
6355: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
6356: .include "../../graphics/jpeg/buildlink3.mk"
1.1 dsieger 6357:
6358: For security fixes, please update the package vulnerabilities file. See
1.154 rillig 6359: Section 21.1.9, "Handling packages with security problems" for more
1.1 dsieger 6360: information.
6361:
6362: If your package needs files from another package to build, add the relevant
6363: distribution files to DISTFILES, so they will be extracted automatically. See
6364: the print/ghostscript package for an example. (It relies on the jpeg sources
6365: being present in source form during the build.)
6366:
1.154 rillig 6367: 21.1.6. Handling conflicts with other packages
1.1 dsieger 6368:
6369: Your package may conflict with other packages a user might already have
6370: installed on his system, e.g. if your package installs the same set of files as
1.80 wiz 6371: another package in the pkgsrc tree or has the same PKGNAME.
1.1 dsieger 6372:
1.142 leot 6373: For example, x11/libXaw3d and x11/Xaw-Xpm install the same shared library, thus
6374: you set in pkgsrc/x11/libXaw3d/Makefile:
1.1 dsieger 6375:
1.142 leot 6376: CONFLICTS= Xaw-Xpm-[0-9]*
1.1 dsieger 6377:
6378:
1.142 leot 6379: and in pkgsrc/x11/Xaw-Xpm/Makefile:
1.1 dsieger 6380:
1.142 leot 6381: CONFLICTS= libXaw3d-[0-9]*
1.1 dsieger 6382:
1.142 leot 6383:
6384: pkg_add(1) is able to detect attempts to install packages that conflict with
6385: existing packages and abort. However, in many situations this is too late in
6386: the process. Binary package managers will not know about the conflict until
6387: they attempt to install the package after already downloading it and all its
6388: dependencies. Users may also waste time building a package and its dependencies
6389: only to find out at the end that it conflicts with another package they have
6390: installed.
6391:
6392: To avoid these issues CONFLICTS entries should be added in all cases where it
6393: is known that packages conflict with each other. These CONFLICTS entries are
6394: exported in pkg_summary(5) files and consumed by binary package managers to
6395: inform users that packages cannot be installed onto the target system.
1.1 dsieger 6396:
1.154 rillig 6397: 21.1.7. Packages that cannot or should not be built
1.1 dsieger 6398:
6399: There are several reasons why a package might be instructed to not build under
6400: certain circumstances. If the package builds and runs on most platforms, the
1.83 dholland 6401: exceptions should be noted with BROKEN_ON_PLATFORM. If the package builds and
6402: runs on a small handful of platforms, set BROKEN_EXCEPT_ON_PLATFORM instead.
6403: Both BROKEN_ON_PLATFORM and BROKEN_EXCEPT_ON_PLATFORM are OS triples
6404: (OS-version-platform) that can use glob-style wildcards.
6405:
1.114 maya 6406: If a package is not appropriate for some platforms (as opposed to merely
1.83 dholland 6407: broken), a different set of variables should be used as this affects failure
6408: reporting and statistics. If the package is appropriate for most platforms, the
6409: exceptions should be noted with NOT_FOR_PLATFORM. If the package is appropriate
6410: for only a small handful of platforms (often exactly one), set
6411: ONLY_FOR_PLATFORM instead. Both ONLY_FOR_PLATFORM and NOT_FOR_PLATFORM are OS
6412: triples (OS-version-platform) that can use glob-style wildcards.
1.1 dsieger 6413:
6414: Some packages are tightly bound to a specific version of an operating system,
6415: e.g. LKMs or sysutils/lsof. Such binary packages are not backwards compatible
6416: with other versions of the OS, and should be uploaded to a version specific
6417: directory on the FTP server. Mark these packages by setting OSVERSION_SPECIFIC
6418: to "yes". This variable is not currently used by any of the package system
6419: internals, but may be used in the future.
6420:
6421: If the package should be skipped (for example, because it provides
6422: functionality already provided by the system), set PKG_SKIP_REASON to a
6423: descriptive message. If the package should fail because some preconditions are
6424: not met, set PKG_FAIL_REASON to a descriptive message.
6425:
1.154 rillig 6426: 21.1.8. Packages which should not be deleted, once installed
1.1 dsieger 6427:
6428: To ensure that a package may not be deleted, once it has been installed, the
6429: PKG_PRESERVE definition should be set in the package Makefile. This will be
1.25 wiz 6430: carried into any binary package that is made from this pkgsrc entry. A "
6431: preserved" package will not be deleted using pkg_delete(1) unless the "-f"
1.1 dsieger 6432: option is used.
6433:
1.154 rillig 6434: 21.1.9. Handling packages with security problems
1.1 dsieger 6435:
6436: When a vulnerability is found, this should be noted in localsrc/security/
1.205 ! wiz 6437: advisories/pkg-vulnerabilities. Entries in that file consist of three parts:
! 6438:
! 6439: * package version pattern
! 6440:
! 6441: * type of vulnerability (please cut'n'paste an existing one where possible)
! 6442:
! 6443: * URL providing additional information about the issue
! 6444:
! 6445: For the package version pattern please always use `<' to mark an upper bound
! 6446: (not `<='!). This will avoid possible problems due unrelated PKGREVISION bumps
! 6447: not related to security fixes. Lower bounds can be added too, using '>' or '>=
! 6448: '. For example, "foo>'=1<1.2" would mark versions 1.0 (included) to 1.2
! 6449: (excluded) of "foo" as affected by the security issue.
! 6450:
! 6451: Entries should always be added at the bottom of the file.
! 6452:
! 6453: When fixing packages, please modify the upper bound of the corresponding entry.
! 6454: To continue the previous example, if a fix was backported to version 1.1nb2,
! 6455: change the previous pattern to "foo>'=1<1.1nb2".
! 6456:
! 6457: To locally test a package version pattern against a PKGNAME you can use the
! 6458: pkg_admin pmatch command.
! 6459:
! 6460: The URL should be as permanent as possible and provide as much information
! 6461: about the issue as possible. CVE entries are preferred.
! 6462:
! 6463: After committing that file, ask pkgsrc-security@NetBSD.org to update the file
! 6464: on ftp.NetBSD.org.
1.1 dsieger 6465:
6466: After fixing the vulnerability by a patch, its PKGREVISION should be increased
6467: (this is of course not necessary if the problem is fixed by using a newer
1.32 wiz 6468: release of the software), and the pattern in the pkg-vulnerabilities file must
6469: be updated.
1.1 dsieger 6470:
6471: Also, if the fix should be applied to the stable pkgsrc branch, be sure to
6472: submit a pullup request!
6473:
6474: Binary packages already on ftp.NetBSD.org will be handled semi-automatically by
6475: a weekly cron job.
6476:
1.205 ! wiz 6477: In case a security issue is disputed, please contact
! 6478: pkgsrc-security@NetBSD.org.
! 6479:
1.154 rillig 6480: 21.1.10. How to handle incrementing versions when fixing an existing package
1.1 dsieger 6481:
6482: When making fixes to an existing package it can be useful to change the version
6483: number in PKGNAME. To avoid conflicting with future versions by the original
6484: author, a "nb1", "nb2", ... suffix can be used on package versions by setting
6485: PKGREVISION=1 (2, ...). The "nb" is treated like a "." by the package tools.
6486: e.g.
6487:
6488: DISTNAME= foo-17.42
6489: PKGREVISION= 9
6490:
6491: will result in a PKGNAME of "foo-17.42nb9". If you want to use the original
6492: value of PKGNAME without the "nbX" suffix, e.g. for setting DIST_SUBDIR, use
6493: PKGNAME_NOREV.
6494:
6495: When a new release of the package is released, the PKGREVISION should be
6496: removed, e.g. on a new minor release of the above package, things should be
6497: like:
6498:
6499: DISTNAME= foo-17.43
6500:
6501: PKGREVISION should be incremented for any non-trivial change in the resulting
6502: binary package. Without a PKGREVISION bump, someone with the previous version
6503: installed has no way of knowing that their package is out of date. Thus,
6504: changes without increasing PKGREVISION are essentially labeled "this is so
6505: trivial that no reasonable person would want to upgrade", and this is the rough
6506: test for when increasing PKGREVISION is appropriate. Examples of changes that
6507: do not merit increasing PKGREVISION are:
6508:
1.14 jmcneill 6509: * Changing HOMEPAGE, MAINTAINER, OWNER, or comments in Makefile.
1.1 dsieger 6510:
6511: * Changing build variables if the resulting binary package is the same.
6512:
6513: * Changing DESCR.
6514:
6515: * Adding PKG_OPTIONS if the default options don't change.
6516:
6517: Examples of changes that do merit an increase to PKGREVISION include:
6518:
6519: * Security fixes
6520:
6521: * Changes or additions to a patch file
6522:
6523: * Changes to the PLIST
6524:
1.12 weinem 6525: * A dependency is changed or renamed.
6526:
1.1 dsieger 6527: PKGREVISION must also be incremented when dependencies have ABI changes.
6528:
1.154 rillig 6529: 21.1.11. Substituting variable text in the package files (the SUBST framework)
1.1 dsieger 6530:
1.180 rillig 6531: When you want to replace the same text in multiple files, or multiple times in
6532: the same file, it is cumbersome to maintain a patch file for this. This is
6533: where the SUBST framework steps in. It provides an easy-to-use interface for
6534: replacing text in files. It just needs the following information:
1.172 rillig 6535:
1.180 rillig 6536: * In which phase of the package build cycle should the replacement happen?
1.172 rillig 6537:
1.180 rillig 6538: * In which files should the replacement happen?
1.172 rillig 6539:
6540: * Which text should be replaced with what?
6541:
1.180 rillig 6542: This information is encoded in a block of SUBST variables. A minimal example
6543: is:
6544:
6545: SUBST_CLASSES+= paths
6546: SUBST_STAGE.paths= pre-configure
6547: SUBST_FILES.paths= src/*.c
6548: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
6549:
6550: Translated into English, it means: In the pre-configure stage (that is, after
6551: applying the patches from the patches/ directory and before running the
6552: configure script and the portability check), replace the text /usr/local with
6553: the content of the variable PREFIX.
6554:
6555: Each SUBST block starts by appending an identifier to SUBST_CLASSES (note the +
6556: =). This identifier can be chosen freely by the package. If there should ever
6557: be duplicate identifiers, the pkgsrc infrastructure will catch this and fail
6558: early, so don't worry about name collisions.
6559:
6560: Except for SUBST_CLASSES, all variables in a SUBST block are parameterized
6561: using this identifier. In the remainder of this section, these parameterized
6562: variables are written as SUBST_STAGE.*.
6563:
6564: SUBST_CLASSES+= paths
6565: SUBST_STAGE.paths= pre-configure
6566: SUBST_MESSAGE.paths= Fixing absolute paths.
6567: SUBST_FILES.paths= src/*.c
6568: SUBST_FILES.paths+= scripts/*.sh
6569: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
6570: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
6571: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
6572:
6573: To get a complete picture about the SUBST substitutions, run bmake
6574: show-all-subst. If something doesn't work as expected, run pkglint on the
6575: package, which detects several typical mistakes surrounding the SUBST blocks.
6576: For any questions that might remain after this, have a look at mk/subst.mk.
6577:
6578: 21.1.11.1. Choosing the time where the substitutions happen
6579:
6580: The SUBST_STAGE.* is one of {pre,do,post}-
6581: {extract,patch,configure,build,test,install}. Of these, pre-configure is used
6582: most often, by far. The most popular stages are, in chronological order:
6583:
6584: post-extract
6585:
6586: The substitutions are applied immediately after the distfiles are
6587: extracted. Running bmake extract on the package will leave no traces of the
6588: original files.
6589:
6590: When the substitution applies to files for which there is also a patch in
6591: the patches/ directory, this means that the patches will be computed based
6592: on the result of the substitution. When these patches are sent to the
6593: upstream maintainer later, to be fixed in the upstream package, these
6594: patches may no longer match what the upstream author is used to. Because of
6595: this, pre-configure is often a better choice.
6596:
6597: pre-configure
6598:
6599: The substitutions are applied after the patches from the patches/
6600: directory. This makes it possible to run bmake patch on the package, after
6601: which the patches can be edited using the tools pkgvi and mkpatches from
6602: the pkgtools/pkgdiff package.
6603:
6604: When updating the patches, it is helpful to explicitly separate the bmake
6605: patch from the bmake configure, and to only edit the patches between these
6606: commands. Otherwise the substitutions from the SUBST block will end up in
6607: the patch file. When this happens in really obvious ways, pkglint will
6608: complain about patches that contain a hard-coded /usr/pkg instead of the
6609: correct and intended @PREFIX@, but it can only detect these really obvious
6610: cases.
6611:
6612: do-configure
6613:
6614: This stage should only be used if the package defines a pre-configure
6615: action itself, and the substitution must happen after that. Typical
6616: examples are packages that use the pre-configure stage to regenerate the
6617: GNU configure script from configure.ac.
6618:
6619: post-configure
6620:
6621: This stage is used to fix up any mistakes by the configure stage.
6622:
6623: pre-build
6624:
6625: This stage should only be used for substitutions that are clearly related
6626: to building the package, not for fixing the configuration. Substitutions
6627: for pathnames (such as replacing /usr/local with ${PREFIX}) or user names
6628: (such as replacing @MY_USER@ with the actual username) belong in
6629: pre-configure or post-configure instead.
6630:
6631: post-build
6632:
6633: Just as with pre-build, this stage should only be used for substitutions
6634: that are clearly related to building the package, not for fixing the
6635: configuration. Substitutions for pathnames (such as replacing /usr/local
6636: with ${PREFIX}) or user names (such as replacing @MY_USER@ with the actual
6637: username) belong in pre-configure or post-configure instead.
6638:
6639: A typical use is to update pkg-config files to include the rpath compiler
6640: options.
6641:
6642: pre-install
6643:
6644: In general, the install phase should be as simple as possible. As with the
6645: pre-build and post-build stages, it should not be used to fix pathnames or
6646: user names, these belong in pre-configure instead. There are only few
6647: legitimate use cases for applying substitutions in this stage.
6648:
1.181 rillig 6649: 21.1.11.2. Choosing the files where the substitutions happen
1.180 rillig 6650:
6651: The SUBST_FILES.* variable contains a list of filename patterns. These patterns
6652: are relative to WRKSRC since that is where most substitutions happen. A typical
6653: example is:
6654:
6655: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
6656:
6657: The above patterns, especially the last, are quite broad. The SUBST
6658: implementation checks that each filename pattern that is mentioned here has an
6659: effect. For example, if none of the */*/Makefile files contains the patterns to
6660: be found and substituted, that filename pattern is redundant and should be left
1.181 rillig 6661: out. By default, the SUBST framework will complain with an error message. If
6662: the text to be substituted occurs in some of the files from a single pattern,
6663: but not in all of them, that is totally ok, and the SUBST framework will only
6664: print an INFO message for those files.
1.180 rillig 6665:
6666: If there is a good reason for having redundant filename patterns, set
1.181 rillig 6667: SUBST_NOOP_OK.* to yes.
1.180 rillig 6668:
6669: Another popular way of choosing the files for the substitutions is via a shell
6670: command, like this:
6671:
1.181 rillig 6672: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 6673: SUBST_FILES.path= ${C_FILES_CMD:sh}
6674:
6675: The variable name C_FILES_CMD in this example is freely chosen and independent
6676: of the SUBST framework.
6677:
6678: In this variant, the SUBST_FILES.* variable lists each file individually.
6679: Thereby chances are higher that there are filename patterns in which no
6680: substitution happens. Since the SUBST framework cannot know whether the
6681: filename patterns in SUBST_FILES.* have been explicitly listed in the Makefile
6682: (where any redundant filename pattern would be suspicious) or been generated by
6683: a shell command (in which redundant filename patterns are more likely and to be
6684: expected), it will complain about these redundant filename patterns. Therefore,
6685: SUBST blocks that use a shell command to generate the list of filename patterns
6686: often need to set SUBST_NOOP_OK.* to yes.
6687:
6688: 21.1.11.3. Choosing what to substitute
6689:
6690: In most cases, the substitutions are given using one or more sed(1) commands,
6691: like this:
6692:
6693: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
6694:
6695: Each of the sed commands needs to be preceded by the -e option and should be
6696: specified on a line of its own, to avoid hiding short sed commands at the end
6697: of a line.
6698:
6699: Since the sed commands often contain shell metacharacters as the separator (the
6700: | in the above example), it is common to enclose them in single quotes.
6701:
6702: A common substitution is to replace placeholders of the form @VARNAME@ with
6703: their pkgsrc counterpart variable ${VARNAME}. A typical example is:
6704:
6705: SUBST_VARS.path= PREFIX
6706:
1.181 rillig 6707: This type of substitutions is typically done by the GNU configure scripts
6708: during the do-configure stage, but in some cases these need to be overridden.
6709: The same pattern is also used when a package defines patches that replace
6710: previously hard-coded paths like /usr/local with a @PREFIX@ placeholder first,
6711: which then gets substituted by the actual ${PREFIX} in the pre-configure stage.
6712: In many of these cases, it works equally well to just use the SUBST framework
6713: to directly replace /usr/local with ${PREFIX}, thereby omitting the
6714: intermediate patch file.
1.180 rillig 6715:
6716: If the above is not flexible enough, it is possible to not use sed at all for
6717: the substitution but to specify an entirely different command, like this:
6718:
6719: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
1.1 dsieger 6720:
1.180 rillig 6721: This is used for the few remaining packages in which the distributed files use
6722: Windows-style line endings that need to be converted to UNIX-style line
6723: endings.
1.1 dsieger 6724:
1.180 rillig 6725: 21.1.11.4. Other SUBST variables
1.172 rillig 6726:
1.180 rillig 6727: When a SUBST block is applied during a package build, a message is logged. The
6728: default message is fine for most purposes but can be overridden by setting
6729: SUBST_MESSAGE.* to an individual message.
1.1 dsieger 6730:
1.154 rillig 6731: 21.2. The fetch phase
1.1 dsieger 6732:
1.154 rillig 6733: 21.2.1. Packages whose distfiles aren't available for plain downloading
1.1 dsieger 6734:
6735: If you need to download from a dynamic URL you can set DYNAMIC_MASTER_SITES and
6736: a make fetch will call files/getsite.sh with the name of each file to download
6737: as an argument, expecting it to output the URL of the directory from which to
6738: download it. graphics/ns-cult3d is an example of this usage.
6739:
6740: If the download can't be automated, because the user must submit personal
6741: information to apply for a password, or must pay for the source, or whatever,
6742: you can set FETCH_MESSAGE to a list of lines that are displayed to the user
6743: before aborting the build. Example:
6744:
6745: FETCH_MESSAGE= "Please download the files"
6746: FETCH_MESSAGE+= " "${DISTFILES:Q}
6747: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
6748:
1.154 rillig 6749: 21.2.2. How to handle modified distfiles with the 'old' name
1.1 dsieger 6750:
6751: Sometimes authors of a software package make some modifications after the
6752: software was released, and they put up a new distfile without changing the
6753: package's version number. If a package is already in pkgsrc at that time, the
6754: checksum will no longer match. The contents of the new distfile should be
6755: compared against the old one before changing anything, to make sure the
6756: distfile was really updated on purpose, and that no trojan horse or so crept
6757: in. Please mention that the distfiles were compared and what was found in your
1.54 rodent 6758: commit message.
6759:
6760: Then, the correct way to work around this is to set DIST_SUBDIR to a unique
1.109 wiz 6761: directory name, usually based on PKGNAME_NOREV (but take care with python or
6762: ruby packages, where PKGNAME includes a variable prefix). All DISTFILES and
6763: PATCHFILES for this package will be put in that subdirectory of the local
1.154 rillig 6764: distfiles directory. (See Section 21.1.10, "How to handle incrementing versions
1.109 wiz 6765: when fixing an existing package" for more details.) In case this happens more
6766: often, PKGNAME can be used (thus including the nbX suffix) or a date stamp can
6767: be appended, like ${PKGNAME_NOREV}-YYYYMMDD.
1.54 rodent 6768:
6769: DIST_SUBDIR is also used when a distfile's name does not contain a version and
6770: the distfile is apt to change. In cases where the likelihood of this is very
6771: small, DIST_SUBDIR might not be required. Additionally, DIST_SUBDIR must not be
6772: removed unless the distfile name changes, even if a package is being moved or
6773: renamed.
6774:
6775: Do not forget regenerating the distinfo file after that, since it contains the
6776: DIST_SUBDIR path in the filenames. Also, increase the PKGREVISION if the
6777: installed package is different. Furthermore, a mail to the package's authors
6778: seems appropriate telling them that changing distfiles after releases without
6779: changing the file names is not good practice.
1.1 dsieger 6780:
1.154 rillig 6781: 21.2.3. Packages hosted on github.com
1.88 tnn 6782:
1.90 tnn 6783: Helper methods exist for packages hosted on github.com which will often have
6784: distfile names that clash with other packages, for example 1.0.tar.gz. Use one
6785: of the three recipes from below:
1.88 tnn 6786:
1.154 rillig 6787: 21.2.3.1. Fetch based on a tagged release
1.88 tnn 6788:
1.189 bacon 6789: If your distfile URL looks similar to https://github.com/username/example/
6790: archive/v1.0.zip, then you are packaging a tagged release.
1.88 tnn 6791:
1.189 bacon 6792: DISTNAME= example-1.0
1.90 tnn 6793: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 6794: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 6795: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 6796: EXTRACT_SUFX= .zip
6797:
1.189 bacon 6798: 21.2.3.2. Fetch based on a specific commit before the first release
6799:
6800: If your distfile looks similar to https://github.com/username/example/archive/
6801: 988881adc9fc3655077dc2d4d757d480b5ea0e11 and is from a commit before the first
6802: release, then set the package version to 0.0.0.N, where N is the number of
6803: commits to the repository, and set GITHUB_TAG to the commit hash. This will
6804: (almost) ensure that the first tagged release will have a version greater than
6805: this one so that package upgrades will function properly.
6806:
6807: DISTNAME= example-0.0.0.347
6808: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6809: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
6810: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
6811:
6812: 21.2.3.3. Fetch based on a specific commit after a release
1.88 tnn 6813:
1.189 bacon 6814: If your distfile looks similar to https://github.com/username/example/archive/
6815: 988881adc9fc3655077dc2d4d757d480b5ea0e11 and is from a commit after a release,
6816: then include the last release version and the commit count since that release
6817: in the package version and set GITHUB_TAG to the commit hash. The latest
6818: release and commit count are shown in the output of "git describe --tags":
6819:
6820: # git clone https://github.com/username/example
6821: # cd example
6822: # git describe --tags
6823: 1.2.3-5-g988881a
1.88 tnn 6824:
1.189 bacon 6825: DISTNAME= example-1.2.3.5
6826: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6827: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 6828: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.88 tnn 6829:
1.189 bacon 6830: 21.2.3.4. Fetch based on release
1.88 tnn 6831:
1.189 bacon 6832: If your distfile URL looks similar to https://github.com/username/example/
6833: releases/download/rel-1.6/offensive-1.6.zip, then you are packaging a release.
1.88 tnn 6834:
1.90 tnn 6835: DISTNAME= offensive-1.6
1.88 tnn 6836: PKGNAME= ${DISTNAME:S/offensive/proper/}
1.90 tnn 6837: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 6838: GITHUB_PROJECT= example
1.90 tnn 6839: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
6840: EXTRACT_SUFX= .zip
1.88 tnn 6841:
1.154 rillig 6842: 21.3. The configure phase
1.1 dsieger 6843:
1.154 rillig 6844: 21.3.1. Shared libraries - libtool
1.1 dsieger 6845:
6846: pkgsrc supports many different machines, with different object formats like
6847: a.out and ELF, and varying abilities to do shared library and dynamic loading
6848: at all. To accompany this, varying commands and options have to be passed to
6849: the compiler, linker, etc. to get the Right Thing, which can be pretty annoying
6850: especially if you don't have all the machines at your hand to test things. The
6851: devel/libtool pkg can help here, as it just "knows" how to build both static
6852: and dynamic libraries from a set of source files, thus being
6853: platform-independent.
6854:
6855: Here's how to use libtool in a package in seven simple steps:
6856:
6857: 1. Add USE_LIBTOOL=yes to the package Makefile.
6858:
6859: 2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of "$
6860: {CC}". You could even add it to the definition of CC, if only libraries are
6861: being built in a given Makefile. This one command will build both PIC and
6862: non-PIC library objects, so you need not have separate shared and
6863: non-shared library rules.
6864:
6865: 3. For the linking of the library, remove any "ar", "ranlib", and "ld
6866: -Bshareable" commands, and instead use:
6867:
6868: ${LIBTOOL} --mode=link \
6869: ${CC} -o ${.TARGET:.a=.la} \
6870: ${OBJS:.o=.lo} \
6871: -rpath ${PREFIX}/lib \
6872: -version-info major:minor
6873:
6874: Note that the library is changed to have a .la extension, and the objects
6875: are changed to have a .lo extension. Change OBJS as necessary. This
6876: automatically creates all of the .a, .so.major.minor, and ELF symlinks (if
6877: necessary) in the build directory. Be sure to include "-version-info",
6878: especially when major and minor are zero, as libtool will otherwise strip
6879: off the shared library version.
6880:
6881: From the libtool manual:
6882:
6883: So, libtool library versions are described by three integers:
6884:
6885: CURRENT
6886: The most recent interface number that this library implements.
6887:
6888: REVISION
6889: The implementation number of the CURRENT interface.
6890:
6891: AGE
6892: The difference between the newest and oldest interfaces that
6893: this library implements. In other words, the library implements
6894: all the interface numbers in the range from number `CURRENT -
6895: AGE' to `CURRENT'.
6896:
6897: If two libraries have identical CURRENT and AGE numbers, then the
6898: dynamic linker chooses the library with the greater REVISION number.
6899:
6900: The "-release" option will produce different results for a.out and ELF
1.25 wiz 6901: (excluding symlinks) in only one case. An ELF library of the form "
6902: libfoo-release.so.x.y" will have a symlink of "libfoo.so.x.y" on an a.out
1.1 dsieger 6903: platform. This is handled automatically.
6904:
6905: The "-rpath argument" is the install directory of the library being built.
6906:
6907: In the PLIST, include only the .la file, the other files will be added
6908: automatically.
6909:
6910: 4. When linking shared object (.so) files, i.e. files that are loaded via
6911: dlopen(3), NOT shared libraries, use "-module -avoid-version" to prevent
6912: them getting version tacked on.
6913:
6914: The PLIST file gets the foo.so entry.
6915:
6916: 5. When linking programs that depend on these libraries before they are
6917: installed, preface the cc(1) or ld(1) line with "${LIBTOOL} --mode=link",
6918: and it will find the correct libraries (static or shared), but please be
6919: aware that libtool will not allow you to specify a relative path in -L
6920: (such as "-L../somelib"), because it expects you to change that argument to
6921: be the .la file. e.g.
6922:
6923: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
6924:
6925: should be changed to:
6926:
6927: ${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
6928:
6929: and it will do the right thing with the libraries.
6930:
6931: 6. When installing libraries, preface the install(1) or cp(1) command with "$
6932: {LIBTOOL} --mode=install", and change the library name to .la. e.g.
6933:
1.23 jakllsch 6934: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 6935:
6936: This will install the static .a, shared library, any needed symlinks, and
6937: run ldconfig(8).
6938:
6939: 7. In your PLIST, include only the .la file (this is a change from previous
6940: behaviour).
6941:
1.154 rillig 6942: 21.3.2. Using libtool on GNU packages that already support libtool
1.1 dsieger 6943:
6944: Add USE_LIBTOOL=yes to the package Makefile. This will override the package's
6945: own libtool in most cases. For older libtool using packages, libtool is made by
6946: ltconfig script during the do-configure step; you can check the libtool script
6947: location by doing make configure; find work*/ -name libtool.
6948:
6949: LIBTOOL_OVERRIDE specifies which libtool scripts, relative to WRKSRC, to
6950: override. By default, it is set to "libtool */libtool */*/libtool". If this
6951: does not match the location of the package's libtool script(s), set it as
6952: appropriate.
6953:
6954: If you do not need *.a static libraries built and installed, then use
6955: SHLIBTOOL_OVERRIDE instead.
6956:
6957: If your package makes use of the platform-independent library for loading
6958: dynamic shared objects, that comes with libtool (libltdl), you should include
6959: devel/libltdl/buildlink3.mk.
6960:
6961: Some packages use libtool incorrectly so that the package may not work or build
6962: in some circumstances. Some of the more common errors are:
6963:
6964: * The inclusion of a shared object (-module) as a dependent library in an
6965: executable or library. This in itself isn't a problem if one of two things
6966: has been done:
6967:
6968: 1. The shared object is named correctly, i.e. libfoo.la, not foo.la
6969:
6970: 2. The -dlopen option is used when linking an executable.
6971:
6972: * The use of libltdl without the correct calls to initialisation routines.
6973: The function lt_dlinit() should be called and the macro
6974: LTDL_SET_PRELOADED_SYMBOLS included in executables.
6975:
1.154 rillig 6976: 21.3.3. GNU Autoconf/Automake
1.1 dsieger 6977:
6978: If a package needs GNU autoconf or automake to be executed to regenerate the
6979: configure script and Makefile.in makefile templates, then they should be
6980: executed in a pre-configure target.
6981:
6982: For packages that need only autoconf:
6983:
6984: AUTOCONF_REQD= 2.50 # if default version is not good enough
6985: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
6986: ...
6987:
6988: pre-configure:
6989: cd ${WRKSRC} && autoconf
6990:
6991: ...
6992:
6993: and for packages that need automake and autoconf:
6994:
6995: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
6996: USE_TOOLS+= automake # use "automake14" for automake-1.4
6997: ...
6998:
6999: pre-configure:
7000: set -e; cd ${WRKSRC}; \
7001: aclocal; autoheader; automake -a --foreign -i; autoconf
7002:
7003: ...
7004:
7005: Packages which use GNU Automake will almost certainly require GNU Make.
7006:
7007: There are times when the configure process makes additional changes to the
7008: generated files, which then causes the build process to try to re-execute the
7009: automake sequence. This is prevented by touching various files in the configure
7010: stage. If this causes problems with your package you can set AUTOMAKE_OVERRIDE=
7011: NO in the package Makefile.
7012:
1.154 rillig 7013: 21.4. Programming languages
1.1 dsieger 7014:
1.154 rillig 7015: 21.4.1. C, C++, and Fortran
1.1 dsieger 7016:
7017: Compilers for the C, C++, and Fortran languages comes with the NetBSD base
7018: system. By default, pkgsrc assumes that a package is written in C and will hide
1.184 rillig 7019: all other compilers (via the wrapper framework, see Chapter 18, Buildlink
1.1 dsieger 7020: methodology).
7021:
7022: To declare which language's compiler a package needs, set the USE_LANGUAGES
7023: variable. Allowed values currently are "c", "c++", and "fortran" (and any
7024: combination). The default is "c". Packages using GNU configure scripts, even if
7025: written in C++, usually need a C compiler for the configure phase.
7026:
1.154 rillig 7027: 21.4.2. Java
1.1 dsieger 7028:
7029: If a program is written in Java, use the Java framework in pkgsrc. The package
7030: must include ../../mk/java-vm.mk. This Makefile fragment provides the following
7031: variables:
7032:
7033: * USE_JAVA defines if a build dependency on the JDK is added. If USE_JAVA is
7034: set to "run", then there is only a runtime dependency on the JDK. The
7035: default is "yes", which also adds a build dependency on the JDK.
7036:
7037: * Set USE_JAVA2 to declare that a package needs a Java2 implementation. The
7038: supported values are "yes", "1.4", and "1.5". "yes" accepts any Java2
7039: implementation, "1.4" insists on versions 1.4 or above, and "1.5" only
7040: accepts versions 1.5 or above. This variable is not set by default.
7041:
1.25 wiz 7042: * PKG_JAVA_HOME is automatically set to the runtime location of the used Java
7043: implementation dependency. It may be used to set JAVA_HOME to a good value
7044: if the program needs this variable to be defined.
7045:
1.205 ! wiz 7046: 21.4.3. Go
! 7047:
! 7048: If a program is written in Go and has any dependencies on other Go modules,
! 7049: have the package include ../../lang/go/go-module.mk.
! 7050:
! 7051: 1. Generate a list of those dependencies with make clean && make patch && make
! 7052: show-go-modules > go-modules.mk.
! 7053:
! 7054: 2. Prepend
! 7055:
! 7056: .include
! 7057: "go-modules.mk"
! 7058:
! 7059: to any other
! 7060:
! 7061: .include
! 7062:
! 7063: s.
! 7064:
! 7065: 3. Incorporate these modules in distinfo with make makesum.
! 7066:
! 7067: 21.4.4. Packages containing Perl scripts
1.1 dsieger 7068:
1.203 nia 7069: If your package contains interpreted Perl scripts, add "perl" to the USE_TOOLS
1.1 dsieger 7070: variable and set REPLACE_PERL to ensure that the proper interpreter path is
7071: set. REPLACE_PERL should contain a list of scripts, relative to WRKSRC, that
1.74 wiz 7072: you want adjusted. Every occurrence of */bin/perl in a she-bang line will be
7073: replaced with the full path to the perl executable.
1.1 dsieger 7074:
7075: If a particular version of perl is needed, set the PERL5_REQD variable to the
7076: version number. The default is "5.0".
7077:
1.203 nia 7078: See Section 21.6.6, "Packages installing Perl modules" for information about
1.1 dsieger 7079: handling perl modules.
7080:
1.205 ! wiz 7081: 21.4.5. Packages containing shell scripts
1.41 wiz 7082:
7083: REPLACE_SH, REPLACE_BASH, REPLACE_CSH, and REPLACE_KSH can be used to replace
1.195 gutterid 7084: shell hash bangs in files. Please use the appropriate one, preferring
7085: REPLACE_SH in case this shell is sufficient. Each should contain a list of
7086: scripts, relative to WRKSRC, that you want adjusted. Every occurrence of the
7087: matching shell in a she-bang line will be replaced with the full path to the
7088: shell executable. When using REPLACE_BASH, don't forget to add bash to
7089: USE_TOOLS.
1.41 wiz 7090:
1.205 ! wiz 7091: 21.4.6. Other programming languages
1.1 dsieger 7092:
7093: Currently, there is no special handling for other languages in pkgsrc. If a
7094: compiler package provides a buildlink3.mk file, include that, otherwise just
7095: add a (build) dependency on the appropriate compiler package.
7096:
1.154 rillig 7097: 21.5. The build phase
1.1 dsieger 7098:
7099: The most common failures when building a package are that some platforms do not
7100: provide certain header files, functions or libraries, or they provide the
7101: functions in a library that the original package author didn't know. To work
7102: around this, you can rewrite the source code in most cases so that it does not
7103: use the missing functions or provides a replacement function.
7104:
1.154 rillig 7105: 21.5.1. Compiling C and C++ code conditionally
1.1 dsieger 7106:
7107: If a package already comes with a GNU configure script, the preferred way to
7108: fix the build failure is to change the configure script, not the code. In the
7109: other cases, you can utilize the C preprocessor, which defines certain macros
7110: depending on the operating system and hardware architecture it compiles for.
7111: These macros can be queried using for example #if defined(__i386). Almost every
7112: operating system, hardware architecture and compiler has its own macro. For
7113: example, if the macros __GNUC__, __i386__ and __NetBSD__ are all defined, you
7114: know that you are using NetBSD on an i386 compatible CPU, and your compiler is
7115: GCC.
7116:
7117: The list of the following macros for hardware and operating system depends on
7118: the compiler that is used. For example, if you want to conditionally compile
7119: code on Solaris, don't use __sun__, as the SunPro compiler does not define it.
7120: Use __sun instead.
7121:
1.154 rillig 7122: 21.5.1.1. C preprocessor macros to identify the operating system
1.1 dsieger 7123:
7124: To distinguish between 4.4 BSD-derived systems and the rest of the world, you
7125: should use the following code.
7126:
7127: #include <sys/param.h>
7128: #if (defined(BSD) && BSD >= 199306)
7129: /* BSD-specific code goes here */
7130: #else
7131: /* non-BSD-specific code goes here */
7132: #endif
7133:
7134: If this distinction is not fine enough, you can also test for the following
7135: macros.
7136:
1.46 obache 7137: Cygwin __CYGWIN__
7138: DragonFly __DragonFly__
1.1 dsieger 7139: FreeBSD __FreeBSD__
1.46 obache 7140: Haiku __HAIKU__
1.1 dsieger 7141: Interix __INTERIX
7142: IRIX __sgi (TODO: get a definite source for this)
7143: Linux linux, __linux, __linux__
1.83 dholland 7144: Mac OS X __APPLE__
1.46 obache 7145: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7146: Minix3 __minix
1.1 dsieger 7147: NetBSD __NetBSD__
7148: OpenBSD __OpenBSD__
7149: Solaris sun, __sun
7150:
1.154 rillig 7151: 21.5.1.2. C preprocessor macros to identify the hardware architecture
1.1 dsieger 7152:
7153: i386 i386, __i386, __i386__
7154: MIPS __mips
7155: SPARC sparc, __sparc
7156:
1.154 rillig 7157: 21.5.1.3. C preprocessor macros to identify the compiler
1.1 dsieger 7158:
7159: GCC __GNUC__ (major version), __GNUC_MINOR__
7160: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7161: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7162: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7163:
1.154 rillig 7164: 21.5.2. How to handle compiler bugs
1.1 dsieger 7165:
7166: Some source files trigger bugs in the compiler, based on combinations of
7167: compiler version and architecture and almost always relation to optimisation
7168: being enabled. Common symptoms are gcc internal errors or never finishing
7169: compiling a file.
7170:
7171: Typically, a workaround involves testing the MACHINE_ARCH and compiler version,
1.87 tnn 7172: disabling optimisation for that combination of file, MACHINE_ARCH and compiler.
7173:
7174: This used to be a big problem in the past, but is rarely needed now as compiler
7175: technology has matured. If you still need to add a compiler specific
7176: workaround, please do so in the file hacks.mk and describe the symptom and
7177: compiler version as detailed as possible.
1.1 dsieger 7178:
1.172 rillig 7179: 21.5.3. No such file or directory
7180:
7181: Compilation sometimes fails with an error message like this:
7182:
7183: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
7184: fatal error: pango/pango.h: No such file or directory
7185:
7186: The proper way to fix this problem depends on the type of the header, which is
7187: described in the following sections.
7188:
7189: 21.5.3.1. Headers from other packages
7190:
7191: If the header name looks like it comes from a different package, that other
7192: package should be included via the buildlink3 framework.
7193:
7194: First, look whether the header is somewhere in the buildlink3 directory below
7195: WRKDIR. In the above case of the missing Pango header:
7196:
7197: $ find work/.buildlink/ -print | grep -F pango/pango.h
7198:
7199: In the case of Pango, the output is:
7200:
7201: work/.buildlink/include/pango-1.0/pango/pango.h
7202:
7203: If the pango/pango.h file were placed directly in the .buildlink directory, it
7204: would have been found automatically. There is an extra pango-1.0 path component
7205: though, which means that the compiler command line must contain an option of
7206: the form -I${BUILDLINK3_PREFIX.pango}/include/pango-1.0. In most cases this
7207: option is generated by the configure script, which can be examined using:
7208:
7209: $ $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
7210: -I/usr/pkg/include/pango-1.0
7211: -I/usr/pkg/include/pango-1.0
7212: -I/usr/pkg/include/pango-1.0
7213: -I/usr/pkg/include/pango-1.0
7214: -I/usr/pkg/include/pango-1.0
7215:
7216: This looks good. These options are transformed by the buildlink wrapper to
7217: refer to the correct path inside work/.buildlink.
7218:
7219: Since the compilation fails though, examine the compiler command lines in work
7220: /.work.log to see whether the -I option is included in the particular command
7221: line.
7222:
7223: To further analyze the situation, run bmake build-env, which sets up an
7224: interactive, realistic environment including all the pkgsrc wrapper commands
7225: and environment variables. From there, try to compile some simple example
7226: programs that use the header.
7227:
7228: 21.5.3.2. Headers generated during the build
7229:
7230: If the name of the header seems to come from the package itself, and if the
7231: build is run with parallel jobs, the package may have some undeclared
7232: dependencies between the .c and the .h files, and a C file is compiled before
7233: its required header is generated.
7234:
7235: To see whether the build runs with parallel jobs, run bmake show-all-build |
7236: grep JOBS. Its output looks like this:
7237:
7238: usr MAKE_JOBS= 7
7239: pkg MAKE_JOBS_SAFE # undefined
7240: def _MAKE_JOBS_N= 7
7241:
7242: In this case the pkgsrc user has asked pkgsrc to build packages with 7 jobs in
7243: parallel (MAKE_JOBS). The package could have disabled parallel builds by
7244: setting MAKE_JOBS_SAFE to no, but in this case it hasn't.
7245:
7246: To see whether the build failure is caused by parallel builds, first save the
7247: exact error message and a bit of context, maybe you need it later for reporting
7248: a bug. Next, run:
7249:
7250: MAKE_JOBS_SAFE=no bmake clean build
7251:
7252: If that succeeds, file a bug report against the pkgsrc package, including the
7253: exact error message and the contents of your mk.conf file.
7254:
1.173 rillig 7255: 21.5.3.3. Symlinks
7256:
7257: Pkgsrc does not work reliably if any of LOCALBASE, VARBASE or WRKDIR contains a
7258: symlink. Since 2019Q2, the pkgsrc bootstrap program prevents installing pkgsrc
7259: in symlink-based directories. Existing pkgsrc installations are not checked for
7260: symlinks though.
7261:
7262: The "No such file or directory" error messages are a typical symptom of
7263: symlinks, and it's quite difficult to find out that this is the actual cause.
7264:
7265: 21.5.3.4. Stale working directories
7266:
7267: When building a hierarchy of packages, it may happen that one package is built
7268: and then pkgsrc is updated. This situation can provoke various hard to diagnose
7269: build errors. To clean up the situation:
7270:
7271: $ (cd ../../ && test -f mk/bsd.pkg.mk && rm -rf */*/work)
7272:
7273: (The test for bsd.pkg.mk just prevents running this command in the wrong
7274: directory.)
7275:
7276: If you have set WRKOBJDIR in mk.conf, remove that directory as well.
7277:
7278: 21.5.3.5. Other possible reasons
7279:
7280: On platforms other than BSD, third-party packages are installed in /usr/
7281: include, together with the base system. This means that pkgsrc cannot
7282: distinguish between headers provided by the base system (which it needs) and
7283: headers from third-party packages (which are often included in pkgsrc as well).
7284: This can lead to subtle version mismatches.
7285:
7286: In pkgsrc installations that have been active for several years, it may happen
7287: that some files are manually deleted. To exclude this unlikely reason, run
7288: pkg_admin check.
7289:
7290: It may help to run pkg_admin rebuild-tree to check/fix dependencies.
7291:
7292: If all of the above doesn't help, see Chapter 2, Getting help for contact
7293: information. Be prepared to describe what you have tried so far and what any
7294: error messages were.
7295:
1.172 rillig 7296: 21.5.4. Undefined reference to "..."
1.1 dsieger 7297:
7298: This error message often means that a package did not link to a shared library
7299: it needs. The following functions are known to cause this error message over
7300: and over.
7301:
7302: +-----------------------------------------------------+
7303: | Function |Library |Affected platforms|
7304: |-------------------------+--------+------------------|
7305: |accept, bind, connect |-lsocket|Solaris |
7306: |-------------------------+--------+------------------|
7307: |crypt |-lcrypt |DragonFly, NetBSD |
7308: |-------------------------+--------+------------------|
7309: |dlopen, dlsym |-ldl |Linux |
7310: |-------------------------+--------+------------------|
7311: |gethost* |-lnsl |Solaris |
7312: |-------------------------+--------+------------------|
7313: |inet_aton |-lresolv|Solaris |
7314: |-------------------------+--------+------------------|
7315: |nanosleep, sem_*, timer_*|-lrt |Solaris |
7316: |-------------------------+--------+------------------|
7317: |openpty |-lutil |Linux |
7318: +-----------------------------------------------------+
7319:
7320: To fix these linker errors, it is often sufficient to say LIBS.OperatingSystem+
7321: = -lfoo to the package Makefile and then say bmake clean; bmake.
7322:
1.172 rillig 7323: 21.5.4.1. Special issue: The SunPro compiler
1.1 dsieger 7324:
7325: When you are using the SunPro compiler, there is another possibility. That
7326: compiler cannot handle the following code:
7327:
7328: extern int extern_func(int);
7329:
7330: static inline int
7331: inline_func(int x)
7332: {
7333: return extern_func(x);
7334: }
7335:
7336: int main(void)
7337: {
7338: return 0;
7339: }
7340:
7341: It generates the code for inline_func even if that function is never used. This
7342: code then refers to extern_func, which can usually not be resolved. To solve
7343: this problem you can try to tell the package to disable inlining of functions.
7344:
1.172 rillig 7345: 21.5.5. Running out of memory
1.1 dsieger 7346:
7347: Sometimes packages fail to build because the compiler runs into an operating
7348: system specific soft limit. With the UNLIMIT_RESOURCES variable pkgsrc can be
1.94 wiz 7349: told to unlimit the resources. Currently, the allowed values are any
7350: combination of "cputime", "datasize", "memorysize", and "stacksize". Setting
7351: this variable is similar to running the shell builtin ulimit command to raise
7352: the maximum data segment size or maximum stack size of a process, respectively,
7353: to their hard limits.
1.1 dsieger 7354:
1.154 rillig 7355: 21.6. The install phase
1.1 dsieger 7356:
1.154 rillig 7357: 21.6.1. Creating needed directories
1.1 dsieger 7358:
7359: The BSD-compatible install supplied with some operating systems cannot create
7360: more than one directory at a time. As such, you should call ${INSTALL_*_DIR}
7361: like this:
7362:
7363: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7364: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
7365:
7366: You can also just append "dir1 dir2" to the INSTALLATION_DIRS variable, which
7367: will automatically do the right thing.
7368:
1.154 rillig 7369: 21.6.2. Where to install documentation
1.1 dsieger 7370:
7371: In general, documentation should be installed into ${PREFIX}/share/doc/$
7372: {PKGBASE} or ${PREFIX}/share/doc/${PKGNAME} (the latter includes the version
7373: number of the package).
7374:
7375: Many modern packages using GNU autoconf allow to set the directory where HTML
7376: documentation is installed with the "--with-html-dir" option. Sometimes using
7377: this flag is needed because otherwise the documentation ends up in ${PREFIX}/
7378: share/doc/html or other places.
7379:
7380: An exception to the above is that library API documentation generated with the
7381: textproc/gtk-doc tools, for use by special browsers (devhelp) should be left at
7382: their default location, which is ${PREFIX}/share/gtk-doc. Such documentation
7383: can be recognized from files ending in .devhelp or .devhelp2. (It is also
7384: acceptable to install such files in ${PREFIX}/share/doc/${PKGBASE} or ${PREFIX}
7385: /share/doc/${PKGNAME}; the .devhelp* file must be directly in that directory
7386: then, no additional subdirectory level is allowed in this case. This is usually
7387: achieved by using "--with-html-dir=${PREFIX}/share/doc". ${PREFIX}/share/
7388: gtk-doc is preferred though.)
7389:
1.154 rillig 7390: 21.6.3. Installing highscore files
1.1 dsieger 7391:
7392: Certain packages, most of them in the games category, install a score file that
7393: allows all users on the system to record their highscores. In order for this to
7394: work, the binaries need to be installed setgid and the score files owned by the
1.36 wiz 7395: appropriate group and/or owner (traditionally the "games" user/group). Set
7396: USE_GAMESGROUP to yes to support this. The following variables, documented in
7397: more detail in mk/defaults/mk.conf, control this behaviour: GAMEDATAMODE,
1.100 leot 7398: GAMEDIRMODE, GAMES_GROUP, GAMEMODE, GAME_USER. Other useful variables are:
7399: GAMEDIR_PERMS, GAMEDATA_PERMS and SETGID_GAMES_PERMS.
7400:
7401: An example that illustrates some of the variables described above is games/
7402: moon-buggy. OWN_DIRS_PERMS is used to properly set directory permissions of the
7403: directory where the scorefile is saved, REQD_FILES_PERMS is used to create a
7404: dummy scorefile (mbscore) with the proper permissions and SPECIAL_PERMS is used
7405: to install setgid the game binary:
7406:
7407: USE_GAMESGROUP= yes
7408:
7409: BUILD_DEFS+= VARBASE
7410:
7411: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
7412: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
7413: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
7414:
7415: Various INSTALL_* variables are also available: INSTALL_GAME to install setgid
7416: game binaries, INSTALL_GAME_DIR to install game directories that are needed to
7417: be accessed by setgid games and INSTALL_GAME_DATA to install scorefiles.
1.1 dsieger 7418:
1.14 jmcneill 7419: A package should therefore never hard code file ownership or access permissions
1.100 leot 7420: but rely on *_PERMS as described above or alternatively on INSTALL_GAME,
7421: INSTALL_GAME_DATA and INSTALL_GAME_DIR to set these correctly.
1.1 dsieger 7422:
1.154 rillig 7423: 21.6.4. Adding DESTDIR support to packages
1.4 rillig 7424:
1.14 jmcneill 7425: DESTDIR support means that a package installs into a staging directory, not the
7426: final location of the files. Then a binary package is created which can be used
7427: for installation as usual. There are two ways: Either the package must install
1.25 wiz 7428: as root ("destdir") or the package can install as non-root user ("user-destdir"
7429: ).
1.14 jmcneill 7430:
1.113 leot 7431: * PKG_DESTDIR_SUPPORT has to be set to "destdir" or "user-destdir". By
7432: default PKG_DESTDIR_SUPPORT is set to "user-destdir" to help catching more
7433: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
7434: PKG_DESTDIR_SUPPORT needs to be set before the inclusion.
1.14 jmcneill 7435:
1.4 rillig 7436: * All installation operations have to be prefixed with ${DESTDIR}.
7437:
7438: * automake gets this DESTDIR mostly right automatically. Many manual rules
7439: and pre/post-install often are incorrect; fix them.
7440:
1.17 imil 7441: * If files are installed with special owner/group use SPECIAL_PERMS.
1.4 rillig 7442:
7443: * In general, packages should support UNPRIVILEGED to be able to use DESTDIR.
7444:
1.154 rillig 7445: 21.6.5. Packages with hardcoded paths to other interpreters
1.1 dsieger 7446:
7447: Your package may also contain scripts with hardcoded paths to other
1.203 nia 7448: interpreters besides (or as well as) Perl. To correct the full pathname to the
1.1 dsieger 7449: script interpreter, you need to set the following definitions in your Makefile
7450: (we shall use tclsh in this example):
7451:
7452: REPLACE_INTERPRETER+= tcl
7453: REPLACE.tcl.old= .*/bin/tclsh
7454: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
7455: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
7456: # relative to ${WRKSRC}, just as in REPLACE_PERL
7457:
7458: Note
7459:
7460: Before March 2006, these variables were called _REPLACE.* and _REPLACE_FILES.*.
7461:
1.203 nia 7462: 21.6.6. Packages installing Perl modules
1.1 dsieger 7463:
7464: Makefiles of packages providing perl5 modules should include the Makefile
7465: fragment ../../lang/perl5/module.mk. It provides a do-configure target for the
7466: standard perl configuration for such modules as well as various hooks to tune
7467: this configuration. See comments in this file for details.
7468:
7469: Perl5 modules will install into different places depending on the version of
7470: perl used during the build process. To address this, pkgsrc will append lines
7471: to the PLIST corresponding to the files listed in the installed .packlist file
7472: generated by most perl5 modules. This is invoked by defining PERL5_PACKLIST to
1.48 wiz 7473: a space-separated list of packlist files relative to PERL5_PACKLIST_DIR
7474: (PERL5_INSTALLVENDORARCH by default), e.g.:
1.1 dsieger 7475:
1.48 wiz 7476: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 7477:
1.48 wiz 7478: The perl5 config variables installarchlib, installscript, installvendorbin,
7479: installvendorscript, installvendorarch, installvendorlib, installvendorman1dir,
7480: and installvendorman3dir represent those locations in which components of perl5
7481: modules may be installed, provided as variable with uppercase and prefixed with
7482: PERL5_, e.g. PERL5_INSTALLARCHLIB and may be used by perl5 packages that don't
7483: have a packlist. These variables are also substituted for in the PLIST as
7484: uppercase prefixed with PERL5_SUB_.
1.1 dsieger 7485:
1.154 rillig 7486: 21.6.7. Packages installing info files
1.1 dsieger 7487:
7488: Some packages install info files or use the "makeinfo" or "install-info"
7489: commands. INFO_FILES should be defined in the package Makefile so that INSTALL
7490: and DEINSTALL scripts will be generated to handle registration of the info
7491: files in the Info directory file. The "install-info" command used for the info
7492: files registration is either provided by the system, or by a special purpose
7493: package automatically added as dependency if needed.
7494:
7495: PKGINFODIR is the directory under ${PREFIX} where info files are primarily
7496: located. PKGINFODIR defaults to "info" and can be overridden by the user.
7497:
7498: The info files for the package should be listed in the package PLIST; however
7499: any split info files need not be listed.
7500:
7501: A package which needs the "makeinfo" command at build time must add "makeinfo"
7502: to USE_TOOLS in its Makefile. If a minimum version of the "makeinfo" command is
7503: needed it should be noted with the TEXINFO_REQD variable in the package
7504: Makefile. By default, a minimum version of 3.12 is required. If the system does
7505: not provide a makeinfo command or if it does not match the required minimum, a
7506: build dependency on the devel/gtexinfo package will be added automatically.
7507:
7508: The build and installation process of the software provided by the package
7509: should not use the install-info command as the registration of info files is
1.25 wiz 7510: the task of the package INSTALL script, and it must use the appropriate
1.1 dsieger 7511: makeinfo command.
7512:
7513: To achieve this goal, the pkgsrc infrastructure creates overriding scripts for
7514: the install-info and makeinfo commands in a directory listed early in PATH.
7515:
7516: The script overriding install-info has no effect except the logging of a
7517: message. The script overriding makeinfo logs a message and according to the
7518: value of TEXINFO_REQD either runs the appropriate makeinfo command or exit on
7519: error.
7520:
1.154 rillig 7521: 21.6.8. Packages installing man pages
1.1 dsieger 7522:
7523: All packages that install manual pages should install them into the same
7524: directory, so that there is one common place to look for them. In pkgsrc, this
7525: place is ${PREFIX}/${PKGMANDIR}, and this expression should be used in
1.25 wiz 7526: packages. The default for PKGMANDIR is "man". Another often-used value is "
7527: share/man".
1.1 dsieger 7528:
7529: Note
7530:
7531: The support for a custom PKGMANDIR is far from complete.
7532:
7533: The PLIST files can just use man/ as the top level directory for the man page
7534: file entries, and the pkgsrc framework will convert as needed. In all other
7535: places, the correct PKGMANDIR must be used.
7536:
7537: Packages that are configured with GNU_CONFIGURE set as "yes", by default will
7538: use the ./configure --mandir switch to set where the man pages should be
7539: installed. The path is GNU_CONFIGURE_MANDIR which defaults to ${PREFIX}/$
7540: {PKGMANDIR}.
7541:
7542: Packages that use GNU_CONFIGURE but do not use --mandir, can set
7543: CONFIGURE_HAS_MANDIR to "no". Or if the ./configure script uses a non-standard
7544: use of --mandir, you can set GNU_CONFIGURE_MANDIR as needed.
7545:
1.184 rillig 7546: See Section 19.5, "Man page compression" for information on installation of
1.1 dsieger 7547: compressed manual pages.
7548:
1.203 nia 7549: 21.6.9. Packages installing X11 fonts
1.1 dsieger 7550:
7551: If a package installs font files, you will need to rebuild the fonts database
7552: in the directory where they get installed at installation and deinstallation
7553: time. This can be automatically done by using the pkginstall framework.
7554:
7555: You can list the directories where fonts are installed in the FONTS_DIRS.type
7556: variables, where type can be one of "ttf", "type1" or "x11". Also make sure
7557: that the database file fonts.dir is not listed in the PLIST.
7558:
7559: Note that you should not create new directories for fonts; instead use the
7560: standard ones to avoid that the user needs to manually configure his X server
7561: to find them.
7562:
1.203 nia 7563: 21.6.10. Packages installing SGML or XML data
1.1 dsieger 7564:
7565: If a package installs SGML or XML data files that need to be registered in
7566: system-wide catalogs (like DTDs, sub-catalogs, etc.), you need to take some
7567: extra steps:
7568:
7569: 1. Include ../../textproc/xmlcatmgr/catalogs.mk in your Makefile, which takes
7570: care of registering those files in system-wide catalogs at installation and
7571: deinstallation time.
7572:
7573: 2. Set SGML_CATALOGS to the full path of any SGML catalogs installed by the
7574: package.
7575:
7576: 3. Set XML_CATALOGS to the full path of any XML catalogs installed by the
7577: package.
7578:
7579: 4. Set SGML_ENTRIES to individual entries to be added to the SGML catalog.
7580: These come in groups of three strings; see xmlcatmgr(1) for more
7581: information (specifically, arguments recognized by the 'add' action). Note
7582: that you will normally not use this variable.
7583:
7584: 5. Set XML_ENTRIES to individual entries to be added to the XML catalog. These
7585: come in groups of three strings; see xmlcatmgr(1) for more information
7586: (specifically, arguments recognized by the 'add' action). Note that you
7587: will normally not use this variable.
7588:
1.203 nia 7589: 21.6.11. Packages installing extensions to the MIME database
1.1 dsieger 7590:
7591: If a package provides extensions to the MIME database by installing .xml files
7592: inside ${PREFIX}/share/mime/packages, you need to take some extra steps to
7593: ensure that the database is kept consistent with respect to these new files:
7594:
7595: 1. Include ../../databases/shared-mime-info/mimedb.mk (avoid using the
7596: buildlink3.mk file from this same directory, which is reserved for
7597: inclusion from other buildlink3.mk files). It takes care of rebuilding the
7598: MIME database at installation and deinstallation time, and disallows any
7599: access to it directly from the package.
7600:
1.25 wiz 7601: 2. Check the PLIST and remove any entries under the share/mime directory,
1.1 dsieger 7602: except for files saved under share/mime/packages. The former are handled
7603: automatically by the update-mime-database program, but the latter are
7604: package-dependent and must be removed by the package that installed them in
7605: the first place.
7606:
7607: 3. Remove any share/mime/* directories from the PLIST. They will be handled by
7608: the shared-mime-info package.
7609:
1.203 nia 7610: 21.6.12. Packages using intltool
1.1 dsieger 7611:
7612: If a package uses intltool during its build, add intltool to the USE_TOOLS,
7613: which forces it to use the intltool package provided by pkgsrc, instead of the
7614: one bundled with the distribution file.
7615:
7616: This tracks intltool's build-time dependencies and uses the latest available
7617: version; this way, the package benefits of any bug fixes that may have appeared
7618: since it was released.
7619:
1.203 nia 7620: 21.6.13. Packages installing startup scripts
1.1 dsieger 7621:
7622: If a package contains a rc.d script, it won't be copied into the startup
7623: directory by default, but you can enable it, by adding the option
1.4 rillig 7624: PKG_RCD_SCRIPTS=YES in mk.conf. This option will copy the scripts into /etc/
7625: rc.d when a package is installed, and it will automatically remove the scripts
7626: when the package is deinstalled.
1.1 dsieger 7627:
1.203 nia 7628: 21.6.14. Packages installing TeX modules
1.1 dsieger 7629:
7630: If a package installs TeX packages into the texmf tree, the ls-R database of
7631: the tree needs to be updated.
7632:
7633: Note
7634:
1.23 jakllsch 7635: Except the main TeX packages such as kpathsea, packages should install files
7636: into ${PREFIX}/share/texmf-dist, not ${PREFIX}/share/texmf.
1.1 dsieger 7637:
1.23 jakllsch 7638: 1. Include ../../print/kpathsea/texmf.mk. This takes care of rebuilding the
7639: ls-R database at installation and deinstallation time.
1.1 dsieger 7640:
1.23 jakllsch 7641: 2. If your package installs files into a texmf tree other than the one at $
7642: {PREFIX}/share/texmf-dist, set TEX_TEXMF_DIRS to the list of all texmf
7643: trees that need database update.
1.1 dsieger 7644:
7645: If your package also installs font map files that need to be registered
1.30 dholland 7646: using updmap, include ../../print/tex-tetex/map.mk and set TEX_MAP_FILES
7647: and/or TEX_MIXEDMAP_FILES to the list of all such font map files. Then
7648: updmap will be run automatically at installation/deinstallation to enable/
7649: disable font map files for TeX output drivers.
1.1 dsieger 7650:
7651: 3. Make sure that none of ls-R databases are included in PLIST, as they will
1.30 dholland 7652: be removed only by the kpathsea package.
1.1 dsieger 7653:
1.203 nia 7654: 21.6.15. Packages supporting running binaries in emulation
1.1 dsieger 7655:
7656: There are some packages that provide libraries and executables for running
7657: binaries from a one operating system on a different one (if the latter supports
7658: it). One example is running Linux binaries on NetBSD.
7659:
7660: The pkgtools/rpm2pkg helps in extracting and packaging Linux rpm packages.
7661:
7662: The CHECK_SHLIBS can be set to no to avoid the check-shlibs target, which tests
7663: if all libraries for each installed executable can be found by the dynamic
7664: linker. Since the standard dynamic linker is run, this fails for emulation
7665: packages, because the libraries used by the emulation are not in the standard
7666: directories.
7667:
1.203 nia 7668: 21.6.16. Packages installing hicolor icons
1.1 dsieger 7669:
7670: If a package installs images under the share/icons/hicolor and/or updates the
7671: share/icons/hicolor/icon-theme.cache database, you need to take some extra
7672: steps to make sure that the shared theme directory is handled appropriately and
7673: that the cache database is rebuilt:
7674:
7675: 1. Include ../../graphics/hicolor-icon-theme/buildlink3.mk.
7676:
7677: 2. Check the PLIST and remove the entry that refers to the theme cache.
7678:
7679: 3. Ensure that the PLIST does not remove the shared icon directories from the
7680: share/icons/hicolor hierarchy because they will be handled automatically.
7681:
7682: The best way to verify that the PLIST is correct with respect to the last two
7683: points is to regenerate it using make print-PLIST.
7684:
1.203 nia 7685: 21.6.17. Packages installing desktop files
1.1 dsieger 7686:
7687: If a package installs .desktop files under share/applications and these include
1.54 rodent 7688: MIME information (MimeType key), you need to take extra steps to ensure that
7689: they are registered into the MIME database:
1.1 dsieger 7690:
7691: 1. Include ../../sysutils/desktop-file-utils/desktopdb.mk.
7692:
7693: 2. Check the PLIST and remove the entry that refers to the share/applications/
7694: mimeinfo.cache file. It will be handled automatically.
7695:
7696: The best way to verify that the PLIST is correct with respect to the last point
7697: is to regenerate it using make print-PLIST.
7698:
1.154 rillig 7699: 21.7. Marking packages as having problems
1.1 dsieger 7700:
1.23 jakllsch 7701: In some cases one does not have the time to solve a problem immediately. In
7702: this case, one can plainly mark a package as broken. For this, one just sets
7703: the variable BROKEN to the reason why the package is broken (similar to the
1.162 rillig 7704: PKG_FAIL_REASON variable). A user trying to build the package will immediately
7705: be shown this message, and the build will not be even tried.
1.1 dsieger 7706:
1.23 jakllsch 7707: BROKEN packages are removed from pkgsrc in irregular intervals.
1.1 dsieger 7708:
1.184 rillig 7709: Chapter 22. GNOME packaging and porting
7710:
7711: Table of Contents
7712:
7713: 22.1. Meta packages
7714: 22.2. Packaging a GNOME application
7715: 22.3. Updating GNOME to a newer version
7716: 22.4. Patching guidelines
7717:
7718: Quoting GNOME's web site:
7719:
7720: The GNOME project provides two things: The GNOME desktop environment, an
7721: intuitive and attractive desktop for users, and the GNOME development
7722: platform, an extensive framework for building applications that integrate
7723: into the rest of the desktop.
7724:
7725: pkgsrc provides a seamless way to automatically build and install a complete
7726: GNOME environment under many different platforms. We can say with confidence
7727: that pkgsrc is one of the most advanced build and packaging systems for GNOME
7728: due to its included technologies buildlink3, the wrappers and tools framework
7729: and automatic configuration file management. Lots of efforts are put into
7730: achieving a completely clean deinstallation of installed software components.
7731:
7732: Given that pkgsrc is NetBSD's official packaging system, the above also means
7733: that great efforts are put into making GNOME work under this operating system.
7734:
7735: This chapter is aimed at pkgsrc developers and other people interested in
7736: helping our GNOME porting and packaging efforts. It provides instructions on
7737: how to manage the existing packages and some important information regarding
7738: their internals.
7739:
7740: We need your help!
7741:
7742: Should you have some spare cycles to devote to NetBSD, pkgsrc and GNOME and are
7743: willing to learn new exciting stuff, please jump straight to the pending work
7744: list! There is still a long way to go to get a fully-functional GNOME desktop
7745: under NetBSD and we need your help to achieve it!
7746:
7747: 22.1. Meta packages
7748:
7749: pkgsrc includes three GNOME-related meta packages:
7750:
7751: * meta-pkgs/gnome-base: Provides the core GNOME desktop environment. It only
7752: includes the necessary bits to get it to boot correctly, although it may
7753: lack important functionality for daily operation. The idea behind this
7754: package is to let end users build their own configurations on top of this
7755: one, first installing this meta package to achieve a functional setup and
7756: then adding individual applications.
7757:
7758: * meta-pkgs/gnome: Provides a complete installation of the GNOME platform and
7759: desktop as defined by the GNOME project; this is based on the components
7760: distributed in the platform/x.y/x.y.z/sources and desktop/x.y/x.y.z/sources
7761: directories of the official FTP server. Developer-only tools found in those
7762: directories are not installed unless required by some other component to
7763: work properly. Similarly, packages from the bindings set (bindings/x.y/
7764: x.y.z/sources) are not pulled in unless required as a dependency for an
7765: end-user component. This package "extends" meta-pkgs/gnome-base.
7766:
7767: * meta-pkgs/gnome-devel: Installs all the tools required to build a GNOME
7768: component when fetched from the CVS repository. These are required to let
7769: the autogen.sh scripts work appropriately.
7770:
7771: In all these packages, the DEPENDS lines are sorted in a way that eases
7772: updates: a package may depend on other packages listed before it but not on any
7773: listed after it. It is very important to keep this order to ease updates so...
7774: do not change it to alphabetical sorting!
7775:
7776: 22.2. Packaging a GNOME application
7777:
7778: Almost all GNOME applications are written in C and use a common set of tools as
7779: their build system. Things get different with the new bindings to other
7780: languages (such as Python), but the following will give you a general idea on
7781: the minimum required tools:
7782:
7783: * Almost all GNOME applications use the GNU Autotools as their build system.
7784: As a general rule you will need to tell this to your package:
7785:
7786: GNU_CONFIGURE=yes
7787: USE_LIBTOOL=yes
7788: USE_TOOLS+=gmake
7789:
7790: * If the package uses pkg-config to detect dependencies, add this tool to the
7791: list of required utilities:
7792:
7793: USE_TOOLS+=pkg-config
7794:
7795: Also use pkgtools/verifypc at the end of the build process to ensure that
7796: you did not miss to specify any dependency in your package and that the
7797: version requirements are all correct.
7798:
7799: * If the package uses intltool, be sure to add intltool to the USE_TOOLS to
7800: handle dependencies and to force the package to use the latest available
7801: version.
7802:
7803: * If the package uses gtk-doc (a documentation generation utility), do not
7804: add a dependency on it. The tool is rather big and the distfile should come
7805: with pregenerated documentation anyway; if it does not, it is a bug that
7806: you ought to report. For such packages you should disable gtk-doc (unless
7807: it is the default):
7808:
7809: CONFIGURE_ARGS+=--disable-gtk-doc
7810:
7811: The default location of installed HTML files (share/gtk-doc/<package-name>)
7812: is correct and should not be changed unless the package insists on
7813: installing them somewhere else. Otherwise programs as devhelp will not be
7814: able to open them. You can do that with an entry similar to:
1.1 dsieger 7815:
1.184 rillig 7816: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
1.1 dsieger 7817:
1.184 rillig 7818: GNOME uses multiple shared directories and files under the installation prefix
7819: to maintain databases. In this context, shared means that those exact same
7820: directories and files are used among several different packages, leading to
7821: conflicts in the PLIST. pkgsrc currently includes functionality to handle the
7822: most common cases, so you have to forget about using @unexec ${RMDIR} lines in
7823: your file lists and omitting shared files from them. If you find yourself doing
7824: those, your package is most likely incorrect.
1.1 dsieger 7825:
1.184 rillig 7826: The following table lists the common situations that result in using shared
7827: directories or files. For each of them, the appropriate solution is given.
7828: After applying the solution be sure to regenerate the package's file list with
7829: make print-PLIST and ensure it is correct.
1.1 dsieger 7830:
1.184 rillig 7831: Table 22.1. PLIST handling for GNOME packages
1.1 dsieger 7832:
1.184 rillig 7833: +-----------------------------------------------------------------------------+
7834: | If the package... | Then... |
7835: |-------------------------------------------+---------------------------------|
1.203 nia 7836: |Installs icons under the share/icons/ |See Section 21.6.16, "Packages |
7837: |hicolor hierarchy or updates share/icons/ |installing hicolor icons". |
1.184 rillig 7838: |hicolor/icon-theme.cache. | |
7839: |-------------------------------------------+---------------------------------|
1.203 nia 7840: | |See Section 21.6.11, "Packages |
1.184 rillig 7841: |Installs files under share/mime/packages. |installing extensions to the MIME|
7842: | |database". |
7843: |-------------------------------------------+---------------------------------|
1.203 nia 7844: |Installs .desktop files under share/ |See Section 21.6.17, "Packages |
1.184 rillig 7845: |applications and these include MIME |installing desktop files". |
7846: |information. | |
7847: +-----------------------------------------------------------------------------+
1.1 dsieger 7848:
7849:
1.184 rillig 7850: 22.3. Updating GNOME to a newer version
1.1 dsieger 7851:
1.184 rillig 7852: When seeing GNOME as a whole, there are two kinds of updates:
1.1 dsieger 7853:
1.184 rillig 7854: Major update
1.1 dsieger 7855:
1.184 rillig 7856: Given that there is still a very long way for GNOME 3 (if it ever appears),
7857: we consider a major update one that goes from a 2.X version to a 2.Y one,
7858: where Y is even and greater than X. These are hard to achieve because they
7859: introduce lots of changes in the components' code and almost all GNOME
7860: distfiles are updated to newer versions. Some of them can even break API
7861: and ABI compatibility with the previous major version series. As a result,
7862: the update needs to be done all at once to minimize breakage.
1.1 dsieger 7863:
1.184 rillig 7864: A major update typically consists of around 80 package updates and the
7865: addition of some new ones.
1.1 dsieger 7866:
1.184 rillig 7867: Minor update
1.1 dsieger 7868:
1.184 rillig 7869: We consider a minor update one that goes from a 2.A.X version to a 2.A.Y
7870: one where Y is greater than X. These are easy to achieve because they do
7871: not update all GNOME components, can be done in an incremental way and do
7872: not break API nor ABI compatibility.
1.1 dsieger 7873:
1.184 rillig 7874: A minor update typically consists of around 50 package updates, although
7875: the numbers here may vary a lot.
1.1 dsieger 7876:
1.184 rillig 7877: In order to update the GNOME components in pkgsrc to a new stable release
7878: (either major or minor), the following steps should be followed:
1.1 dsieger 7879:
1.184 rillig 7880: 1. Get a list of all the tarballs that form the new release by using the
7881: following commands. These will leave the full list of the components'
7882: distfiles into the list.txt file:
1.1 dsieger 7883:
1.184 rillig 7884: % echo ls "*.tar.bz2" | \
7885: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
7886: awk '{ print $9 }' >list.txt
7887: % echo ls "*.tar.bz2" | \
7888: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
7889: awk '{ print $9 }' >>list.txt
1.1 dsieger 7890:
1.184 rillig 7891: 2. Open each meta package's Makefile and bump their version to the release you
7892: are updating them to. The three meta packages should be always consistent
7893: with versioning. Obviously remove any PKGREVISIONs that might be in them.
1.1 dsieger 7894:
1.184 rillig 7895: 3. For each meta package, update all its DEPENDS lines to match the latest
7896: versions as shown by the above commands. Do not list any newer version
7897: (even if found in the FTP) because the meta packages are supposed to list
7898: the exact versions that form a specific GNOME release. Exceptions are
7899: permitted here if a newer version solves a serious issue in the overall
7900: desktop experience; these typically come in the form of a revision bump in
7901: pkgsrc, not in newer versions from the developers.
1.1 dsieger 7902:
1.184 rillig 7903: Packages not listed in the list.txt file should be updated to the latest
7904: version available (if found in pkgsrc). This is the case, for example, of
7905: the dependencies on the GNU Autotools in the meta-pkgs/gnome-devel meta
7906: package.
1.1 dsieger 7907:
1.184 rillig 7908: 4. Generate a patch from the modified meta packages and extract the list of
7909: "new" lines. This will provide you an outline on what packages need to be
7910: updated in pkgsrc and in what order:
1.1 dsieger 7911:
1.184 rillig 7912: % cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt
1.1 dsieger 7913:
1.184 rillig 7914: 5. For major desktop updates it is recommended to zap all your installed
7915: packages and start over from scratch at this point.
1.1 dsieger 7916:
1.184 rillig 7917: 6. Now comes the longest step by far: iterate over the contents of todo.txt
7918: and update the packages listed in it in order. For major desktop updates
7919: none of these should be committed until the entire set is completed because
7920: there are chances of breaking not-yet-updated packages.
1.1 dsieger 7921:
1.184 rillig 7922: 7. Once the packages are up to date and working, commit them to the tree one
7923: by one with appropriate log messages. At the end, commit the three meta
7924: package updates and all the corresponding changes to the doc/CHANGES-<YEAR>
7925: and pkgsrc/doc/TODO files.
1.1 dsieger 7926:
1.184 rillig 7927: 22.4. Patching guidelines
1.1 dsieger 7928:
1.184 rillig 7929: GNOME is a very big component in pkgsrc which approaches 100 packages. Please,
7930: it is very important that you always, always, always feed back any portability
7931: fixes you do to a GNOME package to the mainstream developers (see
7932: Section 12.3.5, "Feedback to the author"). This is the only way to get their
7933: attention on portability issues and to ensure that future versions can be built
7934: out-of-the box on NetBSD. The less custom patches in pkgsrc, the easier further
7935: updates are. Those developers in charge of issuing major GNOME updates will be
7936: grateful if you do that.
1.1 dsieger 7937:
1.200 cirnatda 7938: The most common places to report bugs are the GNOME's GitLab and the
7939: freedesktop.org's GitLab. Not all components use these to track bugs, but most
7940: of them do. Do not be short on your reports: always provide detailed
1.184 rillig 7941: explanations of the current failure, how it can be improved to achieve maximum
1.200 cirnatda 7942: portability and, if at all possible, provide a patch against the main Git
7943: branch. The more verbose you are, the higher chances of your patch being
7944: accepted.
1.1 dsieger 7945:
1.184 rillig 7946: Also, please avoid using preprocessor magic to fix portability issues. While
7947: the FreeBSD GNOME people are doing a great job in porting GNOME to their
7948: operating system, the official GNOME sources are now plagued by conditionals
7949: that check for __FreeBSD__ and similar macros. This hurts portability. Please
7950: see our patching guidelines (Section 12.3.4, "Patching guidelines") for more
7951: details.
1.1 dsieger 7952:
1.154 rillig 7953: Chapter 23. Submitting and Committing
1.1 dsieger 7954:
7955: Table of Contents
7956:
1.154 rillig 7957: 23.1. Submitting binary packages
7958: 23.2. Submitting source packages (for non-NetBSD-developers)
7959: 23.3. General notes when adding, updating, or removing packages
7960: 23.4. Commit Messages
7961: 23.5. Committing: Adding a package to CVS
7962: 23.6. Updating a package to a newer version
7963: 23.7. Renaming a package in pkgsrc
7964: 23.8. Moving a package in pkgsrc
1.1 dsieger 7965:
1.154 rillig 7966: 23.1. Submitting binary packages
1.1 dsieger 7967:
7968: Our policy is that we accept binaries only from pkgsrc developers to guarantee
7969: that the packages don't contain any trojan horses etc. This is not to annoy
7970: anyone but rather to protect our users! You're still free to put up your
7971: home-made binary packages and tell the world where to get them. NetBSD
1.154 rillig 7972: developers doing bulk builds and wanting to upload them please see Chapter 8,
1.66 asau 7973: Creating binary packages for everything in pkgsrc (bulk builds).
1.1 dsieger 7974:
1.154 rillig 7975: 23.2. Submitting source packages (for non-NetBSD-developers)
1.1 dsieger 7976:
7977: First, check that your package is complete, compiles and runs well; see
1.184 rillig 7978: Chapter 14, Creating a new pkgsrc package from scratch and the rest of this
7979: document. Next, generate an uuencoded gzipped tar(1) archive that contains all
7980: files that make up the package. Finally, send this package to the pkgsrc bug
7981: tracking system, either with the send-pr(1) command, or if you don't have that,
7982: go to the web page https://www.NetBSD.org/support/send-pr.html, which contains
7983: some instructions and a link to a form where you can submit packages. The
7984: sysutils/gtk-send-pr package is also available as a substitute for either of
7985: the above two tools.
1.1 dsieger 7986:
7987: In the form of the problem report, the category should be "pkg", the synopsis
7988: should include the package name and version number, and the description field
7989: should contain a short description of your package (contents of the COMMENT
1.25 wiz 7990: variable or DESCR file are OK). The uuencoded package data should go into the "
7991: fix" field.
1.1 dsieger 7992:
7993: If you want to submit several packages, please send a separate PR for each one,
7994: it's easier for us to track things that way.
7995:
7996: Alternatively, you can also import new packages into pkgsrc-wip ("pkgsrc
1.174 leot 7997: work-in-progress"); see the homepage at https://pkgsrc.org/wip/ for details.
1.1 dsieger 7998:
1.154 rillig 7999: 23.3. General notes when adding, updating, or removing packages
1.1 dsieger 8000:
8001: Please note all package additions, updates, moves, and removals in pkgsrc/doc/
8002: CHANGES-YYYY. It's very important to keep this file up to date and conforming
8003: to the existing format, because it will be used by scripts to automatically
8004: update pages on www.NetBSD.org and other sites. Additionally, check the pkgsrc/
8005: doc/TODO file and remove the entry for the package you updated or removed, in
8006: case it was mentioned there.
8007:
8008: When the PKGREVISION of a package is bumped, the change should appear in pkgsrc
8009: /doc/CHANGES-YYYY if it is security related or otherwise relevant. Mass bumps
8010: that result from a dependency being updated should not be mentioned. In all
8011: other cases it's the developer's decision.
8012:
8013: There is a make target that helps in creating proper CHANGES-YYYY entries: make
8014: changes-entry. It uses the optional CTYPE and NETBSD_LOGIN_NAME variables. The
8015: general usage is to first make sure that your CHANGES-YYYY file is up-to-date
8016: (to avoid having to resolve conflicts later-on) and then to cd to the package
8017: directory. For package updates, make changes-entry is enough. For new packages,
8018: or package moves or removals, set the CTYPE variable on the command line to
1.4 rillig 8019: "Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in mk.conf if
1.23 jakllsch 8020: your local login name is not the same as your NetBSD login name. The target
8021: also automatically removes possibly existing entries for the package in the
8022: TODO file. Don't forget to commit the changes, e.g. by using make
1.66 asau 8023: commit-changes-entry! If you are not using a checkout directly from
1.23 jakllsch 8024: cvs.NetBSD.org, but e.g. a local copy of the repository, you can set
8025: USE_NETBSD_REPO=yes. This makes the cvs commands use the main repository.
1.1 dsieger 8026:
1.154 rillig 8027: 23.4. Commit Messages
1.130 wiz 8028:
8029: For several years, there have been mirrors of pkgsrc in fossil, git, and hg.
8030: Standard practise when using these tools is to make the first line of a commit
8031: message function as a summary that can be read without the rest, such as is
8032: commonly done with "git log --oneline". For this reason, we have the following
8033: guidelines for pkgsrc commit messages:
8034:
1.131 wiz 8035: * Start the commit message with a line that explains the big picture in 65
1.130 wiz 8036: characters or less. When a commit is for one package, include the name of
8037: the package. For updates, include the version to which it is updated.
8038:
8039: * Leave the next line empty.
8040:
8041: * Then come the details for the commit (changes in that package, reason for a
8042: change) and any relevant PRs. Wrap this section.
8043:
8044: Here is an example:
8045:
8046: libxslt: update to 1.0.30
8047:
8048: Changes since 1.0.29:
8049: ...
8050:
8051:
8052: Here is another example:
8053:
8054: mk/bsd.pkg.mk: enable SSP by default on NetBSD
8055:
8056: (rationale)
8057:
8058:
8059: Commit messages are final: no "cvs admin" is allowed on the pkgsrc repository
8060: to change commit messages.
8061:
1.154 rillig 8062: 23.5. Committing: Adding a package to CVS
1.1 dsieger 8063:
8064: This section is only of interest for pkgsrc developers with write access to the
1.34 wiz 8065: pkgsrc repository.
8066:
8067: When the package is finished, "cvs add" the files. Start by adding the
8068: directory and then files in the directory. Don't forget to add the new package
8069: to the category's Makefile. Make sure you don't forget any files; you can check
8070: by running "cvs status". An example:
8071:
8072: $ cd .../pkgsrc/category
8073: $ cvs add pkgname
8074: $ cd pkgname
8075: $ cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8076: $ cvs add patches/p*
8077: $ cvs status | less
1.35 wiz 8078: $ cvs commit
1.34 wiz 8079: $ cd ..
8080: $ vi Makefile # add SUBDIRS+=pkgname line
1.35 wiz 8081: $ cvs commit Makefile
1.66 asau 8082: $ cd pkgname
1.73 jnemeth 8083: $ make CTYPE=Added commit-changes-entry
1.1 dsieger 8084:
8085: The commit message of the initial import should include part of the DESCR file,
8086: so people reading the mailing lists know what the package is/does.
8087:
1.34 wiz 8088: Also mention the new package in pkgsrc/doc/CHANGES-20xx.
8089:
8090: Previously, "cvs import" was suggested, but it was much easier to get wrong
8091: than "cvs add".
1.1 dsieger 8092:
1.154 rillig 8093: 23.6. Updating a package to a newer version
1.1 dsieger 8094:
8095: Please always put a concise, appropriate and relevant summary of the changes
8096: between old and new versions into the commit log when updating a package. There
8097: are various reasons for this:
8098:
8099: * A URL is volatile, and can change over time. It may go away completely or
8100: its information may be overwritten by newer information.
8101:
8102: * Having the change information between old and new versions in our CVS
8103: repository is very useful for people who use either cvs or anoncvs.
8104:
8105: * Having the change information between old and new versions in our CVS
8106: repository is very useful for people who read the pkgsrc-changes mailing
8107: list, so that they can make tactical decisions about when to upgrade the
8108: package.
8109:
8110: Please also recognize that, just because a new version of a package has been
8111: released, it should not automatically be upgraded in the CVS repository. We
8112: prefer to be conservative in the packages that are included in pkgsrc -
8113: development or beta packages are not really the best thing for most places in
8114: which pkgsrc is used. Please use your judgement about what should go into
8115: pkgsrc, and bear in mind that stability is to be preferred above new and
8116: possibly untested features.
8117:
1.154 rillig 8118: 23.7. Renaming a package in pkgsrc
1.21 snj 8119:
8120: Renaming packages is not recommended.
8121:
1.175 gutterid 8122: When renaming packages, be sure to fix any references to the old name in other
1.21 snj 8123: Makefiles, options, buildlink files, etc.
8124:
1.175 gutterid 8125: Also, when renaming a package, please add the package name and version pattern
1.167 leot 8126: (s) of the previous package to SUPERSEDES. This may be repeated for multiple
8127: renames. The new package would be an exact replacement. Example:
8128:
8129: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
8130: SUPERSEDES+= optcomp-[0-9]*
1.21 snj 8131:
8132: Note that "successor" in the CHANGES-YYYY file doesn't necessarily mean that it
8133: supersedes, as that successor may not be an exact replacement but is a
8134: suggestion for the replaced functionality.
8135:
1.154 rillig 8136: 23.8. Moving a package in pkgsrc
1.21 snj 8137:
8138: It is preferred that packages are not renamed or moved, but if needed please
8139: follow these steps.
1.1 dsieger 8140:
8141: 1. Make a copy of the directory somewhere else.
8142:
8143: 2. Remove all CVS dirs.
8144:
8145: Alternatively to the first two steps you can also do:
8146:
8147: % cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package
8148:
8149: and use that for further work.
8150:
1.25 wiz 8151: 3. Fix CATEGORIES and any DEPENDS paths that just did "../package" instead of
1.1 dsieger 8152: "../../category/package".
8153:
1.21 snj 8154: 4. In the modified package's Makefile, consider setting PREV_PKGPATH to the
8155: previous category/package pathname. The PREV_PKGPATH can be used by tools
8156: for doing an update using pkgsrc building; for example, it can search the
8157: pkg_summary(5) database for PREV_PKGPATH (if no SUPERSEDES) and then use
8158: the corresponding new PKGPATH for that moved package. Note that it may have
8159: multiple matches, so the tool should also check on the PKGBASE too. The
8160: PREV_PKGPATH probably has no value unless SUPERSEDES is not set, i.e.
8161: PKGBASE stays the same.
8162:
8163: 5. cvs import the modified package in the new place.
1.1 dsieger 8164:
1.21 snj 8165: 6. Check if any package depends on it:
1.1 dsieger 8166:
8167: % cd /usr/pkgsrc
8168: % grep /package */*/Makefile* */*/buildlink*
8169:
1.21 snj 8170: 7. Fix paths in packages from step 5 to point to new location.
1.1 dsieger 8171:
1.21 snj 8172: 8. cvs rm (-f) the package at the old location.
1.1 dsieger 8173:
1.21 snj 8174: 9. Remove from oldcategory/Makefile.
1.1 dsieger 8175:
1.21 snj 8176: 10. Add to newcategory/Makefile.
1.1 dsieger 8177:
1.21 snj 8178: 11. Commit the changed and removed files:
1.1 dsieger 8179:
8180: % cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile
8181:
8182: (and any packages from step 5, of course).
8183:
1.154 rillig 8184: Chapter 24. Frequently Asked Questions
1.1 dsieger 8185:
8186: This section contains the answers to questions that may arise when you are
8187: writing a package. If you don't find your question answered here, first have a
8188: look in the other chapters, and if you still don't have the answer, ask on the
8189: pkgsrc-users mailing list.
8190:
1.154 rillig 8191: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
8192: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
8193: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
8194: 24.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
1.1 dsieger 8195: BUILDLINK_LIBS?
1.154 rillig 8196: 24.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
8197: 24.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 8198: the := inside it.
1.154 rillig 8199: 24.7. Which mailing lists are there for package developers?
8200: 24.8. Where is the pkgsrc documentation?
8201: 24.9. I have a little time to kill. What shall I do?
1.1 dsieger 8202:
1.154 rillig 8203: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
1.1 dsieger 8204:
8205: MAKEFLAGS are the flags passed to the pkgsrc-internal invocations of make
8206: (1), while MAKE_FLAGS are the flags that are passed to the MAKE_PROGRAM
8207: when building the package. [FIXME: What is .MAKEFLAGS for?]
8208:
1.154 rillig 8209: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
1.1 dsieger 8210:
8211: MAKE is the path to the make(1) program that is used in the pkgsrc
8212: infrastructure. GMAKE is the path to GNU Make, but you need to say
8213: USE_TOOLS+=gmake to use that. MAKE_PROGRAM is the path to the Make
8214: program that is used for building the package.
8215:
1.154 rillig 8216: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
1.1 dsieger 8217:
8218: CC is the path to the real C compiler, which can be configured by the
8219: pkgsrc user. PKG_CC is the path to the compiler wrapper. PKGSRC_COMPILER
8220: is not a path to a compiler, but the type of compiler that should be
8221: used. See mk/compiler.mk for more information about the latter variable.
8222:
1.154 rillig 8223: 24.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
1.1 dsieger 8224: BUILDLINK_LIBS?
8225:
8226: [FIXME]
8227:
1.154 rillig 8228: 24.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
1.1 dsieger 8229:
1.25 wiz 8230: For optimization reasons, some variables are only available in the "
8231: wrapper" phase and later. To "simulate" the wrapper phase, append
1.1 dsieger 8232: PKG_PHASE=wrapper to the above command.
8233:
1.154 rillig 8234: 24.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 8235: the := inside it.
8236:
1.108 rillig 8237: The := is not really an assignment operator, although it looks like it.
8238: Instead, it is a degenerate form of ${LIST:old_string=new_string}, which
8239: is documented in the make(1) man page and which is commonly used in the
8240: form ${SRCS:.c=.o}. In the case of MASTER_SITE_*, old_string is the empty
8241: string and new_string is package/. That's where the : and the = fall
8242: together.
1.1 dsieger 8243:
1.154 rillig 8244: 24.7. Which mailing lists are there for package developers?
1.1 dsieger 8245:
8246: tech-pkg
8247:
8248: This is a list for technical discussions related to pkgsrc
8249: development, e.g. soliciting feedback for changes to pkgsrc
8250: infrastructure, proposed new features, questions related to porting
8251: pkgsrc to a new platform, advice for maintaining a package, patches
8252: that affect many packages, help requests moved from pkgsrc-users when
8253: an infrastructure bug is found, etc.
8254:
8255: pkgsrc-bugs
8256:
8257: All bug reports in category "pkg" sent with send-pr(1) appear here.
8258: Please do not report your bugs here directly; use one of the other
8259: mailing lists.
8260:
1.154 rillig 8261: 24.8. Where is the pkgsrc documentation?
1.1 dsieger 8262:
8263: There are many places where you can find documentation about pkgsrc:
8264:
8265: * The pkgsrc guide (this document) is a collection of chapters that
8266: explain large parts of pkgsrc, but some chapters tend to be outdated.
8267: Which ones they are is hard to say.
8268:
1.174 leot 8269: * On the mailing list archives (see https://mail-index.NetBSD.org/),
8270: you can find discussions about certain features, announcements of new
1.1 dsieger 8271: parts of the pkgsrc infrastructure and sometimes even announcements
8272: that a certain feature has been marked as obsolete. The benefit here
8273: is that each message has a date appended to it.
8274:
8275: * Many of the files in the mk/ directory start with a comment that
8276: describes the purpose of the file and how it can be used by the
8277: pkgsrc user and package authors. An easy way to find this
8278: documentation is to run bmake help.
8279:
8280: * The CVS log messages are a rich source of information, but they tend
8281: to be highly abbreviated, especially for actions that occur often.
8282: Some contain a detailed description of what has changed, but they are
8283: geared towards the other pkgsrc developers, not towards an average
8284: pkgsrc user. They also only document changes, so if you don't know
8285: what has been before, these messages may not be worth too much to
8286: you.
8287:
8288: * Some parts of pkgsrc are only "implicitly documented", that is the
8289: documentation exists only in the mind of the developer who wrote the
8290: code. To get this information, use the cvs annotate command to see
8291: who has written it and ask on the tech-pkg mailing list, so that
8292: others can find your questions later (see above). To be sure that the
8293: developer in charge reads the mail, you may CC him or her.
8294:
1.154 rillig 8295: 24.9. I have a little time to kill. What shall I do?
1.1 dsieger 8296:
8297: This is not really an FAQ yet, but here's the answer anyway.
8298:
8299: * Run pkg_chk -N (from the pkgtools/pkg_chk package). It will tell you
8300: about newer versions of installed packages that are available, but
8301: not yet updated in pkgsrc.
8302:
1.198 leot 8303: * Browse pkgsrc/doc/TODO -- it contains a list of suggested new
8304: packages and a list of cleanups and enhancements for pkgsrc that
8305: would be nice to have.
1.1 dsieger 8306:
1.71 wiz 8307: * Review packages for which review was requested on the tech-pkg
8308: mailing list.
1.1 dsieger 8309:
8310: Part III. The pkgsrc infrastructure internals
8311:
8312: This part of the guide deals with everything from the infrastructure that is
8313: behind the interfaces described in the developer's guide. A casual package
8314: maintainer should not need anything from this part.
8315:
8316: Table of Contents
8317:
1.184 rillig 8318: 25. Design of the pkgsrc infrastructure
1.1 dsieger 8319:
1.184 rillig 8320: 25.1. The meaning of variable definitions
8321: 25.2. Avoiding problems before they arise
8322: 25.3. Variable evaluation
1.1 dsieger 8323:
1.184 rillig 8324: 25.3.1. At load time
8325: 25.3.2. At runtime
1.1 dsieger 8326:
1.184 rillig 8327: 25.4. How can variables be specified?
8328: 25.5. Designing interfaces for Makefile fragments
1.1 dsieger 8329:
1.184 rillig 8330: 25.5.1. Procedures with parameters
8331: 25.5.2. Actions taken on behalf of parameters
1.1 dsieger 8332:
1.184 rillig 8333: 25.6. The order in which files are loaded
1.1 dsieger 8334:
1.184 rillig 8335: 25.6.1. The order in bsd.prefs.mk
8336: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 8337:
1.184 rillig 8338: 26. Regression tests
1.1 dsieger 8339:
1.184 rillig 8340: 26.1. Running the regression tests
8341: 26.2. Adding a new regression test
1.1 dsieger 8342:
1.184 rillig 8343: 26.2.1. Overridable functions
8344: 26.2.2. Helper functions
1.1 dsieger 8345:
1.184 rillig 8346: 27. Porting pkgsrc
1.1 dsieger 8347:
1.184 rillig 8348: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8349:
1.184 rillig 8350: Chapter 25. Design of the pkgsrc infrastructure
1.1 dsieger 8351:
8352: Table of Contents
8353:
1.184 rillig 8354: 25.1. The meaning of variable definitions
8355: 25.2. Avoiding problems before they arise
8356: 25.3. Variable evaluation
1.1 dsieger 8357:
1.184 rillig 8358: 25.3.1. At load time
8359: 25.3.2. At runtime
1.1 dsieger 8360:
1.184 rillig 8361: 25.4. How can variables be specified?
8362: 25.5. Designing interfaces for Makefile fragments
1.1 dsieger 8363:
1.184 rillig 8364: 25.5.1. Procedures with parameters
8365: 25.5.2. Actions taken on behalf of parameters
1.1 dsieger 8366:
1.184 rillig 8367: 25.6. The order in which files are loaded
1.1 dsieger 8368:
1.184 rillig 8369: 25.6.1. The order in bsd.prefs.mk
8370: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 8371:
8372: The pkgsrc infrastructure consists of many small Makefile fragments. Each such
8373: fragment needs a properly specified interface. This chapter explains how such
8374: an interface looks like.
8375:
1.184 rillig 8376: 25.1. The meaning of variable definitions
1.1 dsieger 8377:
8378: Whenever a variable is defined in the pkgsrc infrastructure, the location and
8379: the way of definition provide much information about the intended use of that
8380: variable. Additionally, more documentation may be found in a header comment or
8381: in this pkgsrc guide.
8382:
8383: A special file is mk/defaults/mk.conf, which lists all variables that are
8384: intended to be user-defined. They are either defined using the ?= operator or
8385: they are left undefined because defining them to anything would effectively
8386: mean "yes". All these variables may be overridden by the pkgsrc user in the
8387: MAKECONF file.
8388:
8389: Outside this file, the following conventions apply: Variables that are defined
8390: using the ?= operator may be overridden by a package.
8391:
8392: Variables that are defined using the = operator may be used read-only at
8393: run-time.
8394:
8395: Variables whose name starts with an underscore must not be accessed outside the
8396: pkgsrc infrastructure at all. They may change without further notice.
8397:
8398: Note
8399:
8400: These conventions are currently not applied consistently to the complete pkgsrc
8401: infrastructure.
8402:
1.184 rillig 8403: 25.2. Avoiding problems before they arise
1.1 dsieger 8404:
8405: All variables that contain lists of things should default to being empty. Two
8406: examples that do not follow this rule are USE_LANGUAGES and DISTFILES. These
8407: variables cannot simply be modified using the += operator in package Makefiles
8408: (or other files included by them), since there is no guarantee whether the
8409: variable is already set or not, and what its value is. In the case of
8410: DISTFILES, the packages "know" the default value and just define it as in the
8411: following example.
8412:
8413: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
8414:
8415: Because of the selection of this default value, the same value appears in many
8416: package Makefiles. Similarly for USE_LANGUAGES, but in this case the default
8417: value ("c") is so short that it doesn't stand out. Nevertheless it is mentioned
8418: in many files.
8419:
1.184 rillig 8420: 25.3. Variable evaluation
1.1 dsieger 8421:
1.184 rillig 8422: 25.3.1. At load time
1.1 dsieger 8423:
8424: Variable evaluation takes place either at load time or at runtime, depending on
8425: the context in which they occur. The contexts where variables are evaluated at
8426: load time are:
8427:
8428: * The right hand side of the := and != operators,
8429:
8430: * Make directives like .if or .for,
8431:
8432: * Dependency lines.
8433:
8434: A special exception are references to the iteration variables of .for loops,
8435: which are expanded inline, no matter in which context they appear.
8436:
8437: As the values of variables may change during load time, care must be taken not
8438: to evaluate them by accident. Typical examples for variables that should not be
8439: evaluated at load time are DEPENDS and CONFIGURE_ARGS. To make the effect more
8440: clear, here is an example:
8441:
8442: CONFIGURE_ARGS= # none
8443: CFLAGS= -O
8444: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
8445:
8446: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
8447:
8448: CFLAGS+= -Wall
8449:
8450: This code shows how the use of the := operator can quickly lead to unexpected
8451: results. The first paragraph is fairly common code. The second paragraph
8452: evaluates the CONFIGURE_ARGS variable, which results in CFLAGS=-O. In the third
8453: paragraph, the -Wall is appended to the CFLAGS, but this addition will not
8454: appear in CONFIGURE_ARGS. In actual code, the three paragraphs from above
8455: typically occur in completely unrelated files.
8456:
1.184 rillig 8457: 25.3.2. At runtime
1.1 dsieger 8458:
8459: After all the files have been loaded, the values of the variables cannot be
8460: changed anymore. Variables that are used in the shell commands are expanded at
8461: this point.
8462:
1.184 rillig 8463: 25.4. How can variables be specified?
1.1 dsieger 8464:
8465: There are many ways in which the definition and use of a variable can be
8466: restricted in order to detect bugs and violations of the (mostly unwritten)
1.108 rillig 8467: policies. A package can be checked with pkglint -Wall to see whether it meets
8468: these rules.
1.1 dsieger 8469:
1.184 rillig 8470: 25.5. Designing interfaces for Makefile fragments
1.1 dsieger 8471:
8472: Most of the .mk files fall into one of the following classes. Cases where a
8473: file falls into more than one class should be avoided as it often leads to
8474: subtle bugs.
8475:
1.184 rillig 8476: 25.5.1. Procedures with parameters
1.1 dsieger 8477:
8478: In a traditional imperative programming language some of the .mk files could be
1.198 leot 8479: described as procedures. They take some input parameters and--after
8480: inclusion--provide a result in output parameters. Since all variables in
1.23 jakllsch 8481: Makefiles have global scope care must be taken not to use parameter names that
8482: have already another meaning. For example, PKGNAME is a bad choice for a
8483: parameter name.
1.1 dsieger 8484:
8485: Procedures are completely evaluated at preprocessing time. That is, when
8486: calling a procedure all input parameters must be completely resolvable. For
8487: example, CONFIGURE_ARGS should never be an input parameter since it is very
8488: likely that further text will be added after calling the procedure, which would
8489: effectively apply the procedure to only a part of the variable. Also,
1.108 rillig 8490: references to other variables will be modified after calling the procedure.
1.1 dsieger 8491:
8492: A procedure can declare its output parameters either as suitable for use in
8493: preprocessing directives or as only available at runtime. The latter
8494: alternative is for variables that contain references to other runtime
8495: variables.
8496:
8497: Procedures shall be written such that it is possible to call the procedure more
8498: than once. That is, the file must not contain multiple-inclusion guards.
8499:
8500: Examples for procedures are mk/bsd.options.mk and mk/buildlink3/bsd.builtin.mk.
8501: To express that the parameters are evaluated at load time, they should be
8502: assigned using the := operator, which should be used only for this purpose.
8503:
1.184 rillig 8504: 25.5.2. Actions taken on behalf of parameters
1.1 dsieger 8505:
8506: Action files take some input parameters and may define runtime variables. They
8507: shall not define loadtime variables. There are action files that are included
8508: implicitly by the pkgsrc infrastructure, while other must be included
8509: explicitly.
8510:
8511: An example for action files is mk/subst.mk.
8512:
1.184 rillig 8513: 25.6. The order in which files are loaded
1.1 dsieger 8514:
8515: Package Makefiles usually consist of a set of variable definitions, and include
8516: the file ../../mk/bsd.pkg.mk in the very last line. Before that, they may also
8517: include various other *.mk files if they need to query the availability of
8518: certain features like the type of compiler or the X11 implementation. Due to
8519: the heavy use of preprocessor directives like .if and .for, the order in which
8520: the files are loaded matters.
8521:
8522: This section describes at which point the various files are loaded and gives
8523: reasons for that order.
8524:
1.184 rillig 8525: 25.6.1. The order in bsd.prefs.mk
1.1 dsieger 8526:
8527: The very first action in bsd.prefs.mk is to define some essential variables
8528: like OPSYS, OS_VERSION and MACHINE_ARCH.
8529:
1.4 rillig 8530: Then, the user settings are loaded from the file specified in MAKECONF, which
8531: is usually mk.conf. After that, those variables that have not been overridden
8532: by the user are loaded from mk/defaults/mk.conf.
1.1 dsieger 8533:
8534: After the user settings, the system settings and platform settings are loaded,
8535: which may override the user settings.
8536:
8537: Then, the tool definitions are loaded. The tool wrappers are not yet in effect.
8538: This only happens when building a package, so the proper variables must be used
8539: instead of the direct tool names.
8540:
8541: As the last steps, some essential variables from the wrapper and the package
8542: system flavor are loaded, as well as the variables that have been cached in
8543: earlier phases of a package build.
8544:
1.184 rillig 8545: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 8546:
8547: First, bsd.prefs.mk is loaded.
8548:
8549: Then, the various *-vars.mk files are loaded, which fill default values for
8550: those variables that have not been defined by the package. These variables may
8551: later be used even in unrelated files.
8552:
8553: Then, the file bsd.pkg.error.mk provides the target error-check that is added
8554: as a special dependency to all other targets that use DELAYED_ERROR_MSG or
8555: DELAYED_WARNING_MSG.
8556:
8557: Then, the package-specific hacks from hacks.mk are included.
8558:
8559: Then, various other files follow. Most of them don't have any dependencies on
8560: what they need to have included before or after them, though some do.
8561:
8562: The code to check PKG_FAIL_REASON and PKG_SKIP_REASON is then executed, which
8563: restricts the use of these variables to all the files that have been included
8564: before. Appearances in later files will be silently ignored.
8565:
8566: Then, the files for the main targets are included, in the order of later
8567: execution, though the actual order should not matter.
8568:
8569: At last, some more files are included that don't set any interesting variables
8570: but rather just define make targets to be executed.
8571:
1.184 rillig 8572: Chapter 26. Regression tests
1.1 dsieger 8573:
8574: Table of Contents
8575:
1.184 rillig 8576: 26.1. Running the regression tests
8577: 26.2. Adding a new regression test
1.1 dsieger 8578:
1.184 rillig 8579: 26.2.1. Overridable functions
8580: 26.2.2. Helper functions
1.1 dsieger 8581:
8582: The pkgsrc infrastructure consists of a large codebase, and there are many
8583: corners where every little bit of a file is well thought out, making pkgsrc
8584: likely to fail as soon as anything is changed near those parts. To prevent most
8585: changes from breaking anything, a suite of regression tests should go along
8586: with every important part of the pkgsrc infrastructure. This chapter describes
8587: how regression tests work in pkgsrc and how you can add new tests.
8588:
1.184 rillig 8589: 26.1. Running the regression tests
1.1 dsieger 8590:
1.25 wiz 8591: You first need to install the pkgtools/pkg_regress package, which provides the
1.1 dsieger 8592: pkg_regress command. Then you can simply run that command, which will run all
1.168 rillig 8593: tests in the regress/ directory.
1.1 dsieger 8594:
1.184 rillig 8595: 26.2. Adding a new regression test
1.1 dsieger 8596:
1.168 rillig 8597: Every directory in the regress/ directory that contains a file called spec is
1.1 dsieger 8598: considered a regression test. This file is a shell program that is included by
8599: the pkg_regress command. The following functions can be overridden to suit your
8600: needs.
8601:
1.184 rillig 8602: 26.2.1. Overridable functions
1.1 dsieger 8603:
1.108 rillig 8604: These functions do not take any parameters. Although they are called in "set -e
1.168 rillig 8605: " mode, they don't stop at the first failing command. See this Stack Overflow
1.108 rillig 8606: question for details.
1.1 dsieger 8607:
1.108 rillig 8608: do_setup
1.1 dsieger 8609:
8610: This function prepares the environment for the test. By default it does
8611: nothing.
8612:
1.108 rillig 8613: do_test
1.1 dsieger 8614:
8615: This function runs the actual test. By default, it calls TEST_MAKE with the
8616: arguments MAKEARGS_TEST and writes its output including error messages into
8617: the file TEST_OUTFILE.
8618:
1.108 rillig 8619: When defining this function, make sure that all output that needs to be
8620: checked is written to the correct output file. Example:
8621:
8622: do_test() {
8623: echo "Example output"
8624: } 1>$TEST_OUTFILE 2>&1
8625:
8626: check_result
1.1 dsieger 8627:
8628: This function is run after the test and is typically used to compare the
8629: actual output from the one that is expected. It can make use of the various
1.108 rillig 8630: helper functions from the next section. Example:
8631:
8632: check_result() {
8633: exit_status 0
8634: output_require "Example"
8635: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
8636: output_prohibit "no such file or directory"
1.169 rillig 8637: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 8638: }
1.1 dsieger 8639:
1.108 rillig 8640: do_cleanup
1.1 dsieger 8641:
8642: This function cleans everything up after the test has been run. By default
8643: it does nothing.
8644:
1.184 rillig 8645: 26.2.2. Helper functions
1.1 dsieger 8646:
1.168 rillig 8647: regress_fail message...
8648:
8649: This function makes the test fail with the given error message.
8650:
1.108 rillig 8651: exit_status expected
1.1 dsieger 8652:
1.108 rillig 8653: This function compares the exitcode of the do_test function with its first
8654: parameter. If they differ, the test will fail.
1.1 dsieger 8655:
1.108 rillig 8656: output_require regex...
1.1 dsieger 8657:
8658: This function checks for each of its parameters if the output from do_test
1.108 rillig 8659: matches the extended regular expression. If it does not, the test will
8660: fail. Example:
8661:
8662: output_require "looks fine"
8663: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.1 dsieger 8664:
1.177 leot 8665: output_prohibit regex...
1.1 dsieger 8666:
8667: This function checks for each of its parameters if the output from do_test
8668: () does not match the extended regular expression. If any of the regular
8669: expressions matches, the test will fail.
8670:
1.184 rillig 8671: Chapter 27. Porting pkgsrc
1.1 dsieger 8672:
8673: Table of Contents
8674:
1.184 rillig 8675: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8676:
8677: The pkgsrc system has already been ported to many operating systems, hardware
8678: architectures and compilers. This chapter explains the necessary steps to make
8679: pkgsrc even more portable.
8680:
1.184 rillig 8681: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8682:
8683: To port pkgsrc to a new operating system (called MyOS in this example), you
8684: need to touch the following files:
8685:
8686: pkgtools/bootstrap-mk-files/files/mods/MyOS.sys.mk
8687:
8688: This file contains some basic definitions, for example the name of the C
8689: compiler.
8690:
8691: mk/bsd.prefs.mk
8692:
8693: Insert code that defines the variables OPSYS, OS_VERSION, LOWER_OS_VERSION,
8694: LOWER_VENDOR, MACHINE_ARCH, OBJECT_FMT, APPEND_ELF, and the other variables
8695: that appear in this file.
8696:
8697: mk/platform/MyOS.mk
8698:
8699: This file contains the platform-specific definitions that are used by
8700: pkgsrc. Start by copying one of the other files and edit it to your needs.
8701:
8702: mk/tools/tools.MyOS.mk
8703:
8704: This file defines the paths to all the tools that are needed by one or the
8705: other package in pkgsrc, as well as by pkgsrc itself. Find out where these
8706: tools are on your platform and add them.
8707:
8708: Now, you should be able to build some basic packages, like lang/perl5, shells/
8709: bash.
8710:
8711: Appendix A. A simple example package: bison
8712:
8713: Table of Contents
8714:
8715: A.1. files
8716:
8717: A.1.1. Makefile
8718: A.1.2. DESCR
8719: A.1.3. PLIST
8720: A.1.4. Checking a package with pkglint
8721:
8722: A.2. Steps for building, installing, packaging
8723:
8724: We checked to find a piece of software that wasn't in the packages collection,
1.25 wiz 8725: and picked GNU bison. Quite why someone would want to have bison when Berkeley
1.1 dsieger 8726: yacc is already present in the tree is beyond us, but it's useful for the
8727: purposes of this exercise.
8728:
8729: A.1. files
8730:
8731: A.1.1. Makefile
8732:
1.2 rillig 8733: # $NetBSD$
1.1 dsieger 8734: #
8735:
8736: DISTNAME= bison-1.25
8737: CATEGORIES= devel
1.171 rillig 8738: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 8739:
1.30 dholland 8740: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 8741: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 8742: COMMENT= GNU yacc clone
8743:
8744: GNU_CONFIGURE= yes
1.47 wiz 8745: INFO_FILES= yes
1.1 dsieger 8746:
8747: .include "../../mk/bsd.pkg.mk"
8748:
8749: A.1.2. DESCR
8750:
8751: GNU version of yacc. Can make re-entrant parsers, and numerous other
8752: improvements. Why you would want this when Berkeley yacc(1) is part
8753: of the NetBSD source tree is beyond me.
8754:
8755: A.1.3. PLIST
8756:
1.2 rillig 8757: @comment $NetBSD$
1.1 dsieger 8758: bin/bison
8759: man/man1/bison.1.gz
8760: share/bison.simple
8761: share/bison.hairy
8762:
8763: A.1.4. Checking a package with pkglint
8764:
8765: The NetBSD package system comes with pkgtools/pkglint which helps to check the
8766: contents of these files. After installation it is quite easy to use, just
1.171 rillig 8767: change to the directory of the package you wish to examine and run pkglint:
1.1 dsieger 8768:
8769: $ pkglint
1.171 rillig 8770: ERROR: Makefile: Each package must define its LICENSE.
8771: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
8772: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
8773: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
8774: 1 error, 2 warnings and 1 note found.
8775: (Run "pkglint -e" to show explanations.)
8776: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 8777: (Run "pkglint -F" to automatically fix some issues.)
1.1 dsieger 8778:
8779: Depending on the supplied command line arguments (see pkglint(1)), more checks
1.170 rillig 8780: will be performed. Use e.g. pkglint -Wall for a very thorough check.
1.1 dsieger 8781:
8782: A.2. Steps for building, installing, packaging
8783:
8784: Create the directory where the package lives, plus any auxiliary directories:
8785:
8786: # cd /usr/pkgsrc/lang
8787: # mkdir bison
8788: # cd bison
8789: # mkdir patches
8790:
1.184 rillig 8791: Create Makefile, DESCR and PLIST (see Chapter 12, Package components - files,
1.1 dsieger 8792: directories and contents) then continue with fetching the distfile:
8793:
8794: # make fetch
8795: >> bison-1.25.tar.gz doesn't seem to exist on this system.
8796: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
8797: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8798: ftp: Error retrieving file: 500 Internal error
8799:
8800: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
8801: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8802: ftp: Error retrieving file: 500 Internal error
8803:
8804: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
8805: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8806: Successfully retrieved file.
8807:
8808: Generate the checksum of the distfile into distinfo:
8809:
8810: # make makedistinfo
8811:
8812: Now compile:
8813:
8814: # make
8815: >> Checksum OK for bison-1.25.tar.gz.
8816: ===> Extracting for bison-1.25
8817: ===> Patching for bison-1.25
8818: ===> Ignoring empty patch directory
8819: ===> Configuring for bison-1.25
8820: creating cache ./config.cache
8821: checking for gcc... cc
8822: checking whether we are using GNU C... yes
8823: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
8824: checking how to run the C preprocessor... cc -E
8825: checking for minix/config.h... no
8826: checking for POSIXized ISC... no
8827: checking whether cross-compiling... no
8828: checking for ANSI C header files... yes
8829: checking for string.h... yes
8830: checking for stdlib.h... yes
8831: checking for memory.h... yes
8832: checking for working const... yes
8833: checking for working alloca.h... no
8834: checking for alloca... yes
8835: checking for strerror... yes
8836: updating cache ./config.cache
8837: creating ./config.status
8838: creating Makefile
8839: ===> Building for bison-1.25
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 LR0.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 allocate.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 closure.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 conflicts.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 derives.c
8845: 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
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 getargs.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 gram.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 lalr.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 lex.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 main.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 nullable.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 output.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 print.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 reader.c
8855: 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
8856: 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
8857: 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
8858: 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
8859: 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
8860: 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
8861: 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
8862: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
8863: rm -f bison.s1
8864: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1
8865:
8866: Everything seems OK, so install the files:
8867:
8868: # make install
8869: >> Checksum OK for bison-1.25.tar.gz.
8870: ===> Installing for bison-1.25
8871: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
8872: rm -f /usr/pkg/bin/bison
8873: cd /usr/pkg/share; rm -f bison.simple bison.hairy
8874: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
8875: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
8876: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
8877: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
8878: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
8879: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
8880: ===> Registering installation for bison-1.25
8881:
8882: You can now use bison, and also - if you decide so - remove it with pkg_delete
8883: bison. Should you decide that you want a binary package, do this now:
8884:
8885: # make package
8886: >> Checksum OK for bison-1.25.tar.gz.
8887: ===> Building package for bison-1.25
8888: Creating package bison-1.25.tgz
8889: Registering depends:.
8890: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
8891:
8892: Now that you don't need the source and object files any more, clean up:
8893:
8894: # make clean
8895: ===> Cleaning for bison-1.25
8896:
8897: Appendix B. Build logs
8898:
8899: Table of Contents
8900:
8901: B.1. Building figlet
8902: B.2. Packaging figlet
8903:
8904: B.1. Building figlet
8905:
8906: # make
8907: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8908: => figlet221.tar.gz doesn't seem to exist on this system.
8909: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
8910: => [172219 bytes]
8911: Connected to ftp.plig.net.
8912: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
8913: 331 Guest login ok, send your complete e-mail address as password.
8914: 230-You are user #5 of 500 simultaneous users allowed.
8915: 230-
8916: 230- ___ _ _ _
8917: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
8918: 230- | _| _| . |_| . | | | . |_| . | _| . |
8919: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
8920: 230- |_| |_| |___| |___|
8921: 230-
8922: 230-** Welcome to ftp.plig.org **
8923: 230-
8924: 230-Please note that all transfers from this FTP site are logged. If you
8925: 230-do not like this, please disconnect now.
8926: 230-
1.19 snj 8927: 230-This archive is available via
1.1 dsieger 8928: 230-
8929: 230-HTTP: http://ftp.plig.org/
8930: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
8931: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
8932: 230-
8933: 230-Please email comments, bug reports and requests for packages to be
8934: 230-mirrored to ftp-admin@plig.org.
8935: 230-
8936: 230-
8937: 230 Logged in anonymously.
8938: Remote system type is UNIX.
8939: Using binary mode to transfer files.
8940: 200 Type okay.
8941: 250 "/pub" is new cwd.
8942: 250-"/pub/figlet" is new cwd.
8943: 250-
8944: 250-Welcome to the figlet archive at ftp.figlet.org
8945: 250-
8946: 250- ftp://ftp.figlet.org/pub/figlet/
8947: 250-
8948: 250-The official FIGlet web page is:
8949: 250- http://www.figlet.org/
8950: 250-
8951: 250-If you have questions, please mailto:info@figlet.org. If you want to
8952: 250-contribute a font or something else, you can email us.
8953: 250
8954: 250 "/pub/figlet/program" is new cwd.
8955: 250 "/pub/figlet/program/unix" is new cwd.
8956: local: figlet221.tar.gz remote: figlet221.tar.gz
8957: 502 Unimplemented command.
8958: 227 Entering Passive Mode (195,40,6,41,246,104)
8959: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
8960: 38% |************** | 65800 64.16 KB/s 00:01 ETA
8961: 226 Transfer completed.
8962: 172219 bytes received in 00:02 (75.99 KB/s)
8963: 221 Goodbye.
8964: => Checksum OK for figlet221.tar.gz.
8965: ===> Extracting for figlet-2.2.1nb2
8966: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
8967: ===> Patching for figlet-2.2.1nb2
8968: ===> Applying pkgsrc patches for figlet-2.2.1nb2
8969: ===> Overriding tools for figlet-2.2.1nb2
8970: ===> Creating toolchain wrappers for figlet-2.2.1nb2
8971: ===> Configuring for figlet-2.2.1nb2
8972: ===> Building for figlet-2.2.1nb2
8973: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
8974: chmod a+x figlet
8975: gcc -O2 -o chkfont chkfont.c
8976: => Unwrapping files-to-be-installed.
8977: #
8978: # make install
8979: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8980: ===> Installing for figlet-2.2.1nb2
8981: install -d -o root -g wheel -m 755 /usr/pkg/bin
8982: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
8983: mkdir -p /usr/pkg/share/figlet
8984: cp figlet /usr/pkg/bin
8985: cp chkfont /usr/pkg/bin
8986: chmod 555 figlist showfigfonts
8987: cp figlist /usr/pkg/bin
8988: cp showfigfonts /usr/pkg/bin
8989: cp fonts/*.flf /usr/pkg/share/figlet
8990: cp fonts/*.flc /usr/pkg/share/figlet
8991: cp figlet.6 /usr/pkg/man/man6
8992: ===> Registering installation for figlet-2.2.1nb2
8993: #
8994:
8995: B.2. Packaging figlet
8996:
8997: # make package
8998: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8999: ===> Packaging figlet-2.2.1nb2
9000: ===> Building binary package for figlet-2.2.1nb2
9001: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
9002: Using SrcDir value of /usr/pkg
9003: Registering depends:.
9004: #
9005:
9006: Appendix C. Directory layout of the pkgsrc FTP server
9007:
9008: Table of Contents
9009:
1.23 jakllsch 9010: C.1. distfiles: The distributed source files
9011: C.2. misc: Miscellaneous things
9012: C.3. packages: Binary packages
9013: C.4. reports: Bulk build reports
1.148 leot 9014: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 9015:
9016: As in other big projects, the directory layout of pkgsrc is quite complex for
9017: newbies. This chapter explains where you find things on the FTP server. The
9018: base directory on ftp.NetBSD.org is /pub/pkgsrc/. On other servers it may be
9019: different, but inside this directory, everything should look the same, no
9020: matter on which server you are. This directory contains some subdirectories,
9021: which are explained below.
9022:
1.23 jakllsch 9023: C.1. distfiles: The distributed source files
1.1 dsieger 9024:
9025: The directory distfiles contains lots of archive files from all pkgsrc
9026: packages, which are mirrored here. The subdirectories are called after their
9027: package names and are used when the distributed files have names that don't
9028: explicitly contain a version number or are otherwise too generic (for example
9029: release.tar.gz).
9030:
1.23 jakllsch 9031: C.2. misc: Miscellaneous things
1.1 dsieger 9032:
9033: This directory contains things that individual pkgsrc developers find worth
9034: publishing.
9035:
1.23 jakllsch 9036: C.3. packages: Binary packages
1.1 dsieger 9037:
1.3 rillig 9038: This directory contains binary packages for the various platforms that are
9039: supported by pkgsrc. Each subdirectory is of the form OPSYS/ARCH/OSVERSION_TAG.
9040: The meaning of these variables is:
9041:
9042: * OPSYS is the name of the operating system for which the packages have been
1.9 rillig 9043: built. The name is taken from the output of the uname command, so it may
9044: differ from the one you are used to hear.
1.3 rillig 9045:
1.8 rillig 9046: * ARCH is the hardware architecture of the platform for which the packages
1.10 hubertf 9047: have been built. It also includes the ABI (Application Binary Interface)
9048: for platforms that have several of them.
1.3 rillig 9049:
1.8 rillig 9050: * OSVERSION is the version of the operating system. For version numbers that
9051: change often (for example NetBSD-current), the often-changing part should
9052: be replaced with an x, for example 4.99.x.
1.3 rillig 9053:
1.23 jakllsch 9054: * TAG is either 20xxQy for a stable branch, or head for packages built from
1.8 rillig 9055: the HEAD branch. The latter should only be used when the packages are
9056: updated on a regular basis. Otherwise the date from checking out pkgsrc
9057: should be appended, for example head_20071015.
1.3 rillig 9058:
9059: The rationale for exactly this scheme is that the pkgsrc users looking for
9060: binary packages can quickly click through the directories on the server and
9061: find the best binary packages for their machines. Since they usually know the
9062: operating system and the hardware architecture, OPSYS and ARCH are placed
9063: first. After these choices, they can select the best combination of OSVERSION
9064: and TAG together, since it is usually the case that packages stay compatible
9065: between different version of the operating system.
9066:
9067: In each of these directories, there is a whole binary packages collection for a
9068: specific platform. It has a directory called All which contains all binary
9069: packages. Besides that, there are various category directories that contain
9070: symbolic links to the real binary packages.
1.1 dsieger 9071:
1.23 jakllsch 9072: C.4. reports: Bulk build reports
1.8 rillig 9073:
9074: Here are the reports from bulk builds, for those who want to fix packages that
9075: didn't build on some of the platforms. The structure of subdirectories should
1.23 jakllsch 9076: look like the one in Section C.3, "packages: Binary packages".
1.8 rillig 9077:
1.148 leot 9078: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 9079:
9080: These directories contain the "real" pkgsrc, that is the files that define how
9081: to create binary packages from source archives.
9082:
1.149 leot 9083: Each of the current, stable and pkgsrc-20xxQy directories share the same
9084: structure. They each contain a pkgsrc directory and pkgsrc.tar.{bz,gz,xz} file.
9085:
1.1 dsieger 9086: The directory pkgsrc contains a snapshot of the CVS repository, which is
1.149 leot 9087: updated regularly. The file pkgsrc.tar.{bz,gz,xz} contains the same as the
9088: directory, ready to be downloaded as a whole.
1.1 dsieger 9089:
1.149 leot 9090: The current directory contains files related to the HEAD branch of the CVS
9091: repository. In this directory there is an additional file called
9092: pkgsrc-readmes.tar.{bz,gz,xz} that contains all pkgsrc READMEs with information
9093: about categories and packages.
9094:
9095: The stable directory is a symlink to the latest pkgsrc-20xxQy.
9096:
9097: The pkgsrc-20xxQy. directories contain files related to the -20xxQy stable
9098: branch of the CVS repository. In these directories there is an additional file
9099: called pkgsrc-20xxQy.tar.{bz,gz,xz}, which contains the state of pkgsrc when it
9100: was branched.
1.148 leot 9101:
1.154 rillig 9102: Appendix D. Help topics
9103:
9104: The following list contains all help topics that are available when running
9105: bmake help topic=:index.
9106:
1.205 ! wiz 9107: #! -lintl
! 9108: 32bit 64bit
! 9109: ABI ACCEPTABLE_LICENSES
! 9110: ACROREAD_FONTPATH ADDITIONAL
! 9111: AFAIK AIX
! 9112: ALLOW_VULNERABLE_PACKAGES ALL_ENV
! 9113: ALSA_PC ALTERNATIVES_SRC
! 9114: AMANDA_TMP AMANDA_USER
! 9115: AMANDA_VAR APACHE_GROUP
! 9116: APACHE_MODULE_NAME APACHE_MODULE_SRC
! 9117: APACHE_MODULE_SRCDIR APACHE_PKG_PREFIX
! 9118: APACHE_SUEXEC_CONFIGURE_ARGS APACHE_SUEXEC_DOCROOT
! 9119: APACHE_USER APPEND_ABI
! 9120: APPEND_ELF ARLA_CACHE
! 9121: AUDIT_PACKAGES_FLAGS AUTOCONF_REQD
! 9122: AUTOMAKE_OVERRIDE AUTOMAKE_REQD
! 9123: AUTO_MKDIRS BDB185_DEFAULT
! 9124: BDBBASE BDB_ACCEPTED
! 9125: BDB_DEFAULT BDB_LIBS
! 9126: BDB_TYPE BINCIMAP_GROUP
! 9127: BINCIMAP_USER BIND_DIR
! 9128: BIND_GROUP BIND_USER
! 9129: BINOWN BINPKG_SITES
! 9130: BIN_INSTALL_FLAGS BISON_PKGDATADIR
! 9131: BLAS BLAS_ACCEPTED
! 9132: BLAS_C_INTERFACE BLAS_INCLUDES
! 9133: BLAS_INDEX64 BLAS_LIBS
! 9134: BLAS_TYPE BOOTSTRAP_DEPENDS
! 9135: BOOTSTRAP_SETUPTOOLS BROKEN
! 9136: BROKEN_EXCEPT_ON_PLATFORM BROKEN_ON_PLATFORM
! 9137: BSDSRCDIR BSDXSRCDIR
! 9138: BSD_MAKE_ENV BUILDLINK_AUTO_DIRS
! 9139: BUILDLINK_AUTO_VARS BUILDLINK_CFLAGS
! 9140: BUILDLINK_CONTENTS_FILTER BUILDLINK_CPPFLAGS
! 9141: BUILDLINK_DEPMETHOD BUILDLINK_FILES
! 9142: BUILDLINK_FILES_CMD BUILDLINK_FNAME_TRANSFORM
! 9143: BUILDLINK_LDFLAGS BUILDLINK_LIBS
! 9144: BUILDLINK_OPSYS_SUPPORT_PTHREAD BUILDLINK_PKGNAME
! 9145: BUILDLINK_PREFIX BUILDLINK_RPATHDIRS
! 9146: BUILDLINK_TREE BUILD_DEFS
! 9147: BUILD_DEFS_EFFECTS BUILD_DEPENDS
! 9148: BUILD_DIRS BUILD_ENV_SHELL
! 9149: BUILD_MAKE_CMD BUILD_MAKE_FLAGS
! 9150: BUILD_TARGET BUILTIN_FIND_FILES
! 9151: BUILTIN_FIND_FILES_VAR BUILTIN_FIND_GREP
! 9152: BUILTIN_FIND_HEADERS BUILTIN_FIND_HEADERS_VAR
! 9153: BUILTIN_FIND_PKGCONFIG BUILTIN_FIND_PKGCONFIG_VAR
! 9154: BUILTIN_PKG BUILTIN_TEST_CURSES_DEFINES
! 9155: BUILTIN_TEST_CURSES_FUNCS BUILTIN_VERSION_SCRIPT
! 9156: BUILTIN_X11_TYPE BUILTIN_X11_VERSION
! 9157: CACTI_GROUP CACTI_USER
! 9158: CANNA_GROUP CANNA_USER
! 9159: CAT CBLAS_LIBS
! 9160: CCACHE_BASE CCACHE_DIR
! 9161: CCACHE_LOGFILE CC_VERSION
! 9162: CC_VERSION_STRING CDRECORD_CONF
! 9163: CDROM_PKG_URL_DIR CDROM_PKG_URL_HOST
! 9164: CHECKOUT_DATE CHECK_COMPILER
! 9165: CHECK_FAKEHOME CHECK_FILES
! 9166: CHECK_FILES_SKIP CHECK_FILES_STRICT
! 9167: CHECK_HEADERS CHECK_HEADERS_SKIP
! 9168: CHECK_INTERPRETER CHECK_INTERPRETER_SKIP
! 9169: CHECK_PERMS CHECK_PERMS_AUTOFIX
! 9170: CHECK_PERMS_SKIP CHECK_PORTABILITY
! 9171: CHECK_PORTABILITY_EXPERIMENTAL CHECK_PORTABILITY_SKIP
! 9172: CHECK_RELRO CHECK_RELRO_SKIP
! 9173: CHECK_RELRO_SUPPORTED CHECK_SHLIBS
! 9174: CHECK_SHLIBS_BLACKLIST CHECK_SHLIBS_SKIP
! 9175: CHECK_SHLIBS_SUPPORTED CHECK_SSP
! 9176: CHECK_SSP_SKIP CHECK_SSP_SUPPORTED
! 9177: CHECK_STRIPPED CHECK_STRIPPED_SKIP
! 9178: CHECK_WRKREF CHECK_WRKREF_EXTRA_DIRS
! 9179: CHECK_WRKREF_SKIP CLAMAV_DBDIR
! 9180: CLAMAV_GROUP CLAMAV_USER
! 9181: CLANGBASE CLEANDEPENDS
! 9182: CMAKE_DEPENDENCIES_REWRITE CMAKE_INSTALL_NAME_DIR
! 9183: CMAKE_INSTALL_PREFIX CMAKE_MODULE_PATH_OVERRIDE
! 9184: CMAKE_PKGSRC_BUILD_FLAGS CMAKE_PREFIX_PATH
! 9185: CMAKE_USE_GNU_INSTALL_DIRS COMMON_LISP_DOCFILES
! 9186: COMMON_LISP_EXAMPLES COMMON_LISP_EXTRAFILES
! 9187: COMMON_LISP_PACKAGES COMMON_LISP_SYSTEM
! 9188: COMPILER_RPATH_FLAG COMPILER_USE_SYMLINKS
! 9189: CONFIGURE_ARGS CONFIGURE_DIRS
! 9190: CONFIGURE_ENV CONFIGURE_ENV_SHELL
! 9191: CONFIGURE_HAS_INFODIR CONFIGURE_HAS_MANDIR
! 9192: CONFIGURE_SCRIPT CONFIG_SHELL
! 9193: CONFIG_SHELL_FLAGS CONF_FILES
! 9194: CONF_FILES_MODE CONF_FILES_PERMS
! 9195: CONSERVER_DEFAULTHOST CONSERVER_DEFAULTPORT
! 9196: CP CPP
! 9197: CPP_PRECOMP_FLAGS CREATE_WRKDIR_SYMLINK
! 9198: CROSSBASE CTFCONVERT
! 9199: CTF_FILES_SKIP CTF_SUPPORTED
! 9200: CTYPE CUPS_GROUP
! 9201: CUPS_SYSTEM_GROUPS CUPS_USER
! 9202: CURSES_DEFAULT CURSES_TYPE
! 9203: CVS_EXTRACTDIR CVS_MODULE
! 9204: CVS_PROJECT CVS_REPOSITORIES
! 9205: CVS_ROOT CVS_ROOT_GNU
! 9206: CVS_ROOT_NONGNU CVS_ROOT_SOURCEFORGE
! 9207: CVS_TAG CXX
! 9208: CYRUS_GROUP CYRUS_IDLE
! 9209: CYRUS_USER DAEMONTOOLS_GROUP
! 9210: DAEMONTOOLS_LOG_USER DARWIN_NO_SYSTEM_LIBS
! 9211: DARWIN_REQUIRES_FILTER DBUS_GROUP
! 9212: DBUS_USER DEFANG_GROUP
! 9213: DEFANG_USER DEFAULT_ACCEPTABLE_LICENSES
! 9214: DEFAULT_DISTFILES DEFAULT_IRC_SERVER
! 9215: DEFAULT_SERIAL_DEVICE DEF_UMASK
! 9216: DEINSTALLDEPENDS DEINSTALL_SRC
! 9217: DEINSTALL_TEMPLATES DELAYED_ERROR_MSG
! 9218: DELAYED_WARNING_MSG DEPENDS
! 9219: DEPENDS_TARGET DEPENDS_TYPE
! 9220: DESTDIR DESTDIR_VARNAME
! 9221: DIALER_GROUP DIGEST_REQD
! 9222: DISTDIR DISTFILES
! 9223: DISTINFO_FILE DISTNAME
! 9224: DIST_PATH DIST_SUBDIR
! 9225: DJBDNS_AXFR_USER DJBDNS_CACHE_USER
! 9226: DJBDNS_DJBDNS_GROUP DJBDNS_LOG_USER
! 9227: DJBDNS_RBL_USER DJBDNS_TINY_USER
! 9228: DLOPEN_REQUIRE_PTHREADS DL_AUTO_VARS
! 9229: DL_CFLAGS DL_LDFLAGS
! 9230: DL_LIBS DNS
! 9231: DOCOWN DOWNLOADED_DISTFILE
! 9232: DT_LAYOUT DYNAMIC_SITES_CMD
! 9233: DYNAMIC_SITES_SCRIPT ECHO
! 9234: ECHO_N ELK_GUI
! 9235: EMACS_TYPE EMULDIR
! 9236: EMULSUBDIR EMULSUBDIRSLASH
! 9237: EMUL_ARCH EMUL_DISTRO
! 9238: EMUL_EXEC_FMT EMUL_IS_NATIVE
! 9239: EMUL_MODULES EMUL_OPSYS
! 9240: EMUL_PKG_FMT EMUL_PLATFORM
! 9241: EMUL_PLATFORMS EMUL_PREFER
! 9242: EMUL_REQD EMUL_TYPE
! 9243: ERROR_MSG EXIM_GROUP
! 9244: EXIM_USER EXPORT_SYMBOLS_LDFLAGS
! 9245: EXTRACTOR EXTRACT_CMD
! 9246: EXTRACT_CMD_DEFAULT EXTRACT_DIR
! 9247: EXTRACT_ELEMENTS EXTRACT_ENV
! 9248: EXTRACT_ONLY EXTRACT_OPTS
! 9249: EXTRACT_SUFX EXTRACT_USING
! 9250: FAIL FAILOVER_FETCH
! 9251: FAIL_MSG FAKE_NCURSES
! 9252: FAM FAM_ACCEPTED
! 9253: FAM_DEFAULT FAM_SERVER
! 9254: FCPATH FEATURE_CPPFLAGS
! 9255: FEATURE_LDFLAGS FEATURE_LIBS
! 9256: FETCH_AFTER_ARGS FETCH_BEFORE_ARGS
! 9257: FETCH_CMD FETCH_OUTPUT_ARGS
! 9258: FETCH_PROXY FETCH_RESUME_ARGS
! 9259: FETCH_TIMEOUT FETCH_USE_IPV4_ONLY
! 9260: FETCH_USING FILES_SUBST
! 9261: FILES_SUBST_SED FIX_SYSTEM_HEADERS
! 9262: FLUXBOX_USE_GNOME FLUXBOX_USE_KDE
! 9263: FLUXBOX_USE_XFT FLUXBOX_USE_XINERAMA
! 9264: FONTDIR FONTS_DIRS
! 9265: FONTS_VERBOSE FOO_HACKS_MK
! 9266: FOSSIL_EXTRACTDIR FOSSIL_REPO
! 9267: FOSSIL_REPOSITORIES FOSSIL_VERSION
! 9268: FOX_USE_XUNICODE FREEWNN_GROUP
! 9269: FREEWNN_USER FTP_PKG_URL_DIR
! 9270: FTP_PKG_URL_HOST GAMEDATAMODE
! 9271: GAMEDATA_PERMS GAMEDIRMODE
! 9272: GAMEDIR_PERMS GAMEGRP
! 9273: GAMEMODE GAMEOWN
! 9274: GAMES_GROUP GAMES_USER
! 9275: GCC GCCBASE
! 9276: GCC_REQD GCC_VERSION_SUFFIX
! 9277: GEM_BUILD GEM_CLEANBUILD
! 9278: GEM_CLEANBUILD_EXTENSIONS GEM_DOCDIR
! 9279: GEM_EXTSDIR GEM_HOME
! 9280: GEM_KEEPBUILD GEM_LIBDIR
! 9281: GEM_NAME GEM_PATH
! 9282: GEM_PLUGINSDIR GEM_SPECFILE
! 9283: GENERATE_PLIST GHC
! 9284: GHOSTSCRIPT_REQD GITHUB_PROJECT
! 9285: GITHUB_RELEASE GITHUB_SUBMODULES
! 9286: GITHUB_TAG GITHUB_TYPE
! 9287: GITLAB_PROJECT GITLAB_TAG
! 9288: GITLAB_TYPE GIT_BRANCH
! 9289: GIT_ENV GIT_EXTRACTDIR
! 9290: GIT_REPO GIT_REPOSITORIES
! 9291: GIT_REVISION GIT_TAG
! 9292: GNU GNU_CONFIGURE
! 9293: GNU_CONFIGURE_INFODIR GNU_CONFIGURE_MANDIR
! 9294: GNU_CONFIGURE_QUIET GNU_CONFIGURE_STRICT
! 9295: GODEP_REDIRECTS GO_BUILD_PATTERN
! 9296: GO_DEPS GO_DIST_BASE
! 9297: GO_MODULE_FILES GO_SRCPATH
! 9298: GO_VERSION_DEFAULT GROUP_SPECIFIC_PKGS
! 9299: GRUB_NETWORK_CARDS GRUB_PRESET_COMMAND
! 9300: GRUB_SCAN_ARGS GZIP
! 9301: HASKELL_COMPILER HASKELL_ENABLE_HADDOCK_DOCUMENTATION
! 9302: HASKELL_ENABLE_LIBRARY_PROFILING HASKELL_ENABLE_SHARED_LIBRARY
! 9303: HASKELL_OPTIMIZATION_LEVEL HAS_CONFIGURE
! 9304: HEADER_TEMPLATES HG_REPO
! 9305: HG_REPOSITORIES HG_TAG
! 9306: HOMEPAGE HOST_PKGTOOLS_ARGS
! 9307: HOST_SPECIFIC_PKGS HOWL_GROUP
! 9308: HOWL_USER ICCBASE
! 9309: ICECAST_CHROOTDIR ICON_THEMES
! 9310: IDOBASE IGNORE_CCACHE
! 9311: IGNORE_INFO_DIRS IGNORE_INTERACTIVE_FETCH
! 9312: IMAKE IMAKEOPTS
! 9313: IMAKE_MAKE IMAKE_MANINSTALL
! 9314: IMAP_UW_CCLIENT_MBOX_FMT IMDICTDIR
! 9315: INCOMPAT_CURSES INFO_DIR
! 9316: INFO_FILES INFO_FILES_VERBOSE
! 9317: INFO_MSG INIT_SYSTEM
! 9318: INN_DATA_DIR INN_GROUP
! 9319: INN_USER INSTALLATION_DIRS
! 9320: INSTALLATION_DIRS_FROM_PLIST INSTALL_ENV
! 9321: INSTALL_SH_OVERRIDE INSTALL_SRC
! 9322: INSTALL_TEMPLATES INSTALL_UNSTRIPPED
! 9323: IRCD_HYBRID_IRC_GROUP IRCD_HYBRID_IRC_USER
! 9324: IRCD_HYBRID_MAXCONN IRCD_HYBRID_NICLEN
! 9325: IRCD_HYBRID_SYSLOG_EVENTS IRCD_HYBRID_SYSLOG_FACILITY
! 9326: IRCD_HYBRID_TOPICLEN IRIX
! 9327: IRRD_USE_PGP JABBERD_GROUP
! 9328: JABBERD_LOGDIR JABBERD_PIDDIR
! 9329: JABBERD_SPOOLDIR JABBERD_USER
! 9330: JAKARTA_HOME JAVA_APP_PATH
! 9331: JAVA_APP_TARGETS JAVA_BINPREFIX
! 9332: JAVA_CLASSPATH JAVA_HOME
! 9333: JAVA_LD_LIBRARY_PATH JAVA_NAME
! 9334: JAVA_UNLIMIT JAVA_WRAPPERS
! 9335: JPEG_ACCEPTED JPEG_DEFAULT
! 9336: KERBEROS KERMIT_SUID_UUCP
! 9337: KJS_USE_PCRE KNEWS_DOMAIN_FILE
! 9338: KNEWS_DOMAIN_NAME KRB5_ACCEPTED
! 9339: KRB5_DEFAULT LANGUAGES
! 9340: LAPACKE_LIBS LAPACK_LIBS
! 9341: LATEX2HTML_ICONPATH LDCONFIG_ADD_CMD
! 9342: LDCONFIG_REMOVE_CMD LEAFNODE_DATA_DIR
! 9343: LEAFNODE_GROUP LEAFNODE_USER
! 9344: LIBDVDCSS_HOMEPAGE LIBDVDCSS_MASTER_SITES
! 9345: LIBRSVG_TYPE LIBTOOL
! 9346: LIBTOOLIZE_PLIST LIBTOOL_M4_OVERRIDE
! 9347: LIBUSB_TYPE LICENSE
! 9348: LINKER_RPATH_FLAG LINK_RPATH_FLAG
! 9349: LINUX_BASE_NODEPS LINUX_BASE_PREFERRED
! 9350: LINUX_BASE_REQUIRED LINUX_LOCALES
! 9351: LOCALBASE LOCALBASE_LOCKTYPE
! 9352: LOCALPATCHES LOVE_DATA
! 9353: LOVE_GAME LOVE_VERSION
! 9354: LP32PLATFORMS LP64PLATFORMS
! 9355: MACHINE_PLATFORM MAILAGENT_DOMAIN
! 9356: MAILAGENT_EMAIL MAILAGENT_FQDN
! 9357: MAILAGENT_ORGANIZATION MAJORDOMO_HOMEDIR
! 9358: MAJOR_OS_VERSION MAKEINFO_ARGS
! 9359: MAKE_DIRS MAKE_DIRS_PERMS
! 9360: MAKE_ENV MAKE_FILE
! 9361: MAKE_FLAGS MAKE_JOBS
! 9362: MAKE_JOBS_SAFE MAKE_PROGRAM
! 9363: MANCOMPRESSED_IF_MANZ MANINSTALL
! 9364: MANZ MASTER_SITES
! 9365: MASTER_SITE_BACKUP MASTER_SITE_LOCAL
! 9366: MASTER_SITE_MOZILLA MASTER_SITE_OVERRIDE
! 9367: MASTER_SITE_PERL_CPAN MASTER_SORT
! 9368: MASTER_SORT_RANDOM MASTER_SORT_REGEX
! 9369: MECAB_CHARSET MEDIATOMB_GROUP
! 9370: MEDIATOMB_USER MIPSPROBASE
! 9371: MIREDO_GROUP MIREDO_USER
! 9372: MISSING_FEATURES MKDIR
! 9373: MLDONKEY_GROUP MLDONKEY_HOME
! 9374: MLDONKEY_USER MONOTONE_GROUP
! 9375: MONOTONE_USER MOTIFBASE
! 9376: MOTIF_TYPE MOTIF_TYPE_DEFAULT
! 9377: MPI_TYPE MSGFMT_STRIP_MSGCTXT
! 9378: MSGFMT_STRIP_MSGID_PLURAL MTOOLS_ENABLE_FLOPPYD
! 9379: MUST MV
! 9380: MYSQL_CHARSET MYSQL_DATADIR
! 9381: MYSQL_EXTRA_CHARSET MYSQL_GROUP
! 9382: MYSQL_USER MYSQL_VERSION
! 9383: MYSQL_VERSIONS_ACCEPTED MYSQL_VERSIONS_ALL
! 9384: MYSQL_VERSION_DEFAULT NAGIOSCMD_GROUP
! 9385: NAGIOSDIR NAGIOS_GROUP
! 9386: NAGIOS_USER NATIVE_APPEND_ABI
! 9387: NATIVE_APPEND_ELF NATIVE_EXEC_FMT
! 9388: NATIVE_MACHINE_PLATFORM NATIVE_OBJECT_FMT
! 9389: NBPAX_PROGRAM_PREFIX NETBSD_LOGIN_NAME
! 9390: NMH_EDITOR NMH_MTA
! 9391: NMH_PAGER NOLOGIN
! 9392: NOTE NOT_FOR_PLATFORM
! 9393: NOT_PAX_ASLR_SAFE NOT_PAX_MPROTECT_SAFE
! 9394: NO_BUILD NO_CHECKSUM
! 9395: NO_CONFIGURE NO_SKIP
! 9396: NS_PREFERRED NULLMAILER_GROUP
! 9397: NULLMAILER_USER OASIS
! 9398: OASIS_BUILD_ARGS OBJHOSTNAME
! 9399: OBJMACHINE OCAML_FINDLIB_DIRS
! 9400: OCAML_FINDLIB_REGISTER OCAML_FINDLIB_REGISTER_VERBOSE
! 9401: OCAML_SITELIBDIR OCAML_TOPKG_DOCDIR
! 9402: OCAML_USE_DUNE OCAML_USE_FINDLIB
! 9403: OCAML_USE_JBUILDER OCAML_USE_OASIS
! 9404: OCAML_USE_OASIS_DYNRUN OCAML_USE_OPAM
! 9405: OCAML_USE_OPT_COMPILER OCAML_USE_TOPKG
! 9406: OMF ONLY_FOR_COMPILER
! 9407: ONLY_FOR_PLATFORM OPENSSH_CHROOT
! 9408: OPENSSH_GROUP OPENSSH_USER
! 9409: OPSYS OPSYS_EMULDIR
! 9410: OS OSS_TYPE
! 9411: OSX OSX_TOLERATE_SDK_SKEW
! 9412: OS_HAVE_ALSA OS_HAVE_RCD
! 9413: OS_VARIANT OS_VERSION
! 9414: OTF_FONTS_DIR OVERRIDE_DIRDEPTH
! 9415: OVERRIDE_GEMSPEC OVERRIDE_GNU_CONFIG_SCRIPTS
! 9416: OVERRIDE_ROCKSPEC OWN_DIRS
! 9417: OWN_DIRS_PERMS P4GROUP
! 9418: P4PORT P4ROOT
! 9419: P4USER PACKAGES
! 9420: PALMOS_DEFAULT_SDK PAMBASE
! 9421: PAM_DEFAULT PAPERSIZE
! 9422: PASSIVE_FETCH PATCHDIR
! 9423: PATCHFILES PATCH_ARGS
! 9424: PATCH_DEBUG PATCH_DIST_ARGS
! 9425: PATCH_DIST_CAT PATCH_DIST_STRIP
! 9426: PATCH_FUZZ_FACTOR PATCH_STRIP
! 9427: PATH PCCBASE
! 9428: PEAR PEAR_CHANNEL
! 9429: PEAR_CHANNEL_ALIAS PEAR_CHANNEL_VERSION
! 9430: PEAR_CMD PEAR_LIB
! 9431: PEAR_PACKAGE_XML PERL5
! 9432: PERL5_CONFIGURE PERL5_CONFIGURE_DIRS
! 9433: PERL5_LDFLAGS PERL5_LICENSE
! 9434: PERL5_MODULE_TYPE PERL5_PACKLIST
! 9435: PERL5_PACKLIST_DIR PERL5_PERLBASE
! 9436: PERL5_SITEBASE PERL5_USE_PACKLIST
! 9437: PERL5_VENDORBASE PFCTL
! 9438: PFVAR_H PF_VERSION
! 9439: PGGROUP PGHOME
! 9440: PGPKGSRCDIR PGSQL_TYPE
! 9441: PGSQL_VERSION PGSQL_VERSIONS_ACCEPTED
! 9442: PGSQL_VERSION_DEFAULT PGUSER
! 9443: PG_LIB_EXT PHP
! 9444: PHPCOMMON_MK PHPPKGSRCDIR
! 9445: PHP_BASE_VERS PHP_CHECK_INSTALLED
! 9446: PHP_EXTENSION_DIR PHP_INITIAL_TEENY
! 9447: PHP_PKG_PREFIX PHP_VERSION
! 9448: PHP_VERSIONS_ACCEPTED PHP_VERSIONS_INCOMPATIBLE
! 9449: PHP_VERSION_DEFAULT PHP_VERSION_REQD
! 9450: PILRC_USE_GTK PKGCONFIG_BASE
! 9451: PKGCONFIG_FILE PKGCONFIG_OVERRIDE
! 9452: PKGCONFIG_OVERRIDE_STAGE PKGDIR
! 9453: PKGGNUDIR PKGINFODIR
! 9454: PKGLOCALEDIR PKGMANDIR
! 9455: PKGNAME PKGNAME_REQD
! 9456: PKGPATH PKGREVISION
! 9457: PKGSRC_BLAS_TYPES PKGSRC_CHANGES
! 9458: PKGSRC_COMPILER PKGSRC_KEEP_BIN_PKGS
! 9459: PKGSRC_LOCKTYPE PKGSRC_MAKE_ENV
! 9460: PKGSRC_MESSAGE_RECIPIENTS PKGSRC_MKPIE
! 9461: PKGSRC_MKREPRO PKGSRC_RUN_TEST
! 9462: PKGSRC_SETENV PKGSRC_SLEEPSECS
! 9463: PKGSRC_TODO PKGSRC_USE_CTF
! 9464: PKGSRC_USE_FORTIFY PKGSRC_USE_RELRO
! 9465: PKGSRC_USE_SSP PKGSRC_USE_STACK_CHECK
! 9466: PKGTASKS_DATAFILE PKGTOOLS_ARGS
! 9467: PKGTOOLS_ENV PKG_ALTERNATIVES
! 9468: PKG_APACHE PKG_APACHE_ACCEPTED
! 9469: PKG_APACHE_DEFAULT PKG_BEST_EXISTS
! 9470: PKG_BUILD_OPTIONS PKG_COMPRESSION
! 9471: PKG_CONFIG PKG_CONFIG_PERMS
! 9472: PKG_CREATE_USERGROUP PKG_DB_TMPDIR
! 9473: PKG_DEBUG_LEVEL PKG_DEFAULT_OPTIONS
! 9474: PKG_DESTDIR_SUPPORT PKG_DEVELOPER
! 9475: PKG_DISABLED_OPTIONS PKG_FATAL_ERRORS
! 9476: PKG_FC PKG_FILELIST_CMD
! 9477: PKG_GECOS PKG_GID
! 9478: PKG_GROUPS PKG_GROUPS_VARS
! 9479: PKG_HOME PKG_INIT_SCRIPTS
! 9480: PKG_JAVA_HOME PKG_JVM
! 9481: PKG_JVMS_ACCEPTED PKG_JVM_DEFAULT
! 9482: PKG_LEGACY_OPTIONS PKG_LIBTOOL
! 9483: PKG_OPTIONS PKG_OPTIONS_DEPRECATED_WARNINGS
! 9484: PKG_OPTIONS_LEGACY_OPTS PKG_OPTIONS_LEGACY_VARS
! 9485: PKG_OPTIONS_NONEMPTY_SETS PKG_OPTIONS_OPTIONAL_GROUPS
! 9486: PKG_OPTIONS_REQUIRED_GROUPS PKG_OPTIONS_VAR
! 9487: PKG_PHP PKG_PHP_MAJOR_VERS
! 9488: PKG_PHP_VERSION PKG_RCD_SCRIPTS
! 9489: PKG_REFCOUNT_DBDIR PKG_REGISTER_SHELLS
! 9490: PKG_RESUME_TRANSFERS PKG_SHELL
! 9491: PKG_SUGGESTED_OPTIONS PKG_SUPPORTED_OPTIONS
! 9492: PKG_SYSCONFBASE PKG_SYSCONFBASEDIR
! 9493: PKG_SYSCONFDIR PKG_SYSCONFDIR_PERMS
! 9494: PKG_SYSCONFSUBDIR PKG_SYSCONFVAR
! 9495: PKG_TOOLS_BIN PKG_UID
! 9496: PKG_UPDATE_FONTS_DB PKG_USERS
! 9497: PKG_USERS_VARS PKG_VERBOSE
! 9498: PLEASE PLIST
! 9499: PLIST_AWK PLIST_AWK_ENV
! 9500: PLIST_SRC PLIST_SUBST
! 9501: PLIST_TYPE PLIST_VARS
! 9502: POPTOP_USE_MPPE POSSIBLE_GFORTRAN_VERSION
! 9503: POST_FETCH_HOOK PREFER
! 9504: PREFER_NATIVE PREFER_NATIVE_PTHREADS
! 9505: PREFER_PKGSRC PREFIX
! 9506: PREPEND_PATH PRE_ROOT_CMD
! 9507: PRIVILEGED_STAGES PS
! 9508: PTHREAD_AUTO_VARS PTHREAD_CFLAGS
! 9509: PTHREAD_LDFLAGS PTHREAD_LIBS
! 9510: PTHREAD_OPTS PTHREAD_TYPE
! 9511: PVM_SSH PYPKGPREFIX
! 9512: PYTHON_FOR_BUILD_ONLY PYTHON_SELF_CONFLICT
! 9513: PYTHON_VERSIONED_DEPENDENCIES PYTHON_VERSIONS_ACCEPTED
! 9514: PYTHON_VERSIONS_INCOMPATIBLE PYTHON_VERSION_DEFAULT
! 9515: PYTHON_VERSION_REQD PYVERSSUFFIX
! 9516: PY_NO_EGG QMAILDIR
! 9517: QMAIL_ALIAS_USER QMAIL_DAEMON_USER
! 9518: QMAIL_LOG_USER QMAIL_NOFILES_GROUP
! 9519: QMAIL_PASSWD_USER QMAIL_QMAIL_GROUP
! 9520: QMAIL_QUEUE_DIR QMAIL_QUEUE_EXTRA
! 9521: QMAIL_QUEUE_USER QMAIL_REMOTE_USER
! 9522: QMAIL_ROOT_USER QMAIL_SEND_USER
! 9523: QPOPPER_FAC QPOPPER_SPOOL_DIR
! 9524: QPOPPER_USER RAKE_NAME
! 9525: RASMOL_DEPTH RCD_DIR
! 9526: RCD_ORDER RCD_SCRIPTS
! 9527: RCD_SCRIPTS_DIR RCD_SCRIPTS_EXAMPLEDIR
! 9528: RCD_SCRIPTS_MODE RCD_SCRIPTS_SHELL
! 9529: RCD_SCRIPT_SRC RCD_SUBR
! 9530: RDOC READLINE_DEFAULT
! 9531: READLINE_TYPE REAL_ROOT_GROUP
! 9532: REAL_ROOT_USER RECURSIVE_MAKE
! 9533: RELAY_CTRL_DIR RELRO_SUPPORTED
! 9534: REPLACE_AWK REPLACE_BASH
! 9535: REPLACE_CSH REPLACE_KSH
! 9536: REPLACE_PERL REPLACE_PERL6
! 9537: REPLACE_PHP REPLACE_PYTHON
! 9538: REPLACE_RUBY REPLACE_RUBY_DIRS
! 9539: REPLACE_RUBY_PAT REPLACE_SH
! 9540: REPLACE_TEXLUA REQD_DIRS
! 9541: REQD_DIRS_PERMS REQD_FILES
! 9542: REQD_FILES_MODE REQD_FILES_PERMS
! 9543: RESOLV_AUTO_VARS RESOLV_LDFLAGS
! 9544: RESOLV_LIBS RM
! 9545: ROCKSPEC_NAME ROCKSPEC_SPECFILE
! 9546: ROOT_CMD ROOT_GROUP
! 9547: ROOT_USER RPCGEN
! 9548: RPM RPM2PKG_PLIST
! 9549: RPM2PKG_PREFIX RPM2PKG_STAGE
! 9550: RPM2PKG_STRIP RPM2PKG_SUBPREFIX
! 9551: RPMFILES RPMIGNOREPATH
! 9552: RPM_DB_PREFIX RSSH_CVS_PATH
! 9553: RSSH_RDIST_PATH RSSH_RSYNC_PATH
! 9554: RSSH_SCP_PATH RSSH_SFTP_SERVER_PATH
! 9555: RUBY RUBYGEM
! 9556: RUBYGEM_NAME RUBYGEM_OPTIONS
! 9557: RUBYGEM_VERBOSE RUBY_ABI_VERSION
! 9558: RUBY_ARCH RUBY_ARCHINC
! 9559: RUBY_ARCHLIB RUBY_BASE
! 9560: RUBY_BASERIDIR RUBY_BUILD_DOCUMENT
! 9561: RUBY_DLEXT RUBY_DOC
! 9562: RUBY_DYNAMIC_DIRS RUBY_EG
! 9563: RUBY_ENCODING_ARG RUBY_EXTCONF
! 9564: RUBY_EXTCONF_CHECK RUBY_EXTCONF_DEBUG
! 9565: RUBY_EXTCONF_MAKEFILE RUBY_GEM_BASE
! 9566: RUBY_INC RUBY_LIB
! 9567: RUBY_LIB_BASE RUBY_NAME
! 9568: RUBY_NOVERSION RUBY_PKGPREFIX
! 9569: RUBY_RAILS RUBY_RAILS52_VERSION
! 9570: RUBY_RAILS60_VERSION RUBY_RAILS61_VERSION
! 9571: RUBY_RAILS_ACCEPTED RUBY_RAILS_DEFAULT
! 9572: RUBY_RAILS_REQD RUBY_RAILS_STRICT_DEP
! 9573: RUBY_RIDIR RUBY_SETUP
! 9574: RUBY_SHLIB RUBY_SHLIBALIAS
! 9575: RUBY_SHLIBVER RUBY_SIMPLE_INSTALL
! 9576: RUBY_SITEARCHLIB RUBY_SITELIB
! 9577: RUBY_SITELIB_BASE RUBY_SITERIDIR
! 9578: RUBY_SLEXT RUBY_SRCDIR
! 9579: RUBY_STATICLIB RUBY_SUFFIX
! 9580: RUBY_SYSRIDIR RUBY_USE_PTHREAD
! 9581: RUBY_VENDORARCHLIB RUBY_VENDORLIB
! 9582: RUBY_VENDORLIB_BASE RUBY_VER
! 9583: RUBY_VERSION RUBY_VERSIONS_ACCEPTED
! 9584: RUBY_VERSIONS_INCOMPATIBLE RUBY_VERSION_DEFAULT
! 9585: RUBY_VERSION_REQD RUBY_VER_DIR
! 9586: RUN RUN_LDCONFIG
! 9587: SAWFISH_THEMES SCO
! 9588: SCREWS_GROUP SCREWS_USER
! 9589: SCRIPTS_ENV SCROLLKEEPER_DATADIR
! 9590: SCROLLKEEPER_REBUILDDB SCROLLKEEPER_UPDATEDB
! 9591: SDIST_PAWD SERIAL_DEVICES
! 9592: SETGIDGAME SETGID_GAMES_PERMS
! 9593: SETUID_ROOT_PERMS SH
! 9594: SHLIB SHORTNAME
! 9595: SIGN_PACKAGES SILC_CLIENT_WITH_PERL
! 9596: SITE_SPECIFIC_PKGS SKIP_DEPENDS
! 9597: SMF_INSTANCES SMF_MANIFEST
! 9598: SMF_METHODS SMF_METHOD_SHELL
! 9599: SMF_METHOD_SRC SMF_NAME
! 9600: SMF_PREFIX SMF_SRCDIR
! 9601: SNIPROXY_GROUP SNIPROXY_USER
! 9602: SOURCE_BUFFSIZE SPECIAL_PERMS
! 9603: SPECIFIC_PKGS SSH_SUID
! 9604: SSP_SUPPORTED SSYNC_PAWD
! 9605: STEP_MSG STRIP
! 9606: STRIP_DBG STRIP_DEBUG
! 9607: STRIP_DEBUG_SUPPORTED STRIP_FILES_SKIP
! 9608: SU SUBDIR
! 9609: SUBST SUBST_CLASSES
! 9610: SUBST_FILES SUBST_FILTER_CMD
! 9611: SUBST_MESSAGE SUBST_NOOP_OK
! 9612: SUBST_SED SUBST_SHOW_DIFF
! 9613: SUBST_SKIP_TEXT_CHECK SUBST_STAGE
! 9614: SUBST_VARS SUNWSPROBASE
! 9615: SUSE_PREFER SU_CMD
! 9616: SVN_EXTRACTDIR SVN_REPO
! 9617: SVN_REPOSITORIES SVN_REVISION
! 9618: SYSCONFBASE TBL
! 9619: TERMCAP_TYPE TERMINFO_DEFAULT
! 9620: TERMINFO_TYPE TEST
! 9621: TEST_DEPENDS TEST_DIRS
! 9622: TEST_ENV TEST_ENV_SHELL
! 9623: TEST_MAKE_CMD TEST_MAKE_FLAGS
! 9624: TEST_TARGET TEXLIVE_IGNORE_PATTERNS
! 9625: TEXLIVE_REV TEXLIVE_UNVERSIONED
! 9626: TEXMFSITE TEX_FORMATS
! 9627: TEX_HYPHEN_DAT TEX_HYPHEN_DEF
! 9628: TEX_TEXMF_DIRS THTTPD_LOG_FACILITY
! 9629: TINYDYN_USER TO
! 9630: TOOLS_ALIASES TOOLS_ALWAYS_WRAP
! 9631: TOOLS_ARGS TOOLS_BROKEN
! 9632: TOOLS_CMD TOOLS_CMDLINE_SED
! 9633: TOOLS_CREATE TOOLS_DIR
! 9634: TOOLS_FAIL TOOLS_GNU_MISSING
! 9635: TOOLS_LDCONFIG TOOLS_NOOP
! 9636: TOOLS_PATH TOOLS_SCRIPT
! 9637: TOOL_DEPENDS TTF_FONTDIR
! 9638: TTF_FONTS_DIR TYPE
! 9639: UAC_REQD_EXECS UCSPI_SSL_GROUP
! 9640: UCSPI_SSL_USER UNLIMIT_RESOURCES
! 9641: UNPRIVILEGED UNPRIVILEGED_GROUP
! 9642: UNPRIVILEGED_GROUPS UNPRIVILEGED_USER
! 9643: UNWRAP_FILES UNWRAP_PATTERNS
! 9644: UPDATE_GEMSPEC UPDATE_TARGET
! 9645: URI USERGROUP_PHASE
! 9646: USERPPP_GROUP USER_SPECIFIC_PKGS
! 9647: USE_ABI_DEPENDS USE_APR
! 9648: USE_BSD_MAKEFILE USE_BUILTIN
! 9649: USE_CROSS_COMPILE USE_CURSES
! 9650: USE_CWRAPPERS USE_DB185
! 9651: USE_FEATURES USE_GAMESGROUP
! 9652: USE_GCC_RUNTIME USE_IMAKE
! 9653: USE_JAVA USE_JAVA2
! 9654: USE_LANGUAGES USE_LIBTOOL
! 9655: USE_NATIVE_GCC USE_NETBSD_REPO
! 9656: USE_PKGSRC_GCC USE_PKGSRC_GCC_RUNTIME
! 9657: USE_PKGTASKS USE_PKG_ADMIN_DIGEST
! 9658: USE_RUBY_EXTCONF USE_RUBY_INSTALL
! 9659: USE_RUBY_SETUP USE_RUBY_SETUP_PKG
! 9660: USE_TOOLS UUCP_GROUP
! 9661: UUCP_USER VARBASE
! 9662: VARNAME VIM_EXTRA_OPTS
! 9663: WARNING_MSG WCALC_CGIDIR
! 9664: WCALC_CGIPATH WCALC_HTMLDIR
! 9665: WCALC_HTMLPATH WDM_MANAGERS
! 9666: WRAPPER_CC WRAPPER_REORDER_CMDS
! 9667: WRKDIR WRKDIR_BASENAME
! 9668: WRKDIR_LOCKTYPE WRKLOG
! 9669: WRKOBJDIR WRKSRC
! 9670: X10_PORT X11
! 9671: X11BASE X11_PKGSRCDIR
! 9672: X11_TYPE X509_CERTIFICATE
! 9673: X509_KEY XAW_TYPE
! 9674: XLOCK_DEFAULT_MODE XMKMF
! 9675: XMKMF_FLAGS XXX
! 9676: XXXX YES
! 9677: ZSH_STATIC __stdc__
! 9678: _vargroups accept
! 9679: acquire-localbase-lock acquire-lock
! 9680: add administrator
! 9681: alloca alternatives
! 9682: aslr asprintf
! 9683: atlas autoconf
! 9684: automake autoreconf
! 9685: awk bash
! 9686: big-endian bin-install
! 9687: bind binpkg-list
! 9688: blas bootstrap-depends
! 9689: broken broken_on_platform
! 9690: bsd bsd.prog.mk
! 9691: build build-env
! 9692: buildlink-directories buildlink-oss-soundcard-h
! 9693: c c++
! 9694: ccache cce
! 9695: cdefs ceil
! 9696: changes changes-entry
! 9697: changes-entry-noupdate check
! 9698: check-clean check-files
! 9699: check-files-clean check-vulnerable
! 9700: checksum checksum-phase
! 9701: clean clean-depends
! 9702: cleandir commit
! 9703: commit-changes-entry compact
! 9704: compiler conf
! 9705: config.guess config.sub
! 9706: configuration configure
! 9707: configure-env configure-help
! 9708: configure_args connect
! 9709: cos cputime
! 9710: create-usergroup csh
! 9711: ctf cvs
! 9712: debug declaration
! 9713: declare defined
! 9714: depend dependencies
! 9715: depends depends-checksum
! 9716: depends-fetch deps
! 9717: describe destdir
! 9718: disable distclean
! 9719: distinfo dl
! 9720: dlopen do-build
! 9721: do-buildlink do-clean
! 9722: do-configure do-configure-post-hook
! 9723: do-extract do-fetch
! 9724: do-install emul
! 9725: emul-distinfo emul-fetch
! 9726: emulation emulator
! 9727: enable endian
! 9728: endif enomem
! 9729: err errx
! 9730: etc exp
! 9731: extract-rpm fabs
! 9732: feature features
! 9733: fetch fetch-list
! 9734: follows forbids
! 9735: form format
! 9736: fortify fortify_source
! 9737: fossil friend
! 9738: fts fts_close
! 9739: fts_open fts_read
! 9740: fts_set gcc
! 9741: gethostbyaddr gethostbyname
! 9742: gethostbyname2 getopt_long
! 9743: getprogname getservbyname
! 9744: getservbyport getservent
! 9745: gettext git
! 9746: github gitlab
! 9747: glob gnu
! 9748: gnu_configure_strict go
! 9749: go-deps golang
! 9750: guess-license hashbang
! 9751: heimdal help
! 9752: hg imake
! 9753: increment inet_aton
! 9754: interp interpreter
! 9755: intl ip4
! 9756: ip6 ipv4
! 9757: ipv6 iso
! 9758: kerberos krb
! 9759: krb5 ksh
! 9760: lapack latex
! 9761: libintl_bindtextdomain libintl_gettext
! 9762: libintl_textdomain libnbcompat
! 9763: libs libtool
! 9764: licence license
! 9765: lintl little-endian
! 9766: lock locking
! 9767: lvalue make
! 9768: makesum memory
! 9769: mercurial meta
! 9770: meta-package meta_package
! 9771: mit-krb5 mk.conf
! 9772: mkl mount
! 9773: mprotect mremap
! 9774: nb nbcompat
! 9775: netlib obstack
! 9776: obstack_ptr_grow occurs
! 9777: only openblas
! 9778: options options.mk
! 9779: order override
! 9780: override-intltool override-message-intltool
! 9781: package parallel
! 9782: path pax
! 9783: paxctl pbulk-index
! 9784: pc perl
! 9785: perl5 perms
! 9786: php pkg-build-options
! 9787: pkg-config pkg_build_options
! 9788: platform plist
! 9789: post-extract post-fetch
! 9790: post-wrapper pre-build-checks-hook
! 9791: pre-configure pre-configure-checks-hook
! 9792: pre-extract pre-fetch
! 9793: print-go-deps print-plist
! 9794: print-summary-data privileged-install-hook
! 9795: pypi python
! 9796: readme-all recv
! 9797: recvfrom regcomp
! 9798: release-localbase-lock release-lock
! 9799: relro rename
! 9800: reorder replace
! 9801: replace_interpreter reproducible
! 9802: resolv root
! 9803: ruby send
! 9804: sendfile sendto
! 9805: setenv setgid
! 9806: setprogname setuid
! 9807: sh shebang
! 9808: show show-all
! 9809: show-build-defs show-depends
! 9810: show-deps show-distfiles
! 9811: show-downlevel show-subdir-var
! 9812: show-tools show-var
! 9813: show-vars snprintf
! 9814: socket ssp
! 9815: st_mode stage-install
! 9816: strcasestr strict
! 9817: strip strndup
! 9818: strnlen strsep
! 9819: subst substitutions
! 9820: subversion sun
! 9821: sunpro sunwspro
! 9822: svn symlink
! 9823: test test-env
! 9824: tex texlive
! 9825: tmp tool
! 9826: tools tools-libtool-m4-override
! 9827: type ulimit
! 9828: undefined undo-replace
! 9829: unlimit unprivileged
! 9830: unprivileged-install-hook unstripped
! 9831: update upload
! 9832: upload-distfiles use_tools
! 9833: user utimes
! 9834: vasprintf verbose
! 9835: vsnprintf warn
! 9836: warning warnings
! 9837: warnx wattr_off
! 9838: wattr_on work
! 9839: wrapper wrkdir
1.154 rillig 9840:
9841: Appendix E. Editing guidelines for the pkgsrc guide
1.1 dsieger 9842:
9843: Table of Contents
9844:
1.154 rillig 9845: E.1. Make targets
9846: E.2. Procedure
1.1 dsieger 9847:
9848: This section contains information on editing the pkgsrc guide itself.
9849:
1.154 rillig 9850: E.1. Make targets
1.1 dsieger 9851:
9852: The pkgsrc guide's source code is stored in pkgsrc/doc/guide/files, and several
9853: files are created from it:
9854:
9855: * pkgsrc/doc/pkgsrc.txt
9856:
9857: * pkgsrc/doc/pkgsrc.html
9858:
1.174 leot 9859: * https://www.NetBSD.org/docs/pkgsrc/
1.1 dsieger 9860:
1.174 leot 9861: * https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf: The PDF version of the
9862: pkgsrc guide.
1.1 dsieger 9863:
1.174 leot 9864: * https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps: PostScript version of the
1.2 rillig 9865: pkgsrc guide.
1.1 dsieger 9866:
1.154 rillig 9867: E.2. Procedure
1.1 dsieger 9868:
9869: The procedure to edit the pkgsrc guide is:
9870:
1.190 bacon 9871: 1. Make sure you have checked out the htdocs repository into a sibling
9872: directory of your pkgsrc directory. You will need the ability to commit
9873: from both pkgsrc and htdocs.
9874:
9875: 2. Make sure you have the packages needed to regenerate the pkgsrc guide (and
1.46 obache 9876: other XML-based NetBSD documentation) installed. These are automatically
9877: installed when you install the meta-pkgs/pkgsrc-guide-tools package.
1.1 dsieger 9878:
1.190 bacon 9879: 3. Run cd doc/guide to get to the right directory. All further steps will take
1.1 dsieger 9880: place here.
9881:
1.190 bacon 9882: 4. Edit the XML file(s) in files/.
1.1 dsieger 9883:
1.190 bacon 9884: 5. Run bmake to check the pkgsrc guide for valid XML and to build the final
1.1 dsieger 9885: output files. If you get any errors at this stage, you can just edit the
9886: files, as there are only symbolic links in the working directory, pointing
9887: to the files in files/.
9888:
1.190 bacon 9889: 6. (cd files && cvs commit)
1.1 dsieger 9890:
1.190 bacon 9891: 7. Run bmake clean && bmake to regenerate the output files with the proper RCS
1.1 dsieger 9892: Ids.
9893:
1.190 bacon 9894: 8. Run bmake regen to install and commit the files in both pkgsrc/doc and
1.1 dsieger 9895: htdocs.
9896:
9897: Note
9898:
9899: If you have added, removed or renamed some chapters, you need to
9900: synchronize them using cvs add or cvs delete in the htdocs directory.
9901:
CVSweb <webmaster@jp.NetBSD.org>