Annotation of htdocs/docs/pkgsrc/pkgsrc.txt, revision 1.255
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.252 jnemeth 15: Copyright 1994-2024 The NetBSD Foundation, Inc
1.1 dsieger 16:
1.252 jnemeth 17: $NetBSD: pkgsrc.xml,v 1.43 2024/01/02 07:26:32 jnemeth Exp $
1.1 dsieger 18:
19: Abstract
20:
21: pkgsrc is a centralized package management system for Unix-like operating
22: systems. This guide provides information for users and developers of pkgsrc. It
23: covers installation of binary and source packages, creation of binary and
24: source packages and a high-level overview about the infrastructure.
25:
26: -------------------------------------------------------------------------------
27:
28: Table of Contents
29:
30: 1. What is pkgsrc?
31: 1.1. Introduction
32: 1.1.1. Why pkgsrc?
33: 1.1.2. Supported platforms
34: 1.2. Overview
35: 1.3. Terminology
36: 1.3.1. Roles involved in pkgsrc
37: 1.4. Typography
38: I. The pkgsrc user's guide
1.154 rillig 39: 2. Getting help
40: 3. Where to get pkgsrc and how to keep it up-to-date
41: 3.1. Getting pkgsrc for the first time
42: 3.1.1. As tar archive
43: 3.1.2. Via anonymous CVS
44: 3.2. Keeping pkgsrc up-to-date
45: 3.2.1. Via tar files
46: 3.2.2. Via CVS
47: 4. Using pkgsrc on systems other than NetBSD
48: 4.1. Binary distribution
49: 4.2. Bootstrapping pkgsrc
50: 5. Using pkgsrc
51: 5.1. Using binary packages
52: 5.1.1. Finding binary packages
53: 5.1.2. Installing binary packages
1.202 nia 54: 5.1.3. Updating packages
55: 5.1.4. Deinstalling packages
56: 5.1.5. Getting information about installed packages
57: 5.1.6. Checking for security vulnerabilities in installed packages
58: 5.1.7. Finding if newer versions of your installed packages are in
1.232 gutterid 59: pkgsrc
1.202 nia 60: 5.1.8. Other administrative functions
1.154 rillig 61: 5.2. Building packages from source
62: 5.2.1. Requirements
63: 5.2.2. Fetching distfiles
64: 5.2.3. How to build and install
65: 6. Configuring pkgsrc
66: 6.1. General configuration
67: 6.2. Variables affecting the build process
1.241 rillig 68: 6.3. Preferences for native or pkgsrc software
69: 6.4. Variables affecting the installation process
70: 6.5. Selecting and configuring the compiler
71: 6.5.1. Selecting the compiler
72: 6.5.2. Additional flags to the compiler (CFLAGS)
73: 6.5.3. Additional flags to the linker (LDFLAGS)
74: 6.6. Developer/advanced settings
75: 6.7. Selecting Build Options
1.154 rillig 76: 7. Creating binary packages
77: 7.1. Building a single binary package
78: 7.2. Settings for creation of binary packages
79: 8. Creating binary packages for everything in pkgsrc (bulk builds)
80: 8.1. Preparations
1.180 rillig 81: 8.2. Running a bulk build
1.154 rillig 82: 8.2.1. Configuration
83: 8.3. Requirements of a full bulk build
1.178 rillig 84: 8.4. Bulk build variants
1.179 rillig 85: 8.4.1. Detect unknown configure options
86: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 87: 8.4.3. Force compiler options only in the build phase
88: 8.4.4. Use custom directories
89: 8.4.5. Turn warnings into errors
90: 8.4.6. Reject packages for which pkglint reports errors
91: 8.4.7. Reject packages that contain forbidden strings
92: 8.4.8. Reject packages whose self-test fails
93: 8.4.9. Reject packages that use undefined shell variables
94: 8.4.10. Turn off verbose logging
1.178 rillig 95: 8.5. Creating a multiple CD-ROM packages collection
96: 8.5.1. Example of cdpack
1.154 rillig 97: 9. Directory layout of the installed files
98: 9.1. File system layout in ${LOCALBASE}
99: 9.2. File system layout in ${VARBASE}
100: 10. Frequently Asked Questions
101: 10.1. Are there any mailing lists for pkg-related discussion?
102: 10.2. Utilities for package management (pkgtools)
103: 10.3. How to use pkgsrc as non-root
104: 10.4. How to resume transfers when fetching distfiles?
105: 10.5. How can I install/use modular X.org from pkgsrc?
106: 10.6. How to fetch files from behind a firewall
107: 10.7. How to fetch files from HTTPS sites
108: 10.8. How do I tell make fetch to do passive FTP?
109: 10.9. How to fetch all distfiles at once
110: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc"
1.232 gutterid 111: mean?
1.154 rillig 112: 10.11. What does "Could not find bsd.own.mk" mean?
1.221 nia 113: 10.12. Using 'sudo' or `priv` with pkgsrc
1.154 rillig 114: 10.13. How do I change the location of configuration files?
115: 10.14. Automated security checks
116: 10.15. Why do some packages ignore my CFLAGS?
117: 10.16. A package does not build. What shall I do?
118: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/???
1.232 gutterid 119: merge conflicts" mean?
1.1 dsieger 120: II. The pkgsrc developer's guide
1.154 rillig 121: 11. Getting help
1.184 rillig 122: 12. Package components - files, directories and contents
123: 12.1. Makefile
124: 12.2. distinfo
125: 12.3. patches/*
126: 12.3.1. Structure of a single patch file
127: 12.3.2. Creating patch files
128: 12.3.3. Sources where the patch files come from
129: 12.3.4. Patching guidelines
130: 12.3.5. Feedback to the author
131: 12.4. Other mandatory files
132: 12.5. Optional files
133: 12.5.1. Files affecting the binary package
134: 12.5.2. Files affecting the build process
135: 12.5.3. Files affecting nothing at all
136: 12.6. work*
137: 12.7. files/*
138: 13. The build process
139: 13.1. Introduction
140: 13.2. Program location
141: 13.3. Directories used during the build process
142: 13.4. Running a phase
143: 13.5. The fetch phase
144: 13.5.1. What to fetch and where to get it from
145: 13.5.2. How are the files fetched?
146: 13.6. The checksum phase
147: 13.7. The extract phase
148: 13.8. The patch phase
149: 13.9. The tools phase
150: 13.10. The wrapper phase
151: 13.11. The configure phase
152: 13.12. The build phase
153: 13.13. The test phase
154: 13.14. The install phase
155: 13.15. The package phase
156: 13.16. Cleaning up
157: 13.17. Other helpful targets
158: 14. Creating a new pkgsrc package from scratch
159: 14.1. Common types of packages
1.219 nia 160: 14.1.1. Python modules and programs
161: 14.1.2. R packages
162: 14.1.3. TeXlive packages
1.184 rillig 163: 14.2. Examples
164: 14.2.1. How the www/nvu package came into pkgsrc
165: 15. Programming in Makefiles
166: 15.1. Caveats
167: 15.2. Makefile variables
168: 15.2.1. Naming conventions
169: 15.3. Code snippets
170: 15.3.1. Adding things to a list
171: 15.3.2. Echoing a string exactly as-is
172: 15.3.3. Passing CFLAGS to GNU configure scripts
173: 15.3.4. Handling possibly empty variables
1.229 gutterid 174: 15.3.5. Testing yes/no variables in conditions
1.184 rillig 175: 16. Options handling
176: 16.1. Global default options
177: 16.2. Converting packages to use bsd.options.mk
178: 16.3. Option Names
179: 16.4. Determining the options of dependencies
180: 17. Tools needed for building or running
181: 17.1. Tools for pkgsrc builds
182: 17.2. Tools needed by packages
183: 17.3. Tools provided by platforms
184: 18. Buildlink methodology
185: 18.1. Converting packages to use buildlink3
186: 18.2. Writing buildlink3.mk files
187: 18.2.1. Anatomy of a buildlink3.mk file
188: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and
1.232 gutterid 189: BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files
1.184 rillig 190: 18.3. Writing builtin.mk files
191: 18.3.1. Anatomy of a builtin.mk file
192: 19. PLIST issues
193: 19.1. RCS ID
194: 19.2. Semi-automatic PLIST generation
195: 19.3. Tweaking output of make print-PLIST
196: 19.4. Variable substitution in PLIST
197: 19.5. Man page compression
198: 19.6. Changing PLIST source with PLIST_SRC
199: 19.7. Platform-specific and differing PLISTs
200: 19.8. Build-specific PLISTs
201: 19.9. Sharing directories between packages
202: 20. The pkginstall framework
203: 20.1. Files and directories outside the installation prefix
204: 20.1.1. Directory manipulation
205: 20.1.2. File manipulation
206: 20.2. Configuration files
207: 20.2.1. How PKG_SYSCONFDIR is set
208: 20.2.2. Telling the software where configuration files are
1.239 dholland 209: 20.2.3. Patching installation
210: 20.2.4. Declaring configuration files
211: 20.2.5. Disabling handling of configuration files
1.184 rillig 212: 20.3. System startup scripts
213: 20.3.1. Disabling handling of system startup scripts
214: 20.4. System users and groups
215: 20.5. System shells
216: 20.5.1. Disabling shell registration
217: 20.6. Fonts
218: 20.6.1. Disabling automatic update of the fonts databases
1.154 rillig 219: 21. Making your package work
220: 21.1. General operation
221: 21.1.1. How to pull in user-settable variables from mk.conf
222: 21.1.2. User interaction
223: 21.1.3. Handling licenses
224: 21.1.4. Restricted packages
225: 21.1.5. Handling dependencies
226: 21.1.6. Handling conflicts with other packages
227: 21.1.7. Packages that cannot or should not be built
228: 21.1.8. Packages which should not be deleted, once installed
229: 21.1.9. Handling packages with security problems
230: 21.1.10. How to handle incrementing versions when fixing an
1.232 gutterid 231: existing package
1.154 rillig 232: 21.1.11. Substituting variable text in the package files (the SUBST
1.232 gutterid 233: framework)
1.154 rillig 234: 21.2. The fetch phase
235: 21.2.1. Packages whose distfiles aren't available for plain
1.232 gutterid 236: downloading
1.154 rillig 237: 21.2.2. How to handle modified distfiles with the 'old' name
238: 21.2.3. Packages hosted on github.com
239: 21.3. The configure phase
240: 21.3.1. Shared libraries - libtool
241: 21.3.2. Using libtool on GNU packages that already support libtool
242: 21.3.3. GNU Autoconf/Automake
1.223 nia 243: 21.3.4. Meson / ninja
1.154 rillig 244: 21.4. Programming languages
245: 21.4.1. C, C++, and Fortran
246: 21.4.2. Java
1.205 wiz 247: 21.4.3. Go
1.223 nia 248: 21.4.4. Rust
249: 21.4.5. Packages containing Perl scripts
250: 21.4.6. Packages containing shell scripts
251: 21.4.7. Other programming languages
1.154 rillig 252: 21.5. The build phase
253: 21.5.1. Compiling C and C++ code conditionally
254: 21.5.2. How to handle compiler bugs
1.172 rillig 255: 21.5.3. No such file or directory
256: 21.5.4. Undefined reference to "..."
257: 21.5.5. Running out of memory
1.154 rillig 258: 21.6. The install phase
259: 21.6.1. Creating needed directories
260: 21.6.2. Where to install documentation
261: 21.6.3. Installing highscore files
262: 21.6.4. Adding DESTDIR support to packages
263: 21.6.5. Packages with hardcoded paths to other interpreters
1.203 nia 264: 21.6.6. Packages installing Perl modules
1.254 wiz 265: 21.6.7. Packages installing pkg-config files
266: 21.6.8. Packages installing info files
267: 21.6.9. Packages installing man pages
268: 21.6.10. Packages installing X11 fonts
269: 21.6.11. Packages installing SGML or XML data
270: 21.6.12. Packages installing extensions to the MIME database
271: 21.6.13. Packages using intltool
272: 21.6.14. Packages installing startup scripts
273: 21.6.15. Packages installing TeX modules
274: 21.6.16. Packages supporting running binaries in emulation
275: 21.6.17. Packages installing hicolor icons
276: 21.6.18. Packages installing desktop files
1.154 rillig 277: 21.7. Marking packages as having problems
1.184 rillig 278: 22. GNOME packaging and porting
279: 22.1. Meta packages
280: 22.2. Packaging a GNOME application
281: 22.3. Updating GNOME to a newer version
282: 22.4. Patching guidelines
1.154 rillig 283: 23. Submitting and Committing
284: 23.1. Submitting binary packages
285: 23.2. Submitting source packages (for non-NetBSD-developers)
286: 23.3. General notes when adding, updating, or removing packages
287: 23.4. Commit Messages
288: 23.5. Committing: Adding a package to CVS
289: 23.6. Updating a package to a newer version
290: 23.7. Renaming a package in pkgsrc
291: 23.8. Moving a package in pkgsrc
292: 24. Frequently Asked Questions
1.1 dsieger 293: III. The pkgsrc infrastructure internals
1.184 rillig 294: 25. Design of the pkgsrc infrastructure
295: 25.1. The meaning of variable definitions
296: 25.2. Avoiding problems before they arise
297: 25.3. Variable evaluation
298: 25.3.1. At load time
299: 25.3.2. At runtime
300: 25.4. How can variables be specified?
301: 25.5. Designing interfaces for Makefile fragments
302: 25.5.1. Procedures with parameters
303: 25.5.2. Actions taken on behalf of parameters
304: 25.6. The order in which files are loaded
305: 25.6.1. The order in bsd.prefs.mk
306: 25.6.2. The order in bsd.pkg.mk
307: 26. Regression tests
308: 26.1. Running the regression tests
309: 26.2. Adding a new regression test
310: 26.2.1. Overridable functions
311: 26.2.2. Helper functions
312: 27. Porting pkgsrc
313: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 314: A. A simple example package: bison
315: A.1. files
316: A.1.1. Makefile
317: A.1.2. DESCR
318: A.1.3. PLIST
319: A.1.4. Checking a package with pkglint
320: A.2. Steps for building, installing, packaging
1.207 leot 321: B. Security hardening
322: B.1. Mechanisms
323: B.1.1. Enabled by default
324: B.1.2. Not enabled by default
325: B.2. Caveats
326: B.2.1. Problems with PKGSRC_MKPIE
327: B.2.2. Problems with PKGSRC_USE_FORTIFY
328: B.2.3. Problems with PKGSRC_USE_RELRO
329: B.2.4. Problems with PKGSRC_USE_SSP
330: B.3. Auditing the system
331: B.3.1. Checking for PIE
332: B.3.2. Checking for partial RELRO
333: B.3.3. Checking for full RELRO
334: B.3.4. Checking for SSP
335: C. Build logs
336: C.1. Building figlet
337: C.2. Packaging figlet
338: D. Directory layout of the pkgsrc FTP server
339: D.1. distfiles: The distributed source files
340: D.2. misc: Miscellaneous things
341: D.3. packages: Binary packages
342: D.4. reports: Bulk build reports
343: D.5. current, stable, pkgsrc-20xxQy: source packages
344: E. Help topics
345: F. Editing guidelines for the pkgsrc guide
346: F.1. Make targets
347: F.2. Procedure
1.1 dsieger 348:
349: List of Tables
350:
351: 1.1. Platforms supported by pkgsrc
1.184 rillig 352: 12.1. Patching examples
353: 22.1. PLIST handling for GNOME packages
1.1 dsieger 354:
355: Chapter 1. What is pkgsrc?
356:
357: Table of Contents
358:
359: 1.1. Introduction
360: 1.1.1. Why pkgsrc?
361: 1.1.2. Supported platforms
362: 1.2. Overview
363: 1.3. Terminology
364: 1.3.1. Roles involved in pkgsrc
365: 1.4. Typography
366:
367: 1.1. Introduction
368:
369: There is a lot of software freely available for Unix-based systems, which is
370: usually available in form of the source code. Before such software can be used,
371: it needs to be configured to the local system, compiled and installed, and this
372: is exactly what The NetBSD Packages Collection (pkgsrc) does. pkgsrc also has
373: some basic commands to handle binary packages, so that not every user has to
374: build the packages for himself, which is a time-costly task.
375:
376: pkgsrc currently contains several thousand packages, including:
377:
1.104 sevan 378: * www/apache24 - The Apache web server
1.1 dsieger 379:
380: * www/firefox - The Firefox web browser
381:
382: * meta-pkgs/gnome - The GNOME Desktop Environment
383:
1.102 ryoon 384: * meta-pkgs/kde4 - The K Desktop Environment
1.1 dsieger 385:
1.108 rillig 386: ? just to name a few.
1.1 dsieger 387:
388: pkgsrc has built-in support for handling varying dependencies, such as pthreads
389: and X11, and extended features such as IPv6 support on a range of platforms.
390:
391: 1.1.1. Why pkgsrc?
392:
393: pkgsrc provides the following key features:
394:
395: * Easy building of software from source as well as the creation and
396: installation of binary packages. The source and latest patches are
397: retrieved from a master or mirror download site, checksum verified, then
398: built on your system. Support for binary-only distributions is available
399: for both native platforms and NetBSD emulated platforms.
400:
401: * All packages are installed in a consistent directory tree, including
402: binaries, libraries, man pages and other documentation.
403:
1.104 sevan 404: * Tracking of package dependencies automatically, including when performing
405: updates, to ensure required packages are installed. The configuration files
406: of various packages are handled automatically during updates, so local
407: changes are preserved.
1.1 dsieger 408:
409: * Like NetBSD, pkgsrc is designed with portability in mind and consists of
410: highly portable code. This allows the greatest speed of development when
1.26 spz 411: porting to a new platform. This portability also ensures that pkgsrc is
1.1 dsieger 412: consistent across all platforms.
413:
414: * The installation prefix, acceptable software licenses, international
415: encryption requirements and build-time options for a large number of
416: packages are all set in a simple, central configuration file.
417:
418: * The entire source (not including the distribution files) is freely
419: available under a BSD license, so you may extend and adapt pkgsrc to your
420: needs. Support for local packages and patches is available right out of the
421: box, so you can configure it specifically for your environment.
422:
423: The following principles are basic to pkgsrc:
424:
1.198 leot 425: * "It should only work if it's right." -- That means, if a package contains
1.1 dsieger 426: bugs, it's better to find them and to complain about them rather than to
427: just install the package and hope that it works. There are numerous checks
1.175 gutterid 428: in pkgsrc that try to find such bugs: static analysis tools (pkgtools/
1.1 dsieger 429: pkglint), build-time checks (portability of shell scripts), and
430: post-installation checks (installed files, references to shared libraries,
431: script interpreters).
432:
1.198 leot 433: * "If it works, it should work everywhere" -- Like NetBSD has been ported to
1.1 dsieger 434: many hardware architectures, pkgsrc has been ported to many operating
435: systems. Care is taken that packages behave the same on all platforms.
436:
437: 1.1.2. Supported platforms
438:
439: pkgsrc consists of both a source distribution and a binary distribution for
440: these operating systems. After retrieving the required source or binaries, you
441: can be up and running with pkgsrc in just minutes!
442:
443: pkgsrc was derived from FreeBSD's ports system, and initially developed for
444: NetBSD only. Since then, pkgsrc has grown a lot, and now supports the following
445: platforms:
446:
447: Table 1.1. Platforms supported by pkgsrc
448:
1.92 sevan 449: +-----------------------------------------------------------------------------+
1.229 gutterid 450: | Platform | Date Support | Notes |
451: | | Added | |
452: |-------------------------------------+---------------+-----------------------|
453: |NetBSD | Aug 1997 | |
454: |-------------------------------------+---------------+-----------------------|
455: |Solaris | Mar 1999 |README.Solaris |
456: |-------------------------------------+---------------+-----------------------|
457: |Linux | Jun 1999 |README.Linux |
458: |-------------------------------------+---------------+-----------------------|
459: |Darwin / Mac OS X / OS X / macOS | Oct 2001 |README.macOS |
460: |-------------------------------------+---------------+-----------------------|
461: |FreeBSD | Nov 2002 |README.FreeBSD |
462: |-------------------------------------+---------------+-----------------------|
463: |OpenBSD | Nov 2002 |README.OpenBSD |
464: |-------------------------------------+---------------+-----------------------|
465: |IRIX | Dec 2002 |README.IRIX |
466: |-------------------------------------+---------------+-----------------------|
467: |BSD/OS | Dec 2003 | |
468: |-------------------------------------+---------------+-----------------------|
469: |AIX | Dec 2003 |README.AIX |
470: |-------------------------------------+---------------+-----------------------|
471: |Interix (Microsoft Windows Services | Mar 2004 |README.Interix |
472: |for Unix) | | |
473: |-------------------------------------+---------------+-----------------------|
474: |DragonFlyBSD | Oct 2004 | |
475: |-------------------------------------+---------------+-----------------------|
476: |OSF/1 | Nov 2004 |README.OSF1 |
477: |-------------------------------------+---------------+-----------------------|
478: |HP-UX | Apr 2007 |README.HPUX |
479: |-------------------------------------+---------------+-----------------------|
480: |Haiku | Sep 2010 |README.Haiku |
481: |-------------------------------------+---------------+-----------------------|
482: |MirBSD | Jan 2011 | |
483: |-------------------------------------+---------------+-----------------------|
484: |Minix3 | Nov 2011 |README.Minix3 |
485: |-------------------------------------+---------------+-----------------------|
486: |Cygwin | Mar 2013 |README.Cygwin |
487: |-------------------------------------+---------------+-----------------------|
488: |GNU/kFreeBSD | Jul 2013 |README.GNUkFreeBSD |
489: |-------------------------------------+---------------+-----------------------|
490: |Bitrig | Jun 2014 |Removed from pkgsrc Sep|
491: | | |2022 |
1.92 sevan 492: +-----------------------------------------------------------------------------+
1.1 dsieger 493:
494:
495: 1.2. Overview
496:
497: This document is divided into three parts. The first, The pkgsrc user's guide,
498: describes how one can use one of the packages in the Package Collection, either
499: by installing a precompiled binary package, or by building one's own copy using
500: the NetBSD package system. The second part, The pkgsrc developer's guide,
501: explains how to prepare a package so it can be easily built by other NetBSD
502: users without knowing about the package's building details. The third part, The
503: pkgsrc infrastructure internals is intended for those who want to understand
504: how pkgsrc is implemented.
505:
506: This document is available in various formats: HTML, PDF, PS, TXT.
507:
508: 1.3. Terminology
509:
510: There has been a lot of talk about "ports", "packages", etc. so far. Here is a
511: description of all the terminology used within this document.
512:
513: Package
514:
515: A set of files and building instructions that describe what's necessary to
516: build a certain piece of software using pkgsrc. Packages are traditionally
1.123 wiz 517: stored under /usr/pkgsrc, but may be stored in any location, referred to as
518: PKGSRCDIR.
1.1 dsieger 519:
520: The NetBSD package system
521:
522: This is the former name of "pkgsrc". It is part of the NetBSD operating
523: system and can be bootstrapped to run on non-NetBSD operating systems as
524: well. It handles building (compiling), installing, and removing of
525: packages.
526:
527: Distfile
528:
529: This term describes the file or files that are provided by the author of
530: the piece of software to distribute his work. All the changes necessary to
531: build on NetBSD are reflected in the corresponding package. Usually the
532: distfile is in the form of a compressed tar-archive, but other types are
533: possible, too. Distfiles are usually stored below /usr/pkgsrc/distfiles.
534:
535: Port
536:
537: This is the term used by FreeBSD and OpenBSD people for what we call a
538: package. In NetBSD terminology, "port" refers to a different architecture.
539:
540: Precompiled/binary package
541:
542: A set of binaries built with pkgsrc from a distfile and stuffed together in
543: a single .tgz file so it can be installed on machines of the same machine
544: architecture without the need to recompile. Packages are usually generated
545: in /usr/pkgsrc/packages; there is also an archive on ftp.NetBSD.org.
546:
547: Sometimes, this is referred to by the term "package" too, especially in the
548: context of precompiled packages.
549:
550: Program
551:
552: The piece of software to be installed which will be constructed from all
553: the files in the distfile by the actions defined in the corresponding
554: package.
555:
556: 1.3.1. Roles involved in pkgsrc
557:
558: pkgsrc users
559:
560: The pkgsrc users are people who use the packages provided by pkgsrc.
561: Typically they are system administrators. The people using the software
562: that is inside the packages (maybe called "end users") are not covered by
563: the pkgsrc guide.
564:
565: There are two kinds of pkgsrc users: Some only want to install pre-built
566: binary packages. Others build the pkgsrc packages from source, either for
567: installing them directly or for building binary packages themselves. For
568: pkgsrc users Part I, "The pkgsrc user's guide" should provide all necessary
569: documentation.
570:
571: package maintainers
572:
573: A package maintainer creates packages as described in Part II, "The pkgsrc
574: developer's guide".
575:
576: infrastructure developers
577:
578: These people are involved in all those files that live in the mk/ directory
579: and below. Only these people should need to read through Part III, "The
580: pkgsrc infrastructure internals", though others might be curious, too.
581:
582: 1.4. Typography
583:
584: When giving examples for commands, shell prompts are used to show if the
585: command should/can be issued as root, or if "normal" user privileges are
1.115 sevan 586: sufficient. We use a # for root's shell prompt, a % for users' shell prompt,
1.229 gutterid 587: assuming they use the C-shell or tcsh and a $ for Bourne shell and derivatives.
1.1 dsieger 588:
589: Part I. The pkgsrc user's guide
590:
591: Table of Contents
592:
1.154 rillig 593: 2. Getting help
594: 3. Where to get pkgsrc and how to keep it up-to-date
595: 3.1. Getting pkgsrc for the first time
596: 3.1.1. As tar archive
597: 3.1.2. Via anonymous CVS
598: 3.2. Keeping pkgsrc up-to-date
599: 3.2.1. Via tar files
600: 3.2.2. Via CVS
601: 4. Using pkgsrc on systems other than NetBSD
602: 4.1. Binary distribution
603: 4.2. Bootstrapping pkgsrc
604: 5. Using pkgsrc
605: 5.1. Using binary packages
606: 5.1.1. Finding binary packages
607: 5.1.2. Installing binary packages
1.202 nia 608: 5.1.3. Updating packages
609: 5.1.4. Deinstalling packages
610: 5.1.5. Getting information about installed packages
611: 5.1.6. Checking for security vulnerabilities in installed packages
612: 5.1.7. Finding if newer versions of your installed packages are in
1.232 gutterid 613: pkgsrc
1.202 nia 614: 5.1.8. Other administrative functions
1.154 rillig 615: 5.2. Building packages from source
616: 5.2.1. Requirements
617: 5.2.2. Fetching distfiles
618: 5.2.3. How to build and install
619: 6. Configuring pkgsrc
620: 6.1. General configuration
621: 6.2. Variables affecting the build process
1.241 rillig 622: 6.3. Preferences for native or pkgsrc software
623: 6.4. Variables affecting the installation process
624: 6.5. Selecting and configuring the compiler
625: 6.5.1. Selecting the compiler
626: 6.5.2. Additional flags to the compiler (CFLAGS)
627: 6.5.3. Additional flags to the linker (LDFLAGS)
628: 6.6. Developer/advanced settings
629: 6.7. Selecting Build Options
1.154 rillig 630: 7. Creating binary packages
631: 7.1. Building a single binary package
632: 7.2. Settings for creation of binary packages
633: 8. Creating binary packages for everything in pkgsrc (bulk builds)
634: 8.1. Preparations
1.180 rillig 635: 8.2. Running a bulk build
1.154 rillig 636: 8.2.1. Configuration
637: 8.3. Requirements of a full bulk build
1.178 rillig 638: 8.4. Bulk build variants
1.179 rillig 639: 8.4.1. Detect unknown configure options
640: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 641: 8.4.3. Force compiler options only in the build phase
642: 8.4.4. Use custom directories
643: 8.4.5. Turn warnings into errors
644: 8.4.6. Reject packages for which pkglint reports errors
645: 8.4.7. Reject packages that contain forbidden strings
646: 8.4.8. Reject packages whose self-test fails
647: 8.4.9. Reject packages that use undefined shell variables
648: 8.4.10. Turn off verbose logging
1.178 rillig 649: 8.5. Creating a multiple CD-ROM packages collection
650: 8.5.1. Example of cdpack
1.154 rillig 651: 9. Directory layout of the installed files
652: 9.1. File system layout in ${LOCALBASE}
653: 9.2. File system layout in ${VARBASE}
654: 10. Frequently Asked Questions
655: 10.1. Are there any mailing lists for pkg-related discussion?
656: 10.2. Utilities for package management (pkgtools)
657: 10.3. How to use pkgsrc as non-root
658: 10.4. How to resume transfers when fetching distfiles?
659: 10.5. How can I install/use modular X.org from pkgsrc?
660: 10.6. How to fetch files from behind a firewall
661: 10.7. How to fetch files from HTTPS sites
662: 10.8. How do I tell make fetch to do passive FTP?
663: 10.9. How to fetch all distfiles at once
664: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
665: 10.11. What does "Could not find bsd.own.mk" mean?
1.221 nia 666: 10.12. Using 'sudo' or `priv` with pkgsrc
1.154 rillig 667: 10.13. How do I change the location of configuration files?
668: 10.14. Automated security checks
669: 10.15. Why do some packages ignore my CFLAGS?
670: 10.16. A package does not build. What shall I do?
671: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.232 gutterid 672: conflicts" mean?
1.1 dsieger 673:
1.154 rillig 674: Chapter 2. Getting help
675:
676: To get help when using pkgsrc, the definitive source is this document, the
677: pkgsrc guide. If you don't find anything here, there are alternatives:
678:
679: * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
680: Run bmake help topic=? to get help for any topic, such as a variable name
681: like BUILD_DEFS, a make target like do-build, a missing C or C++ function
682: like strcasecmp or any other topic.
683:
1.207 leot 684: The available help topics are listed in Appendix E, Help topics.
1.154 rillig 685:
1.163 rillig 686: * To see the value of a single variable, run bmake show-var VARNAME=X.
687:
688: * To see the values of the most common variables, run bmake show-all. These
689: variables are grouped by topic. To see the variables for a single topic,
690: run bmake show-all-topic, for example bmake show-all-fetch.
691:
1.154 rillig 692: * The pkgsrc-users mailing list, to which you can subscribe and then ask your
693: questions.
694:
695: * The #pkgsrc IRC channel, which is accessible via a web browser or by using
696: a specialized chat program such as XChat. Pick any user name and join the
697: channel #pkgsrc.
698:
699: Chapter 3. Where to get pkgsrc and how to keep it up-to-date
1.1 dsieger 700:
701: Table of Contents
702:
1.154 rillig 703: 3.1. Getting pkgsrc for the first time
704: 3.1.1. As tar archive
705: 3.1.2. Via anonymous CVS
706: 3.2. Keeping pkgsrc up-to-date
707: 3.2.1. Via tar files
708: 3.2.2. Via CVS
1.1 dsieger 709:
710: Before you download and extract the files, you need to decide where you want to
711: extract them. When using pkgsrc as root user, pkgsrc is usually installed in /
712: usr/pkgsrc. You are though free to install the sources and binary packages
713: wherever you want in your filesystem, provided that the pathname does not
714: contain white-space or other characters that are interpreted specially by the
715: shell and some other programs. A safe bet is to use only letters, digits,
716: underscores and dashes.
717:
1.154 rillig 718: 3.1. Getting pkgsrc for the first time
1.1 dsieger 719:
1.25 wiz 720: Before you download any pkgsrc files, you should decide whether you want the
1.1 dsieger 721: current branch or the stable branch. The latter is forked on a quarterly basis
722: from the current branch and only gets modified for security updates. The names
723: of the stable branches are built from the year and the quarter, for example
1.246 leot 724: 2023Q3.
1.1 dsieger 725:
726: The second step is to decide how you want to download pkgsrc. You can get it as
1.24 wiz 727: a tar file or via CVS. Both ways are described here.
1.1 dsieger 728:
1.52 asau 729: Note that tar archive contains CVS working copy. Thus you can switch to using
730: CVS at any later time.
1.1 dsieger 731:
1.154 rillig 732: 3.1.1. As tar archive
1.52 asau 733:
1.151 sevan 734: The primary download location for all pkgsrc files is https://cdn.NetBSD.org/
735: pub/pkgsrc/ or ftp://ftp.NetBSD.org/pub/pkgsrc/ (it points to the same
736: location). There are a number of subdirectories for different purposes, which
1.207 leot 737: are described in detail in Appendix D, Directory layout of the pkgsrc FTP
1.151 sevan 738: server.
1.1 dsieger 739:
1.52 asau 740: The tar archive for the current branch is in the directory current and is
1.118 sevan 741: called pkgsrc.tar.gz. It is autogenerated weekly.
1.52 asau 742:
743: To save download time we provide bzip2- and xz-compressed archives which are
744: published at pkgsrc.tar.bz2 and pkgsrc.tar.xz respectively.
745:
746: You can fetch the same files using FTP.
1.1 dsieger 747:
1.246 leot 748: The tar file for the stable branch 2023Q3 is in the directory pkgsrc-2023Q3 and
1.59 jnemeth 749: is also called pkgsrc.tar.gz.
1.1 dsieger 750:
1.136 leot 751: To download the latest pkgsrc stable tarball, run:
1.12 weinem 752:
1.246 leot 753: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2023Q3/pkgsrc.tar.gz
1.12 weinem 754:
1.78 snj 755: If you prefer, you can also fetch it using "wget", "curl", or your web browser.
1.52 asau 756:
1.12 weinem 757: Then, extract it with:
758:
1.78 snj 759: $ tar -xzf pkgsrc.tar.gz -C /usr
1.12 weinem 760:
761: This will create the directory pkgsrc/ in /usr/ and all the package source will
762: be stored under /usr/pkgsrc/.
763:
764: To download pkgsrc-current, run:
765:
766: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz
1.1 dsieger 767:
1.154 rillig 768: 3.1.2. Via anonymous CVS
1.1 dsieger 769:
1.24 wiz 770: To fetch a specific pkgsrc stable branch, run:
1.1 dsieger 771:
1.246 leot 772: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2023Q3 -P pkgsrc
1.13 weinem 773:
1.24 wiz 774: This will create the directory pkgsrc/ in your /usr/ directory and all the
775: package source will be stored under /usr/pkgsrc/.
776:
777: To fetch the pkgsrc current branch, run:
1.1 dsieger 778:
1.40 wiz 779: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 780:
1.30 dholland 781: Refer to the list of available mirrors to choose a faster CVS mirror, if
782: needed.
1.1 dsieger 783:
1.24 wiz 784: If you get error messages from rsh, you need to set CVS_RSH variable. E.g.:
1.1 dsieger 785:
1.40 wiz 786: $ cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 787:
1.24 wiz 788: Refer to documentation on your command shell how to set CVS_RSH=ssh
789: permanently. For Bourne shells, you can set it in your .profile or better
790: globally in /etc/profile:
791:
792: # set CVS remote shell command
793: CVS_RSH=ssh
794: export CVS_RSH
1.12 weinem 795:
1.13 weinem 796: By default, CVS doesn't do things like most people would expect it to do. But
797: there is a way to convince CVS, by creating a file called .cvsrc in your home
1.12 weinem 798: directory and saving the following lines to it. This file will save you lots of
799: headache and some bug reports, so we strongly recommend it. You can find an
800: explanation of this file in the CVS documentation.
1.2 rillig 801:
802: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 803: cvs -q
1.2 rillig 804: checkout -P
1.4 rillig 805: update -dP
806: diff -upN
1.2 rillig 807: rdiff -u
1.24 wiz 808: release -d
1.1 dsieger 809:
1.154 rillig 810: 3.2. Keeping pkgsrc up-to-date
1.1 dsieger 811:
812: The preferred way to keep pkgsrc up-to-date is via CVS (which also works if you
813: have first installed it via a tar file). It saves bandwidth and hard disk
814: activity, compared to downloading the tar file again.
815:
1.154 rillig 816: 3.2.1. Via tar files
1.1 dsieger 817:
818: Warning
819:
820: When updating from a tar file, you first need to completely remove the old
821: pkgsrc directory. Otherwise those files that have been removed from pkgsrc in
822: the mean time will not be removed on your local disk, resulting in
823: inconsistencies. When removing the old files, any changes that you have done to
824: the pkgsrc files will be lost after updating. Therefore updating via CVS is
825: strongly recommended.
826:
827: Note that by default the distfiles and the binary packages are saved in the
828: pkgsrc tree, so don't forget to rescue them before updating. You can also
1.78 snj 829: configure pkgsrc to store distfiles and packages in directories outside the
1.154 rillig 830: pkgsrc tree by setting the DISTDIR and PACKAGES variables. See Chapter 6,
1.78 snj 831: Configuring pkgsrc for the details.
1.1 dsieger 832:
833: To update pkgsrc from a tar file, download the tar file as explained above.
834: Then, make sure that you have not made any changes to the files in the pkgsrc
835: directory. Remove the pkgsrc directory and extract the new tar file. Done.
836:
1.154 rillig 837: 3.2.2. Via CVS
1.1 dsieger 838:
1.26 spz 839: To update pkgsrc via CVS, change to the pkgsrc directory and run cvs:
1.12 weinem 840:
1.26 spz 841: $ cd /usr/pkgsrc && cvs update -dP
842:
843: If you get error messages from rsh, you need to set CVS_RSH variable as
844: described above. E.g.:
845:
846: $ cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP
1.1 dsieger 847:
1.154 rillig 848: 3.2.2.1. Switching between different pkgsrc branches
1.1 dsieger 849:
850: When updating pkgsrc, the CVS program keeps track of the branch you selected.
851: But if you, for whatever reason, want to switch from the stable branch to the
852: current one, you can do it by adding the option "-A" after the "update"
1.25 wiz 853: keyword. To switch from the current branch back to the stable branch, add the "
1.246 leot 854: -rpkgsrc-2023Q3" option.
1.1 dsieger 855:
1.154 rillig 856: 3.2.2.2. What happens to my changes when updating?
1.1 dsieger 857:
858: When you update pkgsrc, the CVS program will only touch those files that are
859: registered in the CVS repository. That means that any packages that you created
860: on your own will stay unmodified. If you change files that are managed by CVS,
861: later updates will try to merge your changes with those that have been done by
862: others. See the CVS manual, chapter "update" for details.
863:
1.154 rillig 864: Chapter 4. Using pkgsrc on systems other than NetBSD
1.1 dsieger 865:
866: Table of Contents
867:
1.154 rillig 868: 4.1. Binary distribution
869: 4.2. Bootstrapping pkgsrc
1.1 dsieger 870:
1.154 rillig 871: 4.1. Binary distribution
1.1 dsieger 872:
1.154 rillig 873: See Section 5.1, "Using binary packages".
1.1 dsieger 874:
1.154 rillig 875: 4.2. Bootstrapping pkgsrc
1.1 dsieger 876:
1.44 asau 877: pkgsrc can be bootstrapped for use in two different modes: privileged and
878: unprivileged one. In unprivileged mode in contrast to privileged one all
1.45 asau 879: programs are installed under one particular user and cannot utilise privileged
1.44 asau 880: operations (packages don't create special users and all special file
881: permissions like setuid are ignored).
882:
1.1 dsieger 883: Installing the bootstrap kit from source should be as simple as:
884:
1.60 asau 885: # env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 886: # cd pkgsrc/bootstrap
887: # ./bootstrap
888:
889:
1.44 asau 890: To bootstrap in unprivileged mode pass "--unprivileged" flag to bootstrap
891:
892: By default, in privileged mode pkgsrc uses /usr/pkg for prefix where programs
1.118 sevan 893: will be installed in, and /usr/pkg/pkgdb for the package database directory
894: where pkgsrc will do its internal bookkeeping, /var is used as varbase, where
1.44 asau 895: packages install their persistent data. In unprivileged mode pkgsrc uses ~/pkg
1.118 sevan 896: for prefix, ~/pkg/pkgdb for the package database, and ~/pkg/var for varbase.
1.44 asau 897:
898: You can change default layout using command-line arguments. Run "./bootstrap
899: --help" to get details.
1.1 dsieger 900:
901: Note
902:
903: The bootstrap installs a bmake tool. Use this bmake when building via pkgsrc.
904: For examples in this guide, use bmake instead of "make".
905:
1.44 asau 906: Note
907:
908: It is possible to bootstrap multiple instances of pkgsrc using non-intersecting
909: directories. Use bmake corresponding to the installation you're working with to
910: build and install packages.
911:
1.154 rillig 912: Chapter 5. Using pkgsrc
1.1 dsieger 913:
914: Table of Contents
915:
1.154 rillig 916: 5.1. Using binary packages
917: 5.1.1. Finding binary packages
918: 5.1.2. Installing binary packages
1.202 nia 919: 5.1.3. Updating packages
920: 5.1.4. Deinstalling packages
921: 5.1.5. Getting information about installed packages
922: 5.1.6. Checking for security vulnerabilities in installed packages
923: 5.1.7. Finding if newer versions of your installed packages are in pkgsrc
924: 5.1.8. Other administrative functions
1.154 rillig 925: 5.2. Building packages from source
926: 5.2.1. Requirements
927: 5.2.2. Fetching distfiles
928: 5.2.3. How to build and install
1.1 dsieger 929:
930: Basically, there are two ways of using pkgsrc. The first is to only install the
931: package tools and to use binary packages that someone else has prepared. This
932: is the "pkg" in pkgsrc. The second way is to install the "src" of pkgsrc, too.
933: Then you are able to build your own packages, and you can still use binary
934: packages from someone else.
935:
1.154 rillig 936: 5.1. Using binary packages
1.1 dsieger 937:
1.151 sevan 938: On the cdn.NetBSD.org site and mirrors, there are collections of binary
1.9 rillig 939: packages, ready to be installed. These binary packages have been built using
940: the default settings for the directories, that is:
941:
942: * /usr/pkg for LOCALBASE, where most of the files are installed,
943:
944: * /usr/pkg/etc for configuration files,
945:
946: * /var for VARBASE, where those files are installed that may change after
947: installation.
948:
949: If you cannot use these directories for whatever reasons (maybe because you're
950: not root), you cannot use these binary packages, but have to build the packages
1.154 rillig 951: yourself, which is explained in Section 4.2, "Bootstrapping pkgsrc".
1.1 dsieger 952:
1.154 rillig 953: 5.1.1. Finding binary packages
1.1 dsieger 954:
1.5 weinem 955: To install binary packages, you first need to know from where to get them. The
1.202 nia 956: first place where you should look is on the main pkgsrc CDN in the directory /
957: pub/pkgsrc/packages.
1.5 weinem 958:
959: This directory contains binary packages for multiple platforms. First, select
1.226 gutterid 960: your operating system. Then, select your hardware architecture, and in the
961: third step, the OS version and the "version" of pkgsrc.
1.9 rillig 962:
1.226 gutterid 963: In this directory, you may find a file called bootstrap.tar.gz which contains
1.9 rillig 964: the package management tools. If the file is missing, it is likely that your
965: operating system already provides those tools. Download the file and extract it
966: in the / directory. It will create the directories /usr/pkg (containing the
1.118 sevan 967: tools for managing binary packages and the database of installed packages).
1.1 dsieger 968:
1.154 rillig 969: 5.1.2. Installing binary packages
1.1 dsieger 970:
1.85 wiz 971: In the directory from the last section, there is a subdirectory called All/,
1.9 rillig 972: which contains all the binary packages that are available for the platform,
1.202 nia 973: excluding those that may not be distributed via HTTP or FTP.
1.9 rillig 974:
975: To install packages directly from an FTP or HTTP server, run the following
976: commands in a Bourne-compatible shell (be sure to su to root first):
977:
1.202 nia 978: # PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"
979: # PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"
1.169 rillig 980: # PKG_PATH="$PKG_PATH/OPSYS/ARCH/VERSIONS/All/"
1.9 rillig 981: # export PATH PKG_PATH
1.202 nia 982: # pkg_add pkgin
1.9 rillig 983:
984: Instead of URLs, you can also use local paths, for example if you are
985: installing from a set of CDROMs, DVDs or an NFS-mounted repository. If you want
986: to install packages from multiple sources, you can separate them by a semicolon
987: in PKG_PATH.
988:
989: After these preparations, installing a package is very easy:
990:
1.202 nia 991: # pkgin search nginx
992: nginx-1.19.6 Lightweight HTTP server and mail proxy server
993: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
994: # pkgin install zsh nginx-1.19.6 vim
1.1 dsieger 995:
1.202 nia 996: Note that pkgin is a user-friendly frontend to the pkg_* tools.
1.1 dsieger 997:
1.202 nia 998: Any prerequisite packages needed to run the package in question will be
999: installed, too, assuming they are present in the repository.
1.1 dsieger 1000:
1001: After you've installed packages, be sure to have /usr/pkg/bin and /usr/pkg/sbin
1002: in your PATH so you can actually start the just installed program.
1003:
1.202 nia 1004: 5.1.3. Updating packages
1.1 dsieger 1005:
1.202 nia 1006: To update binary packages, it is recommended that you use pkgin upgrade. This
1007: will compare the remote package repository to your locally installed packages
1008: and safely replace any older packages.
1.1 dsieger 1009:
1.202 nia 1010: Note that pkgsrc is released as quarterly branches. If you are updating to a
1011: newer quarterly branch of pkgsrc, you may need to adjust the repository in /usr
1012: /pkg/etc/pkgin/repositories.conf.
1.1 dsieger 1013:
1.202 nia 1014: 5.1.4. Deinstalling packages
1.1 dsieger 1015:
1.202 nia 1016: To deinstall a package, it does not matter whether it was installed from source
1017: code or from a binary package. Neither the pkgin or the pkg_delete command need
1018: to know.
1.1 dsieger 1019:
1.202 nia 1020: To delete a package, you can just run pkgin remove package-name. The package
1021: name can be given with or without version number.
1.1 dsieger 1022:
1.202 nia 1023: 5.1.5. Getting information about installed packages
1.1 dsieger 1024:
1025: The pkg_info shows information about installed packages or binary package
1.202 nia 1026: files. As with other management tools, it works with packages installed from
1027: source or binaries.
1.1 dsieger 1028:
1.202 nia 1029: 5.1.6. Checking for security vulnerabilities in installed packages
1.1 dsieger 1030:
1.202 nia 1031: The pkgsrc Security Team and Packages Groups maintain a list of known
1.164 leot 1032: vulnerabilities to packages which are (or have been) included in pkgsrc. The
1.202 nia 1033: list is available from the NetBSD CDN at https://cdn.NetBSD.org/pub/NetBSD/
1.179 rillig 1034: packages/vulns/pkg-vulnerabilities.
1.1 dsieger 1035:
1.202 nia 1036: Please note that not every "vulnerability" with a CVE assignment is exploitable
1037: in every configuration. Some bugs are marked as active simply because an fix
1038: was not marked as such. Operating system specific hardening and mitigation
1039: features may also reduce the impact of bugs.
1040:
1.23 jakllsch 1041: Through pkg_admin fetch-pkg-vulnerabilities, this list can be downloaded
1042: automatically, and a security audit of all packages installed on a system can
1043: take place.
1044:
1045: There are two components to auditing. The first step, pkg_admin
1046: fetch-pkg-vulnerabilities, is for downloading the list of vulnerabilities from
1047: the NetBSD FTP site. The second step, pkg_admin audit, checks to see if any of
1048: your installed packages are vulnerable. If a package is vulnerable, you will
1049: see output similar to the following:
1.1 dsieger 1050:
1051: Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1052: https://www.samba.org/samba/whatsnew/macroexploit.html
1.1 dsieger 1053:
1.23 jakllsch 1054: You may wish to have the vulnerabilities file downloaded daily so that it
1055: remains current. This may be done by adding an appropriate entry to the root
1056: users crontab(5) entry. For example the entry
1057:
1.121 sevan 1058: # Download vulnerabilities file
1.118 sevan 1059: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1060: # Audit the installed packages and email results to root
1061: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1062: root >/dev/null 2>&1
1.118 sevan 1063:
1064:
1065: will update the vulnerability list every day at 3AM, followed by an audit at
1066: 3:09AM. The result of the audit are then emailed to root. On NetBSD this may be
1067: accomplished instead by adding the following line to /etc/daily.conf:
1068:
1069: fetch_pkg_vulnerabilities=YES
1070:
1.23 jakllsch 1071:
1.118 sevan 1072: to fetch the vulnerability list from the daily security script. The system is
1073: set to audit the packages by default but can be set explicitly, if desired (not
1.123 wiz 1074: required), by adding the following line to /etc/security.conf:
1.23 jakllsch 1075:
1.118 sevan 1076: check_pkg_vulnerabilities=YES
1.23 jakllsch 1077:
1078:
1.118 sevan 1079: see daily.conf(5) and security.conf(5) for more details.
1.1 dsieger 1080:
1.202 nia 1081: 5.1.7. Finding if newer versions of your installed packages are in pkgsrc
1.1 dsieger 1082:
1.12 weinem 1083: Install pkgtools/lintpkgsrc and run lintpkgsrc with the "-i" argument to check
1.202 nia 1084: if any packages are stale, e.g.
1.1 dsieger 1085:
1086: % lintpkgsrc -i
1087: ...
1088: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1089:
1090:
1.202 nia 1091: 5.1.8. Other administrative functions
1.1 dsieger 1092:
1093: The pkg_admin executes various administrative functions on the package system.
1094:
1.154 rillig 1095: 5.2. Building packages from source
1.1 dsieger 1096:
1097: After obtaining pkgsrc, the pkgsrc directory now contains a set of packages,
1.25 wiz 1098: organized into categories. You can browse the online index of packages, or run
1.1 dsieger 1099: make readme from the pkgsrc directory to build local README.html files for all
1100: packages, viewable with any web browser such as www/lynx or www/firefox.
1101:
1102: The default prefix for installed packages is /usr/pkg. If you wish to change
1103: this, you should do so by setting LOCALBASE in mk.conf. You should not try to
1104: use multiple different LOCALBASE definitions on the same system (inside a
1105: chroot is an exception).
1106:
1107: The rest of this chapter assumes that the package is already in pkgsrc. If it
1108: is not, see Part II, "The pkgsrc developer's guide" for instructions how to
1109: create your own packages.
1110:
1.154 rillig 1111: 5.2.1. Requirements
1.1 dsieger 1112:
1113: To build packages from source, you need a working C compiler. On NetBSD, you
1114: need to install the "comp" and the "text" distribution sets. If you want to
1115: build X11-related packages, the "xbase" and "xcomp" distribution sets are
1116: required, too.
1117:
1.154 rillig 1118: 5.2.2. Fetching distfiles
1.1 dsieger 1119:
1120: The first step for building a package is downloading the distfiles (i.e. the
1121: unmodified source). If they have not yet been downloaded, pkgsrc will fetch
1122: them automatically.
1123:
1124: If you have all files that you need in the distfiles directory, you don't need
1125: to connect. If the distfiles are on CD-ROM, you can mount the CD-ROM on /cdrom
1126: and add:
1127:
1128: DISTDIR=/cdrom/pkgsrc/distfiles
1129:
1130: to your mk.conf.
1131:
1132: By default a list of distribution sites will be randomly intermixed to prevent
1133: huge load on servers which holding popular packages (for example,
1134: SourceForge.net mirrors). Thus, every time when you need to fetch yet another
1135: distfile all the mirrors will be tried in new (random) order. You can turn this
1136: feature off by setting MASTER_SORT_RANDOM=NO (for PKG_DEVELOPERs it's already
1137: disabled).
1138:
1139: You can overwrite some of the major distribution sites to fit to sites that are
1140: close to your own. By setting one or two variables you can modify the order in
1141: which the master sites are accessed. MASTER_SORT contains a whitespace
1142: delimited list of domain suffixes. MASTER_SORT_REGEX is even more flexible, it
1143: contains a whitespace delimited list of regular expressions. It has higher
1144: priority than MASTER_SORT. Have a look at pkgsrc/mk/defaults/mk.conf to find
1145: some examples. This may save some of your bandwidth and time.
1146:
1147: You can change these settings either in your shell's environment, or, if you
1.4 rillig 1148: want to keep the settings, by editing the mk.conf file, and adding the
1.1 dsieger 1149: definitions there.
1150:
1.132 wiz 1151: If a package depends on many other packages (such as meta-pkgs/kde4), the build
1.1 dsieger 1152: process may alternate between periods of downloading source, and compiling. To
1153: ensure you have all the source downloaded initially you can run the command:
1154:
1155: % make fetch-list | sh
1156:
1157: which will output and run a set of shell commands to fetch the necessary files
1158: into the distfiles directory. You can also choose to download the files
1159: manually.
1160:
1.154 rillig 1161: 5.2.3. How to build and install
1.1 dsieger 1162:
1163: Once the software has downloaded, any patches will be applied, then it will be
1164: compiled for you. This may take some time depending on your computer, and how
1165: many other packages the software depends on and their compile time.
1166:
1167: Note
1168:
1169: If using bootstrap or pkgsrc on a non-NetBSD system, use the pkgsrc bmake
1170: command instead of "make" in the examples in this guide.
1171:
1172: For example, type
1173:
1174: % cd misc/figlet
1175: % make
1176:
1177:
1178: at the shell prompt to build the various components of the package.
1179:
1180: The next stage is to actually install the newly compiled program onto your
1181: system. Do this by entering:
1182:
1183: % make install
1184:
1185:
1186: while you are still in the directory for whatever package you are installing.
1187:
1188: Installing the package on your system may require you to be root. However,
1189: pkgsrc has a just-in-time-su feature, which allows you to only become root for
1190: the actual installation step.
1191:
1192: That's it, the software should now be installed and setup for use. You can now
1193: enter:
1194:
1195: % make clean
1196:
1197:
1198: to remove the compiled files in the work directory, as you shouldn't need them
1199: any more. If other packages were also added to your system (dependencies) to
1200: allow your program to compile, you can tidy these up also with the command:
1201:
1202: % make clean-depends
1203:
1204:
1205: Taking the figlet utility as an example, we can install it on our system by
1.207 leot 1206: building as shown in Appendix C, Build logs.
1.1 dsieger 1207:
1208: The program is installed under the default root of the packages tree - /usr/
1209: pkg. Should this not conform to your tastes, set the LOCALBASE variable in your
1210: environment, and it will use that value as the root of your packages tree. So,
1211: to use /usr/local, set LOCALBASE=/usr/local in your environment. Please note
1212: that you should use a directory which is dedicated to packages and not shared
1213: with other programs (i.e., do not try and use LOCALBASE=/usr). Also, you should
1214: not try to add any of your own files or directories (such as src/, obj/, or
1215: pkgsrc/) below the LOCALBASE tree. This is to prevent possible conflicts
1216: between programs and other files installed by the package system and whatever
1217: else may have been installed there.
1218:
1.4 rillig 1219: Some packages look in mk.conf to alter some configuration options at build
1.1 dsieger 1220: time. Have a look at pkgsrc/mk/defaults/mk.conf to get an overview of what will
1221: be set there by default. Environment variables such as LOCALBASE can be set in
1.4 rillig 1222: mk.conf to save having to remember to set them each time you want to use
1.1 dsieger 1223: pkgsrc.
1224:
1225: Occasionally, people want to "look under the covers" to see what is going on
1226: when a package is building or being installed. This may be for debugging
1227: purposes, or out of simple curiosity. A number of utility values have been
1228: added to help with this.
1229:
1230: 1. If you invoke the make(1) command with PKG_DEBUG_LEVEL=2, then a huge
1231: amount of information will be displayed. For example,
1232:
1233: make patch PKG_DEBUG_LEVEL=2
1234:
1.25 wiz 1235: will show all the commands that are invoked, up to and including the "patch
1236: " stage.
1.1 dsieger 1237:
1238: 2. If you want to know the value of a certain make(1) definition, then the
1239: VARNAME definition should be used, in conjunction with the show-var target.
1240: e.g. to show the expansion of the make(1) variable LOCALBASE:
1241:
1242: % make show-var VARNAME=LOCALBASE
1243: /usr/pkg
1244: %
1245:
1246:
1247: If you want to install a binary package that you've either created yourself
1248: (see next section), that you put into pkgsrc/packages manually or that is
1249: located on a remote FTP server, you can use the "bin-install" target. This
1250: target will install a binary package - if available - via pkg_add(1), else do a
1251: make package. The list of remote FTP sites searched is kept in the variable
1252: BINPKG_SITES, which defaults to ftp.NetBSD.org. Any flags that should be added
1253: to pkg_add(1) can be put into BIN_INSTALL_FLAGS. See pkgsrc/mk/defaults/mk.conf
1254: for more details.
1255:
1256: A final word of warning: If you set up a system that has a non-standard setting
1257: for LOCALBASE, be sure to set that before any packages are installed, as you
1258: cannot use several directories for the same purpose. Doing so will result in
1259: pkgsrc not being able to properly detect your installed packages, and fail
1260: miserably. Note also that precompiled binary packages are usually built with
1261: the default LOCALBASE of /usr/pkg, and that you should not install any if you
1262: use a non-standard LOCALBASE.
1263:
1.154 rillig 1264: Chapter 6. Configuring pkgsrc
1.1 dsieger 1265:
1266: Table of Contents
1267:
1.154 rillig 1268: 6.1. General configuration
1269: 6.2. Variables affecting the build process
1.241 rillig 1270: 6.3. Preferences for native or pkgsrc software
1271: 6.4. Variables affecting the installation process
1272: 6.5. Selecting and configuring the compiler
1273: 6.5.1. Selecting the compiler
1274: 6.5.2. Additional flags to the compiler (CFLAGS)
1275: 6.5.3. Additional flags to the linker (LDFLAGS)
1276: 6.6. Developer/advanced settings
1277: 6.7. Selecting Build Options
1.1 dsieger 1278:
1279: The whole pkgsrc system is configured in a single file, usually called mk.conf.
1280: In which directory pkgsrc looks for that file depends on the installation. On
1281: NetBSD, when you use make(1) from the base system, it is in the directory /etc
1282: /. In all other cases the default location is ${PREFIX}/etc/, depending on
1283: where you told the bootstrap program to install the binary packages.
1284:
1285: The format of the configuration file is that of the usual BSD-style Makefiles.
1286: The whole pkgsrc configuration is done by setting variables in this file. Note
1287: that you can define all kinds of variables, and no special error checking (for
1.112 rillig 1288: example for spelling mistakes) takes place.
1.1 dsieger 1289:
1.154 rillig 1290: 6.1. General configuration
1.1 dsieger 1291:
1.112 rillig 1292: The following variables apply to all pkgsrc packages. A complete list of the
1293: variables that can be configured by the user is available in mk/defaults/
1294: mk.conf, together with some comments that describe each variable's intent.
1.1 dsieger 1295:
1296: * LOCALBASE: Where packages will be installed. The default is /usr/pkg. Do
1297: not mix binary packages with different LOCALBASEs!
1298:
1299: * CROSSBASE: Where "cross" category packages will be installed. The default
1300: is ${LOCALBASE}/cross.
1301:
1.84 wiz 1302: * X11BASE: Where X11 is installed on the system. The default is /usr/X11R7.
1.1 dsieger 1303:
1304: * DISTDIR: Where to store the downloaded copies of the original source
1305: distributions used for building pkgsrc packages. The default is $
1306: {PKGSRCDIR}/distfiles.
1307:
1308: * PKG_DBDIR: Where the database about installed packages is stored. The
1.118 sevan 1309: default is /usr/pkg/pkgdb.
1.1 dsieger 1310:
1311: * MASTER_SITE_OVERRIDE: If set, override the packages' MASTER_SITES with this
1312: value.
1313:
1314: * MASTER_SITE_BACKUP: Backup location(s) for distribution files and patch
1315: files if not found locally or in ${MASTER_SITES} or ${PATCH_SITES}
1.118 sevan 1316: respectively. The defaults is ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/$
1.1 dsieger 1317: {DIST_SUBDIR}/.
1318:
1319: * BINPKG_SITES: List of sites carrying binary pkgs. rel and arch are replaced
1320: with OS release ("2.0", etc.) and architecture ("mipsel", etc.).
1321:
1.23 jakllsch 1322: * ACCEPTABLE_LICENSES: List of acceptable licenses. License names are
1323: case-sensitive. Whenever you try to build a package whose license is not in
1324: this list, you will get an error message. If the license condition is
1325: simple enough, the error message will include specific instructions on how
1326: to change this variable.
1.1 dsieger 1327:
1.154 rillig 1328: 6.2. Variables affecting the build process
1.1 dsieger 1329:
1330: * PACKAGES: The top level directory for the binary packages. The default is $
1331: {PKGSRCDIR}/packages.
1332:
1333: * WRKOBJDIR: The top level directory where, if defined, the separate working
1334: directories will get created, and symbolically linked to from ${WRKDIR}
1335: (see below). This is useful for building packages on several architectures,
1336: then ${PKGSRCDIR} can be NFS-mounted while ${WRKOBJDIR} is local to every
1337: architecture. (It should be noted that PKGSRCDIR should not be set by the
1.198 leot 1338: user -- it is an internal definition which refers to the root of the pkgsrc
1.1 dsieger 1339: tree. It is possible to have many pkgsrc tree instances.)
1340:
1341: * LOCALPATCHES: Directory for local patches that aren't part of pkgsrc. See
1.184 rillig 1342: Section 12.3, "patches/*" for more information.
1.1 dsieger 1343:
1344: * PKGMAKECONF: Location of the mk.conf file used by a package's BSD-style
1345: Makefile. If this is not set, MAKECONF is set to /dev/null to avoid picking
1346: up settings used by builds in /usr/src.
1347:
1.241 rillig 1348: 6.3. Preferences for native or pkgsrc software
1349:
1350: Whenever a package depends on a package that has a builtin.mk file, the
1351: dependent package can either use the built-in (native) version from the base
1352: system or the pkgsrc-provided version. This only affects dependencies, so it is
1353: still possible to build the pkgsrc package devel/pcre++ even when other
1354: packages depend on the native pcre++ version instead.
1355:
1356: To force using the pkgsrc-provided version for a particular package, define "
1357: PREFER_PKGSRC = package-ID" in mk.conf. To force using the native package,
1358: define "PREFER_NATIVE = package-ID". In both cases, the package-ID is the one
1359: from the buildlink3.mk of the package. In most cases, this ID is the same as
1360: the directory name of the package, but for example, devel/pcre++ has the
1361: package ID "pcrexx".
1362:
1363: For the packages that are not listed by their package ID, pkgsrc uses the
1364: pkgsrc-provided version if PREFER_PKGSRC contains the word "yes". Otherwise, if
1365: PREFER_NATIVE contains the word "yes", pkgsrc uses the native version. For
1366: example, to require using the pkgsrc-provided versions for all but the most
1367: basic bits on a NetBSD system, you can set:
1368:
1369: PREFER_PKGSRC= yes
1370: PREFER_NATIVE= getopt skey tcp_wrappers
1371:
1372: A package must have a builtin.mk file to be listed in PREFER_NATIVE, otherwise
1373: it is simply ignored in that list.
1374:
1375: PREFER_PKGSRC and PREFER_NATIVE should be set during bootstrap to ensure that
1376: the bootstrap process does not use inapropriate native tools as dependencies
1377: for core packages.
1378:
1379: # ./bootstrap --prefer-pkgsrc yes --prefer-native openssl
1380:
1381: Switching between settings globally at a later date can introduce complications
1382: with dependency resolution. This is caused by packages built with the opposite
1383: preference being installed alongside each other. Hence, when changing any of
1384: these variables after bootstrap, you need to rebuild all packages depending on
1385: those whose preference has been changed. This is not trivial and should be
1386: avoided.
1387:
1388: When using pkgsrc on Linux systems, there is high risk of "leakage", where
1389: programs installed by pkgsrc may inadvertently use a command or library not
1390: installed by pkgsrc, e.g. those installed by yum or apt. Such foreign
1391: dependencies may be installed, removed, or upgraded to a version incompatible
1392: with the pkgsrc package at any time, causing pkgsrc packages to subsequently
1393: malfunction. Pkgsrc cannot prevent this, as it has no control over other
1394: package managers. Another potential problem is that under Redhat Enterprise and
1395: related Linux systems, yum packages are only patched and never upgraded, so
1396: eventually they may become too outdated for use by pkgsrc. Even intentionally
1397: using foreign dependencies, not considered leakage, can lead to these problems,
1398: so it is generally discouraged. In order to minimize such problems,
1399: PREFER_PKGSRC defaults to "yes" on Linux systems. This ensures that pkgsrc is
1400: aware of any changes to dependency packages and can rebuild or upgrade the
1401: entire dependency tree as needed. This default can be overridden by setting
1402: --prefer-pkgsrc to a list of packages and --prefer-native to "yes".
1403:
1404: 6.4. Variables affecting the installation process
1.1 dsieger 1405:
1.198 leot 1406: * PKGSRC_KEEP_BIN_PKGS: By default, binary packages of built packages are
1.150 leot 1407: preserved in ${PACKAGES}/All. Setting this variable to "no" prevents this.
1.1 dsieger 1408:
1.107 jnemeth 1409: Packages have to support installation into a subdirectory of WRKDIR. This
1410: allows a package to be built, before the actual filesystem is touched. DESTDIR
1411: support exists in two variations:
1.4 rillig 1412:
1413: * Basic DESTDIR support means that the package installation and packaging is
1414: still run as root.
1415:
1416: * Full DESTDIR support can run the complete build, installation and packaging
1417: as normal user. Root privileges are only needed to add packages.
1418:
1419: With basic DESTDIR support, make clean needs to be run as root.
1420:
1.17 imil 1421: Considering the foo/bar package, DESTDIR full support can be tested using the
1422: following commands
1423:
1424: $ id
1425: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1426: $ mkdir $HOME/packages
1427: $ cd $PKGSRCDIR/foo/bar
1428:
1429: Verify DESTDIR full support, no root privileges should be needed
1430:
1.66 asau 1431: $ make stage-install
1.17 imil 1432:
1433: Create a package without root privileges
1434:
1.66 asau 1435: $ make PACKAGES=$HOME/packages package
1.17 imil 1436:
1437: For the following command, you must be able to gain root privileges using su(1)
1438:
1.66 asau 1439: $ make PACKAGES=$HOME/packages install
1.17 imil 1440:
1441: Then, as a simple user
1442:
1443: $ make clean
1444:
1.241 rillig 1445: 6.5. Selecting and configuring the compiler
1.4 rillig 1446:
1.241 rillig 1447: 6.5.1. Selecting the compiler
1.1 dsieger 1448:
1449: By default, pkgsrc will use GCC to build packages. This may be overridden by
1450: setting the following variables in /etc/mk.conf:
1451:
1452: PKGSRC_COMPILER:
1453:
1454: This is a list of values specifying the chain of compilers to invoke when
1455: building packages. Valid values are:
1456:
1.232 gutterid 1457: o ccc: Compaq C Compilers (Tru64)
1.66 asau 1458:
1.232 gutterid 1459: o ccache: compiler cache (chainable)
1.66 asau 1460:
1.232 gutterid 1461: o clang: Clang C and Objective-C compiler
1.66 asau 1462:
1.232 gutterid 1463: o distcc: distributed C/C++ (chainable)
1.1 dsieger 1464:
1.232 gutterid 1465: o f2c: Fortran 77 to C compiler (chainable)
1.66 asau 1466:
1.232 gutterid 1467: o icc: Intel C++ Compiler (Linux)
1.66 asau 1468:
1.232 gutterid 1469: o ido: SGI IRIS Development Option cc (IRIX 5)
1.1 dsieger 1470:
1.232 gutterid 1471: o gcc: GNU C/C++ Compiler
1.1 dsieger 1472:
1.232 gutterid 1473: o hp: HP-UX C/aC++ compilers
1.66 asau 1474:
1.232 gutterid 1475: o mipspro: Silicon Graphics, Inc. MIPSpro (n32/n64)
1.1 dsieger 1476:
1.232 gutterid 1477: o mipspro-ucode: Silicon Graphics, Inc. MIPSpro (o32)
1.1 dsieger 1478:
1.232 gutterid 1479: o sunpro: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio
1.1 dsieger 1480:
1.232 gutterid 1481: o xlc: IBM's XL C/C++ compiler suite
1.66 asau 1482:
1.1 dsieger 1483: The default is "gcc". You can use ccache and/or distcc with an appropriate
1484: PKGSRC_COMPILER setting, e.g. "ccache gcc". This variable should always be
1485: terminated with a value for a real compiler. Note that only one real
1486: compiler should be listed (e.g. "sunpro gcc" is not allowed).
1487:
1488: GCC_REQD:
1489:
1490: This specifies the minimum version of GCC to use when building packages. If
1491: the system GCC doesn't satisfy this requirement, then pkgsrc will build and
1492: install one of the GCC packages to use instead.
1493:
1.153 leot 1494: PYTHON_VERSION_DEFAULT:
1.114 maya 1495:
1496: Specifies which version of python to use when several options are
1497: available.
1498:
1499: PKGSRC_FORTRAN:
1500:
1.176 gutterid 1501: Specifies the Fortran compiler to use. The default is gfortran.
1.114 maya 1502:
1503: GFORTRAN_VERSION:
1504:
1505: If PKGSRC_FORTRAN= gfortran is used, this option specifies which version to
1506: use.
1507:
1.241 rillig 1508: 6.5.2. Additional flags to the compiler (CFLAGS)
1.1 dsieger 1509:
1510: If you wish to set the CFLAGS variable, please make sure to use the += operator
1511: instead of the = operator:
1512:
1513: CFLAGS+= -your -flags
1514:
1515: Using CFLAGS= (i.e. without the "+") may lead to problems with packages that
1.16 jnemeth 1516: need to add their own flags. You may want to take a look at the devel/cpuflags
1.24 wiz 1517: package if you're interested in optimization specifically for the current CPU.
1.1 dsieger 1518:
1.241 rillig 1519: 6.5.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 1520:
1521: If you want to pass flags to the linker, both in the configure step and the
1522: build step, you can do this in two ways. Either set LDFLAGS or LIBS. The
1523: difference between the two is that LIBS will be appended to the command line,
1524: while LDFLAGS come earlier. LDFLAGS is pre-loaded with rpath settings for ELF
1525: machines depending on the setting of USE_IMAKE or the inclusion of mk/
1526: x11.buildlink3.mk. As with CFLAGS, if you do not wish to override these
1527: settings, use the += operator:
1528:
1529: LDFLAGS+= -your -linkerflags
1530:
1.241 rillig 1531: 6.6. Developer/advanced settings
1.1 dsieger 1532:
1533: * PKG_DEVELOPER: Run some sanity checks that package developers want:
1534:
1.42 asau 1535: + make sure patches apply with zero fuzz
1.1 dsieger 1536:
1.42 asau 1537: + run check-shlibs to see that all binaries will find their shared libs.
1.1 dsieger 1538:
1.232 gutterid 1539: * CHECK_FILES_STRICT: Also check VARBASE and PKG_SYSCONFDIR values in PLIST
1540: entries.
1541:
1.1 dsieger 1542: * PKG_DEBUG_LEVEL: The level of debugging output which is displayed whilst
1543: making and installing the package. The default value for this is 0, which
1544: will not display the commands as they are executed (normal, default, quiet
1545: operation); the value 1 will display all shell commands before their
1546: invocation, and the value 2 will display both the shell commands before
1.112 rillig 1547: their invocation, as well as their actual execution progress with set -x.
1.1 dsieger 1548:
1.241 rillig 1549: 6.7. Selecting Build Options
1.1 dsieger 1550:
1551: Some packages have build time options, usually to select between different
1552: dependencies, enable optional support for big dependencies or enable
1553: experimental features.
1554:
1555: To see which options, if any, a package supports, and which options are
1556: mutually exclusive, run make show-options, for example:
1557:
1558: The following options are supported by this package:
1559: ssl Enable SSL support.
1560: Exactly one of the following gecko options is required:
1561: firefox Use firefox as gecko rendering engine.
1562: mozilla Use mozilla as gecko rendering engine.
1563: At most one of the following database options may be selected:
1564: mysql Enable support for MySQL database.
1565: pgsql Enable support for PostgreSQL database.
1566:
1567: These options are enabled by default: firefox
1568: These options are currently enabled: mozilla ssl
1569:
1.4 rillig 1570: The following variables can be defined in mk.conf to select which options to
1571: enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
1.1 dsieger 1572: disable options for all packages that support them, and PKG_OPTIONS.pkgbase,
1573: which can be used to select or disable options specifically for package pkgbase
1574: . Options listed in these variables are selected, options preceded by "-" are
1575: disabled. A few examples:
1576:
1.4 rillig 1577: $ grep "PKG.*OPTION" mk.conf
1.1 dsieger 1578: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1579: PKG_OPTIONS.kdebase= debug -sasl
1580: PKG_OPTIONS.apache= suexec
1581:
1.11 rillig 1582: It is important to note that options that were specifically suggested by the
1.19 snj 1583: package maintainer must be explicitly removed if you do not wish to include the
1584: option. If you are unsure you can view the current state with make show-options
1585: .
1.11 rillig 1586:
1.1 dsieger 1587: The following settings are consulted in the order given, and the last setting
1588: that selects or disables an option is used:
1589:
1590: 1. the default options as suggested by the package maintainer
1591:
1592: 2. the options implied by the settings of legacy variables (see below)
1593:
1594: 3. PKG_DEFAULT_OPTIONS
1595:
1596: 4. PKG_OPTIONS.pkgbase
1597:
1598: For groups of mutually exclusive options, the last option selected is used, all
1599: others are automatically disabled. If an option of the group is explicitly
1600: disabled, the previously selected option, if any, is used. It is an error if no
1601: option from a required group of options is selected, and building the package
1602: will fail.
1603:
1604: Before the options framework was introduced, build options were selected by
1.4 rillig 1605: setting a variable (often named USE_FOO) in mk.conf for each option. To ease
1606: transition to the options framework for the user, these legacy variables are
1607: converted to the appropriate options setting (PKG_OPTIONS.pkgbase)
1608: automatically. A warning is issued to prompt the user to update mk.conf to use
1609: the options framework directly. Support for the legacy variables will be
1.1 dsieger 1610: removed eventually.
1611:
1.154 rillig 1612: Chapter 7. Creating binary packages
1.1 dsieger 1613:
1614: Table of Contents
1615:
1.154 rillig 1616: 7.1. Building a single binary package
1617: 7.2. Settings for creation of binary packages
1.1 dsieger 1618:
1.154 rillig 1619: 7.1. Building a single binary package
1.1 dsieger 1620:
1621: Once you have built and installed a package, you can create a binary package
1622: which can be installed on another system with pkg_add(1). This saves having to
1623: build the same package on a group of hosts and wasting CPU time. It also
1624: provides a simple means for others to install your package, should you
1625: distribute it.
1626:
1627: To create a binary package, change into the appropriate directory in pkgsrc,
1628: and run make package:
1629:
1.112 rillig 1630: $ cd misc/figlet
1631: $ make package
1.1 dsieger 1632:
1.242 gutterid 1633: This will build your package (if not already done) and package it into a binary
1634: package. You can then use the pkg_* tools to manipulate it. Binary packages are
1635: created in PACKAGES, which defaults to /usr/pkgsrc/packages, in the form of a
1636: compressed tar file. See Section C.2, "Packaging figlet" for a continuation of
1637: the above misc/figlet example.
1.1 dsieger 1638:
1.154 rillig 1639: See Chapter 23, Submitting and Committing for information on how to submit such
1.1 dsieger 1640: a binary package.
1641:
1.154 rillig 1642: 7.2. Settings for creation of binary packages
1.1 dsieger 1643:
1.184 rillig 1644: See Section 13.17, "Other helpful targets".
1.6 rillig 1645:
1.154 rillig 1646: Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6 rillig 1647:
1648: Table of Contents
1649:
1.154 rillig 1650: 8.1. Preparations
1.180 rillig 1651: 8.2. Running a bulk build
1.154 rillig 1652: 8.2.1. Configuration
1653: 8.3. Requirements of a full bulk build
1.178 rillig 1654: 8.4. Bulk build variants
1.179 rillig 1655: 8.4.1. Detect unknown configure options
1656: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 1657: 8.4.3. Force compiler options only in the build phase
1658: 8.4.4. Use custom directories
1659: 8.4.5. Turn warnings into errors
1660: 8.4.6. Reject packages for which pkglint reports errors
1661: 8.4.7. Reject packages that contain forbidden strings
1662: 8.4.8. Reject packages whose self-test fails
1663: 8.4.9. Reject packages that use undefined shell variables
1664: 8.4.10. Turn off verbose logging
1.178 rillig 1665: 8.5. Creating a multiple CD-ROM packages collection
1666: 8.5.1. Example of cdpack
1.6 rillig 1667:
1.175 gutterid 1668: For a number of reasons, you may want to build binary packages for a large
1669: selected set of packages in pkgsrc, or even for all pkgsrc packages. For
1.71 wiz 1670: instance, when you have multiple machines that should run the same software, it
1671: is wasted time if they all build their packages themselves from source. Or you
1672: may want to build a list of packages you want and check them before deploying
1.175 gutterid 1673: onto production systems. There is a way of getting a set of binary packages:
1674: the bulk build system, or pbulk ("p" stands for "parallel"). This chapter
1675: describes how to set it up.
1.71 wiz 1676:
1.154 rillig 1677: 8.1. Preparations
1.71 wiz 1678:
1679: First of all, you have to decide whether you build all packages or a limited
1680: set of them. Full bulk builds usually consume a lot more resources, both space
1.175 gutterid 1681: and time, than builds for some practical sets of packages. A number of
1682: particularly heavy packages exist that are not actually interesting to a wide
1683: audience. (The approximate resource consumption for a full bulk build is given
1684: in section Section 8.3, "Requirements of a full bulk build".) For limited bulk
1685: builds you need to make a list of packages you want to build. Note that all
1686: their dependencies will be built, so you don't need to track them manually.
1.71 wiz 1687:
1688: During bulk builds various packages are installed and deinstalled in /usr/pkg
1689: (or whatever LOCALBASE is), so make sure that you don't need any package during
1.112 rillig 1690: the builds. Essentially, you should provide a fresh system, either a chroot
1.71 wiz 1691: environment or something even more restrictive, depending on what the operating
1692: system provides, or dedicate the whole physical machine. As a useful side
1693: effect this makes sure that bulk builds cannot break anything in your system.
1694: There have been numerous cases where certain packages tried to install files
1695: outside the LOCALBASE or wanted to edit some files in /etc.
1.6 rillig 1696:
1.180 rillig 1697: 8.2. Running a bulk build
1.6 rillig 1698:
1.180 rillig 1699: Running a bulk build works roughly as follows:
1.15 rillig 1700:
1701: * First, build the pbulk infrastructure in a fresh pkgsrc location.
1702:
1703: * Then, build each of the packages from a clean installation directory using
1704: the infrastructure.
1705:
1.154 rillig 1706: 8.2.1. Configuration
1.6 rillig 1707:
1.112 rillig 1708: To simplify configuration, we provide the helper script mk/pbulk/pbulk.sh.
1.6 rillig 1709:
1.68 asau 1710: In order to use it, prepare a clear system (real one, chroot environment, jail,
1711: zone, virtual machine). Configure network access to fetch distribution files.
1.112 rillig 1712: Create a user with name "pbulk".
1.68 asau 1713:
1714: Fetch and extract pkgsrc. Use a command like one of these:
1715:
1.151 sevan 1716: # (cd /usr && ftp -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1717: # (cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1.72 wiz 1718: # (cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)
1.68 asau 1719:
1720: Or any other way that fits (e.g., curl, wget).
1721:
1722: Deploy and configure pbulk tools, e.g.:
1723:
1.118 sevan 1724: # sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)
1.68 asau 1725: # sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment
1726: # sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build
1727:
1728: Note
1729:
1730: mk.conf.frag is a fragment of mk.conf that contains settings you want to apply
1731: to packages you build. For instance,
1732:
1.112 rillig 1733: PKG_DEVELOPER= yes # perform more checks
1734: X11_TYPE= modular # use pkgsrc X11
1735: SKIP_LICENSE_CHECK= yes # accept all licences (useful
1736: # when building all packages)
1.68 asau 1737:
1738: If configured for limited list, replace the list in /usr/pbulk/etc/pbulk.list
1.112 rillig 1739: with your list of packages, one per line without empty lines or comments. E.g.:
1.68 asau 1740:
1741: www/firefox
1742: mail/thunderbird
1743: misc/libreoffice4
1744:
1.69 asau 1745: At this point you can also review configuration in /usr/pbulk/etc and make
1746: final amendments, if wanted.
1747:
1.68 asau 1748: Start it:
1749:
1750: # /usr/pbulk/bin/bulkbuild
1751:
1752: After it finishes, you'll have /mnt filled with distribution files, binary
1753: packages, and reports, plain text summary in /mnt/bulklog/meta/report.txt
1754:
1755: Note
1756:
1757: The pbulk.sh script does not cover all possible use cases. While being ready to
1758: run, it serves as a good starting point to understand and build more complex
1759: setups. The script is kept small enough for better understanding.
1760:
1761: Note
1762:
1763: The pbulk.sh script supports running unprivileged bulk build and helps
1.205 wiz 1764: configuring distributed bulk builds. Distributed bulk builds support either
1765: building in worker chroots (each node is a path to a different chroot) that
1766: replicate the target system, including the pbulk prefix, or remote machines
1767: (each node is an IP address that must be accessible over SSH without a
1768: password).
1.15 rillig 1769:
1.154 rillig 1770: 8.3. Requirements of a full bulk build
1.71 wiz 1771:
1772: A complete bulk build requires lots of disk space. Some of the disk space can
1773: be read-only, some other must be writable. Some can be on remote filesystems
1774: (such as NFS) and some should be local. Some can be temporary filesystems,
1775: others must survive a sudden reboot.
1776:
1.205 wiz 1777: * 70 GB for the distfiles (read-write, remote, temporary)
1.71 wiz 1778:
1.205 wiz 1779: * 60 GB for the binary packages (read-write, remote, permanent)
1.71 wiz 1780:
1781: * 1 GB for the pkgsrc tree (read-only, remote, permanent)
1782:
1783: * 5 GB for LOCALBASE (read-write, local, temporary)
1784:
1785: * 10 GB for the log files (read-write, remote, permanent)
1786:
1787: * 5 GB for temporary files (read-write, local, temporary)
1788:
1.178 rillig 1789: 8.4. Bulk build variants
1790:
1791: To ensure that pkgsrc packages work in different configurations, it makes sense
1792: to run non-default bulk builds from time to time. This section lists some ideas
1793: for bulk builds that intentionally let packages fail if they don't follow the
1794: pkgsrc style.
1795:
1.179 rillig 1796: 8.4.1. Detect unknown configure options
1.178 rillig 1797:
1798: Add the following line to mk.conf.
1799:
1800: GNU_CONFIGURE_STRICT= yes
1801:
1802: When a package fails this additional check, the most common cause is that the
1803: configure option was valid for an older version of the package but does not
1804: apply anymore. In that case, just remove it.
1805:
1.179 rillig 1806: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.178 rillig 1807:
1808: The job of a compiler is not restricted to producing executable code, most
1.179 rillig 1809: compilers also detect typical programming mistakes. The pkgsrc compiler
1810: wrappers make it easy to force compiler options when the package is built. This
1811: can be used to find typical bugs across all packages that are in pkgsrc. By
1812: reporting these bugs upstream, the packages will be more reliable with the next
1813: updates.
1.178 rillig 1814:
1.179 rillig 1815: Add some of the following lines to mk.conf:
1.178 rillig 1816:
1817: CFLAGS+= -Werror=char-subscripts
1.179 rillig 1818: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 1819:
1.179 rillig 1820: When a package fails to build using these stricter compiler options, document
1821: the circumstances in which the compiler produced the error message. This
1822: includes:
1.178 rillig 1823:
1824: * The platform (MACHINE_PLATFORM)
1825:
1826: * The source file
1827:
1828: * An excerpt of the code. GCC and Clang already do this as part of the
1829: diagnostic.
1830:
1.179 rillig 1831: * The exact error message from the compiler.
1.178 rillig 1832:
1.179 rillig 1833: If a package produces these error messages, but the package is fine, record
1834: this in your local mk.conf, like this, to skip this check in the next builds:
1.178 rillig 1835:
1.179 rillig 1836: .if ${PKGPATH} == category/package
1.178 rillig 1837: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
1838: # error message
1839: # code
1.179 rillig 1840: # Reason why the code does not need to be fixed.
1.178 rillig 1841: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 1842: .endif
1.178 rillig 1843:
1844: If the error messages from the compiler are valid and the code needs to be
1.179 rillig 1845: fixed, prepare a local patch (see LOCALPATCHES) and report the bug to the
1846: upstream authors of the package, providing them with the information you
1847: collected above.
1.178 rillig 1848:
1.179 rillig 1849: Patches that are not essential for the package to work should only be reported
1850: upstream but not committed to pkgsrc, to make future updates easier.
1851:
1.181 rillig 1852: 8.4.3. Force compiler options only in the build phase
1853:
1854: When adding custom compiler flags via CFLAGS, these apply to all phases of the
1855: package build process. Especially in the configure phase, adding -Werror leads
1856: to wrong decisions. The GNU configure scripts feed many small test programs to
1857: the C compiler to see whether certain headers are available, functions are
1858: defined in a library and programs can be run. In many cases these programs
1859: would not survive a strict compiler run with -Wall -Wextra -Werror.
1860:
1861: The pkgsrc infrastructure is flexible enough to support compiler options being
1862: added between the configure and build phases. It's a little more complicated
1863: than the other examples in this section but still easy enough.
1864:
1865: The basic idea is to use the pkgsrc compiler wrapper to inject the desired
1866: compiler options. The compiler wrapper's original task is to hide unwanted
1867: directories of include files and to normalize compiler options. It does this by
1868: wrapping the compiler command and rewriting the command line. To see this in
1869: action, run bmake patch in a package directory and examine the work/.cwrappers/
1870: config directory. It contains individual configurations for the C compiler and
1871: the related tools. The plan is to find a hook between the configure and build
1872: phases, and to modify these configuration files at that point.
1873:
1874: To find this hook, have a look at mk/build/build.mk, which contains among
1875: others the pre-build-checks-hook. The word checks doesn't quite fit, but the
1876: pre-build-hook sounds good enough.
1877:
1878: The code to be included in mk.conf is:
1879:
1880: # Just a few example options.
1881: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
1882:
1883: .if ${BUILD_ONLY_CFLAGS:U:M*}
1884: pre-build-checks-hook: add-build-only-cflags
1885:
1886: add-build-only-cflags: .PHONY
1887: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
1888: ${TEST} ! -f ${.TARGET} || exit 0; \
1889: for flag in ${BUILD_ONLY_CFLAGS}; do \
1890: ${ECHO} "append=$$flag" >> cc; \
1891: done; \
1892: > ${.TARGET}
1893: .endif
1894:
1895: (When editing the mk.conf, make sure that the commands of the
1896: add-build-only-cflags target are indented with a tab, not with spaces.)
1897:
1898: The condition in the .if statement contains the :U modifier to prevent parse
1899: errors if the variable should be undefined, possibly because it is only defined
1900: for a subset of the packages. The :M* modifier ensures that there is at least
1901: one compiler option, to prevent a syntax error in the shell parser.
1902:
1903: The code around the ${.TARGET} variable ensures that the additional compiler
1904: options are only appended once, even if bmake build is run multiple times. To
1905: do this, it creates a marker file.
1906:
1907: To verify that this setup works, run bmake configure in a package directory. Up
1908: to now, everything works as usual. Examine the directory work/.cwrappers/config
1909: to see that the compiler options from BUILD_ONLY_CFLAGS are not yet added to
1910: the file cc. Examine the tail of the work/.work.log file to see that the normal
1911: compiler options are used.
1912:
1913: Now run bmake build. This will append the options to the file cc and will
1914: create the marker file in the same directory. After that, the build starts as
1915: usual, but with the added compiler options. Examine the tail of the file work
1916: /.work.log to see that the lines starting with [*] don't contain the compiler
1917: options, but the corresponding lines starting with <.> do end with these
1918: options.
1919:
1920: Building packages using this setup variant and fixing the resulting bugs is the
1921: same as in Section 8.4.2, "Detect classes of bugs by forcing compiler warnings"
1922: .
1923:
1924: 8.4.4. Use custom directories
1.178 rillig 1925:
1926: Some directories like PREFIX, VARBASE, PKG_SYSCONFDIR, PKGMANDIR, PKG_INFODIR
1927: can be configured in pkgsrc. Set these to arbitrary paths during bootstrap or
1928: afterwards in mk.conf.
1929:
1930: PREFIX= /a-random-uuid
1931: PKG_SYSCONFDIR= /a-random-uuid
1932: VARBASE= /a-random-uuid
1933: PKGMANDIR= a-random-uuid
1934: PKG_INFODIR= a-random-uuid
1935:
1.181 rillig 1936: 8.4.5. Turn warnings into errors
1.178 rillig 1937:
1938: When building a package, warnings are typically ignored since they just flow by
1939: and do not cause the build to fail immediately. To find these warnings,
1940: redefine them to errors in mk.conf.
1941:
1942: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
1943: WARNING_MSG= ${FAIL_MSG} "(was warning)"
1944:
1945: (There are many more classes of warnings in pkgsrc, and most of them can be
1946: redefined with a simple definition like above.
1947:
1.179 rillig 1948: If a package suggests to add USE_TOOLS+=perl to the package Makefile, research
1.178 rillig 1949: whether the package actually needs Perl. If it does, add USE_TOOLS+=perl to the
1950: package Makefile, and if it doesn't, add TOOLS_BROKEN+=perl.
1951:
1.181 rillig 1952: 8.4.6. Reject packages for which pkglint reports errors
1.178 rillig 1953:
1954: Using pkglint as part of the regular build process is mostly a waste of time.
1955: If you want to fix some of the warnings, just run pkglint recursively on the
1956: whole pkgsrc tree. This will take a few minutes (up to 10), which is much
1957: faster than a complete bulk build.
1958:
1.181 rillig 1959: 8.4.7. Reject packages that contain forbidden strings
1.178 rillig 1960:
1961: To ensure that the binary packages don't contain references to the build
1962: directory, there is already CHECK_WRKREF. If that variable includes the item
1963: extra, it is possible to define additional patterns that must not appear in any
1964: installed file. This is specified in mk.conf.
1965:
1966: CHECK_WRKREF= extra
1967: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
1968: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
1969: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
1970:
1971: The above patterns will probably generate many false positives, therefore the
1972: results need to be taken with a grain of salt.
1973:
1.181 rillig 1974: 8.4.8. Reject packages whose self-test fails
1.178 rillig 1975:
1976: To run the test suites that come with each package, add this line to mk.conf.
1977:
1978: PKGSRC_RUN_TEST= yes
1979:
1980: Be prepared that even the most basic packages fail this test. When doing a bulk
1981: build with this, it will often abort in the early phase where the packages are
1982: scanned for their dependencies since there are cyclic dependencies. There is
1983: still a lot to do in this area.
1984:
1.181 rillig 1985: 8.4.9. Reject packages that use undefined shell variables
1.178 rillig 1986:
1987: To catch typos in the shell snippets from the Makefile fragments, add the -u
1988: flag to most of the commands by adding this line to mk.conf.
1989:
1990: RUN= @set -eu;
1991:
1.181 rillig 1992: After that, ensure that none of the bulk build log files (even those for
1993: successfully built packages) contains the string parameter not set or whatever
1994: error message the command sh -ceu '$undefined' outputs.
1995:
1.178 rillig 1996: See mk/misc/common.mk for the existing definition.
1997:
1.181 rillig 1998: 8.4.10. Turn off verbose logging
1.178 rillig 1999:
2000: The build logs of a package are often quite long. This allows error messages or
2001: other interesting details to hide between the noise. To make the actual error
2002: message stand out more, add these lines to mk.conf.
2003:
2004: GNU_CONFIGURE_QUIET= yes
2005: MAKE_FLAGS+= -s
2006:
2007: The -s option works for both GNU Make and BSD Make. On exotic platforms with
2008: their own make, it may be a little different.
2009:
2010: 8.5. Creating a multiple CD-ROM packages collection
1.1 dsieger 2011:
2012: After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set
2013: of the resulting binary packages to assist in installing packages on other
2014: machines. The pkgtools/cdpack package provides a simple tool for creating the
2015: ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a way that
2016: keeps all the dependencies for a given package on the same CD as that package.
2017:
1.178 rillig 2018: 8.5.1. Example of cdpack
1.1 dsieger 2019:
2020: Complete documentation for cdpack is found in the cdpack(1) man page. The
2021: following short example assumes that the binary packages are left in /usr/
2022: pkgsrc/packages/All and that sufficient disk space exists in /u2 to hold the
2023: ISO 9660 images.
2024:
2025: # mkdir /u2/images
2026: # pkg_add /usr/pkgsrc/packages/All/cdpack
2027: # cdpack /usr/pkgsrc/packages/All /u2/images
2028:
2029:
2030: If you wish to include a common set of files (COPYRIGHT, README, etc.) on each
2031: CD in the collection, then you need to create a directory which contains these
1.175 gutterid 2032: files, e.g.:
1.1 dsieger 2033:
2034: # mkdir /tmp/common
2035: # echo "This is a README" > /tmp/common/README
2036: # echo "Another file" > /tmp/common/COPYING
2037: # mkdir /tmp/common/bin
2038: # echo "#!/bin/sh" > /tmp/common/bin/myscript
2039: # echo "echo Hello world" >> /tmp/common/bin/myscript
2040: # chmod 755 /tmp/common/bin/myscript
2041:
2042:
2043: Now create the images:
2044:
2045: # cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images
2046:
2047: Each image will contain README, COPYING, and bin/myscript in their root
2048: directories.
2049:
1.154 rillig 2050: Chapter 9. Directory layout of the installed files
1.1 dsieger 2051:
2052: Table of Contents
2053:
1.154 rillig 2054: 9.1. File system layout in ${LOCALBASE}
2055: 9.2. File system layout in ${VARBASE}
1.1 dsieger 2056:
2057: The files that are installed by pkgsrc are organized in a way that is similar
2058: to what you find in the /usr directory of the base system. But some details are
2059: different. This is because pkgsrc initially came from FreeBSD and had adopted
2060: its file system hierarchy. Later it was largely influenced by NetBSD. But no
2061: matter which operating system you are using pkgsrc with, you can expect the
2062: same layout for pkgsrc.
2063:
2064: There are mainly four root directories for pkgsrc, which are all configurable
2065: in the bootstrap/bootstrap script. When pkgsrc has been installed as root, the
2066: default locations are:
2067:
2068: LOCALBASE= /usr/pkg
2069: PKG_SYSCONFBASE= /usr/pkg/etc
2070: VARBASE= /var
1.119 sevan 2071: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2072:
2073: In unprivileged mode (when pkgsrc has been installed as any other user), the
2074: default locations are:
2075:
2076: LOCALBASE= ${HOME}/pkg
2077: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2078: VARBASE= ${HOME}/pkg/var
1.119 sevan 2079: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2080:
2081: What these four directories are for, and what they look like is explained
2082: below.
2083:
1.25 wiz 2084: * LOCALBASE corresponds to the /usr directory in the base system. It is the "
2085: main" directory where the files are installed and contains the well-known
1.1 dsieger 2086: subdirectories like bin, include, lib, share and sbin.
2087:
2088: * VARBASE corresponds to /var in the base system. Some programs (especially
2089: games, network daemons) need write access to it during normal operation.
2090:
2091: * PKG_SYSCONFDIR corresponds to /etc in the base system. It contains
2092: configuration files of the packages, as well as pkgsrc's mk.conf itself.
2093:
1.154 rillig 2094: 9.1. File system layout in ${LOCALBASE}
1.1 dsieger 2095:
2096: The following directories exist in a typical pkgsrc installation in $
2097: {LOCALBASE}.
2098:
2099: bin
2100:
2101: Contains executable programs that are intended to be directly used by the
2102: end user.
2103:
2104: emul
2105:
2106: Contains files for the emulation layers of various other operating systems,
2107: especially for NetBSD.
2108:
2109: etc (the usual location of ${PKG_SYSCONFDIR})
2110:
2111: Contains the configuration files.
2112:
2113: include
2114:
2115: Contains headers for the C and C++ programming languages.
2116:
2117: info
2118:
2119: Contains GNU info files of various packages.
2120:
2121: lib
2122:
2123: Contains shared and static libraries.
2124:
2125: libdata
2126:
2127: Contains data files that don't change after installation. Other data files
2128: belong into ${VARBASE}.
2129:
2130: libexec
2131:
2132: Contains programs that are not intended to be used by end users, such as
2133: helper programs or network daemons.
2134:
2135: libexec/cgi-bin
2136:
2137: Contains programs that are intended to be executed as CGI scripts by a web
2138: server.
2139:
2140: man (the usual value of ${PKGMANDIR})
2141:
2142: Contains brief documentation in form of manual pages.
2143:
2144: sbin
2145:
2146: Contains programs that are intended to be used only by the super-user.
2147:
2148: share
2149:
2150: Contains platform-independent data files that don't change after
2151: installation.
2152:
2153: share/doc
2154:
2155: Contains documentation files provided by the packages.
2156:
2157: share/examples
2158:
2159: Contains example files provided by the packages. Among others, the original
2160: configuration files are saved here and copied to ${PKG_SYSCONFDIR} during
2161: installation.
2162:
2163: share/examples/rc.d
2164:
2165: Contains the original files for rc.d scripts.
2166:
2167: var (the usual location of ${VARBASE})
2168:
2169: Contains files that may be modified after installation.
2170:
1.154 rillig 2171: 9.2. File system layout in ${VARBASE}
1.1 dsieger 2172:
2173: db/pkg (the usual location of ${PKG_DBDIR})
2174:
2175: Contains information about the currently installed packages.
2176:
2177: games
2178:
2179: Contains highscore files.
2180:
2181: log
2182:
2183: Contains log files.
2184:
2185: run
2186:
2187: Contains informational files about daemons that are currently running.
2188:
1.154 rillig 2189: Chapter 10. Frequently Asked Questions
1.1 dsieger 2190:
2191: Table of Contents
2192:
1.154 rillig 2193: 10.1. Are there any mailing lists for pkg-related discussion?
2194: 10.2. Utilities for package management (pkgtools)
2195: 10.3. How to use pkgsrc as non-root
2196: 10.4. How to resume transfers when fetching distfiles?
2197: 10.5. How can I install/use modular X.org from pkgsrc?
2198: 10.6. How to fetch files from behind a firewall
2199: 10.7. How to fetch files from HTTPS sites
2200: 10.8. How do I tell make fetch to do passive FTP?
2201: 10.9. How to fetch all distfiles at once
2202: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
2203: 10.11. What does "Could not find bsd.own.mk" mean?
1.221 nia 2204: 10.12. Using 'sudo' or `priv` with pkgsrc
1.154 rillig 2205: 10.13. How do I change the location of configuration files?
2206: 10.14. Automated security checks
2207: 10.15. Why do some packages ignore my CFLAGS?
2208: 10.16. A package does not build. What shall I do?
2209: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.232 gutterid 2210: conflicts" mean?
1.1 dsieger 2211:
2212: This section contains hints, tips & tricks on special things in pkgsrc that we
2213: didn't find a better place for in the previous chapters, and it contains items
2214: for both pkgsrc users and developers.
2215:
1.154 rillig 2216: 10.1. Are there any mailing lists for pkg-related discussion?
1.1 dsieger 2217:
2218: The following mailing lists may be of interest to pkgsrc users:
2219:
2220: * pkgsrc-users: This is a general purpose list for most issues regarding
2221: pkgsrc, regardless of platform, e.g. soliciting user help for pkgsrc
2222: configuration, unexpected build failures, using particular packages,
2223: upgrading pkgsrc installations, questions regarding the pkgsrc release
2224: branches, etc. General announcements or proposals for changes that impact
2225: the pkgsrc user community, e.g. major infrastructure changes, new features,
2226: package removals, etc., may also be posted.
2227:
2228: * pkgsrc-bulk: A list where the results of pkgsrc bulk builds are sent and
2229: discussed.
2230:
2231: * pkgsrc-changes: This list is for those who are interested in getting a
2232: commit message for every change committed to pkgsrc. It is also available
2233: in digest form, meaning one daily message containing all commit messages
2234: for changes to the package source tree in that 24 hour period.
2235:
2236: To subscribe, do:
2237:
2238: % echo subscribe listname | mail majordomo@NetBSD.org
2239:
1.174 leot 2240: Archives for all these mailing lists are available from https://
1.1 dsieger 2241: mail-index.NetBSD.org/.
2242:
1.154 rillig 2243: 10.2. Utilities for package management (pkgtools)
1.1 dsieger 2244:
2245: The directory pkgsrc/pkgtools contains a number of useful utilities for both
2246: users and developers of pkgsrc. This section attempts only to make the reader
1.121 sevan 2247: aware of some of the utilities and when they might be useful, and not to
2248: duplicate the documentation that comes with each package.
1.1 dsieger 2249:
2250: Utilities used by pkgsrc (automatically installed when needed):
2251:
2252: * pkgtools/x11-links: Symlinks for use by buildlink.
2253:
2254: OS tool augmentation (automatically installed when needed):
2255:
1.121 sevan 2256: * pkgtools/digest: Calculates various kinds of checksums (including SHA3).
1.1 dsieger 2257:
2258: * pkgtools/libnbcompat: Compatibility library for pkgsrc tools.
2259:
2260: * pkgtools/mtree: Installed on non-BSD systems due to lack of native mtree.
2261:
2262: * pkgtools/pkg_install: Up-to-date replacement for /usr/sbin/pkg_install, or
2263: for use on operating systems where pkg_install is not present.
2264:
2265: Utilities used by pkgsrc (not automatically installed):
2266:
2267: * pkgtools/pkg_tarup: Create a binary package from an already-installed
2268: package. Used by make replace to save the old package.
2269:
2270: * pkgtools/dfdisk: Adds extra functionality to pkgsrc, allowing it to fetch
2271: distfiles from multiple locations. It currently supports the following
2272: methods: multiple CD-ROMs and network FTP/HTTP connections.
2273:
2274: * devel/cpuflags: Determine the best compiler flags to optimise code for your
1.24 wiz 2275: current CPU and compiler.
1.1 dsieger 2276:
2277: Utilities for keeping track of installed packages, being up to date, etc:
2278:
1.65 wiz 2279: * pkgtools/pkgin: A package update tool similar to apt(1). Download, install,
2280: and upgrade binary packages easily.
2281:
1.1 dsieger 2282: * pkgtools/pkg_chk: Reports on packages whose installed versions do not match
2283: the latest pkgsrc entries.
2284:
2285: * pkgtools/pkgdep: Makes dependency graphs of packages, to aid in choosing a
2286: strategy for updating.
2287:
2288: * pkgtools/pkgdepgraph: Makes graphs from the output of pkgtools/pkgdep (uses
2289: graphviz).
2290:
1.12 weinem 2291: * pkgtools/pkglint: The pkglint(1) program checks a pkgsrc entry for errors.
2292:
2293: * pkgtools/lintpkgsrc: The lintpkgsrc(1) program does various checks on the
2294: complete pkgsrc system.
1.1 dsieger 2295:
2296: * pkgtools/pkgsurvey: Report what packages you have installed.
2297:
2298: Utilities for people maintaining or creating individual packages:
2299:
2300: * pkgtools/pkgdiff: Automate making and maintaining patches for a package
2301: (includes pkgdiff, pkgvi, mkpatches, etc.).
2302:
1.65 wiz 2303: * pkgtools/url2pkg: Aids in converting to pkgsrc.
1.1 dsieger 2304:
2305: Utilities for people maintaining pkgsrc (or: more obscure pkg utilities)
2306:
2307: * pkgtools/pkg_comp: Build packages in a chrooted area.
2308:
2309: * pkgtools/libkver: Spoof kernel version for chrooted cross builds.
2310:
1.154 rillig 2311: 10.3. How to use pkgsrc as non-root
1.1 dsieger 2312:
1.108 rillig 2313: To install packages from source as a non-root user, download pkgsrc as
1.154 rillig 2314: described in Chapter 3, Where to get pkgsrc and how to keep it up-to-date, cd
1.108 rillig 2315: into that directory and run the command ./bootstrap/bootstrap --unprivileged.
2316:
2317: This will install the binary part of pkgsrc to ~/pkg and put the pkgsrc
2318: configuration mk.conf into ~/pkg/etc.
2319:
2320: For more details, see mk/unprivileged.mk.
1.1 dsieger 2321:
1.154 rillig 2322: 10.4. How to resume transfers when fetching distfiles?
1.1 dsieger 2323:
2324: By default, resuming transfers in pkgsrc is disabled, but you can enable this
1.4 rillig 2325: feature by adding the option PKG_RESUME_TRANSFERS=YES into mk.conf. If, during
2326: a fetch step, an incomplete distfile is found, pkgsrc will try to resume it.
1.1 dsieger 2327:
1.61 wiz 2328: You can also use a different program than the platform default program by
2329: changing the FETCH_USING variable. You can specify the program by using of ftp,
2330: fetch, wget or curl. Alternatively, fetching can be disabled by using the value
2331: manual. A value of custom disables the system defaults and dependency tracking
2332: for the fetch program. In that case you have to provide FETCH_CMD,
2333: FETCH_BEFORE_ARGS, FETCH_RESUME_ARGS, FETCH_OUTPUT_ARGS, FETCH_AFTER_ARGS.
1.1 dsieger 2334:
1.16 jnemeth 2335: For example, if you want to use wget to download, you'll have to use something
2336: like:
1.1 dsieger 2337:
1.16 jnemeth 2338: FETCH_USING= wget
1.1 dsieger 2339:
1.154 rillig 2340: 10.5. How can I install/use modular X.org from pkgsrc?
1.1 dsieger 2341:
1.4 rillig 2342: If you want to use modular X.org from pkgsrc instead of your system's own X11
2343: (/usr/X11R6, /usr/openwin, ...) you will have to add the following line into
1.1 dsieger 2344: mk.conf:
2345:
1.4 rillig 2346: X11_TYPE=modular
1.1 dsieger 2347:
1.154 rillig 2348: 10.6. How to fetch files from behind a firewall
1.1 dsieger 2349:
2350: If you are sitting behind a firewall which does not allow direct connections to
2351: Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This
2352: is done using an environment variable in the form of a URL, e.g. in Amdahl, the
2353: machine "orpheus.amdahl.com" is one of the firewalls, and it uses port 80 as
2354: the proxy port number. So the proxy environment variables are:
2355:
2356: ftp_proxy=ftp://orpheus.amdahl.com:80/
2357: http_proxy=http://orpheus.amdahl.com:80/
2358:
1.154 rillig 2359: 10.7. How to fetch files from HTTPS sites
1.65 wiz 2360:
2361: Some fetch tools are not prepared to support HTTPS by default (for example, the
2362: one in NetBSD 6.0), or the one installed by the pkgsrc bootstrap (to avoid an
2363: openssl dependency that low in the dependency graph).
2364:
2365: Usually you won't notice, because distribution files are mirrored weekly to "
2366: ftp.NetBSD.org", but that might not be often enough if you are following
2367: pkgsrc-current. In that case, set FETCH_USING in your mk.conf file to "curl" or
2368: "wget", which are both compiled with HTTPS support by default. Of course, these
2369: tools need to be installed before you can use them this way.
2370:
1.154 rillig 2371: 10.8. How do I tell make fetch to do passive FTP?
1.1 dsieger 2372:
2373: This depends on which utility is used to retrieve distfiles. From bsd.pkg.mk,
2374: FETCH_CMD is assigned the first available command from the following list:
2375:
2376: * ${LOCALBASE}/bin/ftp
2377:
2378: * /usr/bin/ftp
2379:
2380: On a default NetBSD installation, this will be /usr/bin/ftp, which
2381: automatically tries passive connections first, and falls back to active
2382: connections if the server refuses to do passive. For the other tools, add the
1.4 rillig 2383: following to your mk.conf file: PASSIVE_FETCH=1.
1.1 dsieger 2384:
2385: Having that option present will prevent /usr/bin/ftp from falling back to
2386: active transfers.
2387:
1.154 rillig 2388: 10.9. How to fetch all distfiles at once
1.1 dsieger 2389:
2390: You would like to download all the distfiles in a single batch from work or
2391: university, where you can't run a make fetch. There is an archive of distfiles
2392: on ftp.NetBSD.org, but downloading the entire directory may not be appropriate.
2393:
2394: The answer here is to do a make fetch-list in /usr/pkgsrc or one of its
2395: subdirectories, carry the resulting list to your machine at work/school and use
2396: it there. If you don't have a NetBSD-compatible ftp(1) (like tnftp) at work,
2397: don't forget to set FETCH_CMD to something that fetches a URL:
2398:
2399: At home:
2400:
2401: % cd /usr/pkgsrc
2402: % make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh
2403: % scp /tmp/fetch.sh work:/tmp
2404:
2405: At work:
2406:
2407: % sh /tmp/fetch.sh
2408:
2409: then tar up /tmp/distfiles and take it home.
2410:
2411: If you have a machine running NetBSD, and you want to get all distfiles (even
2412: ones that aren't for your machine architecture), you can do so by using the
2413: above-mentioned make fetch-list approach, or fetch the distfiles directly by
2414: running:
2415:
2416: % make mirror-distfiles
2417:
2418: If you even decide to ignore NO_{SRC,BIN}_ON_{FTP,CDROM}, then you can get
2419: everything by running:
2420:
2421: % make fetch NO_SKIP=yes
2422:
1.154 rillig 2423: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
1.1 dsieger 2424:
2425: When compiling the pkgtools/pkg_install package, you get the error from make
2426: that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates
2427: that you don't have installed the "text" set (nroff, ...) from the NetBSD base
2428: distribution on your machine. It is recommended to do that to format man pages.
2429:
2430: In the case of the pkgtools/pkg_install package, you can get away with setting
1.4 rillig 2431: NOMAN=YES either in the environment or in mk.conf.
1.1 dsieger 2432:
1.154 rillig 2433: 10.11. What does "Could not find bsd.own.mk" mean?
1.1 dsieger 2434:
2435: You didn't install the compiler set, comp.tgz, when you installed your NetBSD
2436: machine. Please get and install it, by extracting it in /:
2437:
2438: # cd /
2439: # tar --unlink -zxvpf .../comp.tgz
2440:
2441: comp.tgz is part of every NetBSD release. Get the one that corresponds to your
2442: release (determine via uname -r).
2443:
1.221 nia 2444: 10.12. Using 'sudo' or `priv` with pkgsrc
1.1 dsieger 2445:
2446: When installing packages as non-root user and using the just-in-time su(1)
2447: feature of pkgsrc, it can become annoying to type in the root password for each
2448: required package installed. To avoid this, the sudo package can be used, which
1.221 nia 2449: does password caching over a limited time. To use it, install sudo or priv
2450: (either as binary package, from security/priv, or security/sudo) and then put
2451: the following into your mk.conf, somewhere after the definition of the
2452: LOCALBASE variable:
1.1 dsieger 2453:
2454: .if exists(${LOCALBASE}/bin/sudo)
2455: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2456: .endif
2457:
1.154 rillig 2458: 10.13. How do I change the location of configuration files?
1.1 dsieger 2459:
2460: As the system administrator, you can choose where configuration files are
2461: installed. The default settings make all these files go into ${PREFIX}/etc or
2462: some of its subdirectories; this may be suboptimal depending on your
2463: expectations (e.g., a read-only, NFS-exported PREFIX with a need of per-machine
2464: configuration of the provided packages).
2465:
2466: In order to change the defaults, you can modify the PKG_SYSCONFBASE variable
1.4 rillig 2467: (in mk.conf) to point to your preferred configuration directory; some common
2468: examples include /etc or /etc/pkg.
1.1 dsieger 2469:
2470: Furthermore, you can change this value on a per-package basis by setting the
2471: PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. PKG_SYSCONFVAR's value usually
2472: matches the name of the package you would like to modify, that is, the contents
2473: of PKGBASE.
2474:
2475: Note that after changing these settings, you must rebuild and reinstall any
2476: affected packages.
2477:
1.154 rillig 2478: 10.14. Automated security checks
1.1 dsieger 2479:
2480: Please be aware that there can often be bugs in third-party software, and some
2481: of these bugs can leave a machine vulnerable to exploitation by attackers. In
2482: an effort to lessen the exposure, the NetBSD packages team maintains a database
2483: of known-exploits to packages which have at one time been included in pkgsrc.
2484: The database can be downloaded automatically, and a security audit of all
1.14 jmcneill 2485: packages installed on a system can take place. To do this, refer to the
2486: following two tools (installed as part of the pkgtools/pkg_install package):
1.1 dsieger 2487:
1.21 snj 2488: 1. pkg_admin fetch-pkg-vulnerabilities, an easy way to download a list of the
2489: security vulnerabilities information. This list is kept up to date by the
1.26 spz 2490: pkgsrc security team, and is distributed from the NetBSD ftp server:
1.1 dsieger 2491:
1.177 leot 2492: https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities
1.1 dsieger 2493:
1.21 snj 2494: 2. pkg_admin audit, an easy way to audit the current machine, checking each
1.24 wiz 2495: known vulnerability. If a vulnerable package is installed, it will be shown
2496: by output to stdout, including a description of the type of vulnerability,
2497: and a URL containing more information.
1.1 dsieger 2498:
1.202 nia 2499: Use of these tools is strongly recommended! See Section 5.1.6, "Checking for
1.121 sevan 2500: security vulnerabilities in installed packages" for instructions on how to
2501: automate checking and reporting.
2502:
2503: If this database is installed, pkgsrc builds will use it to perform a security
2504: check before building any package.
1.1 dsieger 2505:
1.154 rillig 2506: 10.15. Why do some packages ignore my CFLAGS?
1.1 dsieger 2507:
2508: When you add your own preferences to the CFLAGS variable in your mk.conf, these
2509: flags are passed in environment variables to the ./configure scripts and to
2510: make(1). Some package authors ignore the CFLAGS from the environment variable
2511: by overriding them in the Makefiles of their package.
2512:
2513: Currently there is no solution to this problem. If you really need the package
2514: to use your CFLAGS you should run make patch in the package directory and then
2515: inspect any Makefile and Makefile.in for whether they define CFLAGS explicitly.
2516: Usually you can remove these lines. But be aware that some "smart" programmers
2517: write so bad code that it only works for the specific combination of CFLAGS
2518: they have chosen.
2519:
1.172 rillig 2520: To find out where the CFLAGS are ignored, add the following lines to mk.conf:
2521:
2522: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
2523: CFLAGS+= -Dpkgsrc___CFLAGS
2524: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
2525:
2526: Then run bmake show-all-configure show-all-build to see whether the above flags
2527: are passed to the actual build commands in general.
2528:
2529: To find out whether the flags are passed to individual compiler commands, have
2530: a look at the file work/.work.log. In most cases, the flags from the original
2531: command lines (the lines starting with [*]) are passed unmodified to the actual
2532: compiler (the lines starting with <.>). If the flag is missing from the actual
2533: compiler command, it must have been removed by the pkgsrc compiler wrappers.
2534:
1.154 rillig 2535: 10.16. A package does not build. What shall I do?
1.1 dsieger 2536:
2537: 1. Make sure that your copy of pkgsrc is consistent. A case that occurs often
2538: is that people only update pkgsrc in parts, because of performance reasons.
2539: Since pkgsrc is one large system, not a collection of many small systems,
2540: there are sometimes changes that only work when the whole pkgsrc tree is
2541: updated.
2542:
1.25 wiz 2543: 2. Make sure that you don't have any CVS conflicts. Search for "<<<<<<" or "
2544: >>>>>>" in all your pkgsrc files.
1.1 dsieger 2545:
1.25 wiz 2546: 3. Make sure that you don't have old copies of the packages extracted. Run
1.1 dsieger 2547: make clean clean-depends to verify this.
2548:
1.108 rillig 2549: 4. If you are a package developer who wants to invest some work, have a look
1.154 rillig 2550: at Chapter 21, Making your package work.
1.108 rillig 2551:
2552: 5. If the problem still exists, write a mail to the pkgsrc-users mailing list.
1.1 dsieger 2553:
1.154 rillig 2554: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.1 dsieger 2555: conflicts" mean?
2556:
2557: You have modified a file from pkgsrc, and someone else has modified that same
2558: file afterwards in the CVS repository. Both changes are in the same region of
2559: the file, so when you updated pkgsrc, the cvs command marked the conflicting
2560: changes in the file. Because of these markers, the file is no longer a valid
2561: Makefile.
2562:
2563: Have a look at that file, and if you don't need your local changes anymore, you
2564: can remove that file and run cvs -q update -dP in that directory to download
2565: the current version.
2566:
2567: Part II. The pkgsrc developer's guide
2568:
2569: This part of the book deals with creating and modifying packages. It starts
2570: with a "HOWTO"-like guide on creating a new package. The remaining chapters are
2571: more like a reference manual for pkgsrc.
2572:
2573: Table of Contents
2574:
1.154 rillig 2575: 11. Getting help
1.184 rillig 2576: 12. Package components - files, directories and contents
2577: 12.1. Makefile
2578: 12.2. distinfo
2579: 12.3. patches/*
2580: 12.3.1. Structure of a single patch file
2581: 12.3.2. Creating patch files
2582: 12.3.3. Sources where the patch files come from
2583: 12.3.4. Patching guidelines
2584: 12.3.5. Feedback to the author
2585: 12.4. Other mandatory files
2586: 12.5. Optional files
2587: 12.5.1. Files affecting the binary package
2588: 12.5.2. Files affecting the build process
2589: 12.5.3. Files affecting nothing at all
2590: 12.6. work*
2591: 12.7. files/*
2592: 13. The build process
2593: 13.1. Introduction
2594: 13.2. Program location
2595: 13.3. Directories used during the build process
2596: 13.4. Running a phase
2597: 13.5. The fetch phase
2598: 13.5.1. What to fetch and where to get it from
2599: 13.5.2. How are the files fetched?
2600: 13.6. The checksum phase
2601: 13.7. The extract phase
2602: 13.8. The patch phase
2603: 13.9. The tools phase
2604: 13.10. The wrapper phase
2605: 13.11. The configure phase
2606: 13.12. The build phase
2607: 13.13. The test phase
2608: 13.14. The install phase
2609: 13.15. The package phase
2610: 13.16. Cleaning up
2611: 13.17. Other helpful targets
2612: 14. Creating a new pkgsrc package from scratch
2613: 14.1. Common types of packages
1.219 nia 2614: 14.1.1. Python modules and programs
2615: 14.1.2. R packages
2616: 14.1.3. TeXlive packages
1.184 rillig 2617: 14.2. Examples
2618: 14.2.1. How the www/nvu package came into pkgsrc
2619: 15. Programming in Makefiles
2620: 15.1. Caveats
2621: 15.2. Makefile variables
2622: 15.2.1. Naming conventions
2623: 15.3. Code snippets
2624: 15.3.1. Adding things to a list
2625: 15.3.2. Echoing a string exactly as-is
2626: 15.3.3. Passing CFLAGS to GNU configure scripts
2627: 15.3.4. Handling possibly empty variables
1.229 gutterid 2628: 15.3.5. Testing yes/no variables in conditions
1.184 rillig 2629: 16. Options handling
2630: 16.1. Global default options
2631: 16.2. Converting packages to use bsd.options.mk
2632: 16.3. Option Names
2633: 16.4. Determining the options of dependencies
2634: 17. Tools needed for building or running
2635: 17.1. Tools for pkgsrc builds
2636: 17.2. Tools needed by packages
2637: 17.3. Tools provided by platforms
2638: 18. Buildlink methodology
2639: 18.1. Converting packages to use buildlink3
2640: 18.2. Writing buildlink3.mk files
2641: 18.2.1. Anatomy of a buildlink3.mk file
2642: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.
1.232 gutterid 2643: pkg in buildlink3.mk files
1.184 rillig 2644: 18.3. Writing builtin.mk files
2645: 18.3.1. Anatomy of a builtin.mk file
2646: 19. PLIST issues
2647: 19.1. RCS ID
2648: 19.2. Semi-automatic PLIST generation
2649: 19.3. Tweaking output of make print-PLIST
2650: 19.4. Variable substitution in PLIST
2651: 19.5. Man page compression
2652: 19.6. Changing PLIST source with PLIST_SRC
2653: 19.7. Platform-specific and differing PLISTs
2654: 19.8. Build-specific PLISTs
2655: 19.9. Sharing directories between packages
2656: 20. The pkginstall framework
2657: 20.1. Files and directories outside the installation prefix
2658: 20.1.1. Directory manipulation
2659: 20.1.2. File manipulation
2660: 20.2. Configuration files
2661: 20.2.1. How PKG_SYSCONFDIR is set
2662: 20.2.2. Telling the software where configuration files are
1.239 dholland 2663: 20.2.3. Patching installation
2664: 20.2.4. Declaring configuration files
2665: 20.2.5. Disabling handling of configuration files
1.184 rillig 2666: 20.3. System startup scripts
2667: 20.3.1. Disabling handling of system startup scripts
2668: 20.4. System users and groups
2669: 20.5. System shells
2670: 20.5.1. Disabling shell registration
2671: 20.6. Fonts
2672: 20.6.1. Disabling automatic update of the fonts databases
1.154 rillig 2673: 21. Making your package work
2674: 21.1. General operation
2675: 21.1.1. How to pull in user-settable variables from mk.conf
2676: 21.1.2. User interaction
2677: 21.1.3. Handling licenses
2678: 21.1.4. Restricted packages
2679: 21.1.5. Handling dependencies
2680: 21.1.6. Handling conflicts with other packages
2681: 21.1.7. Packages that cannot or should not be built
2682: 21.1.8. Packages which should not be deleted, once installed
2683: 21.1.9. Handling packages with security problems
2684: 21.1.10. How to handle incrementing versions when fixing an existing
1.232 gutterid 2685: package
1.154 rillig 2686: 21.1.11. Substituting variable text in the package files (the SUBST
1.232 gutterid 2687: framework)
1.154 rillig 2688: 21.2. The fetch phase
2689: 21.2.1. Packages whose distfiles aren't available for plain downloading
2690: 21.2.2. How to handle modified distfiles with the 'old' name
2691: 21.2.3. Packages hosted on github.com
2692: 21.3. The configure phase
2693: 21.3.1. Shared libraries - libtool
2694: 21.3.2. Using libtool on GNU packages that already support libtool
2695: 21.3.3. GNU Autoconf/Automake
1.223 nia 2696: 21.3.4. Meson / ninja
1.154 rillig 2697: 21.4. Programming languages
2698: 21.4.1. C, C++, and Fortran
2699: 21.4.2. Java
1.205 wiz 2700: 21.4.3. Go
1.223 nia 2701: 21.4.4. Rust
2702: 21.4.5. Packages containing Perl scripts
2703: 21.4.6. Packages containing shell scripts
2704: 21.4.7. Other programming languages
1.154 rillig 2705: 21.5. The build phase
2706: 21.5.1. Compiling C and C++ code conditionally
2707: 21.5.2. How to handle compiler bugs
1.172 rillig 2708: 21.5.3. No such file or directory
2709: 21.5.4. Undefined reference to "..."
2710: 21.5.5. Running out of memory
1.154 rillig 2711: 21.6. The install phase
2712: 21.6.1. Creating needed directories
2713: 21.6.2. Where to install documentation
2714: 21.6.3. Installing highscore files
2715: 21.6.4. Adding DESTDIR support to packages
2716: 21.6.5. Packages with hardcoded paths to other interpreters
1.203 nia 2717: 21.6.6. Packages installing Perl modules
1.254 wiz 2718: 21.6.7. Packages installing pkg-config files
2719: 21.6.8. Packages installing info files
2720: 21.6.9. Packages installing man pages
2721: 21.6.10. Packages installing X11 fonts
2722: 21.6.11. Packages installing SGML or XML data
2723: 21.6.12. Packages installing extensions to the MIME database
2724: 21.6.13. Packages using intltool
2725: 21.6.14. Packages installing startup scripts
2726: 21.6.15. Packages installing TeX modules
2727: 21.6.16. Packages supporting running binaries in emulation
2728: 21.6.17. Packages installing hicolor icons
2729: 21.6.18. Packages installing desktop files
1.154 rillig 2730: 21.7. Marking packages as having problems
1.184 rillig 2731: 22. GNOME packaging and porting
2732: 22.1. Meta packages
2733: 22.2. Packaging a GNOME application
2734: 22.3. Updating GNOME to a newer version
2735: 22.4. Patching guidelines
1.154 rillig 2736: 23. Submitting and Committing
2737: 23.1. Submitting binary packages
2738: 23.2. Submitting source packages (for non-NetBSD-developers)
2739: 23.3. General notes when adding, updating, or removing packages
2740: 23.4. Commit Messages
2741: 23.5. Committing: Adding a package to CVS
2742: 23.6. Updating a package to a newer version
2743: 23.7. Renaming a package in pkgsrc
2744: 23.8. Moving a package in pkgsrc
2745: 24. Frequently Asked Questions
2746:
2747: Chapter 11. Getting help
2748:
2749: To get help when developing pkgsrc, the definitive source is this document, the
2750: pkgsrc guide. If you don't find anything here, there are alternatives:
2751:
2752: * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
2753: Run bmake help topic=? to get help for any topic, such as a variable name
2754: like BUILD_DEFS, a make target like do-build, a missing C or C++ function
2755: like strcasecmp or any other topic.
2756:
1.207 leot 2757: The available help topics are listed in Appendix E, Help topics.
1.154 rillig 2758:
1.163 rillig 2759: * To see the value of a single variable, run bmake show-var VARNAME=X.
2760:
2761: * To see the values of the most common variables, run bmake show-all. These
2762: variables are grouped by topic. To see the variables for a single topic,
2763: run bmake show-all-topic, for example bmake show-all-fetch.
2764:
1.154 rillig 2765: * The tech-pkg mailing list, to which you can subscribe and then ask your
2766: questions.
2767:
2768: * The #pkgsrc IRC channel, which is accessible via a web browser or by using
2769: a specialized chat program such as XChat. Pick any user name and join the
2770: channel #pkgsrc.
1.1 dsieger 2771:
1.184 rillig 2772: Chapter 12. Package components - files, directories and contents
1.1 dsieger 2773:
2774: Table of Contents
2775:
1.184 rillig 2776: 12.1. Makefile
2777: 12.2. distinfo
2778: 12.3. patches/*
2779: 12.3.1. Structure of a single patch file
2780: 12.3.2. Creating patch files
2781: 12.3.3. Sources where the patch files come from
2782: 12.3.4. Patching guidelines
2783: 12.3.5. Feedback to the author
2784: 12.4. Other mandatory files
2785: 12.5. Optional files
2786: 12.5.1. Files affecting the binary package
2787: 12.5.2. Files affecting the build process
2788: 12.5.3. Files affecting nothing at all
2789: 12.6. work*
2790: 12.7. files/*
1.1 dsieger 2791:
1.184 rillig 2792: Whenever you're preparing a package, there are a number of files involved which
2793: are described in the following sections.
1.1 dsieger 2794:
1.184 rillig 2795: 12.1. Makefile
1.1 dsieger 2796:
1.184 rillig 2797: Building, installation and creation of a binary package are all controlled by
2798: the package's Makefile. The Makefile describes various things about a package,
2799: for example from where to get it, how to configure, build, and install it.
1.1 dsieger 2800:
1.184 rillig 2801: A package Makefile contains several sections that describe the package.
1.1 dsieger 2802:
1.184 rillig 2803: In the first section there are the following variables, which should appear
2804: exactly in the order given here. The order and grouping of the variables is
2805: mostly historical and has no further meaning.
1.1 dsieger 2806:
1.184 rillig 2807: * DISTNAME is the basename of the distribution file to be downloaded from the
2808: package's website.
1.1 dsieger 2809:
1.184 rillig 2810: * PKGNAME is the name of the package, as used by pkgsrc. You need to provide
2811: it if DISTNAME (which is the default) is not a good name for the package in
2812: pkgsrc or DISTNAME is not provided (no distribution file is required).
2813: Usually it is the pkgsrc directory name together with the version number.
2814: It must match the regular expression ^[A-Za-z0-9][A-Za-z0-9-_.+]*$, that
2815: is, it starts with a letter or digit, and contains only letters, digits,
1.204 nia 2816: dashes, underscores, dots and plus signs. New packages should have entirely
2817: lower-case names, with the exception of some that must follow pre-existing
2818: conventions (e.g. R packages begin with R-). You can use the :tl variable
2819: modifier to lower-case the package name.
1.26 spz 2820:
1.184 rillig 2821: * CATEGORIES is a list of categories which the package fits in. You can
2822: choose any of the top-level directories of pkgsrc for it.
1.1 dsieger 2823:
1.184 rillig 2824: Currently the following values are available for CATEGORIES. If more than
2825: one is used, they need to be separated by spaces:
1.1 dsieger 2826:
1.184 rillig 2827: archivers cross geography meta-pkgs security
2828: audio databases graphics misc shells
2829: benchmarks devel ham multimedia sysutils
2830: biology editors inputmethod net textproc
2831: cad emulators lang news time
2832: chat finance mail parallel wm
2833: comms fonts math pkgtools www
2834: converters games mbone print x11
1.1 dsieger 2835:
1.184 rillig 2836: * MASTER_SITES, DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES
2837: are discussed in detail in Section 13.5, "The fetch phase".
1.1 dsieger 2838:
1.184 rillig 2839: The second section contains information about separately downloaded patches, if
2840: any.
1.1 dsieger 2841:
1.184 rillig 2842: * PATCHFILES: Name(s) of additional files that contain distribution patches.
2843: There is no default. pkgsrc will look for them at PATCH_SITES. They will
2844: automatically be uncompressed before patching if the names end with .gz or
2845: .Z.
1.1 dsieger 2846:
1.184 rillig 2847: * PATCH_SITES: Primary location(s) for distribution patch files (see
2848: PATCHFILES above) if not found locally.
1.1 dsieger 2849:
1.184 rillig 2850: * PATCH_DIST_STRIP: an argument to patch(1) that sets the pathname strip
2851: count to help find the correct files to patch. It defaults to -p0.
1.1 dsieger 2852:
1.184 rillig 2853: The third section contains the following variables.
1.1 dsieger 2854:
1.253 gutterid 2855: * MAINTAINER is the email address of the person who is currently responsible
2856: for this package. In theory, the maintainer will be aware of upstream
2857: release, keep it updated, and generally resolve problems. Others
2858: contemplating significant changes should ask the maintainer for advice or
2859: review of a proposed change. This is not necessary for micro updates, bug
2860: fixes, pkgsrc-wide changes affecting many packages, and other things
2861: expected to be uncontroversial. It goes with this "should ask" that the
2862: maintainer should respond to inquiries reasonably promptly (most of the
2863: time), and either approve changes or provide reasons why not. Typically,
2864: when packaging a new program, set MAINTAINER to yourself. If you don't
2865: intend to maintain the package (especially if you feel you have no special
2866: insight), set it to <pkgsrc-users@NetBSD.org>. This special value is a code
2867: point indicating that there is no maintainer, but the variable is
2868: mandatory, absent OWNER.
2869:
2870: * OWNER can be used instead of MAINTAINER in relatively rare circumstances
2871: when the package is such that modifying it is riskier than normal. This is
2872: a stronger form of being the maintainer, with an expectation that others
2873: will ask for almost all changes, except revbumps and accommodating
2874: structural changes. Someone who becomes OWNER has a strong obligation to
2875: keep the package very well maintained, to answer queries promptly and to be
2876: a steward of the package on behalf of users. In this case, MAINTAINER
2877: should be omitted.
2878:
2879: Because of the friction that OWNER adds, PMC may downgrade it to MAINTAINER
2880: at any time.
1.1 dsieger 2881:
1.184 rillig 2882: * HOMEPAGE is a URL where users can find more information about the package.
1.1 dsieger 2883:
1.184 rillig 2884: * COMMENT is a one-line description of the package (should not include the
2885: package name).
1.1 dsieger 2886:
1.184 rillig 2887: * LICENSE indicates the license(s) applicable for the package. See
2888: Section 21.1.3, "Handling licenses" for further details.
1.1 dsieger 2889:
1.184 rillig 2890: Other variables that affect the build:
1.1 dsieger 2891:
1.184 rillig 2892: * WRKSRC: The directory where the interesting distribution files of the
2893: package are found. The default is ${WRKDIR}/${DISTNAME}, which works for
2894: most packages.
1.1 dsieger 2895:
1.184 rillig 2896: If a package doesn't create a subdirectory for itself (most GNU software
2897: does, for instance), but extracts itself in the current directory, you
2898: should set WRKSRC=${WRKDIR}.
1.1 dsieger 2899:
1.184 rillig 2900: If a package doesn't create a subdirectory with the name of DISTNAME but
2901: some different name, set WRKSRC to point to the proper name in ${WRKDIR},
2902: for example WRKSRC=${WRKDIR}/${DISTNAME}/unix. See lang/tcl and x11/tk for
2903: other examples.
1.17 imil 2904:
1.184 rillig 2905: The name of the working directory created by pkgsrc is taken from the
2906: WRKDIR_BASENAME variable. By default, its value is work. If you want to use
2907: the same pkgsrc tree for building different kinds of binary packages, you
2908: can change the variable according to your needs. Two other variables handle
2909: common cases of setting WRKDIR_BASENAME individually. If OBJHOSTNAME is
2910: defined in mk.conf, the first component of the host's name is attached to
2911: the directory name. If OBJMACHINE is defined, the platform name is
2912: attached, which might look like work.i386 or work.sparc.
1.17 imil 2913:
1.184 rillig 2914: Please pay attention to the following gotchas:
1.17 imil 2915:
1.184 rillig 2916: * Add MANCOMPRESSED if man pages are installed in compressed form by the
2917: package. For packages using BSD-style makefiles which honor MANZ, there is
2918: MANCOMPRESSED_IF_MANZ.
1.17 imil 2919:
1.184 rillig 2920: * Replace /usr/local with "${PREFIX}" in all files (see patches, below).
1.103 wiz 2921:
1.254 wiz 2922: * If the package installs any info files, see Section 21.6.8, "Packages
1.184 rillig 2923: installing info files".
1.103 wiz 2924:
1.184 rillig 2925: 12.2. distinfo
1.17 imil 2926:
1.184 rillig 2927: The distinfo file contains the message digest, or checksum, of each distfile
2928: needed for the package. This ensures that the distfiles retrieved from the
2929: Internet have not been corrupted during transfer or altered by a malign force
2930: to introduce a security hole. To provide maximum security, all distfiles are
1.243 gutterid 2931: protected using two different message digest algorithms (BLAKE2s and SHA512),
2932: as well as the file size.
1.17 imil 2933:
1.184 rillig 2934: The distinfo file also contains the checksums for all the patches found in the
2935: patches directory (see Section 12.3, "patches/*"). These checksums ensure that
2936: patches are only applied intentionally and that they don't accidentally change,
2937: e.g. when merging different changes together. They also make sure that new
2938: patches are actually added to CVS and old ones are removed. Too see whether the
2939: patches and the distinfo file match, run pkglint after changing the patches.
1.17 imil 2940:
1.184 rillig 2941: To regenerate the distinfo file, use the make distinfo command.
1.17 imil 2942:
1.184 rillig 2943: Some packages have different sets of distfiles depending on the platform, for
2944: example lang/openjdk8. These are kept in the same distinfo file and care should
2945: be taken when upgrading such a package to ensure distfile information is not
2946: lost.
1.17 imil 2947:
1.184 rillig 2948: 12.3. patches/*
1.63 wiz 2949:
1.184 rillig 2950: Some packages don't work out-of-the box on the various platforms that are
2951: supported by pkgsrc. These packages need to be patched to make them work. The
2952: patch files can be found in the patches/ directory.
1.17 imil 2953:
1.184 rillig 2954: In the patch phase, these patches are applied to the files in WRKSRC directory
2955: after extracting them, in alphabetic order.
1.160 brook 2956:
1.184 rillig 2957: 12.3.1. Structure of a single patch file
1.160 brook 2958:
1.184 rillig 2959: The patch-* files should be in diff -bu format, and apply without a fuzz to
2960: avoid problems. (To force patches to apply with fuzz you can set
2961: PATCH_FUZZ_FACTOR=-F2). Furthermore, each patch should contain only changes for
2962: a single file, and no file should be patched by more than one patch file. This
2963: helps to keep future modifications simple.
1.160 brook 2964:
1.184 rillig 2965: Each patch file is structured as follows: In the first line, there is the RCS
2966: Id of the patch itself. The second line should be empty for aesthetic reasons.
2967: After that, there should be a comment for each change that the patch does.
2968: There are a number of standard cases:
1.160 brook 2969:
1.184 rillig 2970: * Patches for commonly known vulnerabilities should mention the vulnerability
2971: ID (CAN, CVE).
1.160 brook 2972:
1.184 rillig 2973: * Patches that change source code should mention the platform and other
2974: environment (for example, the compiler) that the patch is needed for.
1.160 brook 2975:
1.184 rillig 2976: The patch should be commented so that any developer who knows the code of the
2977: application can make some use of the patch. Special care should be taken for
2978: the upstream developers, since we generally want that they accept our patches,
2979: so we have less work in the future.
1.160 brook 2980:
1.184 rillig 2981: 12.3.2. Creating patch files
1.160 brook 2982:
1.184 rillig 2983: One important thing to mention is to pay attention that no RCS IDs get stored
2984: in the patch files, as these will cause problems when later checked into the
2985: NetBSD CVS tree. Use the pkgdiff command from the pkgtools/pkgdiff package to
2986: avoid these problems.
1.160 brook 2987:
1.184 rillig 2988: For even more automation, we recommend using mkpatches from the same package to
1.222 gutterid 2989: make a whole set of patches. You just have to back up files before you edit
2990: them to filename.orig, e.g., with cp -p filename filename.orig or, easier, by
2991: using pkgvi again from the same package. If you upgrade a package this way, you
2992: can easily compare the new set of patches with the previously existing one with
1.184 rillig 2993: patchdiff. The files in patches are replaced by new files, so carefully check
2994: if you want to take all the changes.
1.160 brook 2995:
1.184 rillig 2996: When you have finished a package, remember to generate the checksums for the
2997: patch files by using the make makepatchsum command, see Section 12.2,
2998: "distinfo".
1.1 dsieger 2999:
1.184 rillig 3000: When adding a patch that corrects a problem in the distfile (rather than e.g.
3001: enforcing pkgsrc's view of where man pages should go), send the patch as a bug
3002: report to the maintainer. This benefits non-pkgsrc users of the package, and
3003: usually makes it possible to remove the patch in future version.
1.1 dsieger 3004:
1.184 rillig 3005: The file names of the patch files are usually of the form patch-
3006: path_to_file__with__underscores.c. Many packages still use the previous
3007: convention patch-[a-z][a-z], but new patches should be of the form containing
3008: the filename. mkpatches included in pkgtools/pkgdiff takes care of the name
3009: automatically.
1.1 dsieger 3010:
1.222 gutterid 3011: When updating pre-existing patch files, if a file uses the old patch-[a-z][a-z]
3012: convention, it's best not to change it to the new form, as that will just cause
3013: churn that makes it harder to track changes to patching over time. Similarly,
3014: if a patch now applies at different line offsets, but still applies cleanly
3015: as-is, there's no need to update it, as that also unnecessarily complicates the
3016: patch history.
3017:
1.184 rillig 3018: 12.3.3. Sources where the patch files come from
1.1 dsieger 3019:
1.184 rillig 3020: If you want to share patches between multiple packages in pkgsrc, e.g. because
3021: they use the same distfiles, set PATCHDIR to the path where the patch files can
3022: be found, e.g.:
1.1 dsieger 3023:
1.184 rillig 3024: PATCHDIR= ../../editors/xemacs/patches
1.1 dsieger 3025:
1.184 rillig 3026: Patch files that are distributed by the author or other maintainers can be
3027: listed in PATCHFILES.
1.1 dsieger 3028:
1.184 rillig 3029: If it is desired to store any patches that should not be committed into pkgsrc,
3030: they can be kept outside the pkgsrc tree in the $LOCALPATCHES directory. The
3031: directory tree there is expected to have the same "category/package" structure
3032: as pkgsrc, and patches are expected to be stored inside these dirs (also known
3033: as $LOCALPATCHES/$PKGPATH). For example, if you want to keep a private patch
3034: for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All
3035: files in the named directory are expected to be patch files, and they are
3036: applied after pkgsrc patches are applied.
1.1 dsieger 3037:
1.184 rillig 3038: 12.3.4. Patching guidelines
1.1 dsieger 3039:
1.184 rillig 3040: When fixing a portability issue in the code do not use preprocessor magic to
3041: check for the current operating system nor platform. Doing so hurts portability
3042: to other platforms because the OS-specific details are not abstracted
3043: appropriately.
1.1 dsieger 3044:
1.184 rillig 3045: The general rule to follow is: instead of checking for the operating system the
3046: application is being built on, check for the specific features you need. For
3047: example, instead of assuming that kqueue is available under NetBSD and using
3048: the __NetBSD__ macro to conditionalize kqueue support, add a check that detects
1.198 leot 3049: kqueue itself -- yes, this generally involves patching the configure script.
1.184 rillig 3050: There is absolutely nothing that prevents some OSes from adopting interfaces
3051: from other OSes (e.g. Linux implementing kqueue), something that the above
3052: checks cannot take into account.
1.1 dsieger 3053:
1.184 rillig 3054: Of course, checking for features generally involves more work on the
3055: developer's side, but the resulting changes are cleaner and there are chances
3056: they will work on many other platforms. Not to mention that there are higher
3057: chances of being later integrated into the mainstream sources. Remember: It
3058: doesn't work unless it is right!
1.1 dsieger 3059:
1.184 rillig 3060: Some typical examples:
1.121 sevan 3061:
1.184 rillig 3062: Table 12.1. Patching examples
1.1 dsieger 3063:
1.184 rillig 3064: +-------------------------------------------------------------------------------------------+
3065: | Where | Incorrect | Correct |
3066: |---------+--------------------------+------------------------------------------------------|
3067: | |case ${target_os} in | |
3068: |configure|netbsd*) have_kvm=yes ;; |AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)|
3069: |script |*) have_kvm=no ;; | |
3070: | |esac | |
3071: |---------+--------------------------+------------------------------------------------------|
3072: |C source |#if defined(__NetBSD__) |#if defined(HAVE_SYS_EVENT_H) |
3073: |file |# include <sys/event.h> |# include <sys/event.h> |
3074: | |#endif |#endif |
3075: |---------+--------------------------+------------------------------------------------------|
3076: | |int |int |
3077: | |monitor_file(...) |monitor_file(...) |
3078: | |{ |{ |
3079: | |#if defined(__NetBSD__) |#if defined(HAVE_KQUEUE) |
3080: |C source | int fd = kqueue();| int fd = kqueue(); |
3081: |file | ... | ... |
3082: | |#else |#else |
3083: | | ... | ... |
3084: | |#endif |#endif |
3085: | |} |} |
3086: +-------------------------------------------------------------------------------------------+
1.1 dsieger 3087:
3088:
1.184 rillig 3089: 12.3.5. Feedback to the author
1.1 dsieger 3090:
1.184 rillig 3091: Always, always, always feed back any portability fixes or improvements you do
3092: to a package to the mainstream developers. This is the only way to get their
3093: attention on portability issues and to ensure that future versions can be built
3094: out-of-the box on NetBSD. Furthermore, any user that gets newer distfiles will
3095: get the fixes straight from the packaged code.
1.1 dsieger 3096:
1.184 rillig 3097: This generally involves cleaning up the patches (because sometimes the patches
3098: that are added to pkgsrc are quick hacks), filing bug reports in the
3099: appropriate trackers for the projects and working with the mainstream authors
3100: to accept your changes. It is extremely important that you do it so that the
3101: packages in pkgsrc are kept simple and thus further changes can be done without
3102: much hassle.
1.1 dsieger 3103:
1.184 rillig 3104: When you have done this, please add a URL to the upstream bug report to the
3105: patch comment.
1.1 dsieger 3106:
1.184 rillig 3107: Support the idea of free software!
1.1 dsieger 3108:
1.184 rillig 3109: 12.4. Other mandatory files
1.1 dsieger 3110:
1.184 rillig 3111: DESCR
1.1 dsieger 3112:
1.184 rillig 3113: A multi-line description of the piece of software. This should include any
3114: credits where they are due. Please bear in mind that others do not share
3115: your sense of humour (or spelling idiosyncrasies), and that others will
3116: read everything that you write here.
1.1 dsieger 3117:
1.184 rillig 3118: PLIST
1.1 dsieger 3119:
1.184 rillig 3120: This file governs the files that are installed on your system: all the
3121: binaries, manual pages, etc. There are other directives which may be
3122: entered in this file, to control the creation and deletion of directories,
3123: and the location of inserted files. See Chapter 19, PLIST issues for more
3124: information.
1.1 dsieger 3125:
1.184 rillig 3126: 12.5. Optional files
1.1 dsieger 3127:
1.184 rillig 3128: 12.5.1. Files affecting the binary package
1.1 dsieger 3129:
1.184 rillig 3130: INSTALL
1.1 dsieger 3131:
1.184 rillig 3132: This shell script is invoked twice by pkg_add(1). First time after package
3133: extraction and before files are moved in place, the second time after the
3134: files to install are moved in place. This can be used to do any custom
3135: procedures not possible with @exec commands in PLIST. See pkg_add(1) and
3136: pkg_create(1) for more information. See also Section 20.1, "Files and
3137: directories outside the installation prefix". Please note that you can
3138: modify variables in it easily by using FILES_SUBST in the package's
3139: Makefile:
1.1 dsieger 3140:
1.184 rillig 3141: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3142:
1.184 rillig 3143: replaces "@SOMEVAR@" with "somevalue" in the INSTALL. By default,
3144: substitution is performed for PREFIX, LOCALBASE, X11BASE, VARBASE, and a
3145: few others, type make help topic=FILES_SUBST for a complete list.
1.1 dsieger 3146:
1.184 rillig 3147: DEINSTALL
1.1 dsieger 3148:
1.184 rillig 3149: This script is executed before and after any files are removed. It is this
3150: script's responsibility to clean up any additional messy details around the
3151: package's installation, since all pkg_delete knows is how to delete the
3152: files created in the original distribution. See pkg_delete(1) and
3153: pkg_create(1) for more information. The same methods to replace variables
3154: can be used as for the INSTALL file.
1.1 dsieger 3155:
1.184 rillig 3156: MESSAGE
1.1 dsieger 3157:
1.198 leot 3158: This file is displayed after installation of the package. While this was
3159: used often in the past, it has two problems: the display will be missed if
3160: many packages are intalled at once, and the person installing the package
3161: and the one using or configuring it may be different. It should therefore
3162: be used only in exceptional circumstances where lasting negative
3163: consequences would result from someone not reading it.
3164:
3165: MESSAGE should not be used for:
3166:
1.232 gutterid 3167: o exhortations to read the documentation
1.198 leot 3168:
1.232 gutterid 3169: o reminders to install rc.d files and set variables
1.198 leot 3170:
1.232 gutterid 3171: o anything that should be explained in the installation/configuration
1.198 leot 3172: documentation that should come with the package
3173:
3174: If the documentation provided by upstream needs enhancing, create e.g.
3175: files/README.pkgsrc and install it in the package's documentation
3176: directory.
3177:
3178: Note that MESSAGE is shown for all operating systems and all init systems.
3179: If a MESSAGE is necessary, it should be narrowed to only those operating
3180: systems and init systems to which it applies.
3181:
3182: Note that you can modify variables in it easily by using MESSAGE_SUBST in
3183: the package's Makefile:
1.1 dsieger 3184:
1.184 rillig 3185: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3186:
1.184 rillig 3187: replaces "${SOMEVAR}" with "somevalue" in MESSAGE. By default, substitution
3188: is performed for PKGNAME, PKGBASE, PREFIX, LOCALBASE, X11BASE,
3189: PKG_SYSCONFDIR, ROOT_GROUP, and ROOT_USER.
1.1 dsieger 3190:
1.184 rillig 3191: You can display a different or additional files by setting the MESSAGE_SRC
3192: variable. Its default is MESSAGE, if the file exists.
1.1 dsieger 3193:
1.184 rillig 3194: ALTERNATIVES
1.1 dsieger 3195:
1.184 rillig 3196: This file is used by the alternatives framework. It creates, configures,
3197: and destroys generic wrappers used to run programs with similar interfaces.
3198: See pkg_alternatives(8) from pkgtools/pkg_alternatives for more
3199: information.
1.1 dsieger 3200:
1.184 rillig 3201: Each line of the file contains two filenames, first the wrapper and then
3202: the alternative provided by the package. Both paths are relative to PREFIX.
1.1 dsieger 3203:
1.184 rillig 3204: 12.5.2. Files affecting the build process
1.1 dsieger 3205:
1.184 rillig 3206: Makefile.common
1.1 dsieger 3207:
1.184 rillig 3208: This file contains arbitrary things that could also go into a Makefile, but
3209: its purpose is to be used by more than one package. This file should only
3210: be used when the packages that will use the file are known in advance. For
3211: other purposes it is often better to write a *.mk file and give it a good
3212: name that describes what it does.
1.1 dsieger 3213:
1.184 rillig 3214: buildlink3.mk
1.1 dsieger 3215:
1.184 rillig 3216: This file contains the dependency information for the buildlink3 framework
3217: (see Chapter 18, Buildlink methodology).
1.1 dsieger 3218:
1.184 rillig 3219: hacks.mk
1.1 dsieger 3220:
1.184 rillig 3221: This file contains workarounds for compiler bugs and similar things. It is
3222: included automatically by the pkgsrc infrastructure, so you don't need an
3223: extra .include line for it.
1.1 dsieger 3224:
1.184 rillig 3225: options.mk
1.1 dsieger 3226:
1.184 rillig 3227: This file contains the code for the package-specific options (see
3228: Chapter 16, Options handling) that can be selected by the user. If a
3229: package has only one or two options, it is equally acceptable to put the
3230: code directly into the Makefile.
1.1 dsieger 3231:
1.184 rillig 3232: 12.5.3. Files affecting nothing at all
1.1 dsieger 3233:
1.184 rillig 3234: README*
1.1 dsieger 3235:
1.184 rillig 3236: These files do not take place in the creation of a package and thus are
3237: purely informative to the package developer.
1.1 dsieger 3238:
1.184 rillig 3239: TODO
1.1 dsieger 3240:
1.184 rillig 3241: This file contains things that need to be done to make the package even
3242: better.
1.1 dsieger 3243:
1.184 rillig 3244: 12.6. work*
1.1 dsieger 3245:
1.184 rillig 3246: When you type make, the distribution files are unpacked into the directory
3247: denoted by WRKDIR. It can be removed by running make clean. Besides the
3248: sources, this directory is also used to keep various timestamp files. The
3249: directory gets removed completely on clean. The default is ${.CURDIR}/work or $
3250: {.CURDIR}/work.${MACHINE_ARCH} if OBJMACHINE is set.
1.1 dsieger 3251:
1.184 rillig 3252: 12.7. files/*
1.80 wiz 3253:
1.184 rillig 3254: If you have any files that you wish to be placed in the package prior to
3255: configuration or building, you can place these files here and use a ${CP}
3256: command in the "post-extract" target to achieve this.
1.1 dsieger 3257:
1.184 rillig 3258: If you want to share files in this way with other packages, set the FILESDIR
3259: variable to point to the other package's files directory, e.g.:
1.1 dsieger 3260:
1.184 rillig 3261: FILESDIR= ../../editors/xemacs/files
1.14 jmcneill 3262:
1.184 rillig 3263: Chapter 13. The build process
1.1 dsieger 3264:
1.184 rillig 3265: Table of Contents
1.1 dsieger 3266:
1.184 rillig 3267: 13.1. Introduction
3268: 13.2. Program location
3269: 13.3. Directories used during the build process
3270: 13.4. Running a phase
3271: 13.5. The fetch phase
3272: 13.5.1. What to fetch and where to get it from
3273: 13.5.2. How are the files fetched?
3274: 13.6. The checksum phase
3275: 13.7. The extract phase
3276: 13.8. The patch phase
3277: 13.9. The tools phase
3278: 13.10. The wrapper phase
3279: 13.11. The configure phase
3280: 13.12. The build phase
3281: 13.13. The test phase
3282: 13.14. The install phase
3283: 13.15. The package phase
3284: 13.16. Cleaning up
3285: 13.17. Other helpful targets
1.1 dsieger 3286:
1.184 rillig 3287: 13.1. Introduction
1.122 leot 3288:
1.184 rillig 3289: This chapter gives a detailed description on how a package is built. Building a
3290: package is separated into different phases (for example fetch, build, install),
3291: all of which are described in the following sections. Each phase is split into
3292: so-called stages, which take the name of the containing phase, prefixed by one
3293: of pre-, do- or post-. (Examples are pre-configure, post-build.) Most of the
3294: actual work is done in the do-* stages.
1.1 dsieger 3295:
1.184 rillig 3296: Never override the regular targets (like fetch), if you have to, override the
3297: do-* ones instead.
1.1 dsieger 3298:
1.184 rillig 3299: The basic steps for building a program are always the same. First the program's
3300: source (distfile) must be brought to the local system and then extracted. After
3301: any pkgsrc-specific patches to compile properly are applied, the software can
3302: be configured, then built (usually by compiling), and finally the generated
3303: binaries, etc. can be put into place on the system.
1.1 dsieger 3304:
1.184 rillig 3305: To get more details about what is happening at each step, you can set the
3306: PKG_VERBOSE variable, or the PATCH_DEBUG variable if you are just interested in
3307: more details about the patch step.
1.1 dsieger 3308:
1.184 rillig 3309: 13.2. Program location
1.1 dsieger 3310:
1.184 rillig 3311: Before outlining the process performed by the NetBSD package system in the next
3312: section, here's a brief discussion on where programs are installed, and which
3313: variables influence this.
1.1 dsieger 3314:
1.184 rillig 3315: The automatic variable PREFIX indicates where all files of the final program
3316: shall be installed. It is usually set to LOCALBASE (/usr/pkg), or CROSSBASE for
3317: pkgs in the cross category. The value of PREFIX needs to be put into the
3318: various places in the program's source where paths to these files are encoded.
3319: See Section 12.3, "patches/*" and Section 21.3.1, "Shared libraries - libtool"
3320: for more details.
1.1 dsieger 3321:
1.184 rillig 3322: When choosing which of these variables to use, follow the following rules:
1.1 dsieger 3323:
1.184 rillig 3324: * PREFIX always points to the location where the current pkg will be
3325: installed. When referring to a pkg's own installation path, use "${PREFIX}"
3326: .
1.1 dsieger 3327:
1.223 nia 3328: * LOCALBASE is where all pkgs are installed. If you need to construct a -I or
3329: -L argument to the compiler to find includes and libraries installed by
3330: another pkg, use "${LOCALBASE}". The name LOCALBASE stems from FreeBSD,
3331: which installed all packages in /usr/local. As pkgsrc leaves /usr/local for
3332: the system administrator, this variable is a misnomer.
1.1 dsieger 3333:
1.184 rillig 3334: * X11BASE is where the actual X11 distribution (from xsrc, etc.) is
3335: installed. When looking for standard X11 includes (not those installed by a
3336: package), use "${X11BASE}".
1.1 dsieger 3337:
1.184 rillig 3338: * X11-based packages using imake must set USE_IMAKE to be installed correctly
3339: under LOCALBASE.
1.1 dsieger 3340:
1.184 rillig 3341: * Within ${PREFIX}, packages should install files according to hier(7), with
3342: the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/
3343: man.
1.1 dsieger 3344:
1.184 rillig 3345: 13.3. Directories used during the build process
1.2 rillig 3346:
1.184 rillig 3347: When building a package, various directories are used to store source files,
3348: temporary files, pkgsrc-internal files, and so on. These directories are
3349: explained here.
1.1 dsieger 3350:
1.184 rillig 3351: Some of the directory variables contain relative pathnames. There are two
3352: common base directories for these relative directories: PKGSRCDIR/PKGPATH is
3353: used for directories that are pkgsrc-specific. WRKSRC is used for directories
3354: inside the package itself.
1.1 dsieger 3355:
1.184 rillig 3356: PKGSRCDIR
1.1 dsieger 3357:
1.184 rillig 3358: This is an absolute pathname that points to the pkgsrc root directory.
3359: Generally, you don't need it.
1.1 dsieger 3360:
1.184 rillig 3361: PKGDIR
1.1 dsieger 3362:
1.184 rillig 3363: This is an absolute pathname that points to the current package.
1.1 dsieger 3364:
1.184 rillig 3365: PKGPATH
1.1 dsieger 3366:
1.184 rillig 3367: This is a pathname relative to PKGSRCDIR that points to the current
1.228 gutterid 3368: package. It is defined after including bsd.prefs.mk and can be used in
3369: makefile fragments that are used by several packages to distinguish between
3370: these packages. Other variables that would serve the same purpose are
3371: PKGBASE and PKGNAME, but these are only defined after including bsd.pkg.mk,
3372: which is too late.
3373:
3374: In mk.conf, the pkgsrc user can use PKGPATH to tweak variables like
3375: MAKE_JOBS and CFLAGS.
1.1 dsieger 3376:
1.184 rillig 3377: WRKDIR
1.1 dsieger 3378:
1.184 rillig 3379: This is an absolute pathname pointing to the directory where all work takes
3380: place. The distfiles are extracted to this directory. It also contains
3381: temporary directories and log files used by the various pkgsrc frameworks,
3382: like buildlink or the wrappers.
1.1 dsieger 3383:
1.184 rillig 3384: WRKSRC
1.1 dsieger 3385:
1.184 rillig 3386: This is an absolute pathname pointing to the directory where the distfiles
3387: are extracted. It is usually a direct subdirectory of WRKDIR, and often
3388: it's the only directory entry that isn't hidden. This variable may be
3389: changed by a package Makefile.
1.1 dsieger 3390:
1.184 rillig 3391: The CREATE_WRKDIR_SYMLINK definition takes either the value yes or no and
3392: defaults to no. It indicates whether a symbolic link to the WRKDIR is to be
3393: created in the pkgsrc entry's directory. If users would like to have their
3394: pkgsrc trees behave in a read-only manner, then the value of
3395: CREATE_WRKDIR_SYMLINK should be set to no.
1.1 dsieger 3396:
1.184 rillig 3397: 13.4. Running a phase
1.1 dsieger 3398:
1.184 rillig 3399: You can run a particular phase by typing make phase, where phase is the name of
3400: the phase. This will automatically run all phases that are required for this
3401: phase. The default phase is build, that is, when you run make without
3402: parameters in a package directory, the package will be built, but not
3403: installed.
1.1 dsieger 3404:
1.184 rillig 3405: 13.5. The fetch phase
1.1 dsieger 3406:
1.184 rillig 3407: The first step in building a package is to fetch the distribution files
3408: (distfiles) from the sites that are providing them. This is the task of the
3409: fetch phase.
1.25 wiz 3410:
1.184 rillig 3411: 13.5.1. What to fetch and where to get it from
1.1 dsieger 3412:
1.184 rillig 3413: In simple cases, MASTER_SITES defines all URLs from where the distfile, whose
3414: name is derived from the DISTNAME variable, is fetched. The more complicated
3415: cases are described below.
1.1 dsieger 3416:
1.184 rillig 3417: The variable DISTFILES specifies the list of distfiles that have to be fetched.
3418: Its value defaults to ${DEFAULT_DISTFILES} and its value is ${DISTNAME}$
3419: {EXTRACT_SUFX}, so that most packages don't need to define it at all.
3420: EXTRACT_SUFX is .tar.gz by default, but can be changed freely. Note that if
3421: your package requires additional distfiles to the default one, you cannot just
3422: append the additional filenames using the += operator, but you have write for
3423: example:
1.1 dsieger 3424:
1.184 rillig 3425: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 3426:
1.184 rillig 3427: Each distfile is fetched from a list of sites, usually MASTER_SITES. If the
3428: package has multiple DISTFILES or multiple PATCHFILES from different sites, you
3429: can set SITES.distfile to the list of URLs where the file distfile (including
3430: the suffix) can be found.
1.1 dsieger 3431:
1.184 rillig 3432: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
3433: DISTFILES+= foo-file.tar.gz
3434: SITES.foo-file.tar.gz= \
3435: https://www.somewhere.com/somehow/ \
3436: https://www.somewhereelse.com/mirror/somehow/
1.1 dsieger 3437:
1.184 rillig 3438: When actually fetching the distfiles, each item from MASTER_SITES or SITES.*
3439: gets the name of each distfile appended to it, without an intermediate slash.
3440: Therefore, all site values have to end with a slash or other separator
3441: character. This allows for example to set MASTER_SITES to a URL of a CGI script
3442: that gets the name of the distfile as a parameter. In this case, the definition
3443: would look like:
1.1 dsieger 3444:
1.184 rillig 3445: MASTER_SITES= https://www.example.com/download.cgi?file=
1.1 dsieger 3446:
1.184 rillig 3447: The exception to this rule are URLs starting with a dash. In that case the URL
3448: is taken as is, fetched and the result stored under the name of the distfile.
3449: You can use this style for the case when the download URL style does not match
3450: the above common case. For example, if permanent download URL is a redirector
3451: to the real download URL, or the download file name is offered by an HTTP
3452: Content-Disposition header. In the following example, foo-1.0.0.tar.gz will be
3453: created instead of the default v1.0.0.tar.gz.
1.1 dsieger 3454:
1.184 rillig 3455: DISTNAME= foo-1.0.0
3456: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
1.29 wiz 3457:
1.184 rillig 3458: There are some predefined values for MASTER_SITES, which can be used in
3459: packages. The names of the variables should speak for themselves.
1.29 wiz 3460:
1.225 gutterid 3461: MASTER_SITE_APACHE MASTER_SITE_BACKUP
3462: MASTER_SITE_CRATESIO MASTER_SITE_CYGWIN
3463: MASTER_SITE_DEBIAN MASTER_SITE_FREEBSD
3464: MASTER_SITE_FREEBSD_LOCAL MASTER_SITE_GENTOO
3465: MASTER_SITE_GITHUB MASTER_SITE_GITLAB
3466: MASTER_SITE_GNOME MASTER_SITE_GNU
3467: MASTER_SITE_GNUSTEP MASTER_SITE_HASKELL_HACKAGE
3468: MASTER_SITE_IFARCHIVE MASTER_SITE_KDE
3469: MASTER_SITE_MOZILLA MASTER_SITE_MOZILLA_ALL
3470: MASTER_SITE_MYSQL MASTER_SITE_NETLIB
3471: MASTER_SITE_OPENBSD MASTER_SITE_OPENOFFICE
3472: MASTER_SITE_OSDN MASTER_SITE_PERL_CPAN
3473: MASTER_SITE_PGSQL MASTER_SITE_PYPI
3474: MASTER_SITE_RUBYGEMS MASTER_SITE_R_CRAN
3475: MASTER_SITE_SOURCEFORGE MASTER_SITE_SUNSITE
3476: MASTER_SITE_SUSE MASTER_SITE_TEX_CTAN
3477: MASTER_SITE_XCONTRIB MASTER_SITE_XEMACS
3478: MASTER_SITE_XORG
1.1 dsieger 3479:
1.184 rillig 3480: Some explanations for the less self-explaining ones: MASTER_SITE_BACKUP
3481: contains backup sites for packages that are maintained in ftp://ftp.NetBSD.org/
3482: pub/pkgsrc/distfiles/${DIST_SUBDIR}. MASTER_SITE_LOCAL contains local package
3483: source distributions that are maintained in ftp://ftp.NetBSD.org/pub/pkgsrc/
3484: distfiles/LOCAL_PORTS/.
1.1 dsieger 3485:
1.184 rillig 3486: If you choose one of these predefined sites, you may want to specify a
3487: subdirectory of that site. Since these macros may expand to more than one
3488: actual site, you must use the following construct to specify a subdirectory:
1.1 dsieger 3489:
1.184 rillig 3490: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
3491: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 3492:
1.184 rillig 3493: Note the trailing slash after the subdirectory name.
1.1 dsieger 3494:
1.184 rillig 3495: 13.5.2. How are the files fetched?
1.1 dsieger 3496:
1.184 rillig 3497: The fetch phase makes sure that all the distfiles exist in a local directory
3498: (DISTDIR, which can be set by the pkgsrc user). If the files do not exist, they
3499: are fetched using commands of the form
1.1 dsieger 3500:
1.184 rillig 3501: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
1.1 dsieger 3502:
1.184 rillig 3503: where ${site} varies through several possibilities in turn: first,
3504: MASTER_SITE_OVERRIDE is tried, then the sites specified in either SITES.file if
3505: defined, else MASTER_SITES or PATCH_SITES, as applies, then finally the value
3506: of MASTER_SITE_BACKUP. The order of all except the first and the last can be
3507: optionally sorted by the user, via setting either MASTER_SORT_RANDOM, and
3508: MASTER_SORT_AWK or MASTER_SORT_REGEX.
1.1 dsieger 3509:
1.184 rillig 3510: The specific command and arguments used depend on the FETCH_USING parameter.
3511: The example above is for FETCH_USING=custom.
1.66 asau 3512:
1.184 rillig 3513: The distfiles mirror run by the NetBSD Foundation uses the mirror-distfiles
3514: target to mirror the distfiles, if they are freely distributable. Packages
3515: setting NO_SRC_ON_FTP (usually to "${RESTRICTED}") will not have their
3516: distfiles mirrored.
1.1 dsieger 3517:
1.184 rillig 3518: 13.6. The checksum phase
1.1 dsieger 3519:
1.184 rillig 3520: After the distfile(s) are fetched, their checksum is generated and compared
3521: with the checksums stored in the distinfo file. If the checksums don't match,
3522: the build is aborted. This is to ensure the same distfile is used for building,
3523: and that the distfile wasn't changed, e.g. by some malign force, deliberately
3524: changed distfiles on the master distribution site or network lossage.
1.1 dsieger 3525:
1.184 rillig 3526: 13.7. The extract phase
1.1 dsieger 3527:
1.184 rillig 3528: When the distfiles are present on the local system, they need to be extracted,
3529: as they usually come in the form of some compressed archive format.
1.1 dsieger 3530:
1.184 rillig 3531: By default, all DISTFILES are extracted. If you only need some of them, you can
3532: set the EXTRACT_ONLY variable to the list of those files.
1.1 dsieger 3533:
1.184 rillig 3534: Extracting the files is usually done by a little program, mk/extract/extract,
3535: which already knows how to extract various archive formats, so most likely you
3536: will not need to change anything here. But if you need, the following variables
3537: may help you:
1.1 dsieger 3538:
1.184 rillig 3539: EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}
1.1 dsieger 3540:
1.184 rillig 3541: Use these variables to override the default options for an extract command,
3542: which are defined in mk/extract/extract.
1.1 dsieger 3543:
1.184 rillig 3544: EXTRACT_USING
1.1 dsieger 3545:
1.184 rillig 3546: This variable can be set to bsdtar, gtar, nbtar (which is the default
3547: value), pax, or an absolute pathname pointing to the command with which tar
3548: archives should be extracted. It is preferred to choose bsdtar over gtar if
3549: NetBSD's pax-as-tar is not good enough.
1.1 dsieger 3550:
1.184 rillig 3551: If the extract program doesn't serve your needs, you can also override the
3552: EXTRACT_CMD variable, which holds the command used for extracting the files.
3553: This command is executed in the ${WRKSRC} directory. During execution of this
3554: command, the shell variable extract_file holds the absolute pathname of the
3555: file that is going to be extracted.
1.1 dsieger 3556:
1.184 rillig 3557: And if that still does not suffice, you can override the do-extract target in
3558: the package Makefile.
1.1 dsieger 3559:
1.184 rillig 3560: 13.8. The patch phase
1.1 dsieger 3561:
1.184 rillig 3562: After extraction, all the patches named by the PATCHFILES, those present in the
3563: patches subdirectory of the package as well as in $LOCALPATCHES/$PKGPATH (e.g.
3564: /usr/local/patches/graphics/png) are applied. Patchfiles ending in .Z or .gz
3565: are uncompressed before they are applied, files ending in .orig or .rej are
3566: ignored. Any special options to patch(1) can be handed in PATCH_DIST_ARGS. See
3567: Section 12.3, "patches/*" for more details.
1.1 dsieger 3568:
1.184 rillig 3569: By default patch(1) is given special arguments to make it fail if the expected
3570: text from the patch context is not found in the patched file. If that happens,
3571: fix the patch file by comparing it with the actual text in the file to be
3572: patched.
1.1 dsieger 3573:
1.184 rillig 3574: 13.9. The tools phase
1.1 dsieger 3575:
1.184 rillig 3576: This is covered in Chapter 17, Tools needed for building or running.
1.1 dsieger 3577:
1.184 rillig 3578: 13.10. The wrapper phase
1.1 dsieger 3579:
1.184 rillig 3580: This phase creates wrapper programs for the compilers and linkers. The
3581: following variables can be used to tweak the wrappers.
1.1 dsieger 3582:
1.184 rillig 3583: ECHO_WRAPPER_MSG
1.1 dsieger 3584:
1.184 rillig 3585: The command used to print progress messages. Does nothing by default. Set
3586: to ${ECHO} to see the progress messages.
1.1 dsieger 3587:
1.184 rillig 3588: WRAPPER_DEBUG
1.1 dsieger 3589:
1.184 rillig 3590: This variable can be set to yes (default) or no, depending on whether you
3591: want additional information in the wrapper log file.
1.1 dsieger 3592:
1.184 rillig 3593: WRAPPER_UPDATE_CACHE
1.1 dsieger 3594:
1.184 rillig 3595: This variable can be set to yes or no, depending on whether the wrapper
3596: should use its cache, which will improve the speed. The default value is
3597: yes, but is forced to no if the platform does not support it.
1.1 dsieger 3598:
1.184 rillig 3599: WRAPPER_REORDER_CMDS
1.1 dsieger 3600:
1.184 rillig 3601: A list of reordering commands. A reordering command has the form reorder:l:
3602: lib1:lib2. It ensures that that -llib1 occurs before -llib2.
1.1 dsieger 3603:
1.184 rillig 3604: 13.11. The configure phase
1.1 dsieger 3605:
1.184 rillig 3606: Most pieces of software need information on the header files, system calls, and
3607: library routines which are available on the platform they run on. The process
3608: of determining this information is known as configuration, and is usually
3609: automated. In most cases, a script is supplied with the distfiles, and its
3610: invocation results in generation of header files, Makefiles, etc.
1.1 dsieger 3611:
1.184 rillig 3612: If the package contains a configure script, this can be invoked by setting
3613: HAS_CONFIGURE to "yes". If the configure script is a GNU autoconf script, you
1.187 rillig 3614: should set GNU_CONFIGURE to "yes" instead.
1.1 dsieger 3615:
1.187 rillig 3616: In the do-configure stage, a rough equivalent of the following command is run.
3617: See mk/configure/configure.mk, target do-configure-script for the exact
3618: definition.
3619:
3620: .for dir in ${CONFIGURE_DIRS}
3621: cd ${WRKSRC} && cd ${dir} \
3622: && env ${CONFIGURE_ENV} \
3623: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 3624: .endfor
1.1 dsieger 3625:
1.184 rillig 3626: CONFIGURE_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In
3627: each of these directories, the configure script is run with the environment
3628: CONFIGURE_ENV and arguments CONFIGURE_ARGS. The variables CONFIGURE_ENV,
3629: CONFIGURE_SCRIPT (default: "./configure") and CONFIGURE_ARGS may all be changed
3630: by the package.
1.1 dsieger 3631:
1.184 rillig 3632: If the program uses the Perl way of configuration (mainly Perl modules, but not
3633: only), i.e. a file called Makefile.PL, it should include ../../lang/perl5/
3634: module.mk. To set any parameter for Makefile.PL use the MAKE_PARAMS variable
3635: (e.g., MAKE_PARAMS+=foo=bar
1.1 dsieger 3636:
1.184 rillig 3637: If the program uses an Imakefile for configuration, the appropriate steps can
3638: be invoked by setting USE_IMAKE to "yes". If you only need xmkmf, add it to
3639: USE_TOOLS. You can add variables to xmkmf's environment by adding them to the
3640: SCRIPTS_ENV variable.
1.1 dsieger 3641:
1.184 rillig 3642: If the program uses cmake for configuration, the appropriate steps can be
1.233 wiz 3643: invoked by including ../../devel/cmake/build.mk. You can add variables to
3644: cmake's environment by adding them to the CONFIGURE_ENV variable and arguments
3645: to cmake by adding them to the CMAKE_ARGS variable. If you want to add
3646: arguments only for particular stages, you can use the CMAKE_CONFIGURE_ARGS,
3647: CMAKE_BUILD_ARGS, and CMAKE_INSTALL_ARGS variables. You can set the
3648: CONFIGURE_DIRS variable to the directories in which CMake should be run,
3649: relative to WRKSRC. This defaults to to ".".
1.1 dsieger 3650:
1.184 rillig 3651: If there is no configure step at all, set NO_CONFIGURE to "yes".
1.1 dsieger 3652:
1.184 rillig 3653: 13.12. The build phase
1.1 dsieger 3654:
1.187 rillig 3655: For building a package, a rough equivalent of the following code is executed;
3656: see mk/build/build.mk, target do-build for the exact definition.
1.154 rillig 3657:
1.187 rillig 3658: .for dir in ${BUILD_DIRS}
3659: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 3660: && env ${MAKE_ENV} \
1.187 rillig 3661: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 3662: -f ${MAKE_FILE} \
3663: ${BUILD_TARGET}
3664: .endfor
1.1 dsieger 3665:
1.184 rillig 3666: BUILD_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In each of
3667: these directories, MAKE_PROGRAM is run with the environment MAKE_ENV and
3668: arguments BUILD_MAKE_FLAGS. The variables MAKE_ENV, BUILD_MAKE_FLAGS, MAKE_FILE
3669: and BUILD_TARGET may all be changed by the package.
1.1 dsieger 3670:
1.184 rillig 3671: The default value of MAKE_PROGRAM is "gmake" if USE_TOOLS contains "gmake", "
3672: make" otherwise. The default value of MAKE_FILE is "Makefile", and BUILD_TARGET
3673: defaults to "all".
1.1 dsieger 3674:
1.184 rillig 3675: If there is no build step at all, set NO_BUILD to "yes".
1.1 dsieger 3676:
1.184 rillig 3677: 13.13. The test phase
1.1 dsieger 3678:
1.184 rillig 3679: [TODO]
1.1 dsieger 3680:
1.184 rillig 3681: 13.14. The install phase
1.1 dsieger 3682:
1.184 rillig 3683: Once the build stage has completed, the final step is to install the software
3684: in public directories, so users can access the programs and files.
1.1 dsieger 3685:
1.187 rillig 3686: In the install phase, a rough equivalent of the following code is executed; see
3687: mk/install/install.mk, target do-install for the exact definition.
3688: Additionally, before and after this code, several consistency checks are run
3689: against the files-to-be-installed, see mk/check/*.mk for details.
3690:
3691: .for dir in ${INSTALL_DIRS}
3692: cd ${WRKSRC} && cd ${dir} \
3693: && env ${INSTALL_ENV} ${MAKE_ENV} \
3694: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
3695: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 3696: .endfor
1.1 dsieger 3697:
1.184 rillig 3698: The variable's meanings are analogous to the ones in the build phase.
3699: INSTALL_DIRS defaults to BUILD_DIRS. INSTALL_TARGET is "install" by default,
3700: plus "install.man" if USE_IMAKE is defined and NO_INSTALL_MANPAGES is not
3701: defined.
1.1 dsieger 3702:
1.184 rillig 3703: In the install phase, the following variables are useful. They are all
3704: variations of the install(1) command that have the owner, group and permissions
3705: preset. INSTALL is the plain install command. The specialized variants,
3706: together with their intended use, are:
1.1 dsieger 3707:
1.184 rillig 3708: INSTALL_PROGRAM_DIR
1.1 dsieger 3709:
1.184 rillig 3710: directories that contain binaries
1.1 dsieger 3711:
1.184 rillig 3712: INSTALL_SCRIPT_DIR
1.1 dsieger 3713:
1.184 rillig 3714: directories that contain scripts
1.1 dsieger 3715:
1.184 rillig 3716: INSTALL_LIB_DIR
1.1 dsieger 3717:
1.184 rillig 3718: directories that contain shared and static libraries
1.1 dsieger 3719:
1.184 rillig 3720: INSTALL_DATA_DIR
1.108 rillig 3721:
1.184 rillig 3722: directories that contain data files
1.108 rillig 3723:
1.184 rillig 3724: INSTALL_MAN_DIR
1.108 rillig 3725:
1.184 rillig 3726: directories that contain man pages
1.108 rillig 3727:
1.184 rillig 3728: INSTALL_GAME_DIR
1.108 rillig 3729:
1.184 rillig 3730: directories that contain data files for games
1.108 rillig 3731:
1.184 rillig 3732: INSTALL_PROGRAM
1.108 rillig 3733:
1.184 rillig 3734: binaries that can be stripped from debugging symbols
1.108 rillig 3735:
1.184 rillig 3736: INSTALL_SCRIPT
1.108 rillig 3737:
1.184 rillig 3738: binaries that cannot be stripped
1.108 rillig 3739:
1.184 rillig 3740: INSTALL_GAME
1.108 rillig 3741:
1.184 rillig 3742: game binaries
1.108 rillig 3743:
1.184 rillig 3744: INSTALL_LIB
1.108 rillig 3745:
1.184 rillig 3746: shared and static libraries
1.108 rillig 3747:
1.184 rillig 3748: INSTALL_DATA
1.108 rillig 3749:
1.184 rillig 3750: data files
1.1 dsieger 3751:
1.184 rillig 3752: INSTALL_GAME_DATA
1.1 dsieger 3753:
1.184 rillig 3754: data files for games
1.108 rillig 3755:
1.184 rillig 3756: INSTALL_MAN
1.108 rillig 3757:
1.184 rillig 3758: man pages
1.1 dsieger 3759:
1.184 rillig 3760: Some other variables are:
1.1 dsieger 3761:
1.184 rillig 3762: INSTALL_UNSTRIPPED
1.1 dsieger 3763:
1.184 rillig 3764: If set to yes, do not run strip(1) when installing binaries. Any debugging
3765: sections and symbols present in binaries will be preserved.
1.1 dsieger 3766:
1.184 rillig 3767: INSTALLATION_DIRS
1.1 dsieger 3768:
1.184 rillig 3769: A list of directories relative to PREFIX that are created by pkgsrc at the
3770: beginning of the install phase. The package is supposed to create all
3771: needed directories itself before installing files to it and list all other
3772: directories here.
1.1 dsieger 3773:
1.184 rillig 3774: In the rare cases that a package shouldn't install anything, set NO_INSTALL to
3775: "yes". This is mostly relevant for packages in the regress category.
1.1 dsieger 3776:
1.184 rillig 3777: 13.15. The package phase
1.121 sevan 3778:
1.184 rillig 3779: Once the install stage has completed, a binary package of the installed files
3780: can be built. These binary packages can be used for quick installation without
3781: previous compilation, e.g. by the make bin-install or by using pkg_add.
1.1 dsieger 3782:
1.184 rillig 3783: By default, the binary packages are created in ${PACKAGES}/All and symlinks are
3784: created in ${PACKAGES}/category, one for each category in the CATEGORIES
3785: variable. PACKAGES defaults to pkgsrc/packages.
1.1 dsieger 3786:
1.184 rillig 3787: 13.16. Cleaning up
1.1 dsieger 3788:
1.184 rillig 3789: Once you're finished with a package, you can clean the work directory by
3790: running make clean. If you want to clean the work directories of all
3791: dependencies too, use make clean-depends.
1.1 dsieger 3792:
1.184 rillig 3793: 13.17. Other helpful targets
1.1 dsieger 3794:
1.184 rillig 3795: pre/post-*
1.1 dsieger 3796:
1.184 rillig 3797: For any of the main targets described in the previous section (configure,
3798: build, install, etc.), two auxiliary targets exist with "pre-" and "post-"
3799: used as a prefix for the main target's name. These targets are invoked
3800: before and after the main target is called, allowing extra configuration or
3801: installation steps be performed from a package's Makefile, for example,
3802: which a program's configure script or install target omitted.
3803:
3804: About 5% of the pkgsrc packages define their custom post-extract target,
3805: another 5% define pre-configure, and 10% define post-install. The other pre
3806: /post-* targets are defined even less often.
1.1 dsieger 3807:
1.184 rillig 3808: do-*
1.182 leot 3809:
1.184 rillig 3810: Should one of the main targets do the wrong thing, and should there be no
3811: variable to fix this, you can redefine it with the do-* target. (Note that
3812: redefining the target itself instead of the do-* target is a bad idea, as
3813: the pre-* and post-* targets won't be called anymore, etc.)
1.1 dsieger 3814:
1.184 rillig 3815: About 15% of the pkgsrc packages override the default do-install, the other
3816: do-* targets are overridden even less often.
1.1 dsieger 3817:
1.184 rillig 3818: reinstall
1.1 dsieger 3819:
1.184 rillig 3820: If you did a make install and you noticed some file was not installed
3821: properly, you can repeat the installation with this target, which will
3822: ignore the "already installed" flag.
1.1 dsieger 3823:
1.184 rillig 3824: This is the default value of DEPENDS_TARGET except in the case of make
3825: update and make package, where the defaults are "package" and "update",
3826: respectively.
1.1 dsieger 3827:
1.184 rillig 3828: deinstall
1.1 dsieger 3829:
1.184 rillig 3830: This target does a pkg_delete(1) in the current directory, effectively
3831: de-installing the package. The following variables can be used to tune the
3832: behaviour:
1.1 dsieger 3833:
1.184 rillig 3834: PKG_VERBOSE
1.1 dsieger 3835:
1.184 rillig 3836: Add a "-v" to the pkg_delete(1) command.
1.1 dsieger 3837:
1.184 rillig 3838: DEINSTALLDEPENDS
1.1 dsieger 3839:
1.184 rillig 3840: Remove all packages that require (depend on) the given package. This
3841: can be used to remove any packages that may have been pulled in by a
3842: given package, e.g. if make deinstall DEINSTALLDEPENDS=1 is done in
3843: pkgsrc/x11/kde, this is likely to remove whole KDE. Works by adding "-R
3844: " to the pkg_delete(1) command line.
1.1 dsieger 3845:
1.184 rillig 3846: bin-install
1.1 dsieger 3847:
1.184 rillig 3848: Install a binary package from local disk and via FTP from a list of sites
3849: (see the BINPKG_SITES variable), and do a make package if no binary package
3850: is available anywhere. The arguments given to pkg_add can be set via
3851: BIN_INSTALL_FLAGS e.g., to do verbose operation, etc.
1.1 dsieger 3852:
1.184 rillig 3853: install-clean
1.1 dsieger 3854:
1.184 rillig 3855: This target removes the state files for the "install" and later phases so
3856: that the "install" target may be re-invoked. This can be used after editing
3857: the PLIST to install the package without rebuilding it.
1.1 dsieger 3858:
1.184 rillig 3859: build-clean
1.18 mishka 3860:
1.184 rillig 3861: This target removes the state files for the "build" and later phases so
3862: that the "build" target may be re-invoked.
1.18 mishka 3863:
1.184 rillig 3864: update
1.18 mishka 3865:
1.184 rillig 3866: This target causes the current package to be updated to the latest version.
3867: The package and all depending packages first get de-installed, then current
3868: versions of the corresponding packages get compiled and installed. This is
3869: similar to manually noting which packages are currently installed, then
3870: performing a series of make deinstall and make install (or whatever
3871: UPDATE_TARGET is set to) for these packages.
1.18 mishka 3872:
1.184 rillig 3873: You can use the "update" target to resume package updating in case a
3874: previous make update was interrupted for some reason. However, in this
3875: case, make sure you don't call make clean or otherwise remove the list of
3876: dependent packages in WRKDIR. Otherwise, you lose the ability to
3877: automatically update the current package along with the dependent packages
3878: you have installed.
1.121 sevan 3879:
1.184 rillig 3880: Resuming an interrupted make update will only work as long as the package
3881: tree remains unchanged. If the source code for one of the packages to be
3882: updated has been changed, resuming make update will most certainly fail!
1.1 dsieger 3883:
1.184 rillig 3884: The following variables can be used either on the command line or in
3885: mk.conf to alter the behaviour of make update:
1.1 dsieger 3886:
1.184 rillig 3887: UPDATE_TARGET
1.1 dsieger 3888:
1.184 rillig 3889: Install target to recursively use for the updated package and the
3890: dependent packages. Defaults to DEPENDS_TARGET if set, "install"
3891: otherwise for make update. Other good targets are "package" or "
3892: bin-install". Do not set this to "update" or you will get stuck in an
3893: endless loop!
1.1 dsieger 3894:
1.184 rillig 3895: NOCLEAN
1.1 dsieger 3896:
1.184 rillig 3897: Don't clean up after updating. Useful if you want to leave the work
3898: sources of the updated packages around for inspection or other
3899: purposes. Be sure you eventually clean up the source tree (see the "
3900: clean-update" target below) or you may run into troubles with old
3901: source code still lying around on your next make or make update.
1.1 dsieger 3902:
1.184 rillig 3903: REINSTALL
1.1 dsieger 3904:
1.184 rillig 3905: Deinstall each package before installing (making DEPENDS_TARGET). This
3906: may be necessary if the "clean-update" target (see below) was called
3907: after interrupting a running make update.
1.1 dsieger 3908:
1.184 rillig 3909: DEPENDS_TARGET
1.1 dsieger 3910:
1.184 rillig 3911: Allows you to disable recursion and hardcode the target for packages.
3912: The default is "update" for the update target, facilitating a recursive
3913: update of prerequisite packages. Only set DEPENDS_TARGET if you want to
3914: disable recursive updates. Use UPDATE_TARGET instead to just set a
3915: specific target for each package to be installed during make update
3916: (see above).
1.1 dsieger 3917:
1.184 rillig 3918: clean-update
1.1 dsieger 3919:
1.184 rillig 3920: Clean the source tree for all packages that would get updated if make
3921: update was called from the current directory. This target should not be
3922: used if the current package (or any of its depending packages) have already
3923: been de-installed (e.g., after calling make update) or you may lose some
3924: packages you intended to update. As a rule of thumb: only use this target
3925: before the first time you run make update and only if you have a dirty
3926: package tree (e.g., if you used NOCLEAN).
1.86 wiz 3927:
1.184 rillig 3928: If you are unsure about whether your tree is clean, you can either perform
3929: a make clean at the top of the tree, or use the following sequence of
3930: commands from the directory of the package you want to update (before
3931: running make update for the first time, otherwise you lose all the packages
3932: you wanted to update!):
1.86 wiz 3933:
1.184 rillig 3934: # make clean-update
3935: # make clean CLEANDEPENDS=YES
3936: # make update
1.86 wiz 3937:
3938:
1.184 rillig 3939: The following variables can be used either on the command line or in
3940: mk.conf to alter the behaviour of make clean-update:
1.86 wiz 3941:
1.184 rillig 3942: CLEAR_DIRLIST
1.86 wiz 3943:
1.184 rillig 3944: After make clean, do not reconstruct the list of directories to update
3945: for this package. Only use this if make update successfully installed
3946: all packages you wanted to update. Normally, this is done automatically
3947: on make update, but may have been suppressed by the NOCLEAN variable
3948: (see above).
1.1 dsieger 3949:
1.184 rillig 3950: replace
1.1 dsieger 3951:
1.184 rillig 3952: Update the installation of the current package. This differs from update in
3953: that it does not replace dependent packages. You will need to install
3954: pkgtools/pkg_tarup for this target to work.
1.1 dsieger 3955:
1.184 rillig 3956: Be careful when using this target! There are no guarantees that dependent
3957: packages will still work, in particular they will most certainly break if
3958: you make replace a library package whose shared library major version
3959: changed between your installed version and the new one. For this reason,
3960: this target is not officially supported and only recommended for advanced
3961: users.
1.1 dsieger 3962:
1.184 rillig 3963: info
1.1 dsieger 3964:
1.184 rillig 3965: This target invokes pkg_info(1) for the current package. You can use this
3966: to check which version of a package is installed.
1.86 wiz 3967:
1.184 rillig 3968: index
1.1 dsieger 3969:
1.184 rillig 3970: This is a top-level command, i.e. it should be used in the pkgsrc
3971: directory. It creates a database of all packages in the local pkgsrc tree,
3972: including dependencies, comment, maintainer, and some other useful
3973: information. Individual entries are created by running make describe in the
3974: packages' directories. This index file is saved as pkgsrc/INDEX. It can be
3975: displayed in verbose format by running make print-index. You can search in
3976: it with make search key=something. You can extract a list of all packages
3977: that depend on a particular one by running make show-deps PKG=somepackage.
1.1 dsieger 3978:
1.184 rillig 3979: Running this command takes a very long time, some hours even on fast
3980: machines!
1.1 dsieger 3981:
1.184 rillig 3982: readme
1.1 dsieger 3983:
1.199 nia 3984: This target generates a index.html file, which can be viewed using a
1.184 rillig 3985: browser such as www/firefox or www/links. The generated files contain
3986: references to any packages which are in the PACKAGES directory on the local
3987: host. The generated files can be made to refer to URLs based on
3988: FTP_PKG_URL_HOST and FTP_PKG_URL_DIR. For example, if I wanted to generate
1.199 nia 3989: index.html files which pointed to binary packages on the local machine, in
1.184 rillig 3990: the directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
3991: FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
3992: subdirectories will be searched for all the binary packages.
1.1 dsieger 3993:
1.184 rillig 3994: The target can be run at the toplevel or in category directories, in which
3995: case it descends recursively.
1.1 dsieger 3996:
1.184 rillig 3997: readme-all
1.1 dsieger 3998:
1.184 rillig 3999: This is a top-level command, run it in pkgsrc. Use this target to create a
4000: file README-all.html which contains a list of all packages currently
4001: available in the NetBSD Packages Collection, together with the category
4002: they belong to and a short description. This file is compiled from the
1.199 nia 4003: pkgsrc/*/index.html files, so be sure to run this after a make readme.
1.1 dsieger 4004:
1.184 rillig 4005: cdrom-readme
1.1 dsieger 4006:
1.184 rillig 4007: This is very much the same as the "readme" target (see above), but is to be
4008: used when generating a pkgsrc tree to be written to a CD-ROM. This target
1.199 nia 4009: also produces index.html files, and can be made to refer to URLs based on
1.184 rillig 4010: CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
1.1 dsieger 4011:
1.184 rillig 4012: show-distfiles
1.1 dsieger 4013:
1.184 rillig 4014: This target shows which distfiles and patchfiles are needed to build the
4015: package (ALLFILES, which contains all DISTFILES and PATCHFILES, but not
4016: patches/*).
1.1 dsieger 4017:
1.184 rillig 4018: show-downlevel
1.1 dsieger 4019:
1.184 rillig 4020: This target shows nothing if the package is not installed. If a version of
4021: this package is installed, but is not the version provided in this version
4022: of pkgsrc, then a warning message is displayed. This target can be used to
4023: show which of your installed packages are downlevel, and so the old
4024: versions can be deleted, and the current ones added.
1.1 dsieger 4025:
1.184 rillig 4026: show-pkgsrc-dir
1.1 dsieger 4027:
1.184 rillig 4028: This target shows the directory in the pkgsrc hierarchy from which the
4029: package can be built and installed. This may not be the same directory as
4030: the one from which the package was installed. This target is intended to be
4031: used by people who may wish to upgrade many packages on a single host, and
4032: can be invoked from the top-level pkgsrc Makefile by using the "
4033: show-host-specific-pkgs" target.
1.1 dsieger 4034:
1.184 rillig 4035: show-installed-depends
1.1 dsieger 4036:
1.184 rillig 4037: This target shows which installed packages match the current package's
4038: DEPENDS. Useful if out of date dependencies are causing build problems.
1.1 dsieger 4039:
1.184 rillig 4040: print-build-depends-list
1.1 dsieger 4041:
1.184 rillig 4042: This target shows the list of packages that the current package depends on
4043: for building.
1.1 dsieger 4044:
1.184 rillig 4045: print-run-depends-list
1.1 dsieger 4046:
1.184 rillig 4047: This target shows the list of packages that the current package depends on
4048: for running.
1.1 dsieger 4049:
1.184 rillig 4050: check-shlibs
1.1 dsieger 4051:
1.184 rillig 4052: After a package is installed, check all its binaries and (on ELF platforms)
4053: shared libraries to see if they find the shared libs they need. Run by
4054: default if PKG_DEVELOPER is set in mk.conf.
1.1 dsieger 4055:
1.184 rillig 4056: print-PLIST
1.1 dsieger 4057:
1.184 rillig 4058: After a "make install" from a new or upgraded pkg, this prints out an
4059: attempt to generate a new PLIST from a find -newer work/.extract_done. An
4060: attempt is made to care for shared libs etc., but it is strongly
4061: recommended to review the result before putting it into PLIST. On upgrades,
4062: it's useful to diff the output of this command against an already existing
4063: PLIST file.
1.1 dsieger 4064:
1.184 rillig 4065: If the package installs files via tar(1) or other methods that don't update
4066: file access times, be sure to add these files manually to your PLIST, as
4067: the "find -newer" command used by this target won't catch them!
1.56 ryoon 4068:
1.184 rillig 4069: See Section 19.3, "Tweaking output of make print-PLIST" for more
4070: information on this target.
1.1 dsieger 4071:
1.255 ! wiz 4072: rebuild
! 4073:
! 4074: If you did a make build and you noticed some further modifications of
! 4075: sources are needed, you can repeat the build with this target, which will
! 4076: ignore the "already built" flag. This target is helpful while working with
! 4077: patches.
! 4078:
! 4079: repackage
! 4080:
! 4081: If you did a make package and you noticed some further modifications of
! 4082: sources are needed, you can repeat the package with this target, which will
! 4083: ignore the "already packaged" flag. This target is helpful while working
! 4084: with patches, PLIST* files etc.
! 4085:
! 4086: retest
! 4087:
! 4088: If you did a make test and you noticed some further modifications of
! 4089: sources are needed, you can repeat the test with this target, which will
! 4090: ignore the "already tested" flag. This target is helpful while working with
! 4091: patches.
! 4092:
1.184 rillig 4093: Chapter 14. Creating a new pkgsrc package from scratch
1.1 dsieger 4094:
1.184 rillig 4095: Table of Contents
1.1 dsieger 4096:
1.184 rillig 4097: 14.1. Common types of packages
1.219 nia 4098: 14.1.1. Python modules and programs
4099: 14.1.2. R packages
4100: 14.1.3. TeXlive packages
1.184 rillig 4101: 14.2. Examples
4102: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 4103:
1.184 rillig 4104: When you find a package that is not yet in pkgsrc, you most likely have a URL
4105: from where you can download the source code. Starting with this URL, creating a
4106: package involves only a few steps.
1.1 dsieger 4107:
1.184 rillig 4108: 1. In your mk.conf, set PKG_DEVELOPER=yes to enable the basic quality checks.
1.1 dsieger 4109:
1.184 rillig 4110: 2. Install the package meta-pkgs/pkg_developer, which among others will
4111: install the utilities url2pkg, pkglint, pkgvi and mkpatches:
1.1 dsieger 4112:
1.184 rillig 4113: $ cd /usr/pkgsrc
4114: $ (cd meta-pkgs/pkg_developer && bmake update)
1.1 dsieger 4115:
1.184 rillig 4116: 3. Choose one of the top-level directories as the category in which you want
4117: to place your package. You can also create a directory of your own (maybe
1.219 nia 4118: called local). Change into that category directory:
1.1 dsieger 4119:
1.219 nia 4120: $ cd category
1.1 dsieger 4121:
1.219 nia 4122: 4. Run the program url2pkg, passing as argument the URL of the distribution
4123: file (in most cases a .tar.gz file). This will download the distribution
4124: file and create the necessary files of the package, based on what's in the
4125: distribution file:
1.1 dsieger 4126:
1.184 rillig 4127: $ url2pkg https://www.example.org/packages/package-1.0.tar.gz
1.1 dsieger 4128:
1.184 rillig 4129: 5. Examine the extracted files to determine the dependencies of your package.
4130: Ideally, this is mentioned in some README file, but things may differ. For
4131: each of these dependencies, look where it exists in pkgsrc, and if there is
4132: a file called buildlink3.mk in that directory, add a line to your package
4133: Makefile which includes that file just before the last line. If the
4134: buildlink3.mk file does not exist, it must be created first. The
4135: buildlink3.mk file makes sure that the package's include files and
4136: libraries are provided.
1.1 dsieger 4137:
1.219 nia 4138: If you just need binaries from a dependent package, add a DEPENDS line to
4139: the Makefile, which specifies the version of the dependency and where it
4140: can be found in pkgsrc. This line should be placed in the third paragraph.
4141: If the dependency is only needed for building the package, but not when
4142: using it, use TOOL_DEPENDS or BUILD_DEPENDS instead of DEPENDS. The
4143: difference between TOOL_DEPENDS and BUILD_DEPENDS occurs when
4144: cross-compiling: TOOL_DEPENDS are native packages, i.e. packages for the
4145: platform where the package is built; BUILD_DEPENDS are target packages,
4146: i.e. packages for the platform for which the package is built. There is
4147: also TEST_DEPENDS, which specifies a dependency used only for testing the
4148: resulting package built, using the upstream project's included test suite,
4149: on the native platform. Your package may then look like this:
1.1 dsieger 4150:
1.184 rillig 4151: [...]
1.1 dsieger 4152:
1.184 rillig 4153: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
4154: DEPENDS+= screen-[0-9]*:../../misc/screen
4155: DEPENDS+= screen>=4.0:../../misc/screen
1.1 dsieger 4156:
1.184 rillig 4157: [...]
1.1 dsieger 4158:
1.184 rillig 4159: .include "../../category/package/buildlink3.mk"
4160: .include "../../devel/glib2/buildlink3.mk"
4161: .include "../../mk/bsd.pkg.mk"
1.1 dsieger 4162:
1.184 rillig 4163: 6. Run pkglint to see what things still need to be done to make your package a
4164: "good" one. If you don't know what pkglint's warnings want to tell you, try
4165: pkglint --explain or pkglint -e, which outputs additional explanations.
1.1 dsieger 4166:
1.184 rillig 4167: 7. In many cases the package is not yet ready to build. You can find
4168: instructions for the most common cases in the next section, Section 14.1,
4169: "Common types of packages". After you have followed the instructions over
4170: there, you can hopefully continue here.
1.1 dsieger 4171:
1.184 rillig 4172: 8. Run bmake clean to clean the working directory from the extracted files.
1.219 nia 4173: Besides these files, a lot of cache files and other system information have
4174: been saved in the working directory, which may have become outdated after
4175: you edited the Makefile.
1.1 dsieger 4176:
1.184 rillig 4177: 9. Now, run bmake to build the package. For the various things that can go
4178: wrong in this phase, consult Chapter 21, Making your package work.
1.1 dsieger 4179:
1.184 rillig 4180: If the extracted files from the package need to be fixed, run multiple
4181: rounds of these commands:
1.1 dsieger 4182:
1.219 nia 4183: $ bmake
1.184 rillig 4184: $ pkgvi ${WRKSRC}/some/file/that/does/not/compile
4185: $ mkpatches
1.219 nia 4186: $ bmake mps
4187: $ bmake clean
1.1 dsieger 4188:
1.184 rillig 4189: 10. When the package builds fine, the next step is to install the package. Run
4190: bmake install and hope that everything works.
1.1 dsieger 4191:
1.184 rillig 4192: 11. Up to now, the file PLIST, which contains a list of the files that are
4193: installed by the package, is nearly empty. Run bmake print-PLIST >PLIST to
4194: generate a probably correct list. Check the file using your preferred text
4195: editor to see if the list of files looks plausible.
1.1 dsieger 4196:
1.184 rillig 4197: 12. Run pkglint again to see if the generated PLIST contains garbage or not.
1.1 dsieger 4198:
1.184 rillig 4199: 13. When you ran bmake install, the package had been registered in the database
4200: of installed files, but with an empty list of files. To fix this, run bmake
4201: deinstall and bmake install again. Now the package is registered with the
4202: list of files from PLIST.
1.48 wiz 4203:
1.219 nia 4204: 14. Run bmake clean update to run everything from above again in a single step,
1.184 rillig 4205: making sure that the PLIST is correct and the whole package is created as
4206: intended.
1.48 wiz 4207:
1.219 nia 4208: 15. Run pkglint to see if there's anything left to do.
1.48 wiz 4209:
1.219 nia 4210: 16. Commit the package to pkgsrc-wip or main pkgsrc; see Chapter 23, Submitting
1.184 rillig 4211: and Committing.
1.50 wiz 4212:
1.184 rillig 4213: 14.1. Common types of packages
1.1 dsieger 4214:
1.219 nia 4215: 14.1.1. Python modules and programs
1.1 dsieger 4216:
1.184 rillig 4217: Python modules and programs packages are easily created using a set of
4218: predefined variables.
1.1 dsieger 4219:
1.184 rillig 4220: If some Python versions are not supported by the software, set the
4221: PYTHON_VERSIONS_INCOMPATIBLE variable to the Python versions that are not
4222: supported, e.g.
1.1 dsieger 4223:
1.184 rillig 4224: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.1 dsieger 4225:
1.249 gutterid 4226: If the packaged software is a Python module, include ../../lang/python/
1.253 gutterid 4227: wheel.mk. Note per PEP-518, the minimum and default requirements to create .whl
1.255 ! wiz 4228: files are devel/py-setuptools plus devel/py-wheel; however, there are various
! 4229: other possible tools that projects can use. Thus inclusion of wheel.mk does not
! 4230: imply these defaults are defined as TOOL_DEPENDS. Whatever the project
! 4231: specifically requires as packaging tools must be defined in the package
! 4232: Makefile.
1.1 dsieger 4233:
1.248 wiz 4234: The package directory should be called "py-software" and PKGNAME should be set
4235: to "${PYPKGPREFIX}-${DISTNAME}", e.g.
1.1 dsieger 4236:
1.184 rillig 4237: DISTNAME= foopymodule-1.2.10
4238: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
1.1 dsieger 4239:
1.226 gutterid 4240: For software in PyPi, the name should match what PyPi specifies for "pip
4241: install software".
4242:
1.184 rillig 4243: If it is an application, include "../../lang/python/application.mk". In order
4244: to correctly set the path to the Python interpreter, use the REPLACE_PYTHON
4245: variable and set it to the list of files (paths relative to WRKSRC) that must
4246: be corrected. For example:
1.1 dsieger 4247:
1.184 rillig 4248: REPLACE_PYTHON= *.py
1.1 dsieger 4249:
1.219 nia 4250: 14.1.2. R packages
1.1 dsieger 4251:
1.184 rillig 4252: Simple R packages from CRAN are handled automatically by R2pkg, which is
4253: available in pkgtools/R2pkg. Individual packages (and optionally their
4254: dependencies) may be created and updated. R packages generally follow the same
4255: form, and most of the relevant information needed is contained in a DESCRIPTION
4256: file as part of each R package on CRAN. Consequently, R2pkg downloads that
4257: information and creates or updates a package in the canonical form. The
4258: resulting package should be reviewed for correctness.
1.1 dsieger 4259:
1.219 nia 4260: 14.1.3. TeXlive packages
1.1 dsieger 4261:
1.184 rillig 4262: TeXlive packages from CTAN are handled automatically by texlive2pkg, which is
4263: available in pkgtools/texlive2pkg.
1.1 dsieger 4264:
1.184 rillig 4265: If the TeXlive package name is not known, it may be useful to search CTAN. A "
4266: Contained in" field on the package page typically identifies the basename of
4267: the package file in the TeXlive archive.
1.1 dsieger 4268:
1.184 rillig 4269: If the TeXlive package name is known, download the files from the TeXlive
4270: archive. For package foo, you will need to download foo.tar.xz. Most TeXlive
4271: packages also have associated documentation packages, so download
4272: foo.doc.tar.xz at the same time. These files should be placed in the
4273: appropriate category directory, which is often but not always print. Then run
4274: the following command in the category directory.
1.1 dsieger 4275:
1.184 rillig 4276: texlive2pkg foo.tar.xz foo.doc.tar.xz
1.1 dsieger 4277:
1.184 rillig 4278: This will create two packages, tex-foo and tex-foo-doc. Be sure to check that
4279: both packages are correct.
1.1 dsieger 4280:
1.184 rillig 4281: Finally, CTAN currently does not include version information in package
4282: filenames and changes their contents periodically when updates occur.
4283: Consequently, pkgsrc avoids downloading distfiles directly from CTAN and
4284: instead relies on the pkgsrc archives. For each new or updated TeXlive package,
4285: e.g., the main one and the corresponding documentation, upload the distfiles
4286: with the following command in each package directory.
1.1 dsieger 4287:
1.184 rillig 4288: make upload-distfiles
1.117 sevan 4289:
1.184 rillig 4290: 14.2. Examples
1.117 sevan 4291:
1.184 rillig 4292: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 4293:
1.184 rillig 4294: 14.2.1.1. The initial package
1.1 dsieger 4295:
1.184 rillig 4296: Looking at the file pkgsrc/doc/TODO, I saw that the "nvu" package has not yet
4297: been imported into pkgsrc. As the description says it has to do with the web,
4298: the obvious choice for the category is "www".
1.1 dsieger 4299:
1.184 rillig 4300: $ mkdir www/nvu
4301: $ cd www/nvu
1.1 dsieger 4302:
1.184 rillig 4303: The web site says that the sources are available as a tar file, so I fed that
4304: URL to the url2pkg program:
1.1 dsieger 4305:
1.184 rillig 4306: $ url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.1 dsieger 4307:
1.184 rillig 4308: My editor popped up, and I added a PKGNAME line below the DISTNAME line, as the
4309: package name should not have the word "sources" in it. I also filled in the
4310: MAINTAINER, HOMEPAGE and COMMENT fields. Then the package Makefile looked like
4311: that:
1.1 dsieger 4312:
1.184 rillig 4313: # $NetBSD $
4314: #
1.1 dsieger 4315:
1.184 rillig 4316: DISTNAME= nvu-1.0-sources
4317: PKGNAME= nvu-1.0
4318: CATEGORIES= www
4319: MASTER_SITES= http://cvs.nvu.com/download/
4320: EXTRACT_SUFX= .tar.bz2
1.1 dsieger 4321:
1.184 rillig 4322: MAINTAINER= rillig@NetBSD.org
4323: HOMEPAGE= http://cvs.nvu.com/
4324: COMMENT= Web Authoring System
1.1 dsieger 4325:
1.184 rillig 4326: # url2pkg-marker (please do not remove this line.)
4327: .include "../../mk/bsd.pkg.mk"
1.1 dsieger 4328:
1.184 rillig 4329: On the first line of output above, an artificial space has been added between
4330: NetBSD and $, this is a workaround to prevent CVS expanding to the filename of
4331: the guide.
1.1 dsieger 4332:
1.184 rillig 4333: Then, I quit the editor and watched pkgsrc downloading a large source archive:
1.1 dsieger 4334:
1.184 rillig 4335: url2pkg> Running "make makesum" ...
4336: => Required installed package digest>=20010302: digest-20060826 found
4337: => Fetching nvu-1.0-sources.tar.bz2
4338: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4339: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4340: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4341: url2pkg> Running "make extract" ...
4342: => Required installed package digest>=20010302: digest-20060826 found
4343: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4344: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4345: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4346: ===> Installing dependencies for nvu-1.0
4347: ===> Overriding tools for nvu-1.0
4348: ===> Extracting for nvu-1.0
4349: url2pkg> Adjusting the Makefile.
1.1 dsieger 4350:
1.184 rillig 4351: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.1 dsieger 4352:
1.184 rillig 4353: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.1 dsieger 4354:
1.184 rillig 4355: 14.2.1.2. Fixing all kinds of problems to make the package work
1.1 dsieger 4356:
1.184 rillig 4357: Now that the package has been extracted, let's see what's inside it. The
4358: package has a README.txt, but that only says something about mozilla, so it's
4359: probably useless for seeing what dependencies this package has. But since there
4360: is a GNU configure script in the package, let's hope that it will complain
4361: about everything it needs.
1.1 dsieger 4362:
1.184 rillig 4363: $ bmake
4364: => Required installed package digest>=20010302: digest-20060826 found
4365: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4366: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4367: ===> Patching for nvu-1.0
4368: ===> Creating toolchain wrappers for nvu-1.0
4369: ===> Configuring for nvu-1.0
4370: [...]
4371: configure: error: Perl 5.004 or higher is required.
4372: [...]
4373: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4374: [...]
1.1 dsieger 4375:
1.184 rillig 4376: That worked quite well. So I opened the package Makefile in my editor, and
4377: since it already has a USE_TOOLS line, I just appended "perl" to it. Since the
4378: dependencies of the package have changed now, and since a perl wrapper is
4379: automatically installed in the "tools" phase, I need to build the package from
4380: scratch.
1.1 dsieger 4381:
1.184 rillig 4382: $ bmake clean
4383: ===> Cleaning for nvu-1.0
4384: $ bmake
4385: [...]
4386: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4387: GNU Make. You will not be able to build Mozilla without GNU Make.
4388: [...]
1.1 dsieger 4389:
1.184 rillig 4390: So I added "gmake" to the USE_TOOLS line and tried again (from scratch).
1.1 dsieger 4391:
1.184 rillig 4392: [...]
4393: checking for GTK - version >= 1.2.0... no
4394: *** Could not run GTK test program, checking why...
4395: [...]
1.1 dsieger 4396:
1.184 rillig 4397: Now to the other dependencies. The first question is: Where is the GTK package
4398: hidden in pkgsrc?
1.1 dsieger 4399:
1.184 rillig 4400: $ echo ../../*/gtk*
4401: [many packages ...]
4402: $ echo ../../*/gtk
4403: ../../x11/gtk
4404: $ echo ../../*/gtk2
4405: ../../x11/gtk2
4406: $ echo ../../*/gtk2/bui*
4407: ../../x11/gtk2/buildlink3.mk
1.1 dsieger 4408:
1.184 rillig 4409: The first try was definitely too broad. The second one had exactly one result,
4410: which is very good. But there is one pitfall with GNOME packages. Before GNOME
4411: 2 had been released, there were already many GNOME 1 packages in pkgsrc. To be
4412: able to continue to use these packages, the GNOME 2 packages were imported as
4413: separate packages, and their names usually have a "2" appended. So I checked
4414: whether this was the case here, and indeed it was.
1.1 dsieger 4415:
1.184 rillig 4416: Since the GTK2 package has a buildlink3.mk file, adding the dependency is very
4417: easy. I just inserted an .include line before the last line of the package
4418: Makefile, so that it now looks like this:
1.1 dsieger 4419:
1.184 rillig 4420: [...]
4421: .include "../../x11/gtk2/buildlink3.mk"
4422: .include "../../mk/bsd.pkg.mk
1.1 dsieger 4423:
1.184 rillig 4424: After another bmake clean && bmake, the answer was:
1.108 rillig 4425:
1.184 rillig 4426: [...]
4427: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4428: checking for GTK - version >= 1.2.0... no
4429: *** Could not run GTK test program, checking why...
4430: *** The test program failed to compile or link. See the file config.log for the
4431: *** exact error that occured. This usually means GTK was incorrectly installed
4432: *** or that you have moved GTK since it was installed. In the latter case, you
4433: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4434: configure: error: Test for GTK failed.
4435: [...]
1.1 dsieger 4436:
1.184 rillig 4437: In this particular case, the assumption that "every package prefers GNOME 2"
4438: had been wrong. The first of the lines above told me that this package really
4439: wanted to have the GNOME 1 version of GTK. If the package had looked for GTK2,
4440: it would have looked for pkg-config instead of gtk-config. So I changed the x11
4441: /gtk2 to x11/gtk in the package Makefile, and tried again.
1.1 dsieger 4442:
1.184 rillig 4443: [...]
4444: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
4445: In file included from xpidl.c:42:
4446: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4447: In file included from xpidl.c:42:
4448: xpidl.h:132: error: parse error before "IDL_ns"
4449: [...]
1.1 dsieger 4450:
1.184 rillig 4451: The package still does not find all of its dependencies. Now the question is:
4452: Which package provides the libIDL/IDL.h header file?
1.1 dsieger 4453:
1.184 rillig 4454: $ echo ../../*/*idl*
4455: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4456: $ echo ../../*/*IDL*
4457: ../../net/libIDL
1.1 dsieger 4458:
1.184 rillig 4459: Let's take the one from the second try. So I included the ../../net/libIDL/
4460: buildlink3.mk file and tried again. But the error didn't change. After digging
4461: through some of the code, I concluded that the build process of the package was
4462: broken and couldn't have ever worked, but since the Mozilla source tree is
4463: quite large, I didn't want to fix it. So I added the following to the package
4464: Makefile and tried again:
1.1 dsieger 4465:
1.184 rillig 4466: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4467: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.1 dsieger 4468:
1.184 rillig 4469: The latter line is needed because the package expects the library libIDL.so,
4470: but only libIDL-2.so is available. So I told the compiler wrapper to rewrite
4471: that on the fly.
1.1 dsieger 4472:
1.184 rillig 4473: The next problem was related to a recent change of the FreeType interface. I
4474: looked up in www/seamonkey which patch files were relevant for this issue and
4475: copied them to the patches directory. Then I retried, fixed the patches so that
4476: they applied cleanly and retried again. This time, everything worked.
1.1 dsieger 4477:
1.184 rillig 4478: 14.2.1.3. Installing the package
1.1 dsieger 4479:
1.184 rillig 4480: $ bmake CHECK_FILES=no install
4481: [...]
4482: $ bmake print-PLIST >PLIST
4483: $ bmake deinstall
4484: $ bmake install
1.1 dsieger 4485:
1.184 rillig 4486: Chapter 15. Programming in Makefiles
1.1 dsieger 4487:
1.184 rillig 4488: Table of Contents
1.1 dsieger 4489:
1.184 rillig 4490: 15.1. Caveats
4491: 15.2. Makefile variables
4492: 15.2.1. Naming conventions
4493: 15.3. Code snippets
4494: 15.3.1. Adding things to a list
4495: 15.3.2. Echoing a string exactly as-is
4496: 15.3.3. Passing CFLAGS to GNU configure scripts
4497: 15.3.4. Handling possibly empty variables
1.229 gutterid 4498: 15.3.5. Testing yes/no variables in conditions
1.1 dsieger 4499:
1.184 rillig 4500: Pkgsrc consists of many Makefile fragments, each of which forms a well-defined
4501: part of the pkgsrc system. Using the make(1) system as a programming language
4502: for a big system like pkgsrc requires some discipline to keep the code correct
4503: and understandable.
1.1 dsieger 4504:
1.184 rillig 4505: The basic ingredients for Makefile programming are variables and shell
4506: commands. Among these shell commands may even be more complex ones like awk(1)
4507: programs. To make sure that every shell command runs as intended it is
4508: necessary to quote all variables correctly when they are used.
1.1 dsieger 4509:
1.184 rillig 4510: This chapter describes some patterns that appear quite often in Makefiles,
4511: including the pitfalls that come along with them.
1.1 dsieger 4512:
1.184 rillig 4513: 15.1. Caveats
1.1 dsieger 4514:
1.184 rillig 4515: * When you are creating a file as a target of a rule, always write the data
4516: to a temporary file first and finally rename that file. Otherwise there
4517: might occur an error in the middle of generating the file, and when the
4518: user runs make(1) for the second time, the file exists and will not be
4519: regenerated properly. Example:
1.1 dsieger 4520:
1.184 rillig 4521: wrong:
4522: @echo "line 1" > ${.TARGET}
4523: @echo "line 2" >> ${.TARGET}
4524: @false
1.1 dsieger 4525:
1.184 rillig 4526: correct:
4527: @echo "line 1" > ${.TARGET}.tmp
4528: @echo "line 2" >> ${.TARGET}.tmp
4529: @false
4530: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 4531:
1.184 rillig 4532: When you run make wrong twice, the file wrong will exist, although there
4533: was an error message in the first run. On the other hand, running make
4534: correct gives an error message twice, as expected.
1.1 dsieger 4535:
1.184 rillig 4536: You might remember that make(1) sometimes removes ${.TARGET} in case of
4537: error, but this only happens when it is interrupted, for example by
4538: pressing Ctrl+C. This does not happen when one of the commands fails (like
4539: false(1) above).
1.1 dsieger 4540:
1.184 rillig 4541: 15.2. Makefile variables
1.1 dsieger 4542:
1.184 rillig 4543: Makefile variables contain strings that can be processed using the five
4544: operators =, +=, ?=, := and !=, which are described in the make(1) man page.
1.1 dsieger 4545:
1.184 rillig 4546: When a variable's value is parsed from a Makefile, the hash character # and the
4547: backslash character \ are handled specially. If a backslash is the last
4548: character in a line, that backslash is removed from the line and the line
4549: continues with the next line of the file.
1.1 dsieger 4550:
1.184 rillig 4551: The # character starts a comment that reaches until the end of the line. To get
4552: an actual # character, such as in a URL, write \# instead.
1.1 dsieger 4553:
1.184 rillig 4554: The evaluation of variables either happens immediately or lazy. It happens
4555: immediately when the variable occurs on the right-hand side of the := or the !=
4556: operator, in a .if condition or a .for loop. In the other cases, it is
4557: evaluated lazily.
1.1 dsieger 4558:
1.184 rillig 4559: Some of the modifiers split the string into words and then operate on the
4560: words, others operate on the string as a whole. When a string is split into
4561: words, double quotes and single quotes are interpreted as delimiters, just like
4562: in sh(1).
1.1 dsieger 4563:
1.184 rillig 4564: 15.2.1. Naming conventions
1.1 dsieger 4565:
1.184 rillig 4566: * All variable names starting with an underscore are reserved for use by the
4567: pkgsrc infrastructure. They shall not be used by packages.
1.1 dsieger 4568:
1.184 rillig 4569: * In .for loops you should use lowercase variable names for the iteration
4570: variables.
1.1 dsieger 4571:
1.184 rillig 4572: * All list variables should have a plural name, such as PKG_OPTIONS or
4573: DISTFILES.
1.1 dsieger 4574:
1.184 rillig 4575: 15.3. Code snippets
1.1 dsieger 4576:
1.184 rillig 4577: 15.3.1. Adding things to a list
1.1 dsieger 4578:
1.184 rillig 4579: When adding a string that possibly contains whitespace or quotes to a list
4580: (example 1), it must be quoted using the :Q modifier.
1.1 dsieger 4581:
1.184 rillig 4582: When adding another list to a list (example 2), it must not be quoted, since
4583: its elements are already quoted.
1.1 dsieger 4584:
1.184 rillig 4585: STRING= foo * bar `date`
4586: LIST= # empty
4587: ANOTHER_LIST= a=b c=d
1.1 dsieger 4588:
1.184 rillig 4589: LIST+= ${STRING:Q} # 1
4590: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4591:
1.184 rillig 4592: 15.3.2. Echoing a string exactly as-is
1.1 dsieger 4593:
1.184 rillig 4594: Echoing a string containing special characters needs special work.
1.1 dsieger 4595:
1.184 rillig 4596: STRING= foo bar < > * `date` $$HOME ' "
4597: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4598:
1.184 rillig 4599: all:
4600: echo ${STRING} # 1
4601: echo ${STRING:Q} # 2
4602: printf '%s\n' ${STRING:Q}'' # 3
4603: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 4604:
1.184 rillig 4605: Example 1 leads to a syntax error in the shell, as the characters are just
4606: copied.
1.1 dsieger 4607:
1.184 rillig 4608: Example 2 quotes the string so that the shell interprets it correctly. But the
4609: echo command may additionally interpret strings with a leading dash or those
4610: containing backslashes.
1.1 dsieger 4611:
1.184 rillig 4612: Example 3 can handle arbitrary strings, since printf(1) only interprets the
4613: format string, but not the next argument. The trailing single quotes handle the
4614: case when the string is empty. In that case, the :Q modifier would result in an
4615: empty string too, which would then be skipped by the shell. For printf(1) this
4616: doesn't make a difference, but other programs may care.
1.1 dsieger 4617:
1.184 rillig 4618: In example 4, the EXAMPLE_ENV does not need to be quoted because the quoting
4619: has already been done when adding elements to the list.
1.1 dsieger 4620:
1.184 rillig 4621: 15.3.3. Passing CFLAGS to GNU configure scripts
1.1 dsieger 4622:
1.184 rillig 4623: When passing CFLAGS or similar variables to a GNU-style configure script
4624: (especially those that call other configure scripts), it must not have leading
4625: or trailing whitespace, since otherwise the configure script gets confused. To
4626: trim leading and trailing whitespace, use the :M modifier, as in the following
4627: example:
1.1 dsieger 4628:
1.184 rillig 4629: CPPFLAGS= # empty
4630: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
4631: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 4632:
1.184 rillig 4633: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 4634:
1.184 rillig 4635: all:
4636: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4637: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4638:
1.184 rillig 4639: In this example, CPPFLAGS has both leading and trailing whitespace because the
4640: += operator always adds a space.
1.1 dsieger 4641:
1.184 rillig 4642: 15.3.4. Handling possibly empty variables
1.1 dsieger 4643:
1.184 rillig 4644: When a possibly empty variable is used in a shell program, it may lead to a
4645: syntax error.
1.1 dsieger 4646:
1.184 rillig 4647: EGFILES= # empty
1.1 dsieger 4648:
1.184 rillig 4649: install-examples: # produces a syntax error in the shell
4650: for egfile in ${EGFILES}; do \
4651: echo "Installing $$egfile"; \
4652: done
1.1 dsieger 4653:
1.184 rillig 4654: The shell only sees the text for egfile in ; do, since ${EGFILES} is replaced
4655: with an empty string by make(1). To fix this syntax error, use one of the
4656: snippets below.
1.1 dsieger 4657:
1.229 gutterid 4658: EGFILES= # empty
1.1 dsieger 4659:
1.184 rillig 4660: install-examples:
4661: for egfile in ${EGFILES} ""; do \
4662: [ -n "$$egfile" ] || continue; \
4663: echo "Installing $$egfile"; \
4664: done
1.1 dsieger 4665:
1.184 rillig 4666: In this case, an empty string is appended to the iteration list (to prevent the
4667: syntax error) and filtered out later.
1.1 dsieger 4668:
1.184 rillig 4669: EGFILES= # empty
1.1 dsieger 4670:
1.184 rillig 4671: install-examples:
4672: .for egfile in ${EGFILES}
4673: echo "Installing ${egfile}"
4674: .endfor
1.1 dsieger 4675:
1.184 rillig 4676: If one of the filenames contains special characters, it should be enclosed in
4677: single or double quotes.
1.1 dsieger 4678:
1.184 rillig 4679: To have a shell command test whether a make variable is empty, use the
4680: following code: ${TEST} -z ${POSSIBLY_EMPTY:Q}"".
1.1 dsieger 4681:
1.229 gutterid 4682: 15.3.5. Testing yes/no variables in conditions
4683:
4684: When a variable can have the values yes or no, use the following pattern to
4685: test the variable:
4686:
4687: .if ${VAR:U:tl} == "yes"
4688: # do something
4689: .endif
4690:
4691: The :U modifier is only necessary if the variable can be undefined. If the
4692: variable is guaranteed to be defined, the :U can be omitted.
4693:
4694: The :tl modifier converts the variable value to lowercase, allowing for the
4695: values yes, Yes, YES.
4696:
1.184 rillig 4697: Chapter 16. Options handling
1.1 dsieger 4698:
4699: Table of Contents
4700:
1.184 rillig 4701: 16.1. Global default options
4702: 16.2. Converting packages to use bsd.options.mk
4703: 16.3. Option Names
4704: 16.4. Determining the options of dependencies
1.1 dsieger 4705:
4706: Many packages have the ability to be built to support different sets of
4707: features. bsd.options.mk is a framework in pkgsrc that provides generic
4708: handling of those options that determine different ways in which the packages
4709: can be built. It's possible for the user to specify exactly which sets of
4710: options will be built into a package or to allow a set of global default
4711: options apply.
4712:
1.7 rillig 4713: There are two broad classes of behaviors that one might want to control via
4714: options. One is whether some particular feature is enabled in a program that
4715: will be built anyway, often by including or not including a dependency on some
4716: other package. The other is whether or not an additional program will be built
4717: as part of the package. Generally, it is better to make a split package for
4718: such additional programs instead of using options, because it enables binary
4719: packages to be built which can then be added separately. For example, the foo
4720: package might have minimal dependencies (those packages without which foo
4721: doesn't make sense), and then the foo-gfoo package might include the GTK
4722: frontend program gfoo. This is better than including a gtk option to foo that
4723: adds gfoo, because either that option is default, in which case binary users
4724: can't get foo without gfoo, or not default, in which case they can't get gfoo.
4725: With split packages, they can install foo without having GTK, and later decide
4726: to install gfoo (pulling in GTK at that time). This is an advantage to source
4727: users too, avoiding the need for rebuilds.
4728:
4729: Plugins with widely varying dependencies should usually be split instead of
4730: options.
4731:
4732: It is often more work to maintain split packages, especially if the upstream
4733: package does not support this. The decision of split vs. option should be made
4734: based on the likelihood that users will want or object to the various pieces,
4735: the size of the dependencies that are included, and the amount of work.
4736:
4737: A further consideration is licensing. Non-free parts, or parts that depend on
4738: non-free dependencies (especially plugins) should almost always be split if
4739: feasible.
4740:
1.184 rillig 4741: 16.1. Global default options
1.1 dsieger 4742:
4743: Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of
4744: the options that should be built into every package if that option is
1.4 rillig 4745: supported. This variable should be set in mk.conf.
1.1 dsieger 4746:
1.184 rillig 4747: 16.2. Converting packages to use bsd.options.mk
1.1 dsieger 4748:
4749: The following example shows how bsd.options.mk should be used by the
4750: hypothetical ``wibble'' package, either in the package Makefile, or in a file,
4751: e.g. options.mk, that is included by the main package Makefile.
4752:
4753: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
4754: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
4755: PKG_OPTIONS_OPTIONAL_GROUPS= database
4756: PKG_OPTIONS_GROUP.database= mysql pgsql
4757: PKG_SUGGESTED_OPTIONS= wibble-foo
4758: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
4759: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
4760:
4761: .include "../../mk/bsd.prefs.mk"
4762:
4763: # this package was previously named wibble2
4764: .if defined(PKG_OPTIONS.wibble2)
4765: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
4766: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
4767: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
4768: .endif
4769:
4770: .include "../../mk/bsd.options.mk"
4771:
4772: # Package-specific option-handling
4773:
4774: ###
4775: ### FOO support
4776: ###
4777: .if !empty(PKG_OPTIONS:Mwibble-foo)
4778: CONFIGURE_ARGS+= --enable-foo
4779: .endif
4780:
4781: ###
4782: ### LDAP support
4783: ###
4784: .if !empty(PKG_OPTIONS:Mldap)
4785: . include "../../databases/openldap-client/buildlink3.mk"
4786: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
4787: .endif
4788:
4789: ###
4790: ### database support
4791: ###
4792: .if !empty(PKG_OPTIONS:Mmysql)
4793: . include "../../mk/mysql.buildlink3.mk"
4794: .endif
4795: .if !empty(PKG_OPTIONS:Mpgsql)
4796: . include "../../mk/pgsql.buildlink3.mk"
4797: .endif
4798:
4799: The first section contains the information about which build options are
4800: supported by the package, and any default options settings if needed.
4801:
4802: 1. PKG_OPTIONS_VAR is the name of the make(1) variable that the user can set
4803: to override the default options. It should be set to PKG_OPTIONS.pkgbase.
4804: Do not set it to PKG_OPTIONS.${PKGBASE}, since PKGBASE is not defined at
4805: the point where the options are processed.
4806:
4807: 2. PKG_SUPPORTED_OPTIONS is a list of build options supported by the package.
4808:
4809: 3. PKG_OPTIONS_OPTIONAL_GROUPS is a list of names of groups of mutually
4810: exclusive options. The options in each group are listed in
4811: PKG_OPTIONS_GROUP.groupname. The most specific setting of any option from
4812: the group takes precedence over all other options in the group. Options
4813: from the groups will be automatically added to PKG_SUPPORTED_OPTIONS.
4814:
4815: 4. PKG_OPTIONS_REQUIRED_GROUPS is like PKG_OPTIONS_OPTIONAL_GROUPS, but
4816: building the packages will fail if no option from the group is selected.
4817:
4818: 5. PKG_OPTIONS_NONEMPTY_SETS is a list of names of sets of options. At least
4819: one option from each set must be selected. The options in each set are
4820: listed in PKG_OPTIONS_SET.setname. Options from the sets will be
4821: automatically added to PKG_SUPPORTED_OPTIONS. Building the package will
4822: fail if no option from the set is selected.
4823:
4824: 6. PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
4825: default.
4826:
4827: 7. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE:option" pairs that map
1.4 rillig 4828: legacy mk.conf variables to their option counterparts. Pairs should be
1.1 dsieger 4829: added with "+=" to keep the listing of global legacy variables. A warning
4830: will be issued if the user uses a legacy variable.
4831:
4832: 8. PKG_OPTIONS_LEGACY_OPTS is a list of "old-option:new-option" pairs that map
4833: options that have been renamed to their new counterparts. Pairs should be
4834: added with "+=" to keep the listing of global legacy options. A warning
4835: will be issued if the user uses a legacy option.
4836:
4837: 9. PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
4838: used. This can be used for cases that neither PKG_OPTIONS_LEGACY_VARS nor
4839: PKG_OPTIONS_LEGACY_OPTS can handle, e. g. when PKG_OPTIONS_VAR is renamed.
4840:
4841: 10. PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
4842: variables or options used, and what to use instead.
4843:
4844: A package should never modify PKG_DEFAULT_OPTIONS or the variable named in
4845: PKG_OPTIONS_VAR. These are strictly user-settable. To suggest a default set of
4846: options, use PKG_SUGGESTED_OPTIONS.
4847:
4848: PKG_OPTIONS_VAR must be defined before including bsd.options.mk. If none of
4849: PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and
4850: PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform-specific
4851: options if none of them is supported on the current platform), PKG_OPTIONS is
4852: set to the empty list and the package is otherwise treated as not using the
4853: options framework.
4854:
4855: After the inclusion of bsd.options.mk, the variable PKG_OPTIONS contains the
4856: list of selected build options, properly filtered to remove unsupported and
4857: duplicate options.
4858:
4859: The remaining sections contain the logic that is specific to each option. The
4860: correct way to check for an option is to check whether it is listed in
4861: PKG_OPTIONS:
4862:
4863: .if !empty(PKG_OPTIONS:Moption)
4864:
1.184 rillig 4865: 16.3. Option Names
1.1 dsieger 4866:
4867: Options that enable similar features in different packages (like optional
4868: support for a library) should use a common name in all packages that support it
4869: (like the name of the library). If another package already has an option with
4870: the same meaning, use the same name.
4871:
4872: Options that enable features specific to one package, where it's unlikely that
4873: another (unrelated) package has the same (or a similar) optional feature,
4874: should use a name prefixed with pkgname-.
4875:
4876: If a group of related packages share an optional feature specific to that
4877: group, prefix it with the name of the "main" package (e. g.
4878: djbware-errno-hack).
4879:
4880: For new options, add a line to mk/defaults/options.description. Lines have two
4881: fields, separated by tab. The first field is the option name, the second its
4882: description. The description should be a whole sentence (starting with an
4883: uppercase letter and ending with a period) that describes what enabling the
4884: option does. E. g. "Enable ispell support." The file is sorted by option names.
4885:
1.184 rillig 4886: 16.4. Determining the options of dependencies
1.7 rillig 4887:
4888: When writing buildlink3.mk files, it is often necessary to list different
4889: dependencies based on the options with which the package was built. For
4890: querying these options, the file pkgsrc/mk/pkg-build-options.mk should be used.
4891: A typical example looks like this:
4892:
4893: pkgbase := libpurple
4894: .include "../../mk/pkg-build-options.mk"
4895:
4896: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
4897: ...
4898: .endif
4899:
4900: Including pkg-build-options.mk here will set the variable
4901: PKG_BUILD_OPTIONS.libpurple to the build options of the libpurple package,
4902: which can then be queried like PKG_OPTIONS in the options.mk file. See the file
4903: pkg-build-options.mk for more details.
4904:
1.184 rillig 4905: Chapter 17. Tools needed for building or running
4906:
4907: Table of Contents
4908:
4909: 17.1. Tools for pkgsrc builds
4910: 17.2. Tools needed by packages
4911: 17.3. Tools provided by platforms
4912:
4913: The USE_TOOLS definition is used both internally by pkgsrc and also for
4914: individual packages to define what commands are needed for building a package
4915: (like TOOL_DEPENDS) or for later run-time of an installed packaged (such as
4916: DEPENDS). If the native system provides an adequate tool, then in many cases, a
4917: pkgsrc package will not be used.
4918:
4919: When building a package, the replacement tools are made available in a
4920: directory (as symlinks or wrapper scripts) that is early in the executable
4921: search path. Just like the buildlink system, this helps with consistent builds.
4922:
4923: A tool may be needed to help build a specific package. For example, perl, GNU
4924: make (gmake) or yacc may be needed.
4925:
4926: Also a tool may be needed, for example, because the native system's supplied
4927: tool may be inefficient for building a package with pkgsrc. For example, a
4928: package may need GNU awk, bison (instead of yacc) or a better sed.
4929:
4930: The tools used by a package can be listed by running make show-tools.
4931:
4932: 17.1. Tools for pkgsrc builds
4933:
4934: The default set of tools used by pkgsrc is defined in bsd.pkg.mk. This includes
4935: standard Unix tools, such as: cat, awk, chmod, test, and so on. These can be
4936: seen by running: make show-var VARNAME=USE_TOOLS.
4937:
4938: If a package needs a specific program to build then the USE_TOOLS variable can
4939: be used to define the tools needed.
4940:
4941: 17.2. Tools needed by packages
4942:
4943: In the following examples, the :run means that it is needed at run-time (and
4944: becomes a DEPENDS). The default is a build dependency which can be set with
4945: :build. (So in this example, it is the same as gmake:build and
4946: pkg-config:build.)
4947:
4948: USE_TOOLS+= gmake perl:run pkg-config
4949:
4950: When using the tools framework, a TOOLS_PATH.foo variable is defined which
4951: contains the full path to the appropriate tool. For example, TOOLS_PATH.bash
4952: could be "/bin/bash" on Linux systems.
4953:
4954: If you always need a pkgsrc version of the tool at run-time, then just use
4955: DEPENDS instead.
4956:
4957: 17.3. Tools provided by platforms
4958:
4959: When improving or porting pkgsrc to a new platform, have a look at (or create)
4960: the corresponding platform specific make file fragment under pkgsrc/mk/tools/
4961: tools.${OPSYS}.mk which defines the name of the common tools. For example:
4962:
4963: .if exists(/usr/bin/bzcat)
4964: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
4965: .elif exists(/usr/bin/bzip2)
4966: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
4967: .endif
4968:
4969: TOOLS_PLATFORM.true?= true # shell builtin
4970:
4971: Chapter 18. Buildlink methodology
1.1 dsieger 4972:
4973: Table of Contents
4974:
1.184 rillig 4975: 18.1. Converting packages to use buildlink3
4976: 18.2. Writing buildlink3.mk files
4977: 18.2.1. Anatomy of a buildlink3.mk file
4978: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
1.232 gutterid 4979: buildlink3.mk files
1.184 rillig 4980: 18.3. Writing builtin.mk files
4981: 18.3.1. Anatomy of a builtin.mk file
4982:
4983: Buildlink is a framework in pkgsrc that controls what headers and libraries are
4984: seen by a package's configure and build processes. This is implemented in a two
4985: step process:
4986:
4987: 1. Symlink headers and libraries for dependencies into BUILDLINK_DIR, which by
4988: default is a subdirectory of WRKDIR.
4989:
4990: 2. Create wrapper scripts that are used in place of the normal compiler tools
4991: that translate -I${LOCALBASE}/include and -L${LOCALBASE}/lib into
4992: references to BUILDLINK_DIR. The wrapper scripts also make native compiler
4993: on some operating systems look like GCC, so that packages that expect GCC
4994: won't require modifications to build with those native compilers.
4995:
4996: This normalizes the environment in which a package is built so that the package
4997: may be built consistently despite what other software may be installed. Please
4998: note that the normal system header and library paths, e.g. /usr/include, /usr/
4999: lib, etc., are always searched -- buildlink3 is designed to insulate the
5000: package build from non-system-supplied software.
5001:
5002: 18.1. Converting packages to use buildlink3
1.1 dsieger 5003:
1.184 rillig 5004: The process of converting packages to use the buildlink3 framework ("bl3ifying"
5005: ) is fairly straightforward. The things to keep in mind are:
1.1 dsieger 5006:
1.184 rillig 5007: 1. Ensure that the build always calls the wrapper scripts instead of the
5008: actual toolchain. Some packages are tricky, and the only way to know for
5009: sure is the check ${WRKDIR}/.work.log to see if the wrappers are being
5010: invoked.
1.1 dsieger 5011:
1.184 rillig 5012: 2. Don't override PREFIX from within the package Makefile, e.g. Java VMs,
5013: standalone shells, etc., because the code to symlink files into $
5014: {BUILDLINK_DIR} looks for files relative to "pkg_info -qp pkgname".
1.1 dsieger 5015:
1.184 rillig 5016: 3. Remember that only the buildlink3.mk files that you list in a package's
5017: Makefile are added as dependencies for that package.
1.1 dsieger 5018:
1.184 rillig 5019: If a dependency on a particular package is required for its libraries and
5020: headers, then we replace:
1.1 dsieger 5021:
1.184 rillig 5022: DEPENDS+= foo>=1.1.0:../../category/foo
1.1 dsieger 5023:
1.184 rillig 5024: with
1.1 dsieger 5025:
1.184 rillig 5026: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 5027:
1.184 rillig 5028: The buildlink3.mk files usually define the required dependencies. If you need a
5029: newer version of the dependency when using buildlink3.mk files, then you can
5030: define it in your Makefile; for example:
1.1 dsieger 5031:
1.184 rillig 5032: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5033: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 5034:
1.184 rillig 5035: There are several buildlink3.mk files in pkgsrc/mk that handle special package
5036: issues:
1.1 dsieger 5037:
1.184 rillig 5038: * bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB
5039: implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT.
1.1 dsieger 5040:
1.184 rillig 5041: * curses.buildlink3.mk: If the system comes with neither Curses nor NCurses,
5042: this will take care to install the devel/ncurses package.
1.1 dsieger 5043:
1.184 rillig 5044: * krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding
5045: a dependency on Heimdal or MIT-krb5 for packages that require a Kerberos 5
5046: implementation.
1.1 dsieger 5047:
1.184 rillig 5048: * motif.buildlink3.mk checks for a system-provided Motif installation or adds
5049: a dependency on x11/lesstif or x11/motif. The user can set MOTIF_TYPE to "
5050: dt", "lesstif" or "motif" to choose which Motif version will be used.
1.1 dsieger 5051:
1.184 rillig 5052: * readline.buildlink3.mk checks for a system-provided GNU readline or
5053: editline (libedit) installation, or adds a dependency on devel/readline,
5054: devel/editline. The user can set READLINE_DEFAULT to choose readline
5055: implementation. If your package really needs GNU readline library, its
5056: Makefile should include devel/readline/buildlink3.mk instead of
5057: readline.buildlink3.mk.
1.1 dsieger 5058:
1.184 rillig 5059: * oss.buildlink3.mk defines several variables that may be used by packages
5060: that use the Open Sound System (OSS) API.
1.1 dsieger 5061:
1.184 rillig 5062: * pgsql.buildlink3.mk will accept any of the Postgres versions in the
5063: variable PGSQL_VERSIONS_ACCEPTED and default to the version
5064: PGSQL_VERSION_DEFAULT. See the file for more information.
1.1 dsieger 5065:
1.184 rillig 5066: * pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native
5067: pthreads or adds a dependency on devel/pth as needed.
1.1 dsieger 5068:
1.184 rillig 5069: * xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena
5070: widgets library.
1.1 dsieger 5071:
1.184 rillig 5072: The comments in those buildlink3.mk files provide a more complete description
5073: of how to use them properly.
1.1 dsieger 5074:
1.184 rillig 5075: 18.2. Writing buildlink3.mk files
1.1 dsieger 5076:
1.184 rillig 5077: A package's buildlink3.mk file is included by Makefiles to indicate the need to
5078: compile and link against header files and libraries provided by the package. A
5079: buildlink3.mk file should always provide enough information to add the correct
5080: type of dependency relationship and include any other buildlink3.mk files that
5081: it needs to find headers and libraries that it needs in turn.
1.1 dsieger 5082:
1.184 rillig 5083: To generate an initial buildlink3.mk file for further editing, Rene Hexel's
5084: pkgtools/createbuildlink package is highly recommended. For most packages, the
5085: following command will generate a good starting point for buildlink3.mk files:
1.1 dsieger 5086:
1.184 rillig 5087: % cd pkgsrc/category/pkgdir
5088: % createbuildlink >buildlink3.mk
1.1 dsieger 5089:
5090:
1.184 rillig 5091: 18.2.1. Anatomy of a buildlink3.mk file
1.1 dsieger 5092:
1.184 rillig 5093: The following real-life example buildlink3.mk is taken from pkgsrc/graphics/
5094: tiff:
1.14 jmcneill 5095:
1.184 rillig 5096: BUILDLINK_TREE+= tiff
1.1 dsieger 5097:
1.184 rillig 5098: .if !defined(TIFF_BUILDLINK3_MK)
5099: TIFF_BUILDLINK3_MK:=
1.1 dsieger 5100:
1.184 rillig 5101: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5102: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5103: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 5104:
1.184 rillig 5105: .include "../../devel/zlib/buildlink3.mk"
5106: .include "../../graphics/jpeg/buildlink3.mk"
5107: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 5108:
1.184 rillig 5109: BUILDLINK_TREE+= -tiff
1.1 dsieger 5110:
1.184 rillig 5111: The header and footer manipulate BUILDLINK_TREE, which is common across all
5112: buildlink3.mk files and is used to track the dependency tree.
1.1 dsieger 5113:
1.184 rillig 5114: The main section is protected from multiple inclusion and controls how the
5115: dependency on pkg is added. Several important variables are set in the section:
1.1 dsieger 5116:
1.185 wiz 5117: * BUILDLINK_API_DEPENDS.pkg is the dependency version recorded in the
1.184 rillig 5118: installed package; this should always be set using += to ensure that we're
5119: appending to any pre-existing list of values. This variable should be set
1.185 wiz 5120: to the last version of the package that had an backwards-incompatible API
1.184 rillig 5121: change.
1.1 dsieger 5122:
1.184 rillig 5123: * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory.
1.1 dsieger 5124:
1.184 rillig 5125: * BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use
1.236 gutterid 5126: BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency
5127: is selected by setting BUILDLINK_DEPMETHOD.pkg to "build". By default, the
5128: full dependency is used.
1.1 dsieger 5129:
1.184 rillig 5130: * BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS.pkg (not shown above) are lists
5131: of subdirectories of ${BUILDLINK_PREFIX.pkg} to add to the header and
5132: library search paths. These default to "include" and "lib" respectively.
1.1 dsieger 5133:
1.184 rillig 5134: * BUILDLINK_CPPFLAGS.pkg (not shown above) is the list of preprocessor flags
5135: to add to CPPFLAGS, which are passed on to the configure and build phases.
5136: The "-I" option should be avoided and instead be handled using
5137: BUILDLINK_INCDIRS.pkg as above.
1.66 asau 5138:
1.184 rillig 5139: The following variables are all optionally defined within this second section
5140: (protected against multiple inclusion) and control which package files are
5141: symlinked into ${BUILDLINK_DIR} and how their names are transformed during the
5142: symlinking:
1.23 jakllsch 5143:
1.184 rillig 5144: * BUILDLINK_FILES.pkg (not shown above) is a shell glob pattern relative to $
5145: {BUILDLINK_PREFIX.pkg} to be symlinked into ${BUILDLINK_DIR}, e.g. include/
5146: *.h.
1.1 dsieger 5147:
1.184 rillig 5148: * BUILDLINK_FILES_CMD.pkg (not shown above) is a shell pipeline that outputs
5149: to stdout a list of files relative to ${BUILDLINK_PREFIX.pkg}. The
5150: resulting files are to be symlinked into ${BUILDLINK_DIR}. By default, this
5151: takes the +CONTENTS of a pkg and filters it through $
5152: {BUILDLINK_CONTENTS_FILTER.pkg}.
1.1 dsieger 5153:
1.184 rillig 5154: * BUILDLINK_CONTENTS_FILTER.pkg (not shown above) is a filter command that
5155: filters +CONTENTS input into a list of files relative to $
5156: {BUILDLINK_PREFIX.pkg} on stdout. By default, BUILDLINK_CONTENTS_FILTER.pkg
5157: outputs the contents of the include and lib directories in the package
5158: +CONTENTS.
1.1 dsieger 5159:
1.184 rillig 5160: * BUILDLINK_FNAME_TRANSFORM.pkg (not shown above) is a list of sed arguments
5161: used to transform the name of the source filename into a destination
5162: filename, e.g. -e "s|/curses.h|/ncurses.h|g".
1.1 dsieger 5163:
1.184 rillig 5164: This section can additionally include any buildlink3.mk needed for pkg's
5165: library dependencies. Including these buildlink3.mk files means that the
5166: headers and libraries for these dependencies are also symlinked into $
5167: {BUILDLINK_DIR} whenever the pkg buildlink3.mk file is included. Dependencies
5168: are only added for directly include buildlink3.mk files.
1.1 dsieger 5169:
1.184 rillig 5170: When providing a buildlink3.mk and including other buildlink3.mk files in it,
5171: please only add necessary ones, i.e., those whose libraries or header files are
5172: automatically exposed when the package is use.
1.1 dsieger 5173:
1.184 rillig 5174: In particular, if only an executable (bin/foo) is linked against a library,
5175: that library does not need to be propagated in the buildlink3.mk file.
1.1 dsieger 5176:
1.184 rillig 5177: The following steps should help you decide if a buildlink3.mk file needs to be
5178: included:
1.1 dsieger 5179:
1.184 rillig 5180: * Look at the installed header files: What headers do they include? The
5181: packages providing these files must be buildlinked.
1.1 dsieger 5182:
1.184 rillig 5183: * Run ldd on all installed libraries and look against what other libraries
5184: they link. Some of the packages providing these probably need to be
5185: buildlinked; however, it's not automatic, since e.g. GTK on some systems
5186: pulls in the X libraries, so they will show up in the ldd output, while on
5187: others (like OS X) it won't. ldd output can thus only be used as a hint.
1.1 dsieger 5188:
1.184 rillig 5189: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
5190: buildlink3.mk files
1.16 jnemeth 5191:
1.185 wiz 5192: Both variables set lower bounds for a version of this package. The two
5193: variables differ in that one describes source compatibility (API) and the other
5194: binary compatibility (ABI). The difference is that a change in the API breaks
5195: compilation of programs while changes in the ABI stop compiled programs from
5196: running.
5197:
5198: The BUILDLINK_API_DEPENDS.pkg variable in a buildlink3.mk should be changed
5199: very rarely. (One possible scenario: If all packages using this package need a
5200: higher version than defined in the buildlink3.mk, BUILDLINK_API_DEPENDS.pkg
5201: could be updated to that higher version.)
5202:
5203: On the other hand, changes to BUILDLINK_ABI_DEPENDS.pkg are more common. The
5204: variable will need to be updated every time the major version of one of its
5205: shared libraries is changed, or any other change where a binary built against
5206: the previous version of the package will not run against the new version any
5207: longer.
5208:
5209: In such a case, the package's BUILDLINK_ABI_DEPENDS.pkg must be increased to
5210: require the new package version. Then the PKGREVISION of all packages foo that
5211: depend on this package need to be increased, and if they have buildlink3.mk
5212: files, BUILDLINK_ABI_DEPENDS.foo in their buildlink3.mk files must be increased
5213: to the new version as well. This is required so that a package will pull in the
5214: versions of the packages that use the new ABI and that the packages'
5215: PKGREVISIONs uniquely identify the packages built against the new ABI. The
5216: pkgtools/revbump package can help with these updates.
1.1 dsieger 5217:
1.184 rillig 5218: See Section 21.1.5, "Handling dependencies" for more information about
1.185 wiz 5219: dependencies on other packages, including the BUILDLINK_API_DEPENDS
5220: definitions.
1.1 dsieger 5221:
1.184 rillig 5222: Please take careful consideration before adjusting BUILDLINK_API_DEPENDS.pkg or
1.185 wiz 5223: BUILDLINK_ABI_DEPENDS.pkg in a buildlink3.mk file as we don't want to cause
5224: unneeded package deletions and rebuilds. In many cases, new versions of
5225: packages work just fine with older dependencies.
1.1 dsieger 5226:
1.211 gutterid 5227: Also, it is not needed to set BUILDLINK_ABI_DEPENDS.pkg when it is identical to
1.184 rillig 5228: BUILDLINK_API_DEPENDS.pkg.
1.1 dsieger 5229:
1.211 gutterid 5230: Note there is also the distinction that users are able to disable enforcement
5231: of ABI dependencies using the USE_ABI_DEPENDS variable, but there is no
5232: equivalent option for API dependencies.
5233:
1.184 rillig 5234: 18.3. Writing builtin.mk files
1.1 dsieger 5235:
1.184 rillig 5236: Some packages in pkgsrc install headers and libraries that coincide with
5237: headers and libraries present in the base system. Aside from a buildlink3.mk
5238: file, these packages should also include a builtin.mk file that includes the
5239: necessary checks to decide whether using the built-in software or the pkgsrc
5240: software is appropriate.
1.1 dsieger 5241:
1.184 rillig 5242: The only requirements of a builtin.mk file for pkg are:
1.1 dsieger 5243:
1.184 rillig 5244: 1. It should set USE_BUILTIN.pkg to either "yes" or "no" after it is included.
1.1 dsieger 5245:
1.184 rillig 5246: 2. It should not override any USE_BUILTIN.pkg which is already set before the
5247: builtin.mk file is included.
1.1 dsieger 5248:
1.184 rillig 5249: 3. It should be written to allow multiple inclusion. This is very important
5250: and takes careful attention to Makefile coding.
1.1 dsieger 5251:
1.184 rillig 5252: 18.3.1. Anatomy of a builtin.mk file
1.1 dsieger 5253:
1.184 rillig 5254: The following is the recommended template for builtin.mk files:
1.1 dsieger 5255:
1.184 rillig 5256: .if !defined(IS_BUILTIN.foo)
5257: #
5258: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5259: # genuinely exists in the system or not.
5260: #
5261: IS_BUILTIN.foo?= no
1.1 dsieger 5262:
1.184 rillig 5263: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5264: # version can be determined.
5265: #
5266: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5267: BUILTIN_PKG.foo?= foo-1.0
5268: . endif
5269: .endif # IS_BUILTIN.foo
1.1 dsieger 5270:
1.184 rillig 5271: .if !defined(USE_BUILTIN.foo)
5272: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5273: . if defined(BUILTIN_PKG.foo)
5274: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5275: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5276: USE_BUILTIN.foo!= \
5277: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5278: && ${ECHO} "yes" || ${ECHO} "no"
5279: . endif
5280: . endfor
5281: . endif
5282: .endif # USE_BUILTIN.foo
1.1 dsieger 5283:
1.184 rillig 5284: CHECK_BUILTIN.foo?= no
5285: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5286: #
5287: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5288: # "yes" or "no".
5289: #
5290: .endif # CHECK_BUILTIN.foo
1.1 dsieger 5291:
1.184 rillig 5292: The first section sets IS_BUILTIN.pkg depending on if pkg really exists in the
5293: base system. This should not be a base system software with similar
5294: functionality to pkg; it should only be "yes" if the actual package is included
5295: as part of the base system. This variable is only used internally within the
5296: builtin.mk file.
1.1 dsieger 5297:
1.184 rillig 5298: The second section sets BUILTIN_PKG.pkg to the version of pkg in the base
5299: system if it exists (if IS_BUILTIN.pkg is "yes"). This variable is only used
5300: internally within the builtin.mk file.
1.1 dsieger 5301:
1.184 rillig 5302: The third section sets USE_BUILTIN.pkg and is required in all builtin.mk files.
5303: The code in this section must make the determination whether the built-in
5304: software is adequate to satisfy the dependencies listed in
5305: BUILDLINK_API_DEPENDS.pkg. This is typically done by comparing BUILTIN_PKG.pkg
5306: against each of the dependencies in BUILDLINK_API_DEPENDS.pkg. USE_BUILTIN.pkg
5307: must be set to the correct value by the end of the builtin.mk file. Note that
5308: USE_BUILTIN.pkg may be "yes" even if IS_BUILTIN.pkg is "no" because we may make
5309: the determination that the built-in version of the software is similar enough
5310: to be used as a replacement.
1.1 dsieger 5311:
1.184 rillig 5312: The last section is guarded by CHECK_BUILTIN.pkg, and includes code that uses
5313: the value of USE_BUILTIN.pkg set in the previous section. This typically
5314: includes, e.g., adding additional dependency restrictions and listing
5315: additional files to symlink into ${BUILDLINK_DIR} (via BUILDLINK_FILES.pkg).
1.1 dsieger 5316:
1.184 rillig 5317: Chapter 19. PLIST issues
1.1 dsieger 5318:
1.184 rillig 5319: Table of Contents
1.1 dsieger 5320:
1.184 rillig 5321: 19.1. RCS ID
5322: 19.2. Semi-automatic PLIST generation
5323: 19.3. Tweaking output of make print-PLIST
5324: 19.4. Variable substitution in PLIST
5325: 19.5. Man page compression
5326: 19.6. Changing PLIST source with PLIST_SRC
5327: 19.7. Platform-specific and differing PLISTs
5328: 19.8. Build-specific PLISTs
5329: 19.9. Sharing directories between packages
1.1 dsieger 5330:
1.184 rillig 5331: The PLIST file contains a package's "packing list", i.e. a list of files that
5332: belong to the package (relative to the ${PREFIX} directory it's been installed
5333: in) plus some additional statements - see the pkg_create(1) man page for a full
5334: list. This chapter addresses some issues that need attention when dealing with
5335: the PLIST file (or files, see below!).
1.1 dsieger 5336:
1.184 rillig 5337: 19.1. RCS ID
1.1 dsieger 5338:
1.184 rillig 5339: Be sure to add a RCS ID line as the first thing in any PLIST file you write:
1.1 dsieger 5340:
1.184 rillig 5341: @comment $NetBSD $
1.1 dsieger 5342:
1.184 rillig 5343: An artificial space has been added between NetBSD and $, this is a workaround
5344: here to prevent CVS expanding to the filename of the guide. When adding the RCS
5345: ID the space should be omitted.
1.38 wiz 5346:
1.184 rillig 5347: 19.2. Semi-automatic PLIST generation
1.1 dsieger 5348:
1.184 rillig 5349: You can use the make print-PLIST command to output a PLIST that matches any new
5350: files since the package was extracted. See Section 13.17, "Other helpful
5351: targets" for more information on this target.
1.11 rillig 5352:
1.184 rillig 5353: 19.3. Tweaking output of make print-PLIST
1.1 dsieger 5354:
1.184 rillig 5355: The PRINT_PLIST_AWK variable takes a set of AWK patterns and actions that are
5356: used to filter the output of print-PLIST. You can append any chunk of AWK
5357: scripting you like to it, but be careful with quoting.
1.1 dsieger 5358:
1.184 rillig 5359: For example, to get all files inside the libdata/foo directory removed from the
5360: resulting PLIST:
1.1 dsieger 5361:
1.184 rillig 5362: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 5363:
1.185 wiz 5364: The PRINT_PLIST_AWK transformations are evaluated after the file list and
5365: directory list are sorted. EARLY_PRINT_PLIST_AWK is like PRINT_PLIST_AWK except
5366: it operates before the file list and directory list are sorted.
5367:
1.184 rillig 5368: 19.4. Variable substitution in PLIST
1.1 dsieger 5369:
1.184 rillig 5370: A number of variables are substituted automatically in PLISTs when a package is
5371: installed on a system. This includes the following variables:
1.1 dsieger 5372:
1.184 rillig 5373: ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
1.1 dsieger 5374:
1.184 rillig 5375: Some packages like emacs and perl embed information about which
5376: architecture they were built on into the pathnames where they install their
5377: files. To handle this case, PLIST will be preprocessed before actually
5378: used, and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p
5379: gives. The same is done if the string ${MACHINE_GNU_ARCH} is embedded in
5380: PLIST somewhere - use this on packages that have GNU autoconf-created
5381: configure scripts.
1.1 dsieger 5382:
1.184 rillig 5383: Legacy note
1.1 dsieger 5384:
1.184 rillig 5385: There used to be a symbol "$ARCH" that was replaced by the output of uname
5386: -m, but that's no longer supported and has been removed.
1.1 dsieger 5387:
1.184 rillig 5388: ${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}
1.1 dsieger 5389:
1.184 rillig 5390: Some packages want to embed the OS name and version into some paths. To do
5391: this, use these variables in the PLIST:
1.1 dsieger 5392:
1.232 gutterid 5393: o ${OPSYS} - output of "uname -s"
1.1 dsieger 5394:
1.232 gutterid 5395: o ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
1.1 dsieger 5396:
1.232 gutterid 5397: o ${OS_VERSION} - "uname -r"
1.1 dsieger 5398:
1.184 rillig 5399: For a list of values which are replaced by default, the output of make help
5400: topic=PLIST_SUBST as well as searching the pkgsrc/mk directory with grep for
5401: PLIST_SUBST should help.
1.1 dsieger 5402:
1.184 rillig 5403: If you want to change other variables not listed above, you can add variables
5404: and their expansions to this variable in the following way, similar to
5405: MESSAGE_SUBST (see Section 12.5, "Optional files"):
1.1 dsieger 5406:
1.184 rillig 5407: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 5408:
1.184 rillig 5409: This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue".
1.1 dsieger 5410:
1.184 rillig 5411: The PLIST_VARS variable can be used to simplify the common case of
5412: conditionally including some PLIST entries. It can be done by adding
5413: PLIST_VARS+=foo and setting the corresponding PLIST.foo variable to yes if the
5414: entry should be included. This will substitute "${PLIST.foo}" in the PLIST with
5415: either """" or ""@comment "". For example, in Makefile:
1.1 dsieger 5416:
1.184 rillig 5417: PLIST_VARS+= foo
5418: .if condition
5419: PLIST.foo= yes
5420: .else
1.1 dsieger 5421:
1.184 rillig 5422: And then in PLIST:
1.1 dsieger 5423:
1.184 rillig 5424: @comment $NetBSD $
5425: bin/bar
5426: man/man1/bar.1
5427: ${PLIST.foo}bin/foo
5428: ${PLIST.foo}man/man1/foo.1
5429: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 5430:
1.184 rillig 5431: An artificial space has been added between NetBSD and $, this is a workaround
5432: here to prevent CVS expanding to the filename of the guide. When adding the RCS
1.195 gutterid 5433: ID the space should be omitted.
1.1 dsieger 5434:
1.184 rillig 5435: 19.5. Man page compression
1.1 dsieger 5436:
1.184 rillig 5437: Man pages should be installed in compressed form if MANZ is set (in
5438: bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the
5439: suffix ".gz" is appended/removed automatically for man pages according to MANZ
5440: and MANCOMPRESSED being set or not, see above for details. This modification of
5441: the PLIST file is done on a copy of it, not PLIST itself.
1.100 leot 5442:
1.184 rillig 5443: 19.6. Changing PLIST source with PLIST_SRC
1.100 leot 5444:
1.184 rillig 5445: To use one or more files as source for the PLIST used in generating the binary
5446: package, set the variable PLIST_SRC to the names of that file(s). The files are
5447: later concatenated using cat(1), and the order of things is important. The
5448: default for PLIST_SRC is ${PKGDIR}/PLIST.
1.1 dsieger 5449:
1.184 rillig 5450: 19.7. Platform-specific and differing PLISTs
1.1 dsieger 5451:
1.184 rillig 5452: Some packages decide to install a different set of files based on the operating
5453: system being used. These differences can be automatically handled by using the
5454: following files:
1.1 dsieger 5455:
1.184 rillig 5456: * PLIST.common
1.1 dsieger 5457:
1.184 rillig 5458: * PLIST.${OPSYS}
1.1 dsieger 5459:
1.184 rillig 5460: * PLIST.${MACHINE_ARCH}
1.1 dsieger 5461:
1.184 rillig 5462: * PLIST.${OPSYS}-${MACHINE_ARCH}
1.1 dsieger 5463:
1.184 rillig 5464: * PLIST.common_end
1.1 dsieger 5465:
1.184 rillig 5466: 19.8. Build-specific PLISTs
1.1 dsieger 5467:
1.184 rillig 5468: Some packages decide to generate hard-to-guess file names during installation
5469: that are hard to wire down.
1.1 dsieger 5470:
1.184 rillig 5471: In such cases, you can set the GENERATE_PLIST variable to shell code terminated
5472: (with a semicolon) that will output PLIST entries which will be appended to the
5473: PLIST
1.1 dsieger 5474:
1.184 rillig 5475: You can find one example in editors/xemacs:
1.1 dsieger 5476:
1.184 rillig 5477: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
1.1 dsieger 5478:
1.184 rillig 5479: which will append something like bin/xemacs-21.4.23-54e8ea71.dmp to the PLIST.
1.1 dsieger 5480:
1.184 rillig 5481: 19.9. Sharing directories between packages
1.1 dsieger 5482:
1.184 rillig 5483: A "shared directory" is a directory where multiple (and unrelated) packages
5484: install files. These directories were problematic because you had to add
5485: special tricks in the PLIST to conditionally remove them, or have some
5486: centralized package handle them.
1.106 tnn 5487:
1.184 rillig 5488: In pkgsrc, it is now easy: Each package should create directories and install
5489: files as needed; pkg_delete will remove any directories left empty after
5490: uninstalling a package.
1.106 tnn 5491:
1.184 rillig 5492: If a package needs an empty directory to work, create the directory during
5493: installation as usual, and also add an entry to the PLIST:
1.1 dsieger 5494:
1.184 rillig 5495: @pkgdir path/to/empty/directory
1.1 dsieger 5496:
1.184 rillig 5497: or take a look at MAKE_DIRS and OWN_DIRS.
1.1 dsieger 5498:
1.184 rillig 5499: Chapter 20. The pkginstall framework
1.1 dsieger 5500:
1.184 rillig 5501: Table of Contents
1.1 dsieger 5502:
1.184 rillig 5503: 20.1. Files and directories outside the installation prefix
5504: 20.1.1. Directory manipulation
5505: 20.1.2. File manipulation
5506: 20.2. Configuration files
5507: 20.2.1. How PKG_SYSCONFDIR is set
5508: 20.2.2. Telling the software where configuration files are
1.239 dholland 5509: 20.2.3. Patching installation
5510: 20.2.4. Declaring configuration files
5511: 20.2.5. Disabling handling of configuration files
1.184 rillig 5512: 20.3. System startup scripts
5513: 20.3.1. Disabling handling of system startup scripts
5514: 20.4. System users and groups
5515: 20.5. System shells
5516: 20.5.1. Disabling shell registration
5517: 20.6. Fonts
5518: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 5519:
1.184 rillig 5520: This chapter describes the framework known as pkginstall, whose key features
5521: are:
1.1 dsieger 5522:
1.184 rillig 5523: * Generic installation and manipulation of directories and files outside the
5524: pkgsrc-handled tree, LOCALBASE.
1.1 dsieger 5525:
1.184 rillig 5526: * Automatic handling of configuration files during installation, provided
5527: that packages are correctly designed.
1.1 dsieger 5528:
1.184 rillig 5529: * Generation and installation of system startup scripts.
1.1 dsieger 5530:
1.184 rillig 5531: * Registration of system users and groups.
1.1 dsieger 5532:
1.184 rillig 5533: * Registration of system shells.
1.1 dsieger 5534:
1.184 rillig 5535: * Automatic updating of fonts databases.
1.1 dsieger 5536:
1.184 rillig 5537: The following sections inspect each of the above points in detail.
1.1 dsieger 5538:
1.184 rillig 5539: You may be thinking that many of the things described here could be easily done
5540: with simple code in the package's post-installation target (post-install). This
5541: is incorrect, as the code in them is only executed when building from source.
5542: Machines using binary packages could not benefit from it at all (as the code
5543: itself could be unavailable). Therefore, the only way to achieve any of the
5544: items described above is by means of the installation scripts, which are
5545: automatically generated by pkginstall.
1.1 dsieger 5546:
1.184 rillig 5547: 20.1. Files and directories outside the installation prefix
1.95 wiz 5548:
1.184 rillig 5549: As you already know, the PLIST file holds a list of files and directories that
5550: belong to a package. The names used in it are relative to the installation
5551: prefix (${PREFIX}), which means that it cannot register files outside this
5552: directory (absolute path names are not allowed). Despite this restriction, some
5553: packages need to install files outside this location; e.g., under ${VARBASE} or
5554: ${PKG_SYSCONFDIR}. The only way to achieve this is to create such files during
5555: installation time by using installation scripts.
1.95 wiz 5556:
1.184 rillig 5557: The generic installation scripts are shell scripts that can contain arbitrary
5558: code. The list of scripts to execute is taken from the INSTALL_FILE variable,
5559: which defaults to INSTALL. A similar variable exists for package removal
5560: (DEINSTALL_FILE, whose default is DEINSTALL). These scripts can run arbitrary
5561: commands, so they have the potential to create and manage files anywhere in the
5562: file system.
1.95 wiz 5563:
1.184 rillig 5564: Using these general installation files is not recommended, but may be needed in
5565: some special cases. One reason for avoiding them is that the user has to trust
5566: the packager that there is no unwanted or simply erroneous code included in the
5567: installation script. Also, previously there were many similar scripts for the
5568: same functionality, and fixing a common error involved finding and changing all
5569: of them.
1.95 wiz 5570:
1.184 rillig 5571: The pkginstall framework offers another, standardized way. It provides generic
5572: scripts to abstract the manipulation of such files and directories based on
5573: variables set in the package's Makefile. The rest of this section describes
5574: these variables.
1.1 dsieger 5575:
1.184 rillig 5576: 20.1.1. Directory manipulation
1.1 dsieger 5577:
1.184 rillig 5578: The following variables can be set to request the creation of directories
5579: anywhere in the file system:
1.1 dsieger 5580:
1.184 rillig 5581: * MAKE_DIRS and OWN_DIRS contain a list of directories that should be created
5582: and should attempt to be destroyed by the installation scripts. The
5583: difference between the two is that the latter prompts the administrator to
5584: remove any directories that may be left after deinstallation (because they
5585: were not empty), while the former does not. Example:
1.1 dsieger 5586:
1.184 rillig 5587: MAKE_DIRS+= ${VARBASE}/foo/private
1.1 dsieger 5588:
1.184 rillig 5589: * MAKE_DIRS_PERMS and OWN_DIRS_PERMS contain a list of tuples describing
5590: which directories should be created and should attempt to be destroyed by
5591: the installation scripts. Each tuple holds the following values, separated
5592: by spaces: the directory name, its owner, its group and its numerical mode.
5593: For example:
1.1 dsieger 5594:
1.184 rillig 5595: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5596: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5597:
1.184 rillig 5598: The difference between the two is exactly the same as their non-PERMS
5599: counterparts.
1.1 dsieger 5600:
1.184 rillig 5601: 20.1.2. File manipulation
1.1 dsieger 5602:
1.184 rillig 5603: Creating non-empty files outside the installation prefix is tricky because the
5604: PLIST forces all files to be inside it. To overcome this problem, the only
1.239 dholland 5605: solution is to extract the file in a known place (i.e., inside the installation
5606: prefix) and copy it to the appropriate location during installation (done by
5607: the installation scripts generated by pkginstall). We will call the former the
5608: reference file in the following paragraphs, which describe the variables that
5609: can be used to automatically and consistently handle files outside the
5610: installation prefix:
5611:
5612: * REQD_FILES is a list of pairs of reference and target files. At
5613: installation time, the reference file is copied to the target if and only
5614: if the latter does not exist. Upon deinstallation, the reference file is
1.184 rillig 5615: removed provided that it was not modified by the installation.
1.1 dsieger 5616:
1.239 dholland 5617: * REQD_FILES_PERMS contains tuples describing reference files and targets,
5618: including owner, group, and numeric permissions that should be set. For
5619: example:
1.1 dsieger 5620:
1.184 rillig 5621: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5622: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5623:
1.239 dholland 5624: * CONF_FILES and CONF_FILES_PERMS have the same syntax as REQD_FILES and
5625: REQD_FILES_PERMS respectively. The difference is that these variables are
5626: specifically intended for handling configuration files, for which
5627: additional conventions and constraints apply. See Section 20.2,
5628: "Configuration files" for further discussion. Note in particular that while
5629: handling of configuration files can be disabled by the user (see
5630: Section 20.2.5, "Disabling handling of configuration files"), this setting
5631: does not affect REQD_FILES and REQD_FILES_PERMS.
5632:
5633: To install an empty file, one can use these macros and /dev/null as the
5634: reference file.
1.1 dsieger 5635:
1.184 rillig 5636: 20.2. Configuration files
1.1 dsieger 5637:
1.239 dholland 5638: There are two principles that govern the handling of configuration files in
5639: pkgsrc: first, the user's configuration must not be lost or overwritten by
5640: upgrades or reinstallations; and second, the default configuration should
5641: always be available for reference. To that end, pkgsrc has a framework
5642: specifically for handling configuration files. In general, configuration files
5643: are installed into ${PREFIX}/share/examples, and copied from there to the
5644: pertinent etc directory as a separate step and only as needed.
5645:
5646: To make this work, there are three things that need to happen, any of which may
5647: require patching. First, the package must be told to read its configuration
5648: from the correct place at runtime; this place is ${PKG_SYSCONFDIR} (or possibly
5649: a subdirectory of it) which is often but not always ${PREFIX}/etc. Second, the
5650: package must be taught to install its default configuration files in ${PREFIX}/
5651: share/examples/${PKGBASE}; this is the point at which patching often becomes
5652: required because it is not the same place as the runtime location. Third, the
5653: configuration files need to be declared in the package makefile; this is the
5654: easy part.
5655:
5656: With those elements in place, the right things will happen: the package install
5657: phase and resulting binary package will not touch ${PKG_SYSCONFDIR}, and the
5658: default configuration will be copied into place by the pkgsrc framework only if
5659: not already present. Similarly, upon deinstall the configuration will not be
5660: removed if it has been modified. (This means that in the case of reinstallation
5661: and upgrades, unmodified configuration files are updated but modifications are
5662: never discarded.)
5663:
5664: The following sections describe how to make these things happen and document
5665: other relevant knobs available in the pkgsrc infrastructure.
1.1 dsieger 5666:
1.184 rillig 5667: 20.2.1. How PKG_SYSCONFDIR is set
1.1 dsieger 5668:
1.184 rillig 5669: As said before, the PKG_SYSCONFDIR variable specifies where configuration files
5670: shall be installed. Its contents are set based upon the following variables:
1.1 dsieger 5671:
1.184 rillig 5672: * PKG_SYSCONFBASE: The configuration's root directory. Defaults to ${PREFIX}/
1.239 dholland 5673: etc although it may be overridden by the user to point to their preferred
1.184 rillig 5674: location (e.g., /etc, /etc/pkg, etc.). Packages must not use it directly.
1.1 dsieger 5675:
1.184 rillig 5676: * PKG_SYSCONFSUBDIR: A subdirectory of PKG_SYSCONFBASE under which the
5677: configuration files for the package being built shall be installed. The
5678: definition of this variable only makes sense in the package's Makefile
5679: (i.e., it is not user-customizable).
1.1 dsieger 5680:
1.184 rillig 5681: As an example, consider the Apache package, www/apache24, which places its
5682: configuration files under the httpd/ subdirectory of PKG_SYSCONFBASE. This
5683: should be set in the package Makefile.
1.1 dsieger 5684:
1.184 rillig 5685: * PKG_SYSCONFVAR: Specifies the name of the variable that holds this
5686: package's configuration directory (if different from PKG_SYSCONFBASE). It
5687: defaults to PKGBASE's value, and is always prefixed with PKG_SYSCONFDIR.
1.1 dsieger 5688:
1.184 rillig 5689: * PKG_SYSCONFDIR.${PKG_SYSCONFVAR}: Holds the directory where the
5690: configuration files for the package identified by PKG_SYSCONFVAR's shall be
5691: placed.
1.1 dsieger 5692:
1.184 rillig 5693: Based on the above variables, pkginstall determines the value of
1.239 dholland 5694: PKG_SYSCONFDIR, which is the only variable that may be used within a package to
1.184 rillig 5695: refer to its configuration directory. The algorithm used to set its value is
5696: basically the following:
1.1 dsieger 5697:
1.184 rillig 5698: 1. If PKG_SYSCONFDIR.${PKG_SYSCONFVAR} is set, its value is used.
1.1 dsieger 5699:
1.184 rillig 5700: 2. If the previous variable is not defined but PKG_SYSCONFSUBDIR is set in the
5701: package's Makefile, the resulting value is ${PKG_SYSCONFBASE}/$
5702: {PKG_SYSCONFSUBDIR}.
1.1 dsieger 5703:
1.184 rillig 5704: 3. Otherwise, it is set to ${PKG_SYSCONFBASE}.
1.1 dsieger 5705:
1.184 rillig 5706: It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to
1.239 dholland 5707: OWN_DIRS. This causes it to be automatically created if needed. See
5708: Section 20.1.1, "Directory manipulation" for further details. This does not
5709: apply to subdirectories of ${PKG_SYSCONFDIR}; they must be manually created
5710: with OWN_DIRS or MAKE_DIRS.
1.1 dsieger 5711:
1.184 rillig 5712: 20.2.2. Telling the software where configuration files are
1.1 dsieger 5713:
1.184 rillig 5714: Given that pkgsrc (and users!) expect configuration files to be in a known
1.239 dholland 5715: place, you need to teach each package where to install its files. In some cases
5716: you will have to patch the package Makefiles to achieve it. If you are lucky,
5717: though, it may be as easy as passing an extra flag to the configuration script.
5718: This is the case for packages using GNU autoconf:
1.1 dsieger 5719:
1.184 rillig 5720: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 5721:
1.184 rillig 5722: Note that this specifies where the package has to look for its configuration
1.239 dholland 5723: files, not where they will be installed. Fortunately, there is a different way
1.240 gutterid 5724: to specify the latter, as seen in the next section, although the combination is
5725: rather confusing at first glance.
1.1 dsieger 5726:
1.239 dholland 5727: 20.2.3. Patching installation
1.1 dsieger 5728:
1.239 dholland 5729: As discussed above, packages themselves must not touch the contents of $
1.184 rillig 5730: {PKG_SYSCONFDIR} directly. Bad news is that many software installation scripts
5731: will, out of the box, mess with the contents of that directory. So what is the
5732: correct procedure to fix this issue?
1.1 dsieger 5733:
1.184 rillig 5734: You must teach the package (usually by manually patching it) to install any
5735: configuration files under the examples hierarchy, share/examples/${PKGBASE}/.
5736: This way, the PLIST registers them and the administrator always has the
5737: original copies available.
1.1 dsieger 5738:
1.239 dholland 5739: It turns out that for packages using GNU autoconf it is possible to create the
5740: desired effect by setting sysconfdir on the make command line at install time.
5741: Consider this example taken from mail/mutt:
5742:
5743: EGDIR= ${PREFIX}/share/examples/mutt
5744: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
5745:
5746: Note that the EGDIR variable, though commonly used for this purpose, is local
5747: to that package and has no meaning outside it.
1.1 dsieger 5748:
1.239 dholland 5749: 20.2.4. Declaring configuration files
1.1 dsieger 5750:
1.239 dholland 5751: Once the required configuration files are in place (i.e., under the examples
5752: hierarchy), the pkginstall framework can use them as reference copies during
5753: the package installation to update what is in ${PKG_SYSCONFDIR}. To achieve
5754: this, the variables CONF_FILES and CONF_FILES_PERMS are used. Check out
5755: Section 20.1.2, "File manipulation" for further information about their syntax
5756: and their purpose. Here is an example, taken from the mail/mutt package:
5757:
5758: EGDIR= ${PREFIX}/share/examples/mutt
5759: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5760:
5761: Note that (as in the previous section's example) the EGDIR variable is specific
5762: to the package and has no meaning outside it.
5763:
5764: For reference, the complete example from Mutt is as follows:
5765:
5766: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5767: EGDIR= ${PREFIX}/share/examples/mutt
5768: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5769: INSTALLATION_DIRS+= ${EGDIR}
5770: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.1 dsieger 5771:
1.239 dholland 5772: 20.2.5. Disabling handling of configuration files
1.1 dsieger 5773:
1.184 rillig 5774: The automatic copying of config files can be toggled by setting the environment
5775: variable PKG_CONFIG prior to package installation.
1.1 dsieger 5776:
1.184 rillig 5777: 20.3. System startup scripts
1.1 dsieger 5778:
1.184 rillig 5779: System startup scripts are special files because they must be installed in a
5780: place known by the underlying OS, usually outside the installation prefix.
5781: Therefore, the same rules described in Section 20.1, "Files and directories
5782: outside the installation prefix" apply, and the same solutions can be used.
5783: However, pkginstall provides a special mechanism to handle these files.
1.1 dsieger 5784:
1.184 rillig 5785: In order to provide system startup scripts, the package has to:
1.1 dsieger 5786:
1.184 rillig 5787: 1. Store the script inside ${FILESDIR}, with the .sh suffix appended.
1.223 nia 5788: Considering the print/cups-base package as an example, it has a cupsd.sh in
5789: its files directory.
1.95 wiz 5790:
1.184 rillig 5791: 2. Tell pkginstall to handle it, appending the name of the script, without its
5792: extension, to the RCD_SCRIPTS variable. Continuing the previous example:
1.95 wiz 5793:
1.184 rillig 5794: RCD_SCRIPTS+= cupsd
1.95 wiz 5795:
1.184 rillig 5796: Once this is done, pkginstall will do the following steps for each script in an
5797: automated fashion:
1.95 wiz 5798:
1.184 rillig 5799: 1. Process the file found in the files directory applying all the
5800: substitutions described in the FILES_SUBST variable.
1.1 dsieger 5801:
1.184 rillig 5802: 2. Copy the script from the files directory to the examples hierarchy, $
1.239 dholland 5803: {PREFIX}/share/examples/rc.d/. Note that this reference file must be
1.184 rillig 5804: explicitly registered in the PLIST.
1.1 dsieger 5805:
1.184 rillig 5806: 3. Add code to the installation scripts to copy the startup script from the
5807: examples hierarchy into the system-wide startup scripts directory.
1.1 dsieger 5808:
1.184 rillig 5809: 20.3.1. Disabling handling of system startup scripts
1.1 dsieger 5810:
1.184 rillig 5811: The automatic copying of config files can be toggled by setting the environment
5812: variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts
5813: will be always copied inside the examples hierarchy, ${PREFIX}/share/examples/
5814: rc.d/, no matter what the value of this variable is.
1.1 dsieger 5815:
1.184 rillig 5816: 20.4. System users and groups
1.1 dsieger 5817:
1.184 rillig 5818: If a package needs to create special users and/or groups during installation,
5819: it can do so by using the pkginstall framework.
1.1 dsieger 5820:
1.184 rillig 5821: Users can be created by adding entries to the PKG_USERS variable. Each entry
5822: has the following syntax:
1.1 dsieger 5823:
1.184 rillig 5824: user:group
1.1 dsieger 5825:
1.184 rillig 5826: Further specification of user details may be done by setting per-user
5827: variables. PKG_UID.user is the numeric UID for the user. PKG_GECOS.user is the
5828: user's description or comment. PKG_HOME.user is the user's home directory, and
5829: defaults to /nonexistent if not specified. PKG_SHELL.user is the user's shell,
5830: and defaults to /sbin/nologin if not specified.
1.1 dsieger 5831:
1.184 rillig 5832: Similarly, groups can be created by adding entries to the PKG_GROUPS variable,
5833: whose syntax is:
1.1 dsieger 5834:
1.184 rillig 5835: group
1.1 dsieger 5836:
1.184 rillig 5837: The numeric GID of the group may be set by defining PKG_GID.group.
1.1 dsieger 5838:
1.184 rillig 5839: If a package needs to create the users and groups at an earlier stage, then it
5840: can set USERGROUP_PHASE to either configure,build, or pre-install to indicate
5841: the phase before which the users and groups are created. In this case, the
5842: numeric UIDs and GIDs of the created users and groups are automatically
5843: hardcoded into the final installation scripts.
1.1 dsieger 5844:
1.184 rillig 5845: 20.5. System shells
1.1 dsieger 5846:
1.184 rillig 5847: Packages that install system shells should register them in the shell database,
5848: /etc/shells, to make things easier to the administrator. This must be done from
5849: the installation scripts to keep binary packages working on any system.
5850: pkginstall provides an easy way to accomplish this task.
1.1 dsieger 5851:
1.184 rillig 5852: When a package provides a shell interpreter, it has to set the PKG_SHELL
5853: variable to its absolute file name. This will add some hooks to the
5854: installation scripts to handle it. Consider the following example, taken from
5855: shells/zsh:
1.1 dsieger 5856:
1.184 rillig 5857: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 dsieger 5858:
1.184 rillig 5859: 20.5.1. Disabling shell registration
1.1 dsieger 5860:
1.184 rillig 5861: The automatic registration of shell interpreters can be disabled by the
5862: administrator by setting the PKG_REGISTER_SHELLS environment variable to NO.
1.1 dsieger 5863:
1.184 rillig 5864: 20.6. Fonts
1.1 dsieger 5865:
1.184 rillig 5866: Packages that install X11 fonts should update the database files that index the
5867: fonts within each fonts directory. This can easily be accomplished within the
5868: pkginstall framework.
1.1 dsieger 5869:
1.184 rillig 5870: When a package installs X11 fonts, it must list the directories in which fonts
5871: are installed in the FONTS_DIRS.type variables, where type can be one of "ttf",
5872: "type1" or "x11". This will add hooks to the installation scripts to run the
5873: appropriate commands to update the fonts database files within each of those
5874: directories. For convenience, if the directory path is relative, it is taken to
5875: be relative to the package's installation prefix. Consider the following
5876: example, taken from fonts/dbz-ttf:
1.1 dsieger 5877:
1.184 rillig 5878: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5879:
1.184 rillig 5880: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 5881:
1.184 rillig 5882: The automatic update of fonts databases can be disabled by the administrator by
5883: setting the PKG_UPDATE_FONTS_DB environment variable to NO.
1.1 dsieger 5884:
1.154 rillig 5885: Chapter 21. Making your package work
1.1 dsieger 5886:
5887: Table of Contents
5888:
1.154 rillig 5889: 21.1. General operation
5890: 21.1.1. How to pull in user-settable variables from mk.conf
5891: 21.1.2. User interaction
5892: 21.1.3. Handling licenses
5893: 21.1.4. Restricted packages
5894: 21.1.5. Handling dependencies
5895: 21.1.6. Handling conflicts with other packages
5896: 21.1.7. Packages that cannot or should not be built
5897: 21.1.8. Packages which should not be deleted, once installed
5898: 21.1.9. Handling packages with security problems
5899: 21.1.10. How to handle incrementing versions when fixing an existing
1.232 gutterid 5900: package
1.154 rillig 5901: 21.1.11. Substituting variable text in the package files (the SUBST
1.232 gutterid 5902: framework)
1.154 rillig 5903: 21.2. The fetch phase
5904: 21.2.1. Packages whose distfiles aren't available for plain downloading
5905: 21.2.2. How to handle modified distfiles with the 'old' name
5906: 21.2.3. Packages hosted on github.com
5907: 21.3. The configure phase
5908: 21.3.1. Shared libraries - libtool
5909: 21.3.2. Using libtool on GNU packages that already support libtool
5910: 21.3.3. GNU Autoconf/Automake
1.223 nia 5911: 21.3.4. Meson / ninja
1.154 rillig 5912: 21.4. Programming languages
5913: 21.4.1. C, C++, and Fortran
5914: 21.4.2. Java
1.205 wiz 5915: 21.4.3. Go
1.223 nia 5916: 21.4.4. Rust
5917: 21.4.5. Packages containing Perl scripts
5918: 21.4.6. Packages containing shell scripts
5919: 21.4.7. Other programming languages
1.154 rillig 5920: 21.5. The build phase
5921: 21.5.1. Compiling C and C++ code conditionally
5922: 21.5.2. How to handle compiler bugs
1.172 rillig 5923: 21.5.3. No such file or directory
5924: 21.5.4. Undefined reference to "..."
5925: 21.5.5. Running out of memory
1.154 rillig 5926: 21.6. The install phase
5927: 21.6.1. Creating needed directories
5928: 21.6.2. Where to install documentation
5929: 21.6.3. Installing highscore files
5930: 21.6.4. Adding DESTDIR support to packages
5931: 21.6.5. Packages with hardcoded paths to other interpreters
1.203 nia 5932: 21.6.6. Packages installing Perl modules
1.254 wiz 5933: 21.6.7. Packages installing pkg-config files
5934: 21.6.8. Packages installing info files
5935: 21.6.9. Packages installing man pages
5936: 21.6.10. Packages installing X11 fonts
5937: 21.6.11. Packages installing SGML or XML data
5938: 21.6.12. Packages installing extensions to the MIME database
5939: 21.6.13. Packages using intltool
5940: 21.6.14. Packages installing startup scripts
5941: 21.6.15. Packages installing TeX modules
5942: 21.6.16. Packages supporting running binaries in emulation
5943: 21.6.17. Packages installing hicolor icons
5944: 21.6.18. Packages installing desktop files
1.154 rillig 5945: 21.7. Marking packages as having problems
1.1 dsieger 5946:
1.154 rillig 5947: 21.1. General operation
1.1 dsieger 5948:
5949: One appealing feature of pkgsrc is that it runs on many different platforms. As
5950: a result, it is important to ensure, where possible, that packages in pkgsrc
5951: are portable. This chapter mentions some particular details you should pay
5952: attention to while working on pkgsrc.
5953:
1.154 rillig 5954: 21.1.1. How to pull in user-settable variables from mk.conf
1.1 dsieger 5955:
5956: The pkgsrc user can configure pkgsrc by overriding several variables in the
1.4 rillig 5957: file pointed to by MAKECONF, which is mk.conf by default. When you want to use
5958: those variables in the preprocessor directives of make(1) (for example .if or
5959: .for), you need to include the file ../../mk/bsd.prefs.mk before, which in turn
5960: loads the user preferences.
1.1 dsieger 5961:
5962: But note that some variables may not be completely defined after ../../mk/
5963: bsd.prefs.mk has been included, as they may contain references to variables
1.108 rillig 5964: that are not yet defined. In shell commands (the lines in Makefile that are
5965: indented with a tab) this is no problem, since variables are only expanded when
5966: they are used. But in the preprocessor directives mentioned above and in
5967: dependency lines (of the form target: dependencies) the variables are expanded
5968: at load time.
1.1 dsieger 5969:
5970: Note
5971:
1.108 rillig 5972: To check whether a variable can be used at load time, run pkglint -Wall on your
5973: package.
1.1 dsieger 5974:
1.154 rillig 5975: 21.1.2. User interaction
1.1 dsieger 5976:
5977: Occasionally, packages require interaction from the user, and this can be in a
5978: number of ways:
5979:
5980: * When fetching the distfiles, some packages require user interaction such as
5981: entering username/password or accepting a license on a web page.
5982:
5983: * When extracting the distfiles, some packages may ask for passwords.
5984:
5985: * help to configure the package before it is built
5986:
5987: * help during the build process
5988:
5989: * help during the installation of a package
5990:
1.108 rillig 5991: A package can set the INTERACTIVE_STAGE variable to define which stages need
5992: interaction. This should be done in the package's Makefile, e.g.:
1.1 dsieger 5993:
5994: INTERACTIVE_STAGE= configure install
5995:
5996: The user can then decide to skip this package by setting the BATCH variable.
1.108 rillig 5997: Packages that require interaction are also excluded from bulk builds.
1.1 dsieger 5998:
1.154 rillig 5999: 21.1.3. Handling licenses
1.1 dsieger 6000:
6001: Authors of software can choose the licence under which software can be copied.
1.111 sevan 6002: The Free Software Foundation has declared some licenses "Free", and the Open
6003: Source Initiative has a definition of "Open Source".
6004:
6005: By default, pkgsrc allows packages with Free or Open Source licenses to be
6006: built. To allow packages with other licenses to be built as well, the pkgsrc
6007: user needs to add these licenses to the ACCEPTABLE_LICENSES variable in mk.conf
6008: . Note that this variable only affects which packages may be built, while the
6009: license terms often also restrict the actual use of the package and its
6010: redistribution.
1.1 dsieger 6011:
6012: One might want to only install packages with a BSD license, or the GPL, and not
1.20 jnemeth 6013: the other. The free licenses are added to the default ACCEPTABLE_LICENSES
1.111 sevan 6014: variable. The pkgsrc user can override the default by setting the
6015: ACCEPTABLE_LICENSES variable with "=" instead of "+=". The licenses accepted by
6016: default are defined in the DEFAULT_ACCEPTABLE_LICENSES variable in the file
6017: pkgsrc/mk/license.mk.
1.1 dsieger 6018:
6019: The license tag mechanism is intended to address copyright-related issues
6020: surrounding building, installing and using a package, and not to address
1.20 jnemeth 6021: redistribution issues (see RESTRICTED and NO_SRC_ON_FTP, etc.). Packages with
6022: redistribution restrictions should set these tags.
1.1 dsieger 6023:
6024: Denoting that a package may be copied according to a particular license is done
6025: by placing the license in pkgsrc/licenses and setting the LICENSE variable to a
6026: string identifying the license, e.g. in graphics/xv:
6027:
6028: LICENSE= xv-license
6029:
6030: When trying to build, the user will get a notice that the package is covered by
6031: a license which has not been placed in the ACCEPTABLE_LICENSES variable:
6032:
6033: % make
6034: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6035: ===> To view the license, enter "/usr/bin/make show-license".
6036: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6037: ===> ACCEPTABLE_LICENSES+=xv-license
6038: *** Error code 1
6039:
6040: The license can be viewed with make show-license, and if the user so chooses,
1.4 rillig 6041: the line printed above can be added to mk.conf to convey to pkgsrc that it
1.1 dsieger 6042: should not in the future fail because of that license:
6043:
6044: ACCEPTABLE_LICENSES+=xv-license
6045:
1.111 sevan 6046: The use of LICENSE=shareware, LICENSE=no-commercial-use, and similar language
6047: is deprecated because it does not crisply refer to a particular license text.
6048: Another problem with such usage is that it does not enable a user to tell
6049: pkgsrc to proceed for a single package without also telling pkgsrc to proceed
6050: for all packages with that tag.
6051:
1.154 rillig 6052: 21.1.3.1. Adding a package with a new license
1.1 dsieger 6053:
1.49 rodent 6054: When adding a package with a new license, the following steps are required:
6055:
1.111 sevan 6056: 1. Check whether the license qualifies as Free or Open Source by referencing
6057: Various Licenses and Comments about Them and Licenses by Name | Open Source
6058: Initiative. If this is the case, the filename in pkgsrc/licenses/ does not
6059: need the -license suffix, and the license name should be added to:
1.49 rodent 6060:
6061: + DEFAULT_ACCEPTABLE_LICENSES in pkgsrc/mk/license.mk
6062:
6063: + default_acceptable_licenses in pkgsrc/pkgtools/pkg_install/files/lib/
6064: license.c
6065:
6066: 2. The license text should be added to pkgsrc/licenses for displaying. A list
6067: of known licenses can be seen in this directory.
1.1 dsieger 6068:
1.154 rillig 6069: 21.1.3.2. Change to the license
1.1 dsieger 6070:
1.111 sevan 6071: When the license changes (in a way other than formatting), make sure that the
6072: new license has a different name (e.g., append the version number if it exists,
6073: or the date). Just because a user told pkgsrc to build programs under a
6074: previous version of a license does not mean that pkgsrc should build programs
6075: under the new licenses. The higher-level point is that pkgsrc does not evaluate
6076: licenses for reasonableness; the only test is a mechanistic test of whether a
6077: particular text has been approved by either of two bodies (FSF or OSI).
1.1 dsieger 6078:
1.154 rillig 6079: 21.1.4. Restricted packages
1.1 dsieger 6080:
1.111 sevan 6081: Some licenses restrict how software may be re-distributed. By declaring the
6082: restrictions, package tools can automatically refrain from e.g. placing binary
6083: packages on FTP sites.
6084:
6085: There are four possible restrictions, which are the cross product of sources
6086: (distfiles) and binaries not being placed on FTP sites and CD-ROMs. Because
6087: this is rarely the exact language in any license, and because non-Free licenses
6088: tend to be different from each other, pkgsrc adopts a definition of FTP and
6089: CD-ROM. "FTP" means making the source or binary file available over the
6090: Internet at no charge. "CD-ROM" means making the source or binary available on
6091: some kind of media, together with other source and binary packages, which is
6092: sold for a distribution charge.
1.1 dsieger 6093:
6094: In order to encode these restrictions, the package system defines five make
6095: variables that can be set to note these restrictions:
6096:
6097: * RESTRICTED
6098:
6099: This variable should be set whenever a restriction exists (regardless of
6100: its kind). Set this variable to a string containing the reason for the
6101: restriction. It should be understood that those wanting to understand the
6102: restriction will have to read the license, and perhaps seek advice of
6103: counsel.
6104:
6105: * NO_BIN_ON_CDROM
6106:
6107: Binaries may not be placed on CD-ROM containing other binary packages, for
6108: which a distribution charge may be made. In this case, set this variable to
6109: ${RESTRICTED}.
6110:
6111: * NO_BIN_ON_FTP
6112:
6113: Binaries may not made available on the Internet without charge. In this
6114: case, set this variable to ${RESTRICTED}. If this variable is set, binary
6115: packages will not be included on ftp.NetBSD.org.
6116:
6117: * NO_SRC_ON_CDROM
6118:
6119: Distfiles may not be placed on CD-ROM, together with other distfiles, for
6120: which a fee may be charged. In this case, set this variable to $
6121: {RESTRICTED}.
6122:
6123: * NO_SRC_ON_FTP
6124:
6125: Distfiles may not made available via FTP at no charge. In this case, set
6126: this variable to ${RESTRICTED}. If this variable is set, the distfile(s)
6127: will not be mirrored on ftp.NetBSD.org.
6128:
1.111 sevan 6129: Please note that packages will be removed from pkgsrc when the distfiles are
1.33 wiz 6130: not distributable and cannot be obtained for a period of one full quarter
1.111 sevan 6131: branch. Packages with manual/interactive fetch must have a maintainer and it is
6132: his/her responsibility to ensure this.
1.33 wiz 6133:
1.154 rillig 6134: 21.1.5. Handling dependencies
1.1 dsieger 6135:
1.175 gutterid 6136: Your package may depend on some other package being present, and there are
6137: various ways of expressing this dependency. pkgsrc supports the DEPENDS,
6138: BUILD_DEPENDS, TOOL_DEPENDS, and TEST_DEPENDS definitions, the USE_TOOLS
6139: definition, as well as dependencies via buildlink3.mk, which is the preferred
6140: way to handle dependencies, and which uses the variables named above. See
1.184 rillig 6141: Chapter 18, Buildlink methodology for more information.
1.175 gutterid 6142:
6143: The basic difference is that the DEPENDS definition registers that
6144: pre-requisite in the binary package so it will be pulled in when the binary
6145: package is later installed, whilst the BUILD_DEPENDS, TOOL_DEPENDS, and
6146: TEST_DEPENDS definitions do not, marking a dependency that is only needed for
1.184 rillig 6147: building or testing the resulting package. See also Chapter 14, Creating a new
1.175 gutterid 6148: pkgsrc package from scratch for more information.
6149:
6150: This means that if you only need a package present whilst you are building or
6151: testing, it should be noted as a TOOL_DEPENDS, BUILD_DEPENDS, or TEST_DEPENDS.
6152: When cross-compiling, TOOL_DEPENDS are native packages, i.e. packages for the
6153: architecture where the package is built; BUILD_DEPENDS are target packages,
6154: i.e., packages for the architecture for which the package is built.
1.1 dsieger 6155:
1.175 gutterid 6156: The format for a DEPENDS, BUILD_DEPENDS, TOOL_DEPENDS, and TEST_DEPENDS
6157: definition is:
1.1 dsieger 6158:
6159: <pre-req-package-name>:../../<category>/<pre-req-package>
6160:
6161: Please note that the "pre-req-package-name" may include any of the wildcard
6162: version numbers recognized by pkg_info(1).
6163:
1.55 wiz 6164: 1. If your package needs another package's binaries or libraries to build and
1.1 dsieger 6165: run, and if that package has a buildlink3.mk file available, use it:
6166:
6167: .include "../../graphics/jpeg/buildlink3.mk"
6168:
1.55 wiz 6169: 2. If your package needs another package's binaries or libraries only for
6170: building, and if that package has a buildlink3.mk file available, use it:
6171:
6172: .include "../../graphics/jpeg/buildlink3.mk"
6173:
6174: but set BUILDLINK_DEPMETHOD.jpeg?=build to make it a build dependency only.
6175: This case is rather rare.
6176:
6177: 3. If your package needs binaries from another package to build, use the
1.156 leot 6178: TOOL_DEPENDS definition:
6179:
6180: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.1 dsieger 6181:
1.156 leot 6182: 4. If your package needs static libraries to link against, header files to
6183: include, etc. from another package to build, use the BUILD_DEPENDS
6184: definition.
1.1 dsieger 6185:
1.156 leot 6186: 5. If your package needs a library with which to link and there is no
1.26 spz 6187: buildlink3.mk file available, create one. Using DEPENDS won't be sufficient
6188: because the include files and libraries will be hidden from the compiler.
1.1 dsieger 6189:
1.156 leot 6190: 6. If your package needs some executable to be able to run correctly and if
1.26 spz 6191: there's no buildlink3.mk file, this is specified using the DEPENDS
6192: variable. The print/lyx package needs to be able to execute the latex
1.129 wiz 6193: binary from the tex-latex-bin package when it runs, and that is specified:
1.1 dsieger 6194:
1.129 wiz 6195: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.1 dsieger 6196:
1.175 gutterid 6197: 7. If your package includes a test suite that has extra dependencies only
6198: required for this purpose (frequently this can be run as a "make test"
6199: target), use the TEST_DEPENDS variable.
6200:
6201: 8. You can use wildcards in package dependencies. Note that such wildcard
1.26 spz 6202: dependencies are retained when creating binary packages. The dependency is
6203: checked when installing the binary package and any package which matches
6204: the pattern will be used. Wildcard dependencies should be used with care.
1.1 dsieger 6205:
6206: The "-[0-9]*" should be used instead of "-*" to avoid potentially ambiguous
6207: matches such as "tk-postgresql" matching a "tk-*" DEPENDS.
6208:
6209: Wildcards can also be used to specify that a package will only build
6210: against a certain minimum version of a pre-requisite:
6211:
1.26 spz 6212: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 6213:
1.26 spz 6214: This means that the package will build using version 6.0 of ImageMagick or
6215: newer. Such a dependency may be warranted if, for example, the command line
6216: options of an executable have changed.
6217:
1.183 wiz 6218: If you need to depend on minimum versions of libraries, set
6219: BUILDLINK_API_DEPENDS.pkg to the appropriate pattern before including its
6220: buildlink3.mk file, e.g.
6221:
6222: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
6223: .include "../../graphics/jpeg/buildlink3.mk"
1.1 dsieger 6224:
6225: For security fixes, please update the package vulnerabilities file. See
1.154 rillig 6226: Section 21.1.9, "Handling packages with security problems" for more
1.1 dsieger 6227: information.
6228:
6229: If your package needs files from another package to build, add the relevant
6230: distribution files to DISTFILES, so they will be extracted automatically. See
6231: the print/ghostscript package for an example. (It relies on the jpeg sources
6232: being present in source form during the build.)
6233:
1.154 rillig 6234: 21.1.6. Handling conflicts with other packages
1.1 dsieger 6235:
1.226 gutterid 6236: Your package may conflict with other packages users might already have
6237: installed on their system, e.g., if your package installs the same set of files
1.227 wiz 6238: as another package in the pkgsrc tree.
1.1 dsieger 6239:
1.142 leot 6240: For example, x11/libXaw3d and x11/Xaw-Xpm install the same shared library, thus
6241: you set in pkgsrc/x11/libXaw3d/Makefile:
1.1 dsieger 6242:
1.142 leot 6243: CONFLICTS= Xaw-Xpm-[0-9]*
1.1 dsieger 6244:
1.142 leot 6245: and in pkgsrc/x11/Xaw-Xpm/Makefile:
1.1 dsieger 6246:
1.142 leot 6247: CONFLICTS= libXaw3d-[0-9]*
1.1 dsieger 6248:
1.142 leot 6249: pkg_add(1) is able to detect attempts to install packages that conflict with
6250: existing packages and abort. However, in many situations this is too late in
6251: the process. Binary package managers will not know about the conflict until
6252: they attempt to install the package after already downloading it and all its
6253: dependencies. Users may also waste time building a package and its dependencies
6254: only to find out at the end that it conflicts with another package they have
6255: installed.
6256:
6257: To avoid these issues CONFLICTS entries should be added in all cases where it
6258: is known that packages conflict with each other. These CONFLICTS entries are
6259: exported in pkg_summary(5) files and consumed by binary package managers to
6260: inform users that packages cannot be installed onto the target system.
1.1 dsieger 6261:
1.154 rillig 6262: 21.1.7. Packages that cannot or should not be built
1.1 dsieger 6263:
6264: There are several reasons why a package might be instructed to not build under
6265: certain circumstances. If the package builds and runs on most platforms, the
1.83 dholland 6266: exceptions should be noted with BROKEN_ON_PLATFORM. If the package builds and
6267: runs on a small handful of platforms, set BROKEN_EXCEPT_ON_PLATFORM instead.
6268: Both BROKEN_ON_PLATFORM and BROKEN_EXCEPT_ON_PLATFORM are OS triples
6269: (OS-version-platform) that can use glob-style wildcards.
6270:
1.114 maya 6271: If a package is not appropriate for some platforms (as opposed to merely
1.83 dholland 6272: broken), a different set of variables should be used as this affects failure
6273: reporting and statistics. If the package is appropriate for most platforms, the
6274: exceptions should be noted with NOT_FOR_PLATFORM. If the package is appropriate
6275: for only a small handful of platforms (often exactly one), set
6276: ONLY_FOR_PLATFORM instead. Both ONLY_FOR_PLATFORM and NOT_FOR_PLATFORM are OS
6277: triples (OS-version-platform) that can use glob-style wildcards.
1.1 dsieger 6278:
6279: Some packages are tightly bound to a specific version of an operating system,
6280: e.g. LKMs or sysutils/lsof. Such binary packages are not backwards compatible
6281: with other versions of the OS, and should be uploaded to a version specific
6282: directory on the FTP server. Mark these packages by setting OSVERSION_SPECIFIC
6283: to "yes". This variable is not currently used by any of the package system
6284: internals, but may be used in the future.
6285:
6286: If the package should be skipped (for example, because it provides
6287: functionality already provided by the system), set PKG_SKIP_REASON to a
6288: descriptive message. If the package should fail because some preconditions are
6289: not met, set PKG_FAIL_REASON to a descriptive message.
6290:
1.154 rillig 6291: 21.1.8. Packages which should not be deleted, once installed
1.1 dsieger 6292:
6293: To ensure that a package may not be deleted, once it has been installed, the
6294: PKG_PRESERVE definition should be set in the package Makefile. This will be
1.25 wiz 6295: carried into any binary package that is made from this pkgsrc entry. A "
6296: preserved" package will not be deleted using pkg_delete(1) unless the "-f"
1.1 dsieger 6297: option is used.
6298:
1.154 rillig 6299: 21.1.9. Handling packages with security problems
1.1 dsieger 6300:
1.247 wiz 6301: When a vulnerability is found, this should be noted in pkgsrc/doc/
6302: pkg-vulnerabilities. Entries in that file consist of three parts:
1.205 wiz 6303:
6304: * package version pattern
6305:
6306: * type of vulnerability (please cut'n'paste an existing one where possible)
6307:
6308: * URL providing additional information about the issue
6309:
6310: For the package version pattern please always use `<' to mark an upper bound
6311: (not `<='!). This will avoid possible problems due unrelated PKGREVISION bumps
6312: not related to security fixes. Lower bounds can be added too, using '>' or '>=
1.206 wiz 6313: '. For example, "foo>=1<1.2" would mark versions 1.0 (included) to 1.2
1.205 wiz 6314: (excluded) of "foo" as affected by the security issue.
6315:
6316: Entries should always be added at the bottom of the file.
6317:
6318: When fixing packages, please modify the upper bound of the corresponding entry.
6319: To continue the previous example, if a fix was backported to version 1.1nb2,
1.206 wiz 6320: change the previous pattern to "foo>=1<1.1nb2".
1.205 wiz 6321:
6322: To locally test a package version pattern against a PKGNAME you can use the
6323: pkg_admin pmatch command.
6324:
6325: The URL should be as permanent as possible and provide as much information
6326: about the issue as possible. CVE entries are preferred.
6327:
6328: After committing that file, ask pkgsrc-security@NetBSD.org to update the file
6329: on ftp.NetBSD.org.
1.1 dsieger 6330:
6331: After fixing the vulnerability by a patch, its PKGREVISION should be increased
6332: (this is of course not necessary if the problem is fixed by using a newer
1.32 wiz 6333: release of the software), and the pattern in the pkg-vulnerabilities file must
6334: be updated.
1.1 dsieger 6335:
6336: Also, if the fix should be applied to the stable pkgsrc branch, be sure to
6337: submit a pullup request!
6338:
6339: Binary packages already on ftp.NetBSD.org will be handled semi-automatically by
6340: a weekly cron job.
6341:
1.205 wiz 6342: In case a security issue is disputed, please contact
6343: pkgsrc-security@NetBSD.org.
6344:
1.154 rillig 6345: 21.1.10. How to handle incrementing versions when fixing an existing package
1.1 dsieger 6346:
6347: When making fixes to an existing package it can be useful to change the version
6348: number in PKGNAME. To avoid conflicting with future versions by the original
6349: author, a "nb1", "nb2", ... suffix can be used on package versions by setting
6350: PKGREVISION=1 (2, ...). The "nb" is treated like a "." by the package tools.
6351: e.g.
6352:
6353: DISTNAME= foo-17.42
6354: PKGREVISION= 9
6355:
6356: will result in a PKGNAME of "foo-17.42nb9". If you want to use the original
6357: value of PKGNAME without the "nbX" suffix, e.g. for setting DIST_SUBDIR, use
6358: PKGNAME_NOREV.
6359:
6360: When a new release of the package is released, the PKGREVISION should be
6361: removed, e.g. on a new minor release of the above package, things should be
6362: like:
6363:
6364: DISTNAME= foo-17.43
6365:
6366: PKGREVISION should be incremented for any non-trivial change in the resulting
6367: binary package. Without a PKGREVISION bump, someone with the previous version
6368: installed has no way of knowing that their package is out of date. Thus,
6369: changes without increasing PKGREVISION are essentially labeled "this is so
6370: trivial that no reasonable person would want to upgrade", and this is the rough
6371: test for when increasing PKGREVISION is appropriate. Examples of changes that
6372: do not merit increasing PKGREVISION are:
6373:
1.14 jmcneill 6374: * Changing HOMEPAGE, MAINTAINER, OWNER, or comments in Makefile.
1.1 dsieger 6375:
6376: * Changing build variables if the resulting binary package is the same.
6377:
6378: * Changing DESCR.
6379:
6380: * Adding PKG_OPTIONS if the default options don't change.
6381:
6382: Examples of changes that do merit an increase to PKGREVISION include:
6383:
6384: * Security fixes
6385:
6386: * Changes or additions to a patch file
6387:
6388: * Changes to the PLIST
6389:
1.12 weinem 6390: * A dependency is changed or renamed.
6391:
1.1 dsieger 6392: PKGREVISION must also be incremented when dependencies have ABI changes.
6393:
1.154 rillig 6394: 21.1.11. Substituting variable text in the package files (the SUBST framework)
1.1 dsieger 6395:
1.180 rillig 6396: When you want to replace the same text in multiple files, or multiple times in
6397: the same file, it is cumbersome to maintain a patch file for this. This is
6398: where the SUBST framework steps in. It provides an easy-to-use interface for
6399: replacing text in files. It just needs the following information:
1.172 rillig 6400:
1.180 rillig 6401: * In which phase of the package build cycle should the replacement happen?
1.172 rillig 6402:
1.180 rillig 6403: * In which files should the replacement happen?
1.172 rillig 6404:
6405: * Which text should be replaced with what?
6406:
1.180 rillig 6407: This information is encoded in a block of SUBST variables. A minimal example
6408: is:
6409:
6410: SUBST_CLASSES+= paths
6411: SUBST_STAGE.paths= pre-configure
6412: SUBST_FILES.paths= src/*.c
6413: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
6414:
6415: Translated into English, it means: In the pre-configure stage (that is, after
6416: applying the patches from the patches/ directory and before running the
6417: configure script and the portability check), replace the text /usr/local with
6418: the content of the variable PREFIX.
6419:
6420: Each SUBST block starts by appending an identifier to SUBST_CLASSES (note the +
6421: =). This identifier can be chosen freely by the package. If there should ever
6422: be duplicate identifiers, the pkgsrc infrastructure will catch this and fail
6423: early, so don't worry about name collisions.
6424:
6425: Except for SUBST_CLASSES, all variables in a SUBST block are parameterized
6426: using this identifier. In the remainder of this section, these parameterized
6427: variables are written as SUBST_STAGE.*.
6428:
6429: SUBST_CLASSES+= paths
6430: SUBST_STAGE.paths= pre-configure
6431: SUBST_MESSAGE.paths= Fixing absolute paths.
6432: SUBST_FILES.paths= src/*.c
6433: SUBST_FILES.paths+= scripts/*.sh
6434: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
6435: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
6436: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
6437:
6438: To get a complete picture about the SUBST substitutions, run bmake
6439: show-all-subst. If something doesn't work as expected, run pkglint on the
6440: package, which detects several typical mistakes surrounding the SUBST blocks.
6441: For any questions that might remain after this, have a look at mk/subst.mk.
6442:
6443: 21.1.11.1. Choosing the time where the substitutions happen
6444:
6445: The SUBST_STAGE.* is one of {pre,do,post}-
6446: {extract,patch,configure,build,test,install}. Of these, pre-configure is used
6447: most often, by far. The most popular stages are, in chronological order:
6448:
6449: post-extract
6450:
6451: The substitutions are applied immediately after the distfiles are
6452: extracted. Running bmake extract on the package will leave no traces of the
6453: original files.
6454:
6455: When the substitution applies to files for which there is also a patch in
6456: the patches/ directory, this means that the patches will be computed based
6457: on the result of the substitution. When these patches are sent to the
6458: upstream maintainer later, to be fixed in the upstream package, these
6459: patches may no longer match what the upstream author is used to. Because of
6460: this, pre-configure is often a better choice.
6461:
6462: pre-configure
6463:
6464: The substitutions are applied after the patches from the patches/
6465: directory. This makes it possible to run bmake patch on the package, after
6466: which the patches can be edited using the tools pkgvi and mkpatches from
6467: the pkgtools/pkgdiff package.
6468:
6469: When updating the patches, it is helpful to explicitly separate the bmake
6470: patch from the bmake configure, and to only edit the patches between these
6471: commands. Otherwise the substitutions from the SUBST block will end up in
6472: the patch file. When this happens in really obvious ways, pkglint will
6473: complain about patches that contain a hard-coded /usr/pkg instead of the
6474: correct and intended @PREFIX@, but it can only detect these really obvious
6475: cases.
6476:
6477: do-configure
6478:
6479: This stage should only be used if the package defines a pre-configure
6480: action itself, and the substitution must happen after that. Typical
6481: examples are packages that use the pre-configure stage to regenerate the
6482: GNU configure script from configure.ac.
6483:
6484: post-configure
6485:
6486: This stage is used to fix up any mistakes by the configure stage.
6487:
6488: pre-build
6489:
6490: This stage should only be used for substitutions that are clearly related
6491: to building the package, not for fixing the configuration. Substitutions
6492: for pathnames (such as replacing /usr/local with ${PREFIX}) or user names
6493: (such as replacing @MY_USER@ with the actual username) belong in
6494: pre-configure or post-configure instead.
6495:
6496: post-build
6497:
6498: Just as with pre-build, this stage should only be used for substitutions
6499: that are clearly related to building the package, not for fixing the
6500: configuration. Substitutions for pathnames (such as replacing /usr/local
6501: with ${PREFIX}) or user names (such as replacing @MY_USER@ with the actual
6502: username) belong in pre-configure or post-configure instead.
6503:
6504: A typical use is to update pkg-config files to include the rpath compiler
6505: options.
6506:
6507: pre-install
6508:
6509: In general, the install phase should be as simple as possible. As with the
6510: pre-build and post-build stages, it should not be used to fix pathnames or
6511: user names, these belong in pre-configure instead. There are only few
6512: legitimate use cases for applying substitutions in this stage.
6513:
1.181 rillig 6514: 21.1.11.2. Choosing the files where the substitutions happen
1.180 rillig 6515:
6516: The SUBST_FILES.* variable contains a list of filename patterns. These patterns
6517: are relative to WRKSRC since that is where most substitutions happen. A typical
6518: example is:
6519:
6520: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
6521:
6522: The above patterns, especially the last, are quite broad. The SUBST
6523: implementation checks that each filename pattern that is mentioned here has an
6524: effect. For example, if none of the */*/Makefile files contains the patterns to
6525: be found and substituted, that filename pattern is redundant and should be left
1.181 rillig 6526: out. By default, the SUBST framework will complain with an error message. If
6527: the text to be substituted occurs in some of the files from a single pattern,
6528: but not in all of them, that is totally ok, and the SUBST framework will only
6529: print an INFO message for those files.
1.180 rillig 6530:
6531: If there is a good reason for having redundant filename patterns, set
1.181 rillig 6532: SUBST_NOOP_OK.* to yes.
1.180 rillig 6533:
6534: Another popular way of choosing the files for the substitutions is via a shell
6535: command, like this:
6536:
1.181 rillig 6537: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 6538: SUBST_FILES.path= ${C_FILES_CMD:sh}
6539:
6540: The variable name C_FILES_CMD in this example is freely chosen and independent
6541: of the SUBST framework.
6542:
6543: In this variant, the SUBST_FILES.* variable lists each file individually.
6544: Thereby chances are higher that there are filename patterns in which no
6545: substitution happens. Since the SUBST framework cannot know whether the
6546: filename patterns in SUBST_FILES.* have been explicitly listed in the Makefile
6547: (where any redundant filename pattern would be suspicious) or been generated by
6548: a shell command (in which redundant filename patterns are more likely and to be
6549: expected), it will complain about these redundant filename patterns. Therefore,
6550: SUBST blocks that use a shell command to generate the list of filename patterns
6551: often need to set SUBST_NOOP_OK.* to yes.
6552:
6553: 21.1.11.3. Choosing what to substitute
6554:
6555: In most cases, the substitutions are given using one or more sed(1) commands,
6556: like this:
6557:
6558: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
6559:
6560: Each of the sed commands needs to be preceded by the -e option and should be
6561: specified on a line of its own, to avoid hiding short sed commands at the end
6562: of a line.
6563:
6564: Since the sed commands often contain shell metacharacters as the separator (the
6565: | in the above example), it is common to enclose them in single quotes.
6566:
6567: A common substitution is to replace placeholders of the form @VARNAME@ with
6568: their pkgsrc counterpart variable ${VARNAME}. A typical example is:
6569:
6570: SUBST_VARS.path= PREFIX
6571:
1.181 rillig 6572: This type of substitutions is typically done by the GNU configure scripts
6573: during the do-configure stage, but in some cases these need to be overridden.
6574: The same pattern is also used when a package defines patches that replace
6575: previously hard-coded paths like /usr/local with a @PREFIX@ placeholder first,
6576: which then gets substituted by the actual ${PREFIX} in the pre-configure stage.
6577: In many of these cases, it works equally well to just use the SUBST framework
6578: to directly replace /usr/local with ${PREFIX}, thereby omitting the
6579: intermediate patch file.
1.180 rillig 6580:
6581: If the above is not flexible enough, it is possible to not use sed at all for
6582: the substitution but to specify an entirely different command, like this:
6583:
6584: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
1.1 dsieger 6585:
1.180 rillig 6586: This is used for the few remaining packages in which the distributed files use
6587: Windows-style line endings that need to be converted to UNIX-style line
6588: endings.
1.1 dsieger 6589:
1.180 rillig 6590: 21.1.11.4. Other SUBST variables
1.172 rillig 6591:
1.180 rillig 6592: When a SUBST block is applied during a package build, a message is logged. The
6593: default message is fine for most purposes but can be overridden by setting
6594: SUBST_MESSAGE.* to an individual message.
1.1 dsieger 6595:
1.154 rillig 6596: 21.2. The fetch phase
1.1 dsieger 6597:
1.154 rillig 6598: 21.2.1. Packages whose distfiles aren't available for plain downloading
1.1 dsieger 6599:
6600: If you need to download from a dynamic URL you can set DYNAMIC_MASTER_SITES and
6601: a make fetch will call files/getsite.sh with the name of each file to download
6602: as an argument, expecting it to output the URL of the directory from which to
6603: download it. graphics/ns-cult3d is an example of this usage.
6604:
6605: If the download can't be automated, because the user must submit personal
6606: information to apply for a password, or must pay for the source, or whatever,
6607: you can set FETCH_MESSAGE to a list of lines that are displayed to the user
6608: before aborting the build. Example:
6609:
6610: FETCH_MESSAGE= "Please download the files"
6611: FETCH_MESSAGE+= " "${DISTFILES:Q}
6612: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
6613:
1.154 rillig 6614: 21.2.2. How to handle modified distfiles with the 'old' name
1.1 dsieger 6615:
6616: Sometimes authors of a software package make some modifications after the
6617: software was released, and they put up a new distfile without changing the
6618: package's version number. If a package is already in pkgsrc at that time, the
6619: checksum will no longer match. The contents of the new distfile should be
6620: compared against the old one before changing anything, to make sure the
6621: distfile was really updated on purpose, and that no trojan horse or so crept
6622: in. Please mention that the distfiles were compared and what was found in your
1.54 rodent 6623: commit message.
6624:
6625: Then, the correct way to work around this is to set DIST_SUBDIR to a unique
1.109 wiz 6626: directory name, usually based on PKGNAME_NOREV (but take care with python or
6627: ruby packages, where PKGNAME includes a variable prefix). All DISTFILES and
6628: PATCHFILES for this package will be put in that subdirectory of the local
1.154 rillig 6629: distfiles directory. (See Section 21.1.10, "How to handle incrementing versions
1.109 wiz 6630: when fixing an existing package" for more details.) In case this happens more
6631: often, PKGNAME can be used (thus including the nbX suffix) or a date stamp can
6632: be appended, like ${PKGNAME_NOREV}-YYYYMMDD.
1.54 rodent 6633:
6634: DIST_SUBDIR is also used when a distfile's name does not contain a version and
6635: the distfile is apt to change. In cases where the likelihood of this is very
6636: small, DIST_SUBDIR might not be required. Additionally, DIST_SUBDIR must not be
6637: removed unless the distfile name changes, even if a package is being moved or
6638: renamed.
6639:
6640: Do not forget regenerating the distinfo file after that, since it contains the
6641: DIST_SUBDIR path in the filenames. Also, increase the PKGREVISION if the
6642: installed package is different. Furthermore, a mail to the package's authors
6643: seems appropriate telling them that changing distfiles after releases without
6644: changing the file names is not good practice.
1.1 dsieger 6645:
1.154 rillig 6646: 21.2.3. Packages hosted on github.com
1.88 tnn 6647:
1.90 tnn 6648: Helper methods exist for packages hosted on github.com which will often have
6649: distfile names that clash with other packages, for example 1.0.tar.gz. Use one
6650: of the three recipes from below:
1.88 tnn 6651:
1.154 rillig 6652: 21.2.3.1. Fetch based on a tagged release
1.88 tnn 6653:
1.189 bacon 6654: If your distfile URL looks similar to https://github.com/username/example/
6655: archive/v1.0.zip, then you are packaging a tagged release.
1.88 tnn 6656:
1.189 bacon 6657: DISTNAME= example-1.0
1.90 tnn 6658: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 6659: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 6660: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 6661: EXTRACT_SUFX= .zip
6662:
1.230 gutterid 6663: Here, DISTNAME combined with use of GITHUB_TAG leads the file fetching
6664: infrastructure to save the resulting file locally as example-1.0.zip.
6665:
1.189 bacon 6666: 21.2.3.2. Fetch based on a specific commit before the first release
6667:
6668: If your distfile looks similar to https://github.com/username/example/archive/
6669: 988881adc9fc3655077dc2d4d757d480b5ea0e11 and is from a commit before the first
6670: release, then set the package version to 0.0.0.N, where N is the number of
6671: commits to the repository, and set GITHUB_TAG to the commit hash. This will
6672: (almost) ensure that the first tagged release will have a version greater than
6673: this one so that package upgrades will function properly.
6674:
6675: DISTNAME= example-0.0.0.347
6676: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6677: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
6678: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
6679:
6680: 21.2.3.3. Fetch based on a specific commit after a release
1.88 tnn 6681:
1.189 bacon 6682: If your distfile looks similar to https://github.com/username/example/archive/
6683: 988881adc9fc3655077dc2d4d757d480b5ea0e11 and is from a commit after a release,
6684: then include the last release version and the commit count since that release
6685: in the package version and set GITHUB_TAG to the commit hash. The latest
6686: release and commit count are shown in the output of "git describe --tags":
6687:
6688: # git clone https://github.com/username/example
6689: # cd example
6690: # git describe --tags
6691: 1.2.3-5-g988881a
1.88 tnn 6692:
1.189 bacon 6693: DISTNAME= example-1.2.3.5
6694: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6695: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 6696: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.88 tnn 6697:
1.189 bacon 6698: 21.2.3.4. Fetch based on release
1.88 tnn 6699:
1.189 bacon 6700: If your distfile URL looks similar to https://github.com/username/example/
6701: releases/download/rel-1.6/offensive-1.6.zip, then you are packaging a release.
1.88 tnn 6702:
1.90 tnn 6703: DISTNAME= offensive-1.6
1.88 tnn 6704: PKGNAME= ${DISTNAME:S/offensive/proper/}
1.90 tnn 6705: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 6706: GITHUB_PROJECT= example
1.90 tnn 6707: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
6708: EXTRACT_SUFX= .zip
1.88 tnn 6709:
1.154 rillig 6710: 21.3. The configure phase
1.1 dsieger 6711:
1.154 rillig 6712: 21.3.1. Shared libraries - libtool
1.1 dsieger 6713:
6714: pkgsrc supports many different machines, with different object formats like
6715: a.out and ELF, and varying abilities to do shared library and dynamic loading
6716: at all. To accompany this, varying commands and options have to be passed to
6717: the compiler, linker, etc. to get the Right Thing, which can be pretty annoying
6718: especially if you don't have all the machines at your hand to test things. The
6719: devel/libtool pkg can help here, as it just "knows" how to build both static
6720: and dynamic libraries from a set of source files, thus being
6721: platform-independent.
6722:
6723: Here's how to use libtool in a package in seven simple steps:
6724:
6725: 1. Add USE_LIBTOOL=yes to the package Makefile.
6726:
6727: 2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of "$
6728: {CC}". You could even add it to the definition of CC, if only libraries are
6729: being built in a given Makefile. This one command will build both PIC and
6730: non-PIC library objects, so you need not have separate shared and
6731: non-shared library rules.
6732:
6733: 3. For the linking of the library, remove any "ar", "ranlib", and "ld
6734: -Bshareable" commands, and instead use:
6735:
6736: ${LIBTOOL} --mode=link \
6737: ${CC} -o ${.TARGET:.a=.la} \
6738: ${OBJS:.o=.lo} \
6739: -rpath ${PREFIX}/lib \
6740: -version-info major:minor
6741:
6742: Note that the library is changed to have a .la extension, and the objects
6743: are changed to have a .lo extension. Change OBJS as necessary. This
6744: automatically creates all of the .a, .so.major.minor, and ELF symlinks (if
6745: necessary) in the build directory. Be sure to include "-version-info",
6746: especially when major and minor are zero, as libtool will otherwise strip
6747: off the shared library version.
6748:
6749: From the libtool manual:
6750:
6751: So, libtool library versions are described by three integers:
6752:
6753: CURRENT
6754: The most recent interface number that this library implements.
6755:
6756: REVISION
6757: The implementation number of the CURRENT interface.
6758:
6759: AGE
6760: The difference between the newest and oldest interfaces that
6761: this library implements. In other words, the library implements
6762: all the interface numbers in the range from number `CURRENT -
6763: AGE' to `CURRENT'.
6764:
6765: If two libraries have identical CURRENT and AGE numbers, then the
6766: dynamic linker chooses the library with the greater REVISION number.
6767:
6768: The "-release" option will produce different results for a.out and ELF
1.25 wiz 6769: (excluding symlinks) in only one case. An ELF library of the form "
6770: libfoo-release.so.x.y" will have a symlink of "libfoo.so.x.y" on an a.out
1.1 dsieger 6771: platform. This is handled automatically.
6772:
6773: The "-rpath argument" is the install directory of the library being built.
6774:
6775: In the PLIST, include only the .la file, the other files will be added
6776: automatically.
6777:
6778: 4. When linking shared object (.so) files, i.e. files that are loaded via
6779: dlopen(3), NOT shared libraries, use "-module -avoid-version" to prevent
6780: them getting version tacked on.
6781:
6782: The PLIST file gets the foo.so entry.
6783:
6784: 5. When linking programs that depend on these libraries before they are
6785: installed, preface the cc(1) or ld(1) line with "${LIBTOOL} --mode=link",
6786: and it will find the correct libraries (static or shared), but please be
6787: aware that libtool will not allow you to specify a relative path in -L
6788: (such as "-L../somelib"), because it expects you to change that argument to
6789: be the .la file. e.g.
6790:
6791: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
6792:
6793: should be changed to:
6794:
6795: ${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
6796:
6797: and it will do the right thing with the libraries.
6798:
6799: 6. When installing libraries, preface the install(1) or cp(1) command with "$
6800: {LIBTOOL} --mode=install", and change the library name to .la. e.g.
6801:
1.23 jakllsch 6802: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 6803:
6804: This will install the static .a, shared library, any needed symlinks, and
6805: run ldconfig(8).
6806:
6807: 7. In your PLIST, include only the .la file (this is a change from previous
6808: behaviour).
6809:
1.154 rillig 6810: 21.3.2. Using libtool on GNU packages that already support libtool
1.1 dsieger 6811:
6812: Add USE_LIBTOOL=yes to the package Makefile. This will override the package's
6813: own libtool in most cases. For older libtool using packages, libtool is made by
6814: ltconfig script during the do-configure step; you can check the libtool script
6815: location by doing make configure; find work*/ -name libtool.
6816:
6817: LIBTOOL_OVERRIDE specifies which libtool scripts, relative to WRKSRC, to
6818: override. By default, it is set to "libtool */libtool */*/libtool". If this
6819: does not match the location of the package's libtool script(s), set it as
6820: appropriate.
6821:
6822: If you do not need *.a static libraries built and installed, then use
6823: SHLIBTOOL_OVERRIDE instead.
6824:
6825: If your package makes use of the platform-independent library for loading
6826: dynamic shared objects, that comes with libtool (libltdl), you should include
6827: devel/libltdl/buildlink3.mk.
6828:
6829: Some packages use libtool incorrectly so that the package may not work or build
6830: in some circumstances. Some of the more common errors are:
6831:
6832: * The inclusion of a shared object (-module) as a dependent library in an
6833: executable or library. This in itself isn't a problem if one of two things
6834: has been done:
6835:
6836: 1. The shared object is named correctly, i.e. libfoo.la, not foo.la
6837:
6838: 2. The -dlopen option is used when linking an executable.
6839:
6840: * The use of libltdl without the correct calls to initialisation routines.
6841: The function lt_dlinit() should be called and the macro
6842: LTDL_SET_PRELOADED_SYMBOLS included in executables.
6843:
1.154 rillig 6844: 21.3.3. GNU Autoconf/Automake
1.1 dsieger 6845:
6846: If a package needs GNU autoconf or automake to be executed to regenerate the
1.223 nia 6847: configure script and Makefile.in makefile templates from configure.ac and
6848: Makefile.am, then they should be executed in a pre-configure target:
1.1 dsieger 6849:
1.223 nia 6850: USE_TOOLS+= autoconf automake autoreconf
6851: GNU_CONFIGURE= yes
1.1 dsieger 6852: ...
6853:
6854: pre-configure:
1.223 nia 6855: set -e; cd ${WRKSRC} && autoreconf -fi
1.1 dsieger 6856: ...
6857:
1.223 nia 6858: Packages which use GNU Automake will sometimes require GNU Make (gmake in
6859: USE_TOOLS), but not always. Note that autoreconf only needs to be executed if
6860: configure.ac or Makefiles are modified, or configure is not present.
1.1 dsieger 6861:
6862: There are times when the configure process makes additional changes to the
6863: generated files, which then causes the build process to try to re-execute the
6864: automake sequence. This is prevented by touching various files in the configure
6865: stage. If this causes problems with your package you can set AUTOMAKE_OVERRIDE=
6866: NO in the package Makefile.
6867:
1.223 nia 6868: 21.3.4. Meson / ninja
6869:
6870: Packages using Meson to configure need to include:
6871:
6872: .include "../../devel/meson/build.mk"
6873:
6874: In nearly all cases (any program with dependencies), pkg-config needs to be
6875: added to USE_TOOLS. If the package installs translation files for non-English
6876: languages, also add msgfmt and xgettext:
6877:
6878: USE_TOOLS+= pkg-config msgfmt xgettext
6879:
6880: If any options need to be passed to Meson, use MESON_ARGS instead of
6881: CONFIGURE_ARGS:
6882:
6883: MESON_ARGS+= -Dx11=false
6884:
1.154 rillig 6885: 21.4. Programming languages
1.1 dsieger 6886:
1.154 rillig 6887: 21.4.1. C, C++, and Fortran
1.1 dsieger 6888:
1.244 gutterid 6889: Compilers for the C and C++ languages come with the NetBSD base system. By
1.223 nia 6890: default, pkgsrc assumes that a package is written in C and will hide all other
6891: compilers (via the wrapper framework, see Chapter 18, Buildlink methodology).
1.1 dsieger 6892:
1.243 gutterid 6893: To declare which languages should be made available through pkgsrc's compiler
6894: wrappers, use the USE_LANGUAGES variable. Allowed values currently are:
1.212 wiz 6895:
1.244 gutterid 6896: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.212 wiz 6897:
6898: (and any combination). The default is "c". Packages using GNU configure
6899: scripts, even if written in C++, usually need a C compiler for the configure
1.244 gutterid 6900: phase.
1.243 gutterid 6901:
1.250 jnemeth 6902: To declare which features a package requires from the compiler, set either
1.243 gutterid 6903: USE_CC_FEATURES or USE_CXX_FEATURES. Allowed values for USE_CC_FEATURES are
6904: currently:
6905:
6906: c11, c99, has_include
6907:
6908: Allowed values for USE_CXX_FEATURES are currently:
6909:
6910: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
6911: charconv, parallelism_ts, unique_ptr, put_time,
6912: is_trivially_copy_constructible
1.1 dsieger 6913:
1.251 gutterid 6914: Note at present these variables only affect use of GCC, not other compilers.
6915:
1.244 gutterid 6916: Language variants like gnu99 and c++11 can be specified in FORCE_C_STD and
6917: FORCE_CXX_STD if the package does not explicitly set -std=... when compiling
6918: (i.e. the package assumes the compiler defaults to C++11 or some other
6919: standard). This is a common bug in upstream build systems.
6920:
6921: Allowed values for FORCE_C_STD are currently:
6922:
6923: c90, c99, c11, gnu90, gnu99, gnu11
6924:
6925: Allowed values for FORCE_CXX_STD are currently:
6926:
6927: c++03, c++11, c++14, c++17, c++20,
6928: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
6929:
1.251 gutterid 6930: Note at present these variables only affect use of GCC and Clang.
6931:
1.154 rillig 6932: 21.4.2. Java
1.1 dsieger 6933:
6934: If a program is written in Java, use the Java framework in pkgsrc. The package
6935: must include ../../mk/java-vm.mk. This Makefile fragment provides the following
6936: variables:
6937:
6938: * USE_JAVA defines if a build dependency on the JDK is added. If USE_JAVA is
6939: set to "run", then there is only a runtime dependency on the JDK. The
6940: default is "yes", which also adds a build dependency on the JDK.
6941:
6942: * Set USE_JAVA2 to declare that a package needs a Java2 implementation. The
6943: supported values are "yes", "1.4", and "1.5". "yes" accepts any Java2
6944: implementation, "1.4" insists on versions 1.4 or above, and "1.5" only
6945: accepts versions 1.5 or above. This variable is not set by default.
6946:
1.25 wiz 6947: * PKG_JAVA_HOME is automatically set to the runtime location of the used Java
6948: implementation dependency. It may be used to set JAVA_HOME to a good value
6949: if the program needs this variable to be defined.
6950:
1.205 wiz 6951: 21.4.3. Go
6952:
6953: If a program is written in Go and has any dependencies on other Go modules,
6954: have the package include ../../lang/go/go-module.mk.
6955:
6956: 1. Generate a list of those dependencies with make clean && make patch && make
6957: show-go-modules > go-modules.mk.
6958:
1.223 nia 6959: 2. Prepend .include "go-modules.mk" to any other .includes.
6960:
6961: 3. Incorporate these modules in distinfo with make makesum.
1.205 wiz 6962:
1.223 nia 6963: 21.4.4. Rust
1.205 wiz 6964:
1.223 nia 6965: If a program is written in Rust and uses Cargo to build, have the package
6966: include ../../lang/rust/cargo.mk.
1.205 wiz 6967:
1.223 nia 6968: 1. Generate a list of those dependencies with make CARGO_ARGS="build
6969: --release" build && make print-cargo-depends > cargo-depends.mk.
1.205 wiz 6970:
1.223 nia 6971: 2. Prepend .include "cargo-depends.mk" to any other .includes.
1.205 wiz 6972:
6973: 3. Incorporate these modules in distinfo with make makesum.
6974:
1.223 nia 6975: 21.4.5. Packages containing Perl scripts
1.1 dsieger 6976:
1.203 nia 6977: If your package contains interpreted Perl scripts, add "perl" to the USE_TOOLS
1.1 dsieger 6978: variable and set REPLACE_PERL to ensure that the proper interpreter path is
6979: set. REPLACE_PERL should contain a list of scripts, relative to WRKSRC, that
1.74 wiz 6980: you want adjusted. Every occurrence of */bin/perl in a she-bang line will be
1.210 gutterid 6981: replaced with the full path to the Perl executable.
1.1 dsieger 6982:
1.210 gutterid 6983: If a particular version of Perl is needed, set the PERL5_REQD variable to the
1.1 dsieger 6984: version number. The default is "5.0".
6985:
1.203 nia 6986: See Section 21.6.6, "Packages installing Perl modules" for information about
1.210 gutterid 6987: handling Perl modules.
6988:
6989: There is also the REPLACE_PERL6 variable for the language now known as Raku.
1.1 dsieger 6990:
1.223 nia 6991: 21.4.6. Packages containing shell scripts
1.41 wiz 6992:
6993: REPLACE_SH, REPLACE_BASH, REPLACE_CSH, and REPLACE_KSH can be used to replace
1.225 gutterid 6994: shell she-bangs in files. Please use the appropriate one, preferring REPLACE_SH
6995: when this shell is sufficient. Each should contain a list of scripts, relative
6996: to WRKSRC, that you want adjusted. Every occurrence of the matching shell in a
6997: she-bang line will be replaced with the full path to the shell executable. When
6998: using REPLACE_BASH, don't forget to add bash to USE_TOOLS.
1.41 wiz 6999:
1.223 nia 7000: 21.4.7. Other programming languages
1.1 dsieger 7001:
1.210 gutterid 7002: There are further similar REPLACE variables available, e.g., REPLACE_AWK for
7003: packages containing awk scripts, and REPLACE_R for R. These two, like the
1.211 gutterid 7004: others noted above, have their actions defined centrally in mk/configure/
7005: replace-interpreter.mk. Other languages define the actions of these variables
7006: within their own dedicated part of the tree, e.g., REPLACE_PHP is actioned in
1.245 gutterid 7007: lang/php/replace.mk, and REPLACE_PYTHON is actioned in lang/python/
1.211 gutterid 7008: application.mk. For other languages, consult the mk files found within their
1.216 gutterid 7009: specific directories (the naming convention varies), or check the list found in
7010: Appendix E, Help topics.
1.210 gutterid 7011:
7012: Currently, special handling for other languages varies in pkgsrc. If a compiler
7013: package provides a buildlink3.mk file, include that, otherwise just add a
7014: (build) dependency on the appropriate compiler package.
1.1 dsieger 7015:
1.154 rillig 7016: 21.5. The build phase
1.1 dsieger 7017:
7018: The most common failures when building a package are that some platforms do not
7019: provide certain header files, functions or libraries, or they provide the
7020: functions in a library that the original package author didn't know. To work
7021: around this, you can rewrite the source code in most cases so that it does not
7022: use the missing functions or provides a replacement function.
7023:
1.154 rillig 7024: 21.5.1. Compiling C and C++ code conditionally
1.1 dsieger 7025:
7026: If a package already comes with a GNU configure script, the preferred way to
7027: fix the build failure is to change the configure script, not the code. In the
7028: other cases, you can utilize the C preprocessor, which defines certain macros
7029: depending on the operating system and hardware architecture it compiles for.
7030: These macros can be queried using for example #if defined(__i386). Almost every
7031: operating system, hardware architecture and compiler has its own macro. For
7032: example, if the macros __GNUC__, __i386__ and __NetBSD__ are all defined, you
7033: know that you are using NetBSD on an i386 compatible CPU, and your compiler is
7034: GCC.
7035:
7036: The list of the following macros for hardware and operating system depends on
7037: the compiler that is used. For example, if you want to conditionally compile
7038: code on Solaris, don't use __sun__, as the SunPro compiler does not define it.
7039: Use __sun instead.
7040:
1.154 rillig 7041: 21.5.1.1. C preprocessor macros to identify the operating system
1.1 dsieger 7042:
1.223 nia 7043: To distinguish between specific NetBSD versions, you should use the following
7044: code.
7045:
7046: #ifdef __NetBSD__
7047: #include <sys/param.h>
7048: #if __NetBSD_Prereq__(9,99,17)
7049: /* use a newer feature */
7050: #else
7051: /* older code */
7052: #endif
7053: #endif
7054:
7055: #ifndef _WIN32
7056: /* Unix-like specific code */
7057: #endif
7058:
1.1 dsieger 7059: To distinguish between 4.4 BSD-derived systems and the rest of the world, you
7060: should use the following code.
7061:
7062: #include <sys/param.h>
7063: #if (defined(BSD) && BSD >= 199306)
7064: /* BSD-specific code goes here */
7065: #else
7066: /* non-BSD-specific code goes here */
7067: #endif
7068:
1.223 nia 7069: You can also test for the following macros:
1.1 dsieger 7070:
1.46 obache 7071: Cygwin __CYGWIN__
7072: DragonFly __DragonFly__
1.1 dsieger 7073: FreeBSD __FreeBSD__
1.46 obache 7074: Haiku __HAIKU__
1.1 dsieger 7075: Interix __INTERIX
7076: IRIX __sgi (TODO: get a definite source for this)
1.223 nia 7077: Linux __linux
1.83 dholland 7078: Mac OS X __APPLE__
1.46 obache 7079: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7080: Minix3 __minix
1.1 dsieger 7081: NetBSD __NetBSD__
7082: OpenBSD __OpenBSD__
7083: Solaris sun, __sun
7084:
1.154 rillig 7085: 21.5.1.2. C preprocessor macros to identify the hardware architecture
1.1 dsieger 7086:
7087: i386 i386, __i386, __i386__
1.223 nia 7088: x86-64 __amd64__, __x86_64__
7089: ARM __arm__
1.1 dsieger 7090: MIPS __mips
7091: SPARC sparc, __sparc
1.223 nia 7092: PowerPC __powerpc
1.1 dsieger 7093:
1.154 rillig 7094: 21.5.1.3. C preprocessor macros to identify the compiler
1.1 dsieger 7095:
7096: GCC __GNUC__ (major version), __GNUC_MINOR__
7097: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7098: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7099: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7100:
1.154 rillig 7101: 21.5.2. How to handle compiler bugs
1.1 dsieger 7102:
7103: Some source files trigger bugs in the compiler, based on combinations of
7104: compiler version and architecture and almost always relation to optimisation
7105: being enabled. Common symptoms are gcc internal errors or never finishing
7106: compiling a file.
7107:
7108: Typically, a workaround involves testing the MACHINE_ARCH and compiler version,
1.87 tnn 7109: disabling optimisation for that combination of file, MACHINE_ARCH and compiler.
7110:
7111: This used to be a big problem in the past, but is rarely needed now as compiler
7112: technology has matured. If you still need to add a compiler specific
7113: workaround, please do so in the file hacks.mk and describe the symptom and
7114: compiler version as detailed as possible.
1.1 dsieger 7115:
1.172 rillig 7116: 21.5.3. No such file or directory
7117:
7118: Compilation sometimes fails with an error message like this:
7119:
7120: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
7121: fatal error: pango/pango.h: No such file or directory
7122:
7123: The proper way to fix this problem depends on the type of the header, which is
7124: described in the following sections.
7125:
7126: 21.5.3.1. Headers from other packages
7127:
7128: If the header name looks like it comes from a different package, that other
7129: package should be included via the buildlink3 framework.
7130:
7131: First, look whether the header is somewhere in the buildlink3 directory below
7132: WRKDIR. In the above case of the missing Pango header:
7133:
7134: $ find work/.buildlink/ -print | grep -F pango/pango.h
7135:
7136: In the case of Pango, the output is:
7137:
7138: work/.buildlink/include/pango-1.0/pango/pango.h
7139:
7140: If the pango/pango.h file were placed directly in the .buildlink directory, it
7141: would have been found automatically. There is an extra pango-1.0 path component
7142: though, which means that the compiler command line must contain an option of
7143: the form -I${BUILDLINK3_PREFIX.pango}/include/pango-1.0. In most cases this
7144: option is generated by the configure script, which can be examined using:
7145:
7146: $ $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
7147: -I/usr/pkg/include/pango-1.0
7148: -I/usr/pkg/include/pango-1.0
7149: -I/usr/pkg/include/pango-1.0
7150: -I/usr/pkg/include/pango-1.0
7151: -I/usr/pkg/include/pango-1.0
7152:
7153: This looks good. These options are transformed by the buildlink wrapper to
7154: refer to the correct path inside work/.buildlink.
7155:
7156: Since the compilation fails though, examine the compiler command lines in work
7157: /.work.log to see whether the -I option is included in the particular command
7158: line.
7159:
7160: To further analyze the situation, run bmake build-env, which sets up an
7161: interactive, realistic environment including all the pkgsrc wrapper commands
7162: and environment variables. From there, try to compile some simple example
7163: programs that use the header.
7164:
7165: 21.5.3.2. Headers generated during the build
7166:
7167: If the name of the header seems to come from the package itself, and if the
7168: build is run with parallel jobs, the package may have some undeclared
7169: dependencies between the .c and the .h files, and a C file is compiled before
7170: its required header is generated.
7171:
7172: To see whether the build runs with parallel jobs, run bmake show-all-build |
7173: grep JOBS. Its output looks like this:
7174:
7175: usr MAKE_JOBS= 7
7176: pkg MAKE_JOBS_SAFE # undefined
7177: def _MAKE_JOBS_N= 7
7178:
7179: In this case the pkgsrc user has asked pkgsrc to build packages with 7 jobs in
7180: parallel (MAKE_JOBS). The package could have disabled parallel builds by
7181: setting MAKE_JOBS_SAFE to no, but in this case it hasn't.
7182:
7183: To see whether the build failure is caused by parallel builds, first save the
7184: exact error message and a bit of context, maybe you need it later for reporting
7185: a bug. Next, run:
7186:
7187: MAKE_JOBS_SAFE=no bmake clean build
7188:
7189: If that succeeds, file a bug report against the pkgsrc package, including the
7190: exact error message and the contents of your mk.conf file.
7191:
1.173 rillig 7192: 21.5.3.3. Symlinks
7193:
7194: Pkgsrc does not work reliably if any of LOCALBASE, VARBASE or WRKDIR contains a
7195: symlink. Since 2019Q2, the pkgsrc bootstrap program prevents installing pkgsrc
7196: in symlink-based directories. Existing pkgsrc installations are not checked for
7197: symlinks though.
7198:
7199: The "No such file or directory" error messages are a typical symptom of
7200: symlinks, and it's quite difficult to find out that this is the actual cause.
7201:
7202: 21.5.3.4. Stale working directories
7203:
7204: When building a hierarchy of packages, it may happen that one package is built
7205: and then pkgsrc is updated. This situation can provoke various hard to diagnose
7206: build errors. To clean up the situation:
7207:
1.223 nia 7208: $ (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.173 rillig 7209:
1.223 nia 7210: (The only purpose of the bsd.pkg.mk is to prevent running this command in the
7211: wrong directory.)
1.173 rillig 7212:
7213: If you have set WRKOBJDIR in mk.conf, remove that directory as well.
7214:
7215: 21.5.3.5. Other possible reasons
7216:
7217: On platforms other than BSD, third-party packages are installed in /usr/
7218: include, together with the base system. This means that pkgsrc cannot
7219: distinguish between headers provided by the base system (which it needs) and
7220: headers from third-party packages (which are often included in pkgsrc as well).
7221: This can lead to subtle version mismatches.
7222:
7223: In pkgsrc installations that have been active for several years, it may happen
7224: that some files are manually deleted. To exclude this unlikely reason, run
7225: pkg_admin check.
7226:
7227: It may help to run pkg_admin rebuild-tree to check/fix dependencies.
7228:
7229: If all of the above doesn't help, see Chapter 2, Getting help for contact
7230: information. Be prepared to describe what you have tried so far and what any
7231: error messages were.
7232:
1.172 rillig 7233: 21.5.4. Undefined reference to "..."
1.1 dsieger 7234:
7235: This error message often means that a package did not link to a shared library
7236: it needs. The following functions are known to cause this error message over
7237: and over.
7238:
7239: +-----------------------------------------------------+
7240: | Function |Library |Affected platforms|
7241: |-------------------------+--------+------------------|
7242: |accept, bind, connect |-lsocket|Solaris |
7243: |-------------------------+--------+------------------|
7244: |crypt |-lcrypt |DragonFly, NetBSD |
7245: |-------------------------+--------+------------------|
7246: |dlopen, dlsym |-ldl |Linux |
7247: |-------------------------+--------+------------------|
7248: |gethost* |-lnsl |Solaris |
7249: |-------------------------+--------+------------------|
7250: |inet_aton |-lresolv|Solaris |
7251: |-------------------------+--------+------------------|
7252: |nanosleep, sem_*, timer_*|-lrt |Solaris |
7253: |-------------------------+--------+------------------|
7254: |openpty |-lutil |Linux |
7255: +-----------------------------------------------------+
7256:
1.223 nia 7257: To fix these linker errors, it is often sufficient to add LIBS.OperatingSystem+
7258: = -lfoo to the package Makefile and then run bmake clean; bmake.
1.1 dsieger 7259:
1.223 nia 7260: 21.5.4.1. The SunPro compiler and inline functions
1.1 dsieger 7261:
7262: When you are using the SunPro compiler, there is another possibility. That
7263: compiler cannot handle the following code:
7264:
7265: extern int extern_func(int);
7266:
7267: static inline int
7268: inline_func(int x)
7269: {
7270: return extern_func(x);
7271: }
7272:
7273: int main(void)
7274: {
7275: return 0;
7276: }
7277:
7278: It generates the code for inline_func even if that function is never used. This
7279: code then refers to extern_func, which can usually not be resolved. To solve
7280: this problem you can try to tell the package to disable inlining of functions.
7281:
1.228 gutterid 7282: 21.5.4.2. Missing atomic functions
7283:
7284: When building for older machine architectures (e.g., i386, PowerPC), builds may
7285: fail because the package expects modern 64-bit atomic functions which the
7286: underlying hardware either doesn't support, or will only support with specific
7287: compiler flags. This is generally handled via inclusion of mk/atomic64.mk.
7288:
1.172 rillig 7289: 21.5.5. Running out of memory
1.1 dsieger 7290:
7291: Sometimes packages fail to build because the compiler runs into an operating
7292: system specific soft limit. With the UNLIMIT_RESOURCES variable pkgsrc can be
1.223 nia 7293: told to unlimit the resources. The allowed values are any combination of "
7294: cputime", "datasize", "memorysize", "stacksize" and "virtualsize". Setting this
7295: variable is similar to running the shell builtin ulimit command to raise the
7296: maximum data segment size or maximum stack size of a process, respectively, to
7297: their hard limits.
1.1 dsieger 7298:
1.154 rillig 7299: 21.6. The install phase
1.1 dsieger 7300:
1.154 rillig 7301: 21.6.1. Creating needed directories
1.1 dsieger 7302:
7303: The BSD-compatible install supplied with some operating systems cannot create
7304: more than one directory at a time. As such, you should call ${INSTALL_*_DIR}
7305: like this:
7306:
7307: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7308: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
7309:
1.223 nia 7310: Instead of running the install commands directly, you can also append "dir1
7311: dir2" to the INSTALLATION_DIRS variable, which will automatically do the right
7312: thing.
1.1 dsieger 7313:
1.154 rillig 7314: 21.6.2. Where to install documentation
1.1 dsieger 7315:
7316: In general, documentation should be installed into ${PREFIX}/share/doc/$
1.223 nia 7317: {PKGBASE} or ${PREFIX}/share/doc/${PKGNAME_NOREV} (the latter includes the
7318: version number of the package).
1.1 dsieger 7319:
7320: Many modern packages using GNU autoconf allow to set the directory where HTML
7321: documentation is installed with the "--with-html-dir" option. Sometimes using
7322: this flag is needed because otherwise the documentation ends up in ${PREFIX}/
1.223 nia 7323: share/doc/html or other places. In pkgsrc, the HTML documentation should go
7324: into the package-specific directory, just like any other documentation.
1.1 dsieger 7325:
7326: An exception to the above is that library API documentation generated with the
7327: textproc/gtk-doc tools, for use by special browsers (devhelp) should be left at
7328: their default location, which is ${PREFIX}/share/gtk-doc. Such documentation
7329: can be recognized from files ending in .devhelp or .devhelp2. (It is also
7330: acceptable to install such files in ${PREFIX}/share/doc/${PKGBASE} or ${PREFIX}
7331: /share/doc/${PKGNAME}; the .devhelp* file must be directly in that directory
7332: then, no additional subdirectory level is allowed in this case. This is usually
7333: achieved by using "--with-html-dir=${PREFIX}/share/doc". ${PREFIX}/share/
7334: gtk-doc is preferred though.)
7335:
1.154 rillig 7336: 21.6.3. Installing highscore files
1.1 dsieger 7337:
7338: Certain packages, most of them in the games category, install a score file that
7339: allows all users on the system to record their highscores. In order for this to
7340: work, the binaries need to be installed setgid and the score files owned by the
1.36 wiz 7341: appropriate group and/or owner (traditionally the "games" user/group). Set
7342: USE_GAMESGROUP to yes to support this. The following variables, documented in
7343: more detail in mk/defaults/mk.conf, control this behaviour: GAMEDATAMODE,
1.100 leot 7344: GAMEDIRMODE, GAMES_GROUP, GAMEMODE, GAME_USER. Other useful variables are:
7345: GAMEDIR_PERMS, GAMEDATA_PERMS and SETGID_GAMES_PERMS.
7346:
7347: An example that illustrates some of the variables described above is games/
7348: moon-buggy. OWN_DIRS_PERMS is used to properly set directory permissions of the
7349: directory where the scorefile is saved, REQD_FILES_PERMS is used to create a
7350: dummy scorefile (mbscore) with the proper permissions and SPECIAL_PERMS is used
7351: to install setgid the game binary:
7352:
7353: USE_GAMESGROUP= yes
7354:
7355: BUILD_DEFS+= VARBASE
7356:
7357: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
7358: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
7359: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
7360:
7361: Various INSTALL_* variables are also available: INSTALL_GAME to install setgid
7362: game binaries, INSTALL_GAME_DIR to install game directories that are needed to
7363: be accessed by setgid games and INSTALL_GAME_DATA to install scorefiles.
1.1 dsieger 7364:
1.14 jmcneill 7365: A package should therefore never hard code file ownership or access permissions
1.100 leot 7366: but rely on *_PERMS as described above or alternatively on INSTALL_GAME,
7367: INSTALL_GAME_DATA and INSTALL_GAME_DIR to set these correctly.
1.1 dsieger 7368:
1.154 rillig 7369: 21.6.4. Adding DESTDIR support to packages
1.4 rillig 7370:
1.14 jmcneill 7371: DESTDIR support means that a package installs into a staging directory, not the
7372: final location of the files. Then a binary package is created which can be used
7373: for installation as usual. There are two ways: Either the package must install
1.25 wiz 7374: as root ("destdir") or the package can install as non-root user ("user-destdir"
7375: ).
1.14 jmcneill 7376:
1.113 leot 7377: * PKG_DESTDIR_SUPPORT has to be set to "destdir" or "user-destdir". By
7378: default PKG_DESTDIR_SUPPORT is set to "user-destdir" to help catching more
7379: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
7380: PKG_DESTDIR_SUPPORT needs to be set before the inclusion.
1.14 jmcneill 7381:
1.4 rillig 7382: * All installation operations have to be prefixed with ${DESTDIR}.
7383:
7384: * automake gets this DESTDIR mostly right automatically. Many manual rules
7385: and pre/post-install often are incorrect; fix them.
7386:
1.17 imil 7387: * If files are installed with special owner/group use SPECIAL_PERMS.
1.4 rillig 7388:
7389: * In general, packages should support UNPRIVILEGED to be able to use DESTDIR.
7390:
1.154 rillig 7391: 21.6.5. Packages with hardcoded paths to other interpreters
1.1 dsieger 7392:
7393: Your package may also contain scripts with hardcoded paths to other
1.203 nia 7394: interpreters besides (or as well as) Perl. To correct the full pathname to the
1.1 dsieger 7395: script interpreter, you need to set the following definitions in your Makefile
7396: (we shall use tclsh in this example):
7397:
7398: REPLACE_INTERPRETER+= tcl
7399: REPLACE.tcl.old= .*/bin/tclsh
7400: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
7401: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
7402: # relative to ${WRKSRC}, just as in REPLACE_PERL
7403:
1.203 nia 7404: 21.6.6. Packages installing Perl modules
1.1 dsieger 7405:
7406: Makefiles of packages providing perl5 modules should include the Makefile
7407: fragment ../../lang/perl5/module.mk. It provides a do-configure target for the
7408: standard perl configuration for such modules as well as various hooks to tune
7409: this configuration. See comments in this file for details.
7410:
7411: Perl5 modules will install into different places depending on the version of
7412: perl used during the build process. To address this, pkgsrc will append lines
7413: to the PLIST corresponding to the files listed in the installed .packlist file
7414: generated by most perl5 modules. This is invoked by defining PERL5_PACKLIST to
1.48 wiz 7415: a space-separated list of packlist files relative to PERL5_PACKLIST_DIR
7416: (PERL5_INSTALLVENDORARCH by default), e.g.:
1.1 dsieger 7417:
1.48 wiz 7418: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 7419:
1.48 wiz 7420: The perl5 config variables installarchlib, installscript, installvendorbin,
7421: installvendorscript, installvendorarch, installvendorlib, installvendorman1dir,
7422: and installvendorman3dir represent those locations in which components of perl5
7423: modules may be installed, provided as variable with uppercase and prefixed with
7424: PERL5_, e.g. PERL5_INSTALLARCHLIB and may be used by perl5 packages that don't
7425: have a packlist. These variables are also substituted for in the PLIST as
7426: uppercase prefixed with PERL5_SUB_.
1.1 dsieger 7427:
1.254 wiz 7428: 21.6.7. Packages installing pkg-config files
7429:
7430: Some packages, usually those providing libraries, install pkg-config files so
7431: that their headers and libraries can easily be found. The file names end with
7432: .pc.
7433:
7434: Most of the time, these files only provide the linker flags for the library,
7435: but do not include the flags for setting the rpath so the libraries can also be
7436: found at runtime. Since this is so common, pkgsrc provides PKGCONFIG_OVERRIDE
7437: for this. Many packages generate the .pc from .pc.in, in that case add those
7438: files to the PKGCONFIG_OVERRIDE variable:
7439:
7440: PKGCONFIG_OVERRIDE+= foo.pc.in
7441:
7442:
7443: For packages using meson, the files are generated during build and you also
7444: need to change the phase in which the replacement is done. For example:
7445:
7446: PKGCONFIG_OVERRIDE+= output/meson-private/foo.pc
7447: PKGCONFIG_OVERRIDE_STAGE= post-build
7448:
7449:
7450: 21.6.8. Packages installing info files
1.1 dsieger 7451:
7452: Some packages install info files or use the "makeinfo" or "install-info"
7453: commands. INFO_FILES should be defined in the package Makefile so that INSTALL
7454: and DEINSTALL scripts will be generated to handle registration of the info
7455: files in the Info directory file. The "install-info" command used for the info
7456: files registration is either provided by the system, or by a special purpose
7457: package automatically added as dependency if needed.
7458:
7459: PKGINFODIR is the directory under ${PREFIX} where info files are primarily
7460: located. PKGINFODIR defaults to "info" and can be overridden by the user.
7461:
7462: The info files for the package should be listed in the package PLIST; however
7463: any split info files need not be listed.
7464:
7465: A package which needs the "makeinfo" command at build time must add "makeinfo"
7466: to USE_TOOLS in its Makefile. If a minimum version of the "makeinfo" command is
7467: needed it should be noted with the TEXINFO_REQD variable in the package
7468: Makefile. By default, a minimum version of 3.12 is required. If the system does
7469: not provide a makeinfo command or if it does not match the required minimum, a
7470: build dependency on the devel/gtexinfo package will be added automatically.
7471:
7472: The build and installation process of the software provided by the package
7473: should not use the install-info command as the registration of info files is
1.25 wiz 7474: the task of the package INSTALL script, and it must use the appropriate
1.1 dsieger 7475: makeinfo command.
7476:
7477: To achieve this goal, the pkgsrc infrastructure creates overriding scripts for
7478: the install-info and makeinfo commands in a directory listed early in PATH.
7479:
7480: The script overriding install-info has no effect except the logging of a
7481: message. The script overriding makeinfo logs a message and according to the
7482: value of TEXINFO_REQD either runs the appropriate makeinfo command or exit on
7483: error.
7484:
1.254 wiz 7485: 21.6.9. Packages installing man pages
1.1 dsieger 7486:
7487: All packages that install manual pages should install them into the same
7488: directory, so that there is one common place to look for them. In pkgsrc, this
7489: place is ${PREFIX}/${PKGMANDIR}, and this expression should be used in
1.25 wiz 7490: packages. The default for PKGMANDIR is "man". Another often-used value is "
7491: share/man".
1.1 dsieger 7492:
7493: Note
7494:
7495: The support for a custom PKGMANDIR is far from complete.
7496:
7497: The PLIST files can just use man/ as the top level directory for the man page
7498: file entries, and the pkgsrc framework will convert as needed. In all other
7499: places, the correct PKGMANDIR must be used.
7500:
7501: Packages that are configured with GNU_CONFIGURE set as "yes", by default will
7502: use the ./configure --mandir switch to set where the man pages should be
7503: installed. The path is GNU_CONFIGURE_MANDIR which defaults to ${PREFIX}/$
7504: {PKGMANDIR}.
7505:
7506: Packages that use GNU_CONFIGURE but do not use --mandir, can set
7507: CONFIGURE_HAS_MANDIR to "no". Or if the ./configure script uses a non-standard
7508: use of --mandir, you can set GNU_CONFIGURE_MANDIR as needed.
7509:
1.184 rillig 7510: See Section 19.5, "Man page compression" for information on installation of
1.1 dsieger 7511: compressed manual pages.
7512:
1.254 wiz 7513: 21.6.10. Packages installing X11 fonts
1.1 dsieger 7514:
7515: If a package installs font files, you will need to rebuild the fonts database
7516: in the directory where they get installed at installation and deinstallation
7517: time. This can be automatically done by using the pkginstall framework.
7518:
7519: You can list the directories where fonts are installed in the FONTS_DIRS.type
7520: variables, where type can be one of "ttf", "type1" or "x11". Also make sure
7521: that the database file fonts.dir is not listed in the PLIST.
7522:
7523: Note that you should not create new directories for fonts; instead use the
7524: standard ones to avoid that the user needs to manually configure his X server
7525: to find them.
7526:
1.254 wiz 7527: 21.6.11. Packages installing SGML or XML data
1.1 dsieger 7528:
7529: If a package installs SGML or XML data files that need to be registered in
7530: system-wide catalogs (like DTDs, sub-catalogs, etc.), you need to take some
7531: extra steps:
7532:
7533: 1. Include ../../textproc/xmlcatmgr/catalogs.mk in your Makefile, which takes
7534: care of registering those files in system-wide catalogs at installation and
7535: deinstallation time.
7536:
7537: 2. Set SGML_CATALOGS to the full path of any SGML catalogs installed by the
7538: package.
7539:
7540: 3. Set XML_CATALOGS to the full path of any XML catalogs installed by the
7541: package.
7542:
7543: 4. Set SGML_ENTRIES to individual entries to be added to the SGML catalog.
7544: These come in groups of three strings; see xmlcatmgr(1) for more
7545: information (specifically, arguments recognized by the 'add' action). Note
7546: that you will normally not use this variable.
7547:
7548: 5. Set XML_ENTRIES to individual entries to be added to the XML catalog. These
7549: come in groups of three strings; see xmlcatmgr(1) for more information
7550: (specifically, arguments recognized by the 'add' action). Note that you
7551: will normally not use this variable.
7552:
1.254 wiz 7553: 21.6.12. Packages installing extensions to the MIME database
1.1 dsieger 7554:
7555: If a package provides extensions to the MIME database by installing .xml files
7556: inside ${PREFIX}/share/mime/packages, you need to take some extra steps to
7557: ensure that the database is kept consistent with respect to these new files:
7558:
7559: 1. Include ../../databases/shared-mime-info/mimedb.mk (avoid using the
7560: buildlink3.mk file from this same directory, which is reserved for
7561: inclusion from other buildlink3.mk files). It takes care of rebuilding the
7562: MIME database at installation and deinstallation time, and disallows any
7563: access to it directly from the package.
7564:
1.25 wiz 7565: 2. Check the PLIST and remove any entries under the share/mime directory,
1.1 dsieger 7566: except for files saved under share/mime/packages. The former are handled
7567: automatically by the update-mime-database program, but the latter are
7568: package-dependent and must be removed by the package that installed them in
7569: the first place.
7570:
7571: 3. Remove any share/mime/* directories from the PLIST. They will be handled by
7572: the shared-mime-info package.
7573:
1.254 wiz 7574: 21.6.13. Packages using intltool
1.1 dsieger 7575:
7576: If a package uses intltool during its build, add intltool to the USE_TOOLS,
7577: which forces it to use the intltool package provided by pkgsrc, instead of the
7578: one bundled with the distribution file.
7579:
7580: This tracks intltool's build-time dependencies and uses the latest available
7581: version; this way, the package benefits of any bug fixes that may have appeared
7582: since it was released.
7583:
1.254 wiz 7584: 21.6.14. Packages installing startup scripts
1.1 dsieger 7585:
7586: If a package contains a rc.d script, it won't be copied into the startup
7587: directory by default, but you can enable it, by adding the option
1.4 rillig 7588: PKG_RCD_SCRIPTS=YES in mk.conf. This option will copy the scripts into /etc/
7589: rc.d when a package is installed, and it will automatically remove the scripts
7590: when the package is deinstalled.
1.1 dsieger 7591:
1.254 wiz 7592: 21.6.15. Packages installing TeX modules
1.1 dsieger 7593:
7594: If a package installs TeX packages into the texmf tree, the ls-R database of
7595: the tree needs to be updated.
7596:
7597: Note
7598:
1.23 jakllsch 7599: Except the main TeX packages such as kpathsea, packages should install files
7600: into ${PREFIX}/share/texmf-dist, not ${PREFIX}/share/texmf.
1.1 dsieger 7601:
1.23 jakllsch 7602: 1. Include ../../print/kpathsea/texmf.mk. This takes care of rebuilding the
7603: ls-R database at installation and deinstallation time.
1.1 dsieger 7604:
1.23 jakllsch 7605: 2. If your package installs files into a texmf tree other than the one at $
7606: {PREFIX}/share/texmf-dist, set TEX_TEXMF_DIRS to the list of all texmf
7607: trees that need database update.
1.1 dsieger 7608:
7609: If your package also installs font map files that need to be registered
1.30 dholland 7610: using updmap, include ../../print/tex-tetex/map.mk and set TEX_MAP_FILES
7611: and/or TEX_MIXEDMAP_FILES to the list of all such font map files. Then
7612: updmap will be run automatically at installation/deinstallation to enable/
7613: disable font map files for TeX output drivers.
1.1 dsieger 7614:
7615: 3. Make sure that none of ls-R databases are included in PLIST, as they will
1.30 dholland 7616: be removed only by the kpathsea package.
1.1 dsieger 7617:
1.254 wiz 7618: 21.6.16. Packages supporting running binaries in emulation
1.1 dsieger 7619:
7620: There are some packages that provide libraries and executables for running
7621: binaries from a one operating system on a different one (if the latter supports
7622: it). One example is running Linux binaries on NetBSD.
7623:
7624: The pkgtools/rpm2pkg helps in extracting and packaging Linux rpm packages.
7625:
7626: The CHECK_SHLIBS can be set to no to avoid the check-shlibs target, which tests
7627: if all libraries for each installed executable can be found by the dynamic
7628: linker. Since the standard dynamic linker is run, this fails for emulation
7629: packages, because the libraries used by the emulation are not in the standard
7630: directories.
7631:
1.254 wiz 7632: 21.6.17. Packages installing hicolor icons
1.1 dsieger 7633:
7634: If a package installs images under the share/icons/hicolor and/or updates the
7635: share/icons/hicolor/icon-theme.cache database, you need to take some extra
7636: steps to make sure that the shared theme directory is handled appropriately and
7637: that the cache database is rebuilt:
7638:
7639: 1. Include ../../graphics/hicolor-icon-theme/buildlink3.mk.
7640:
7641: 2. Check the PLIST and remove the entry that refers to the theme cache.
7642:
7643: 3. Ensure that the PLIST does not remove the shared icon directories from the
7644: share/icons/hicolor hierarchy because they will be handled automatically.
7645:
7646: The best way to verify that the PLIST is correct with respect to the last two
7647: points is to regenerate it using make print-PLIST.
7648:
1.254 wiz 7649: 21.6.18. Packages installing desktop files
1.1 dsieger 7650:
7651: If a package installs .desktop files under share/applications and these include
1.54 rodent 7652: MIME information (MimeType key), you need to take extra steps to ensure that
7653: they are registered into the MIME database:
1.1 dsieger 7654:
7655: 1. Include ../../sysutils/desktop-file-utils/desktopdb.mk.
7656:
7657: 2. Check the PLIST and remove the entry that refers to the share/applications/
7658: mimeinfo.cache file. It will be handled automatically.
7659:
7660: The best way to verify that the PLIST is correct with respect to the last point
7661: is to regenerate it using make print-PLIST.
7662:
1.154 rillig 7663: 21.7. Marking packages as having problems
1.1 dsieger 7664:
1.23 jakllsch 7665: In some cases one does not have the time to solve a problem immediately. In
7666: this case, one can plainly mark a package as broken. For this, one just sets
7667: the variable BROKEN to the reason why the package is broken (similar to the
1.162 rillig 7668: PKG_FAIL_REASON variable). A user trying to build the package will immediately
7669: be shown this message, and the build will not be even tried.
1.1 dsieger 7670:
1.23 jakllsch 7671: BROKEN packages are removed from pkgsrc in irregular intervals.
1.1 dsieger 7672:
1.184 rillig 7673: Chapter 22. GNOME packaging and porting
7674:
7675: Table of Contents
7676:
7677: 22.1. Meta packages
7678: 22.2. Packaging a GNOME application
7679: 22.3. Updating GNOME to a newer version
7680: 22.4. Patching guidelines
7681:
7682: Quoting GNOME's web site:
7683:
7684: The GNOME project provides two things: The GNOME desktop environment, an
7685: intuitive and attractive desktop for users, and the GNOME development
7686: platform, an extensive framework for building applications that integrate
7687: into the rest of the desktop.
7688:
7689: pkgsrc provides a seamless way to automatically build and install a complete
7690: GNOME environment under many different platforms. We can say with confidence
7691: that pkgsrc is one of the most advanced build and packaging systems for GNOME
7692: due to its included technologies buildlink3, the wrappers and tools framework
7693: and automatic configuration file management. Lots of efforts are put into
7694: achieving a completely clean deinstallation of installed software components.
7695:
7696: Given that pkgsrc is NetBSD's official packaging system, the above also means
7697: that great efforts are put into making GNOME work under this operating system.
7698:
7699: This chapter is aimed at pkgsrc developers and other people interested in
7700: helping our GNOME porting and packaging efforts. It provides instructions on
7701: how to manage the existing packages and some important information regarding
7702: their internals.
7703:
7704: 22.1. Meta packages
7705:
7706: pkgsrc includes three GNOME-related meta packages:
7707:
7708: * meta-pkgs/gnome-base: Provides the core GNOME desktop environment. It only
7709: includes the necessary bits to get it to boot correctly, although it may
7710: lack important functionality for daily operation. The idea behind this
7711: package is to let end users build their own configurations on top of this
7712: one, first installing this meta package to achieve a functional setup and
7713: then adding individual applications.
7714:
7715: * meta-pkgs/gnome: Provides a complete installation of the GNOME platform and
7716: desktop as defined by the GNOME project; this is based on the components
7717: distributed in the platform/x.y/x.y.z/sources and desktop/x.y/x.y.z/sources
7718: directories of the official FTP server. Developer-only tools found in those
7719: directories are not installed unless required by some other component to
7720: work properly. Similarly, packages from the bindings set (bindings/x.y/
7721: x.y.z/sources) are not pulled in unless required as a dependency for an
7722: end-user component. This package "extends" meta-pkgs/gnome-base.
7723:
7724: * meta-pkgs/gnome-devel: Installs all the tools required to build a GNOME
7725: component when fetched from the CVS repository. These are required to let
7726: the autogen.sh scripts work appropriately.
7727:
7728: In all these packages, the DEPENDS lines are sorted in a way that eases
7729: updates: a package may depend on other packages listed before it but not on any
7730: listed after it. It is very important to keep this order to ease updates so...
7731: do not change it to alphabetical sorting!
7732:
7733: 22.2. Packaging a GNOME application
7734:
7735: Almost all GNOME applications are written in C and use a common set of tools as
7736: their build system. Things get different with the new bindings to other
7737: languages (such as Python), but the following will give you a general idea on
7738: the minimum required tools:
7739:
7740: * Almost all GNOME applications use the GNU Autotools as their build system.
7741: As a general rule you will need to tell this to your package:
7742:
1.223 nia 7743: GNU_CONFIGURE= yes
7744: USE_LIBTOOL= yes
7745: USE_TOOLS+= gmake
1.184 rillig 7746:
7747: * If the package uses pkg-config to detect dependencies, add this tool to the
7748: list of required utilities:
7749:
1.223 nia 7750: USE_TOOLS+= pkg-config
1.184 rillig 7751:
7752: Also use pkgtools/verifypc at the end of the build process to ensure that
7753: you did not miss to specify any dependency in your package and that the
7754: version requirements are all correct.
7755:
7756: * If the package uses intltool, be sure to add intltool to the USE_TOOLS to
7757: handle dependencies and to force the package to use the latest available
7758: version.
7759:
7760: * If the package uses gtk-doc (a documentation generation utility), do not
7761: add a dependency on it. The tool is rather big and the distfile should come
7762: with pregenerated documentation anyway; if it does not, it is a bug that
7763: you ought to report. For such packages you should disable gtk-doc (unless
7764: it is the default):
7765:
1.223 nia 7766: CONFIGURE_ARGS+= --disable-gtk-doc
1.184 rillig 7767:
7768: The default location of installed HTML files (share/gtk-doc/<package-name>)
7769: is correct and should not be changed unless the package insists on
7770: installing them somewhere else. Otherwise programs as devhelp will not be
7771: able to open them. You can do that with an entry similar to:
1.1 dsieger 7772:
1.223 nia 7773: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.1 dsieger 7774:
1.184 rillig 7775: GNOME uses multiple shared directories and files under the installation prefix
7776: to maintain databases. In this context, shared means that those exact same
7777: directories and files are used among several different packages, leading to
7778: conflicts in the PLIST. pkgsrc currently includes functionality to handle the
7779: most common cases, so you have to forget about using @unexec ${RMDIR} lines in
7780: your file lists and omitting shared files from them. If you find yourself doing
7781: those, your package is most likely incorrect.
1.1 dsieger 7782:
1.184 rillig 7783: The following table lists the common situations that result in using shared
7784: directories or files. For each of them, the appropriate solution is given.
7785: After applying the solution be sure to regenerate the package's file list with
7786: make print-PLIST and ensure it is correct.
1.1 dsieger 7787:
1.184 rillig 7788: Table 22.1. PLIST handling for GNOME packages
1.1 dsieger 7789:
1.184 rillig 7790: +-----------------------------------------------------------------------------+
7791: | If the package... | Then... |
7792: |-------------------------------------------+---------------------------------|
1.254 wiz 7793: |Installs icons under the share/icons/ |See Section 21.6.17, "Packages |
1.203 nia 7794: |hicolor hierarchy or updates share/icons/ |installing hicolor icons". |
1.184 rillig 7795: |hicolor/icon-theme.cache. | |
7796: |-------------------------------------------+---------------------------------|
1.254 wiz 7797: | |See Section 21.6.12, "Packages |
1.184 rillig 7798: |Installs files under share/mime/packages. |installing extensions to the MIME|
7799: | |database". |
7800: |-------------------------------------------+---------------------------------|
1.254 wiz 7801: |Installs .desktop files under share/ |See Section 21.6.18, "Packages |
1.184 rillig 7802: |applications and these include MIME |installing desktop files". |
7803: |information. | |
7804: +-----------------------------------------------------------------------------+
1.1 dsieger 7805:
7806:
1.184 rillig 7807: 22.3. Updating GNOME to a newer version
1.1 dsieger 7808:
1.184 rillig 7809: When seeing GNOME as a whole, there are two kinds of updates:
1.1 dsieger 7810:
1.184 rillig 7811: Major update
1.1 dsieger 7812:
1.184 rillig 7813: Given that there is still a very long way for GNOME 3 (if it ever appears),
7814: we consider a major update one that goes from a 2.X version to a 2.Y one,
7815: where Y is even and greater than X. These are hard to achieve because they
7816: introduce lots of changes in the components' code and almost all GNOME
7817: distfiles are updated to newer versions. Some of them can even break API
7818: and ABI compatibility with the previous major version series. As a result,
7819: the update needs to be done all at once to minimize breakage.
1.1 dsieger 7820:
1.184 rillig 7821: A major update typically consists of around 80 package updates and the
7822: addition of some new ones.
1.1 dsieger 7823:
1.184 rillig 7824: Minor update
1.1 dsieger 7825:
1.184 rillig 7826: We consider a minor update one that goes from a 2.A.X version to a 2.A.Y
7827: one where Y is greater than X. These are easy to achieve because they do
7828: not update all GNOME components, can be done in an incremental way and do
7829: not break API nor ABI compatibility.
1.1 dsieger 7830:
1.184 rillig 7831: A minor update typically consists of around 50 package updates, although
7832: the numbers here may vary a lot.
1.1 dsieger 7833:
1.184 rillig 7834: In order to update the GNOME components in pkgsrc to a new stable release
7835: (either major or minor), the following steps should be followed:
1.1 dsieger 7836:
1.184 rillig 7837: 1. Get a list of all the tarballs that form the new release by using the
7838: following commands. These will leave the full list of the components'
7839: distfiles into the list.txt file:
1.1 dsieger 7840:
1.184 rillig 7841: % echo ls "*.tar.bz2" | \
7842: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
7843: awk '{ print $9 }' >list.txt
7844: % echo ls "*.tar.bz2" | \
7845: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
7846: awk '{ print $9 }' >>list.txt
1.1 dsieger 7847:
1.184 rillig 7848: 2. Open each meta package's Makefile and bump their version to the release you
7849: are updating them to. The three meta packages should be always consistent
7850: with versioning. Obviously remove any PKGREVISIONs that might be in them.
1.1 dsieger 7851:
1.184 rillig 7852: 3. For each meta package, update all its DEPENDS lines to match the latest
7853: versions as shown by the above commands. Do not list any newer version
7854: (even if found in the FTP) because the meta packages are supposed to list
7855: the exact versions that form a specific GNOME release. Exceptions are
7856: permitted here if a newer version solves a serious issue in the overall
7857: desktop experience; these typically come in the form of a revision bump in
7858: pkgsrc, not in newer versions from the developers.
1.1 dsieger 7859:
1.184 rillig 7860: Packages not listed in the list.txt file should be updated to the latest
7861: version available (if found in pkgsrc). This is the case, for example, of
7862: the dependencies on the GNU Autotools in the meta-pkgs/gnome-devel meta
7863: package.
1.1 dsieger 7864:
1.184 rillig 7865: 4. Generate a patch from the modified meta packages and extract the list of
7866: "new" lines. This will provide you an outline on what packages need to be
7867: updated in pkgsrc and in what order:
1.1 dsieger 7868:
1.184 rillig 7869: % cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt
1.1 dsieger 7870:
1.184 rillig 7871: 5. For major desktop updates it is recommended to zap all your installed
7872: packages and start over from scratch at this point.
1.1 dsieger 7873:
1.184 rillig 7874: 6. Now comes the longest step by far: iterate over the contents of todo.txt
7875: and update the packages listed in it in order. For major desktop updates
7876: none of these should be committed until the entire set is completed because
7877: there are chances of breaking not-yet-updated packages.
1.1 dsieger 7878:
1.184 rillig 7879: 7. Once the packages are up to date and working, commit them to the tree one
7880: by one with appropriate log messages. At the end, commit the three meta
7881: package updates and all the corresponding changes to the doc/CHANGES-<YEAR>
7882: and pkgsrc/doc/TODO files.
1.1 dsieger 7883:
1.184 rillig 7884: 22.4. Patching guidelines
1.1 dsieger 7885:
1.184 rillig 7886: GNOME is a very big component in pkgsrc which approaches 100 packages. Please,
7887: it is very important that you always, always, always feed back any portability
7888: fixes you do to a GNOME package to the mainstream developers (see
7889: Section 12.3.5, "Feedback to the author"). This is the only way to get their
7890: attention on portability issues and to ensure that future versions can be built
7891: out-of-the box on NetBSD. The less custom patches in pkgsrc, the easier further
7892: updates are. Those developers in charge of issuing major GNOME updates will be
7893: grateful if you do that.
1.1 dsieger 7894:
1.200 cirnatda 7895: The most common places to report bugs are the GNOME's GitLab and the
7896: freedesktop.org's GitLab. Not all components use these to track bugs, but most
7897: of them do. Do not be short on your reports: always provide detailed
1.184 rillig 7898: explanations of the current failure, how it can be improved to achieve maximum
1.200 cirnatda 7899: portability and, if at all possible, provide a patch against the main Git
7900: branch. The more verbose you are, the higher chances of your patch being
7901: accepted.
1.1 dsieger 7902:
1.184 rillig 7903: Also, please avoid using preprocessor magic to fix portability issues. While
7904: the FreeBSD GNOME people are doing a great job in porting GNOME to their
7905: operating system, the official GNOME sources are now plagued by conditionals
7906: that check for __FreeBSD__ and similar macros. This hurts portability. Please
7907: see our patching guidelines (Section 12.3.4, "Patching guidelines") for more
7908: details.
1.1 dsieger 7909:
1.154 rillig 7910: Chapter 23. Submitting and Committing
1.1 dsieger 7911:
7912: Table of Contents
7913:
1.154 rillig 7914: 23.1. Submitting binary packages
7915: 23.2. Submitting source packages (for non-NetBSD-developers)
7916: 23.3. General notes when adding, updating, or removing packages
7917: 23.4. Commit Messages
7918: 23.5. Committing: Adding a package to CVS
7919: 23.6. Updating a package to a newer version
7920: 23.7. Renaming a package in pkgsrc
7921: 23.8. Moving a package in pkgsrc
1.1 dsieger 7922:
1.154 rillig 7923: 23.1. Submitting binary packages
1.1 dsieger 7924:
7925: Our policy is that we accept binaries only from pkgsrc developers to guarantee
7926: that the packages don't contain any trojan horses etc. This is not to annoy
7927: anyone but rather to protect our users! You're still free to put up your
7928: home-made binary packages and tell the world where to get them. NetBSD
1.154 rillig 7929: developers doing bulk builds and wanting to upload them please see Chapter 8,
1.66 asau 7930: Creating binary packages for everything in pkgsrc (bulk builds).
1.1 dsieger 7931:
1.154 rillig 7932: 23.2. Submitting source packages (for non-NetBSD-developers)
1.1 dsieger 7933:
1.218 nia 7934: Firstly, you can import new packages into pkgsrc-wip ("pkgsrc work-in-progress"
7935: ); see the homepage at https://pkgsrc.org/wip/ for details.
7936:
7937: Next, check that your package is complete, compiles and runs well; see
1.184 rillig 7938: Chapter 14, Creating a new pkgsrc package from scratch and the rest of this
1.218 nia 7939: document. Run the pkgtools/pkglint tool and fix any errors that appear.
7940:
7941: Finally, send a report to the pkgsrc bug tracking system, either with the
7942: send-pr(1) command, or if you don't have that, go to the web page https://
7943: www.NetBSD.org/support/send-pr.html, which contains some instructions and a
7944: link to a form where you can submit packages. The sysutils/gtk-send-pr package
7945: is also available as a substitute for either of the above two tools.
1.1 dsieger 7946:
7947: In the form of the problem report, the category should be "pkg", the synopsis
7948: should include the package name and version number, and the description field
7949: should contain a short description of your package (contents of the COMMENT
1.218 nia 7950: variable or DESCR file are OK).
1.1 dsieger 7951:
1.154 rillig 7952: 23.3. General notes when adding, updating, or removing packages
1.1 dsieger 7953:
7954: Please note all package additions, updates, moves, and removals in pkgsrc/doc/
7955: CHANGES-YYYY. It's very important to keep this file up to date and conforming
7956: to the existing format, because it will be used by scripts to automatically
7957: update pages on www.NetBSD.org and other sites. Additionally, check the pkgsrc/
7958: doc/TODO file and remove the entry for the package you updated or removed, in
7959: case it was mentioned there.
7960:
7961: When the PKGREVISION of a package is bumped, the change should appear in pkgsrc
7962: /doc/CHANGES-YYYY if it is security related or otherwise relevant. Mass bumps
7963: that result from a dependency being updated should not be mentioned. In all
7964: other cases it's the developer's decision.
7965:
7966: There is a make target that helps in creating proper CHANGES-YYYY entries: make
7967: changes-entry. It uses the optional CTYPE and NETBSD_LOGIN_NAME variables. The
7968: general usage is to first make sure that your CHANGES-YYYY file is up-to-date
7969: (to avoid having to resolve conflicts later-on) and then to cd to the package
7970: directory. For package updates, make changes-entry is enough. For new packages,
7971: or package moves or removals, set the CTYPE variable on the command line to
1.4 rillig 7972: "Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in mk.conf if
1.23 jakllsch 7973: your local login name is not the same as your NetBSD login name. The target
7974: also automatically removes possibly existing entries for the package in the
7975: TODO file. Don't forget to commit the changes, e.g. by using make
1.66 asau 7976: commit-changes-entry! If you are not using a checkout directly from
1.23 jakllsch 7977: cvs.NetBSD.org, but e.g. a local copy of the repository, you can set
7978: USE_NETBSD_REPO=yes. This makes the cvs commands use the main repository.
1.1 dsieger 7979:
1.154 rillig 7980: 23.4. Commit Messages
1.130 wiz 7981:
7982: For several years, there have been mirrors of pkgsrc in fossil, git, and hg.
7983: Standard practise when using these tools is to make the first line of a commit
7984: message function as a summary that can be read without the rest, such as is
7985: commonly done with "git log --oneline". For this reason, we have the following
7986: guidelines for pkgsrc commit messages:
7987:
1.131 wiz 7988: * Start the commit message with a line that explains the big picture in 65
1.130 wiz 7989: characters or less. When a commit is for one package, include the name of
7990: the package. For updates, include the version to which it is updated.
7991:
7992: * Leave the next line empty.
7993:
7994: * Then come the details for the commit (changes in that package, reason for a
7995: change) and any relevant PRs. Wrap this section.
7996:
7997: Here is an example:
7998:
1.238 wiz 7999: libxslt: update to 1.0.30
1.130 wiz 8000:
1.238 wiz 8001: Changes since 1.0.29:
8002: ...
1.130 wiz 8003:
8004: Here is another example:
8005:
1.238 wiz 8006: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.130 wiz 8007:
1.238 wiz 8008: (rationale)
1.130 wiz 8009:
8010: Commit messages are final: no "cvs admin" is allowed on the pkgsrc repository
8011: to change commit messages.
8012:
1.154 rillig 8013: 23.5. Committing: Adding a package to CVS
1.1 dsieger 8014:
8015: This section is only of interest for pkgsrc developers with write access to the
1.34 wiz 8016: pkgsrc repository.
8017:
8018: When the package is finished, "cvs add" the files. Start by adding the
8019: directory and then files in the directory. Don't forget to add the new package
8020: to the category's Makefile. Make sure you don't forget any files; you can check
8021: by running "cvs status". An example:
8022:
8023: $ cd .../pkgsrc/category
8024: $ cvs add pkgname
8025: $ cd pkgname
8026: $ cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8027: $ cvs add patches/p*
8028: $ cvs status | less
1.35 wiz 8029: $ cvs commit
1.34 wiz 8030: $ cd ..
1.236 gutterid 8031: $ vi Makefile # add SUBDIR+=pkgname line
1.35 wiz 8032: $ cvs commit Makefile
1.66 asau 8033: $ cd pkgname
1.73 jnemeth 8034: $ make CTYPE=Added commit-changes-entry
1.1 dsieger 8035:
8036: The commit message of the initial import should include part of the DESCR file,
8037: so people reading the mailing lists know what the package is/does.
8038:
1.34 wiz 8039: Also mention the new package in pkgsrc/doc/CHANGES-20xx.
8040:
8041: Previously, "cvs import" was suggested, but it was much easier to get wrong
8042: than "cvs add".
1.1 dsieger 8043:
1.154 rillig 8044: 23.6. Updating a package to a newer version
1.1 dsieger 8045:
8046: Please always put a concise, appropriate and relevant summary of the changes
8047: between old and new versions into the commit log when updating a package. There
8048: are various reasons for this:
8049:
8050: * A URL is volatile, and can change over time. It may go away completely or
8051: its information may be overwritten by newer information.
8052:
8053: * Having the change information between old and new versions in our CVS
8054: repository is very useful for people who use either cvs or anoncvs.
8055:
8056: * Having the change information between old and new versions in our CVS
8057: repository is very useful for people who read the pkgsrc-changes mailing
8058: list, so that they can make tactical decisions about when to upgrade the
8059: package.
8060:
8061: Please also recognize that, just because a new version of a package has been
8062: released, it should not automatically be upgraded in the CVS repository. We
8063: prefer to be conservative in the packages that are included in pkgsrc -
8064: development or beta packages are not really the best thing for most places in
8065: which pkgsrc is used. Please use your judgement about what should go into
8066: pkgsrc, and bear in mind that stability is to be preferred above new and
8067: possibly untested features.
8068:
1.154 rillig 8069: 23.7. Renaming a package in pkgsrc
1.21 snj 8070:
8071: Renaming packages is not recommended.
8072:
1.175 gutterid 8073: When renaming packages, be sure to fix any references to the old name in other
1.21 snj 8074: Makefiles, options, buildlink files, etc.
8075:
1.175 gutterid 8076: Also, when renaming a package, please add the package name and version pattern
1.167 leot 8077: (s) of the previous package to SUPERSEDES. This may be repeated for multiple
8078: renames. The new package would be an exact replacement. Example:
8079:
8080: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
8081: SUPERSEDES+= optcomp-[0-9]*
1.21 snj 8082:
8083: Note that "successor" in the CHANGES-YYYY file doesn't necessarily mean that it
8084: supersedes, as that successor may not be an exact replacement but is a
8085: suggestion for the replaced functionality.
8086:
1.154 rillig 8087: 23.8. Moving a package in pkgsrc
1.21 snj 8088:
8089: It is preferred that packages are not renamed or moved, but if needed please
8090: follow these steps.
1.1 dsieger 8091:
8092: 1. Make a copy of the directory somewhere else.
8093:
8094: 2. Remove all CVS dirs.
8095:
8096: Alternatively to the first two steps you can also do:
8097:
8098: % cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package
8099:
8100: and use that for further work.
8101:
1.25 wiz 8102: 3. Fix CATEGORIES and any DEPENDS paths that just did "../package" instead of
1.1 dsieger 8103: "../../category/package".
8104:
1.21 snj 8105: 4. In the modified package's Makefile, consider setting PREV_PKGPATH to the
8106: previous category/package pathname. The PREV_PKGPATH can be used by tools
8107: for doing an update using pkgsrc building; for example, it can search the
8108: pkg_summary(5) database for PREV_PKGPATH (if no SUPERSEDES) and then use
8109: the corresponding new PKGPATH for that moved package. Note that it may have
8110: multiple matches, so the tool should also check on the PKGBASE too. The
8111: PREV_PKGPATH probably has no value unless SUPERSEDES is not set, i.e.
8112: PKGBASE stays the same.
8113:
1.237 gutterid 8114: 5. cvs add the modified package in the new place.
1.1 dsieger 8115:
1.21 snj 8116: 6. Check if any package depends on it:
1.1 dsieger 8117:
8118: % cd /usr/pkgsrc
8119: % grep /package */*/Makefile* */*/buildlink*
8120:
1.21 snj 8121: 7. Fix paths in packages from step 5 to point to new location.
1.1 dsieger 8122:
1.21 snj 8123: 8. cvs rm (-f) the package at the old location.
1.1 dsieger 8124:
1.21 snj 8125: 9. Remove from oldcategory/Makefile.
1.1 dsieger 8126:
1.21 snj 8127: 10. Add to newcategory/Makefile.
1.1 dsieger 8128:
1.21 snj 8129: 11. Commit the changed and removed files:
1.1 dsieger 8130:
8131: % cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile
8132:
8133: (and any packages from step 5, of course).
8134:
1.154 rillig 8135: Chapter 24. Frequently Asked Questions
1.1 dsieger 8136:
8137: This section contains the answers to questions that may arise when you are
8138: writing a package. If you don't find your question answered here, first have a
8139: look in the other chapters, and if you still don't have the answer, ask on the
8140: pkgsrc-users mailing list.
8141:
1.154 rillig 8142: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
8143: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
8144: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
1.223 nia 8145: 24.4. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
8146: 24.5. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.232 gutterid 8147: the := inside it.
1.223 nia 8148: 24.6. Which mailing lists are there for package developers?
8149: 24.7. Where is the pkgsrc documentation?
8150: 24.8. I have a little time to kill. What shall I do?
1.1 dsieger 8151:
1.154 rillig 8152: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
1.1 dsieger 8153:
8154: MAKEFLAGS are the flags passed to the pkgsrc-internal invocations of make
1.223 nia 8155: (1).
8156:
8157: MAKE_FLAGS are the flags that are passed to the MAKE_PROGRAM when
8158: building the package.
8159:
8160: .MAKEFLAGS is an internal variable of bmake and should not be used by
8161: packages.
1.1 dsieger 8162:
1.154 rillig 8163: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
1.1 dsieger 8164:
8165: MAKE is the path to the make(1) program that is used in the pkgsrc
1.223 nia 8166: infrastructure.
8167:
8168: GMAKE is the path to GNU Make, but you need to say USE_TOOLS+=gmake to
8169: use that.
8170:
8171: MAKE_PROGRAM is the path to the Make program that is used for building
8172: the package.
1.1 dsieger 8173:
1.154 rillig 8174: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
1.1 dsieger 8175:
8176: CC is the path to the real C compiler, which can be configured by the
1.223 nia 8177: pkgsrc user.
1.1 dsieger 8178:
1.223 nia 8179: PKG_CC is the path to the compiler wrapper.
1.1 dsieger 8180:
1.223 nia 8181: PKGSRC_COMPILER is not a path to a compiler, but the type of compiler
8182: that should be used. See mk/compiler.mk for more information about the
8183: latter variable.
1.1 dsieger 8184:
1.223 nia 8185: 24.4. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
1.1 dsieger 8186:
1.25 wiz 8187: For optimization reasons, some variables are only available in the "
8188: wrapper" phase and later. To "simulate" the wrapper phase, append
1.1 dsieger 8189: PKG_PHASE=wrapper to the above command.
8190:
1.223 nia 8191: 24.5. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 8192: the := inside it.
8193:
1.223 nia 8194: The := is not an assignment operator, even though it may look like one.
1.108 rillig 8195: Instead, it is a degenerate form of ${LIST:old_string=new_string}, which
8196: is documented in the make(1) man page and which is commonly used in the
8197: form ${SRCS:.c=.o}. In the case of MASTER_SITE_*, old_string is the empty
8198: string and new_string is package/. That's where the : and the = fall
8199: together.
1.1 dsieger 8200:
1.223 nia 8201: 24.6. Which mailing lists are there for package developers?
1.1 dsieger 8202:
8203: tech-pkg
8204:
8205: This is a list for technical discussions related to pkgsrc
8206: development, e.g. soliciting feedback for changes to pkgsrc
8207: infrastructure, proposed new features, questions related to porting
8208: pkgsrc to a new platform, advice for maintaining a package, patches
8209: that affect many packages, help requests moved from pkgsrc-users when
8210: an infrastructure bug is found, etc.
8211:
8212: pkgsrc-bugs
8213:
8214: All bug reports in category "pkg" sent with send-pr(1) appear here.
8215: Please do not report your bugs here directly; use one of the other
8216: mailing lists.
8217:
1.223 nia 8218: 24.7. Where is the pkgsrc documentation?
1.1 dsieger 8219:
8220: There are many places where you can find documentation about pkgsrc:
8221:
8222: * The pkgsrc guide (this document) is a collection of chapters that
8223: explain large parts of pkgsrc, but some chapters tend to be outdated.
8224: Which ones they are is hard to say.
8225:
1.174 leot 8226: * On the mailing list archives (see https://mail-index.NetBSD.org/),
8227: you can find discussions about certain features, announcements of new
1.1 dsieger 8228: parts of the pkgsrc infrastructure and sometimes even announcements
8229: that a certain feature has been marked as obsolete. The benefit here
8230: is that each message has a date appended to it.
8231:
8232: * Many of the files in the mk/ directory start with a comment that
8233: describes the purpose of the file and how it can be used by the
8234: pkgsrc user and package authors. An easy way to find this
8235: documentation is to run bmake help.
8236:
8237: * The CVS log messages are a rich source of information, but they tend
8238: to be highly abbreviated, especially for actions that occur often.
8239: Some contain a detailed description of what has changed, but they are
8240: geared towards the other pkgsrc developers, not towards an average
8241: pkgsrc user. They also only document changes, so if you don't know
8242: what has been before, these messages may not be worth too much to
8243: you.
8244:
8245: * Some parts of pkgsrc are only "implicitly documented", that is the
8246: documentation exists only in the mind of the developer who wrote the
8247: code. To get this information, use the cvs annotate command to see
8248: who has written it and ask on the tech-pkg mailing list, so that
8249: others can find your questions later (see above). To be sure that the
8250: developer in charge reads the mail, you may CC him or her.
8251:
1.223 nia 8252: 24.8. I have a little time to kill. What shall I do?
1.1 dsieger 8253:
8254: This is not really an FAQ yet, but here's the answer anyway.
8255:
8256: * Run pkg_chk -N (from the pkgtools/pkg_chk package). It will tell you
8257: about newer versions of installed packages that are available, but
8258: not yet updated in pkgsrc.
8259:
1.198 leot 8260: * Browse pkgsrc/doc/TODO -- it contains a list of suggested new
8261: packages and a list of cleanups and enhancements for pkgsrc that
8262: would be nice to have.
1.1 dsieger 8263:
1.71 wiz 8264: * Review packages for which review was requested on the tech-pkg
8265: mailing list.
1.1 dsieger 8266:
8267: Part III. The pkgsrc infrastructure internals
8268:
8269: This part of the guide deals with everything from the infrastructure that is
8270: behind the interfaces described in the developer's guide. A casual package
8271: maintainer should not need anything from this part.
8272:
8273: Table of Contents
8274:
1.184 rillig 8275: 25. Design of the pkgsrc infrastructure
8276: 25.1. The meaning of variable definitions
8277: 25.2. Avoiding problems before they arise
8278: 25.3. Variable evaluation
8279: 25.3.1. At load time
8280: 25.3.2. At runtime
8281: 25.4. How can variables be specified?
8282: 25.5. Designing interfaces for Makefile fragments
8283: 25.5.1. Procedures with parameters
8284: 25.5.2. Actions taken on behalf of parameters
8285: 25.6. The order in which files are loaded
8286: 25.6.1. The order in bsd.prefs.mk
8287: 25.6.2. The order in bsd.pkg.mk
8288: 26. Regression tests
8289: 26.1. Running the regression tests
8290: 26.2. Adding a new regression test
8291: 26.2.1. Overridable functions
8292: 26.2.2. Helper functions
8293: 27. Porting pkgsrc
8294: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8295:
1.184 rillig 8296: Chapter 25. Design of the pkgsrc infrastructure
1.1 dsieger 8297:
8298: Table of Contents
8299:
1.184 rillig 8300: 25.1. The meaning of variable definitions
8301: 25.2. Avoiding problems before they arise
8302: 25.3. Variable evaluation
8303: 25.3.1. At load time
8304: 25.3.2. At runtime
8305: 25.4. How can variables be specified?
8306: 25.5. Designing interfaces for Makefile fragments
8307: 25.5.1. Procedures with parameters
8308: 25.5.2. Actions taken on behalf of parameters
8309: 25.6. The order in which files are loaded
8310: 25.6.1. The order in bsd.prefs.mk
8311: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 8312:
8313: The pkgsrc infrastructure consists of many small Makefile fragments. Each such
8314: fragment needs a properly specified interface. This chapter explains how such
8315: an interface looks like.
8316:
1.184 rillig 8317: 25.1. The meaning of variable definitions
1.1 dsieger 8318:
8319: Whenever a variable is defined in the pkgsrc infrastructure, the location and
8320: the way of definition provide much information about the intended use of that
8321: variable. Additionally, more documentation may be found in a header comment or
8322: in this pkgsrc guide.
8323:
8324: A special file is mk/defaults/mk.conf, which lists all variables that are
8325: intended to be user-defined. They are either defined using the ?= operator or
8326: they are left undefined because defining them to anything would effectively
8327: mean "yes". All these variables may be overridden by the pkgsrc user in the
8328: MAKECONF file.
8329:
8330: Outside this file, the following conventions apply: Variables that are defined
8331: using the ?= operator may be overridden by a package.
8332:
8333: Variables that are defined using the = operator may be used read-only at
8334: run-time.
8335:
8336: Variables whose name starts with an underscore must not be accessed outside the
8337: pkgsrc infrastructure at all. They may change without further notice.
8338:
8339: Note
8340:
8341: These conventions are currently not applied consistently to the complete pkgsrc
8342: infrastructure.
8343:
1.184 rillig 8344: 25.2. Avoiding problems before they arise
1.1 dsieger 8345:
8346: All variables that contain lists of things should default to being empty. Two
8347: examples that do not follow this rule are USE_LANGUAGES and DISTFILES. These
8348: variables cannot simply be modified using the += operator in package Makefiles
8349: (or other files included by them), since there is no guarantee whether the
8350: variable is already set or not, and what its value is. In the case of
8351: DISTFILES, the packages "know" the default value and just define it as in the
8352: following example.
8353:
8354: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
8355:
8356: Because of the selection of this default value, the same value appears in many
8357: package Makefiles. Similarly for USE_LANGUAGES, but in this case the default
8358: value ("c") is so short that it doesn't stand out. Nevertheless it is mentioned
8359: in many files.
8360:
1.184 rillig 8361: 25.3. Variable evaluation
1.1 dsieger 8362:
1.184 rillig 8363: 25.3.1. At load time
1.1 dsieger 8364:
8365: Variable evaluation takes place either at load time or at runtime, depending on
8366: the context in which they occur. The contexts where variables are evaluated at
8367: load time are:
8368:
8369: * The right hand side of the := and != operators,
8370:
8371: * Make directives like .if or .for,
8372:
8373: * Dependency lines.
8374:
8375: A special exception are references to the iteration variables of .for loops,
8376: which are expanded inline, no matter in which context they appear.
8377:
8378: As the values of variables may change during load time, care must be taken not
8379: to evaluate them by accident. Typical examples for variables that should not be
8380: evaluated at load time are DEPENDS and CONFIGURE_ARGS. To make the effect more
8381: clear, here is an example:
8382:
8383: CONFIGURE_ARGS= # none
8384: CFLAGS= -O
8385: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
8386:
8387: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
8388:
8389: CFLAGS+= -Wall
8390:
8391: This code shows how the use of the := operator can quickly lead to unexpected
8392: results. The first paragraph is fairly common code. The second paragraph
8393: evaluates the CONFIGURE_ARGS variable, which results in CFLAGS=-O. In the third
8394: paragraph, the -Wall is appended to the CFLAGS, but this addition will not
8395: appear in CONFIGURE_ARGS. In actual code, the three paragraphs from above
8396: typically occur in completely unrelated files.
8397:
1.184 rillig 8398: 25.3.2. At runtime
1.1 dsieger 8399:
8400: After all the files have been loaded, the values of the variables cannot be
8401: changed anymore. Variables that are used in the shell commands are expanded at
8402: this point.
8403:
1.184 rillig 8404: 25.4. How can variables be specified?
1.1 dsieger 8405:
8406: There are many ways in which the definition and use of a variable can be
8407: restricted in order to detect bugs and violations of the (mostly unwritten)
1.108 rillig 8408: policies. A package can be checked with pkglint -Wall to see whether it meets
8409: these rules.
1.1 dsieger 8410:
1.184 rillig 8411: 25.5. Designing interfaces for Makefile fragments
1.1 dsieger 8412:
8413: Most of the .mk files fall into one of the following classes. Cases where a
8414: file falls into more than one class should be avoided as it often leads to
8415: subtle bugs.
8416:
1.184 rillig 8417: 25.5.1. Procedures with parameters
1.1 dsieger 8418:
8419: In a traditional imperative programming language some of the .mk files could be
1.198 leot 8420: described as procedures. They take some input parameters and--after
8421: inclusion--provide a result in output parameters. Since all variables in
1.23 jakllsch 8422: Makefiles have global scope care must be taken not to use parameter names that
8423: have already another meaning. For example, PKGNAME is a bad choice for a
8424: parameter name.
1.1 dsieger 8425:
8426: Procedures are completely evaluated at preprocessing time. That is, when
8427: calling a procedure all input parameters must be completely resolvable. For
8428: example, CONFIGURE_ARGS should never be an input parameter since it is very
8429: likely that further text will be added after calling the procedure, which would
8430: effectively apply the procedure to only a part of the variable. Also,
1.108 rillig 8431: references to other variables will be modified after calling the procedure.
1.1 dsieger 8432:
8433: A procedure can declare its output parameters either as suitable for use in
8434: preprocessing directives or as only available at runtime. The latter
8435: alternative is for variables that contain references to other runtime
8436: variables.
8437:
8438: Procedures shall be written such that it is possible to call the procedure more
8439: than once. That is, the file must not contain multiple-inclusion guards.
8440:
8441: Examples for procedures are mk/bsd.options.mk and mk/buildlink3/bsd.builtin.mk.
8442: To express that the parameters are evaluated at load time, they should be
8443: assigned using the := operator, which should be used only for this purpose.
8444:
1.184 rillig 8445: 25.5.2. Actions taken on behalf of parameters
1.1 dsieger 8446:
8447: Action files take some input parameters and may define runtime variables. They
8448: shall not define loadtime variables. There are action files that are included
8449: implicitly by the pkgsrc infrastructure, while other must be included
8450: explicitly.
8451:
8452: An example for action files is mk/subst.mk.
8453:
1.184 rillig 8454: 25.6. The order in which files are loaded
1.1 dsieger 8455:
8456: Package Makefiles usually consist of a set of variable definitions, and include
8457: the file ../../mk/bsd.pkg.mk in the very last line. Before that, they may also
8458: include various other *.mk files if they need to query the availability of
8459: certain features like the type of compiler or the X11 implementation. Due to
8460: the heavy use of preprocessor directives like .if and .for, the order in which
8461: the files are loaded matters.
8462:
8463: This section describes at which point the various files are loaded and gives
8464: reasons for that order.
8465:
1.184 rillig 8466: 25.6.1. The order in bsd.prefs.mk
1.1 dsieger 8467:
8468: The very first action in bsd.prefs.mk is to define some essential variables
8469: like OPSYS, OS_VERSION and MACHINE_ARCH.
8470:
1.4 rillig 8471: Then, the user settings are loaded from the file specified in MAKECONF, which
8472: is usually mk.conf. After that, those variables that have not been overridden
8473: by the user are loaded from mk/defaults/mk.conf.
1.1 dsieger 8474:
8475: After the user settings, the system settings and platform settings are loaded,
8476: which may override the user settings.
8477:
8478: Then, the tool definitions are loaded. The tool wrappers are not yet in effect.
8479: This only happens when building a package, so the proper variables must be used
8480: instead of the direct tool names.
8481:
8482: As the last steps, some essential variables from the wrapper and the package
8483: system flavor are loaded, as well as the variables that have been cached in
8484: earlier phases of a package build.
8485:
1.184 rillig 8486: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 8487:
8488: First, bsd.prefs.mk is loaded.
8489:
8490: Then, the various *-vars.mk files are loaded, which fill default values for
8491: those variables that have not been defined by the package. These variables may
8492: later be used even in unrelated files.
8493:
8494: Then, the file bsd.pkg.error.mk provides the target error-check that is added
8495: as a special dependency to all other targets that use DELAYED_ERROR_MSG or
8496: DELAYED_WARNING_MSG.
8497:
8498: Then, the package-specific hacks from hacks.mk are included.
8499:
8500: Then, various other files follow. Most of them don't have any dependencies on
8501: what they need to have included before or after them, though some do.
8502:
8503: The code to check PKG_FAIL_REASON and PKG_SKIP_REASON is then executed, which
8504: restricts the use of these variables to all the files that have been included
8505: before. Appearances in later files will be silently ignored.
8506:
8507: Then, the files for the main targets are included, in the order of later
8508: execution, though the actual order should not matter.
8509:
8510: At last, some more files are included that don't set any interesting variables
8511: but rather just define make targets to be executed.
8512:
1.184 rillig 8513: Chapter 26. Regression tests
1.1 dsieger 8514:
8515: Table of Contents
8516:
1.184 rillig 8517: 26.1. Running the regression tests
8518: 26.2. Adding a new regression test
8519: 26.2.1. Overridable functions
8520: 26.2.2. Helper functions
1.1 dsieger 8521:
8522: The pkgsrc infrastructure consists of a large codebase, and there are many
8523: corners where every little bit of a file is well thought out, making pkgsrc
8524: likely to fail as soon as anything is changed near those parts. To prevent most
8525: changes from breaking anything, a suite of regression tests should go along
8526: with every important part of the pkgsrc infrastructure. This chapter describes
8527: how regression tests work in pkgsrc and how you can add new tests.
8528:
1.184 rillig 8529: 26.1. Running the regression tests
1.1 dsieger 8530:
1.25 wiz 8531: You first need to install the pkgtools/pkg_regress package, which provides the
1.1 dsieger 8532: pkg_regress command. Then you can simply run that command, which will run all
1.168 rillig 8533: tests in the regress/ directory.
1.1 dsieger 8534:
1.184 rillig 8535: 26.2. Adding a new regression test
1.1 dsieger 8536:
1.168 rillig 8537: Every directory in the regress/ directory that contains a file called spec is
1.1 dsieger 8538: considered a regression test. This file is a shell program that is included by
8539: the pkg_regress command. The following functions can be overridden to suit your
8540: needs.
8541:
1.184 rillig 8542: 26.2.1. Overridable functions
1.1 dsieger 8543:
1.108 rillig 8544: These functions do not take any parameters. Although they are called in "set -e
1.168 rillig 8545: " mode, they don't stop at the first failing command. See this Stack Overflow
1.108 rillig 8546: question for details.
1.1 dsieger 8547:
1.108 rillig 8548: do_setup
1.1 dsieger 8549:
8550: This function prepares the environment for the test. By default it does
8551: nothing.
8552:
1.108 rillig 8553: do_test
1.1 dsieger 8554:
8555: This function runs the actual test. By default, it calls TEST_MAKE with the
8556: arguments MAKEARGS_TEST and writes its output including error messages into
8557: the file TEST_OUTFILE.
8558:
1.108 rillig 8559: When defining this function, make sure that all output that needs to be
8560: checked is written to the correct output file. Example:
8561:
8562: do_test() {
8563: echo "Example output"
8564: } 1>$TEST_OUTFILE 2>&1
8565:
8566: check_result
1.1 dsieger 8567:
8568: This function is run after the test and is typically used to compare the
8569: actual output from the one that is expected. It can make use of the various
1.108 rillig 8570: helper functions from the next section. Example:
8571:
8572: check_result() {
8573: exit_status 0
8574: output_require "Example"
8575: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
8576: output_prohibit "no such file or directory"
1.169 rillig 8577: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 8578: }
1.1 dsieger 8579:
1.108 rillig 8580: do_cleanup
1.1 dsieger 8581:
8582: This function cleans everything up after the test has been run. By default
8583: it does nothing.
8584:
1.184 rillig 8585: 26.2.2. Helper functions
1.1 dsieger 8586:
1.168 rillig 8587: regress_fail message...
8588:
8589: This function makes the test fail with the given error message.
8590:
1.108 rillig 8591: exit_status expected
1.1 dsieger 8592:
1.108 rillig 8593: This function compares the exitcode of the do_test function with its first
8594: parameter. If they differ, the test will fail.
1.1 dsieger 8595:
1.108 rillig 8596: output_require regex...
1.1 dsieger 8597:
8598: This function checks for each of its parameters if the output from do_test
1.108 rillig 8599: matches the extended regular expression. If it does not, the test will
8600: fail. Example:
8601:
8602: output_require "looks fine"
8603: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.1 dsieger 8604:
1.177 leot 8605: output_prohibit regex...
1.1 dsieger 8606:
8607: This function checks for each of its parameters if the output from do_test
8608: () does not match the extended regular expression. If any of the regular
8609: expressions matches, the test will fail.
8610:
1.184 rillig 8611: Chapter 27. Porting pkgsrc
1.1 dsieger 8612:
8613: Table of Contents
8614:
1.184 rillig 8615: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8616:
8617: The pkgsrc system has already been ported to many operating systems, hardware
8618: architectures and compilers. This chapter explains the necessary steps to make
8619: pkgsrc even more portable.
8620:
1.184 rillig 8621: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8622:
8623: To port pkgsrc to a new operating system (called MyOS in this example), you
8624: need to touch the following files:
8625:
8626: pkgtools/bootstrap-mk-files/files/mods/MyOS.sys.mk
8627:
8628: This file contains some basic definitions, for example the name of the C
8629: compiler.
8630:
8631: mk/bsd.prefs.mk
8632:
1.212 wiz 8633: Insert code that defines the variables OPSYS, OS_VERSION, OPSYS_VERSION,
1.1 dsieger 8634: LOWER_VENDOR, MACHINE_ARCH, OBJECT_FMT, APPEND_ELF, and the other variables
8635: that appear in this file.
8636:
8637: mk/platform/MyOS.mk
8638:
8639: This file contains the platform-specific definitions that are used by
8640: pkgsrc. Start by copying one of the other files and edit it to your needs.
8641:
8642: mk/tools/tools.MyOS.mk
8643:
8644: This file defines the paths to all the tools that are needed by one or the
8645: other package in pkgsrc, as well as by pkgsrc itself. Find out where these
8646: tools are on your platform and add them.
8647:
8648: Now, you should be able to build some basic packages, like lang/perl5, shells/
8649: bash.
8650:
8651: Appendix A. A simple example package: bison
8652:
8653: Table of Contents
8654:
8655: A.1. files
8656: A.1.1. Makefile
8657: A.1.2. DESCR
8658: A.1.3. PLIST
8659: A.1.4. Checking a package with pkglint
8660: A.2. Steps for building, installing, packaging
8661:
8662: We checked to find a piece of software that wasn't in the packages collection,
1.25 wiz 8663: and picked GNU bison. Quite why someone would want to have bison when Berkeley
1.1 dsieger 8664: yacc is already present in the tree is beyond us, but it's useful for the
8665: purposes of this exercise.
8666:
8667: A.1. files
8668:
8669: A.1.1. Makefile
8670:
1.2 rillig 8671: # $NetBSD$
1.1 dsieger 8672: #
8673:
8674: DISTNAME= bison-1.25
8675: CATEGORIES= devel
1.171 rillig 8676: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 8677:
1.30 dholland 8678: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 8679: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 8680: COMMENT= GNU yacc clone
8681:
8682: GNU_CONFIGURE= yes
1.47 wiz 8683: INFO_FILES= yes
1.1 dsieger 8684:
8685: .include "../../mk/bsd.pkg.mk"
8686:
8687: A.1.2. DESCR
8688:
8689: GNU version of yacc. Can make re-entrant parsers, and numerous other
8690: improvements. Why you would want this when Berkeley yacc(1) is part
8691: of the NetBSD source tree is beyond me.
8692:
8693: A.1.3. PLIST
8694:
1.2 rillig 8695: @comment $NetBSD$
1.1 dsieger 8696: bin/bison
8697: man/man1/bison.1.gz
8698: share/bison.simple
8699: share/bison.hairy
8700:
8701: A.1.4. Checking a package with pkglint
8702:
8703: The NetBSD package system comes with pkgtools/pkglint which helps to check the
8704: contents of these files. After installation it is quite easy to use, just
1.171 rillig 8705: change to the directory of the package you wish to examine and run pkglint:
1.1 dsieger 8706:
8707: $ pkglint
1.171 rillig 8708: ERROR: Makefile: Each package must define its LICENSE.
8709: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
8710: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
8711: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
8712: 1 error, 2 warnings and 1 note found.
8713: (Run "pkglint -e" to show explanations.)
8714: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 8715: (Run "pkglint -F" to automatically fix some issues.)
1.1 dsieger 8716:
8717: Depending on the supplied command line arguments (see pkglint(1)), more checks
1.170 rillig 8718: will be performed. Use e.g. pkglint -Wall for a very thorough check.
1.1 dsieger 8719:
8720: A.2. Steps for building, installing, packaging
8721:
8722: Create the directory where the package lives, plus any auxiliary directories:
8723:
8724: # cd /usr/pkgsrc/lang
8725: # mkdir bison
8726: # cd bison
8727: # mkdir patches
8728:
1.184 rillig 8729: Create Makefile, DESCR and PLIST (see Chapter 12, Package components - files,
1.1 dsieger 8730: directories and contents) then continue with fetching the distfile:
8731:
8732: # make fetch
8733: >> bison-1.25.tar.gz doesn't seem to exist on this system.
8734: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
8735: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8736: ftp: Error retrieving file: 500 Internal error
8737:
8738: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
8739: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8740: ftp: Error retrieving file: 500 Internal error
8741:
8742: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
8743: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8744: Successfully retrieved file.
8745:
8746: Generate the checksum of the distfile into distinfo:
8747:
8748: # make makedistinfo
8749:
8750: Now compile:
8751:
8752: # make
8753: >> Checksum OK for bison-1.25.tar.gz.
8754: ===> Extracting for bison-1.25
8755: ===> Patching for bison-1.25
8756: ===> Ignoring empty patch directory
8757: ===> Configuring for bison-1.25
8758: creating cache ./config.cache
8759: checking for gcc... cc
8760: checking whether we are using GNU C... yes
8761: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
8762: checking how to run the C preprocessor... cc -E
8763: checking for minix/config.h... no
8764: checking for POSIXized ISC... no
8765: checking whether cross-compiling... no
8766: checking for ANSI C header files... yes
8767: checking for string.h... yes
8768: checking for stdlib.h... yes
8769: checking for memory.h... yes
8770: checking for working const... yes
8771: checking for working alloca.h... no
8772: checking for alloca... yes
8773: checking for strerror... yes
8774: updating cache ./config.cache
8775: creating ./config.status
8776: creating Makefile
8777: ===> Building for bison-1.25
8778: 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
8779: 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
8780: 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
8781: 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
8782: 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
8783: 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
8784: 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
8785: 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
8786: 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
8787: 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
8788: 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
8789: 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
8790: 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
8791: 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
8792: 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
8793: 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
8794: 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
8795: 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
8796: 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
8797: 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
8798: 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
8799: 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
8800: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
8801: rm -f bison.s1
8802: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1
8803:
8804: Everything seems OK, so install the files:
8805:
8806: # make install
8807: >> Checksum OK for bison-1.25.tar.gz.
8808: ===> Installing for bison-1.25
8809: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
8810: rm -f /usr/pkg/bin/bison
8811: cd /usr/pkg/share; rm -f bison.simple bison.hairy
8812: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
8813: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
8814: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
8815: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
8816: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
8817: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
8818: ===> Registering installation for bison-1.25
8819:
8820: You can now use bison, and also - if you decide so - remove it with pkg_delete
8821: bison. Should you decide that you want a binary package, do this now:
8822:
8823: # make package
8824: >> Checksum OK for bison-1.25.tar.gz.
8825: ===> Building package for bison-1.25
8826: Creating package bison-1.25.tgz
8827: Registering depends:.
8828: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
8829:
8830: Now that you don't need the source and object files any more, clean up:
8831:
8832: # make clean
8833: ===> Cleaning for bison-1.25
8834:
1.207 leot 8835: Appendix B. Security hardening
8836:
8837: Table of Contents
8838:
8839: B.1. Mechanisms
8840: B.1.1. Enabled by default
8841: B.1.2. Not enabled by default
8842: B.2. Caveats
8843: B.2.1. Problems with PKGSRC_MKPIE
8844: B.2.2. Problems with PKGSRC_USE_FORTIFY
8845: B.2.3. Problems with PKGSRC_USE_RELRO
8846: B.2.4. Problems with PKGSRC_USE_SSP
8847: B.3. Auditing the system
8848: B.3.1. Checking for PIE
8849: B.3.2. Checking for partial RELRO
8850: B.3.3. Checking for full RELRO
8851: B.3.4. Checking for SSP
8852:
8853: A number of mechanisms are available in pkgsrc to improve the security of the
8854: resulting system. This page describes the mechanisms, and gives hints about
8855: detecting and fixing problems.
8856:
8857: Mechanisms can be enabled individually in mk.conf, and are individually
8858: described below.
8859:
8860: Typically, a feature will cause some programs to fail to build or work when
8861: first enabled. This can be due to latent problems in the program, and can be
8862: due to other reasons. After enough testing to have confidence that user
8863: problems will be quite rare, individual mechanisms will be enabled by default.
8864:
8865: For each mechanism, see the Caveats section below for an explanation of what
8866: might go wrong at compile time and at run time, and how to notice and address
8867: these problems.
8868:
8869: B.1. Mechanisms
8870:
8871: B.1.1. Enabled by default
8872:
8873: B.1.1.1. PKGSRC_USE_FORTIFY
8874:
8875: This allows substitute wrappers to be used for some commonly used library
8876: functions that do not have built-in bounds checking - but could in some cases.
8877:
8878: Two mitigation levels are available:
8879:
8880: * "weak" only enables checks at compile-time.
8881:
8882: * "strong" enables checks at compile-time and runtime.
8883:
8884: "strong" has been enabled by default since pkgsrc-2017Q3.
8885:
8886: B.1.1.2. PKGSRC_USE_SSP
8887:
8888: This enables a stack-smashing protection mitigation. It is done by adding a
8889: guard variable to functions with vulnerable objects. The guards are initialized
8890: when a function is entered and then checked when the function exits. The guard
8891: check will fail and the program forcibly exited if the variable was modified in
8892: the meantime. This can happen in case of buffer overflows or memory corruption,
8893: and therefore exposing these bugs.
8894:
8895: Different mitigation levels are available:
8896:
8897: * "yes", which will only protect functions considered vulnerable by the
8898: compiler;
8899:
8900: * "all", which will protect every function;
8901:
8902: * "strong", the default, which will apply a better balance between the two
8903: settings above.
8904:
8905: This mitigation is supported by both GCC and clang. It may be supported in
8906: additional compilers, possibly under a different name. It is particularly
8907: useful for unsafe programming languages, such as C/C++.
8908:
8909: * "yes" is enabled by default where known supported since pkgsrc-2017Q3.
8910:
8911: * "strong" is enabled by default where known supported since pkgsrc-2021Q4.
8912:
8913: More details can be found here:
8914:
8915: * Buffer overflow protection on Wikipedia
8916:
8917: B.1.1.3. PKGSRC_MKPIE
8918:
8919: This requests the creation of PIE (Position Independent Executables) for all
8920: executables. The PIE mechanism is normally used for shared libraries, so that
8921: they can be loaded at differing addresses at runtime. PIE itself does not have
8922: useful security properties; however, it is necessary to fully leverage some,
8923: such as ASLR. Some operating systems support Address Space Layout Randomization
8924: (ASLR), which causes different addresses to be used each time a program is run.
8925: This makes it more difficult for an attacker to guess addresses and thus makes
8926: exploits harder to construct. With PIE, ASLR can really be applied to the
8927: entire program, instead of the stack and heap only.
8928:
8929: PIE executables will only be built for toolchains that are known to support
8930: PIE. Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
8931:
8932: PKGSRC_MKPIE was enabled by default after the pkgsrc-2021Q3 branch.
8933:
1.219 nia 8934: B.1.1.4. PKGSRC_USE_RELRO
1.207 leot 8935:
8936: This also makes the exploitation of some security vulnerabilities more
8937: difficult in some cases.
8938:
8939: Two different mitigation levels are available:
8940:
1.219 nia 8941: * partial (the default): the ELF sections are reordered so that internal data
8942: sections precede the program's own data sections, and non-PLT GOT is
8943: read-only;
1.207 leot 8944:
8945: * full: in addition to partial RELRO, every relocation is performed
1.218 nia 8946: immediately when starting the program, allowing the entire GOT to be
8947: read-only. This can greatly slow down startup of large programs.
1.207 leot 8948:
8949: This is currently supported by GCC. Many software distributions now enable this
1.220 nia 8950: feature by default, at the "partial" level.
1.207 leot 8951:
8952: More details can be found here:
8953:
8954: * Hardening ELF binaries using Relocation Read-Only (RELRO)
8955:
1.219 nia 8956: B.1.2. Not enabled by default
8957:
8958: B.1.2.1. PKGSRC_MKREPRO
8959:
8960: With this option, pkgsrc will try to build packages reproducibly. This allows
8961: packages built from the same tree and with the same options, to produce
8962: identical results bit by bit. This option should be combined with ASLR and
8963: PKGSRC_MKPIE to avoid predictable address offsets for attackers attempting to
8964: exploit security vulnerabilities.
8965:
8966: More details can be found here:
8967:
8968: * Reproducible Builds - a set of software development practices that create
8969: an independently-verifiable path from source to binary code
8970:
8971: More work likely needs to be done before pkgsrc is fully reproducible.
8972:
8973: B.1.2.2. PKGSRC_USE_STACK_CHECK
1.207 leot 8974:
8975: This uses -fstack-check with GCC for another stack protection mitigation.
8976:
8977: It asks the compiler to generate code verifying that it does not corrupt the
8978: stack. According to GCC's manual page, this is really only useful for
8979: multi-threaded programs.
8980:
8981: B.2. Caveats
8982:
8983: B.2.1. Problems with PKGSRC_MKPIE
8984:
8985: B.2.1.1. Packages failing to build
8986:
8987: A number of packages may fail to build with this option enabled. The failures
8988: are often related to the absence of the -fPIC compilation flag when building
8989: libraries or executables (or ideally -fPIE in the latter case). This flag is
8990: added to the CFLAGS already, but requires the package to actually support it.
8991:
8992: B.2.1.1.1. How to fix
8993:
8994: These instructions are meant as a reference only; they likely need to be
8995: adapted for many packages individually.
8996:
8997: For packages using Makefiles:
8998:
8999: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
9000: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
9001:
9002: For packages using Imakefiles:
9003:
9004: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
9005: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
9006:
9007: B.2.1.2. Run-time crashes
9008:
9009: Some programs may fail to run, or crash at random times once built as PIE. Two
9010: scenarios are essentially possible. This is nearly always due to a bug in the
9011: program being exposed due to ASLR.
9012:
9013: B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis
9014:
9015: Ideally, packages should be fixed for compatibility with MKPIE. However, in
9016: some cases this is very difficult, due to complex build systems, packages using
9017: non-standard toolchains, or programming languages with odd bootstrapping
9018: mechanisms.
9019:
9020: To disable PKGSRC_MKPIE on a per-package basis, set MKPIE_SUPPORTED= no in the
9021: package's Makefile before bsd.prefs.mk is included.
9022:
9023: B.2.2. Problems with PKGSRC_USE_FORTIFY
9024:
9025: B.2.2.1. Packages failing to build
9026:
9027: This feature makes use of pre-processing directives to look for hardened,
9028: alternative implementations of essential library calls. Some programs may fail
9029: to build as a result; this usually happens for those trying too hard to be
9030: portable, or otherwise abusing definitions in the standard library.
9031:
9032: B.2.2.2. Run-time crashes
9033:
9034: This feature may cause some programs to crash, usually indicating an actual bug
9035: in the program. The fix will typically involve patching the original program's
9036: source code.
9037:
9038: B.2.2.3. Optimization is required
9039:
9040: At least in the case of GCC, FORTIFY will only be applied if optimization is
9041: applied while compiling. This means that the CFLAGS should also contain -O, -O2
9042: or another optimization level. This cannot easily be applied globally, as some
9043: packages may require specific optimization levels.
9044:
9045: B.2.2.4. Disabling FORTIFY on a per-package basis
9046:
9047: Note
9048:
9049: FORTIFY should not be disabled to work around runtime crashes in the program!
9050: This is a very bad idea and will expose you to security vulnerabilities.
9051:
9052: To disable FORTIFY on a per-package basis, set the following in the package's
9053: Makefile before bsd.prefs.mk is included:
9054:
9055: FORTIFY_SUPPORTED= no
9056:
9057: B.2.3. Problems with PKGSRC_USE_RELRO
9058:
9059: B.2.3.1. Performance impact
9060:
9061: For better protection, full RELRO requires every symbol to be resolved when the
9062: program starts, rather than simply when required at run-time. This will have
9063: more impact on programs using a lot of symbols, or linked to libraries exposing
9064: a lot of symbols. Therefore, daemons or programs otherwise running in
9065: background are affected only when started. Programs loading plug-ins at
9066: run-time are affected when loading the plug-ins.
9067:
9068: The impact is not expected to be noticeable on modern hardware, except in some
9069: cases for big programs.
9070:
9071: B.2.3.2. Run-time crashes
9072:
9073: Some programs handle plug-ins and dependencies in a way that conflicts with
9074: RELRO: for instance, with an initialization routine listing any other plug-in
9075: required. With full RELRO, the missing symbols are resolved before the
9076: initialization routine can run, and the dynamic loader will not be able to find
9077: them directly and abort as a result. Unfortunately, this is how Xorg loads its
9078: drivers. Partial RELRO can be applied instead in this case.
9079:
9080: B.2.3.3. Disabling RELRO on a per-package basis
9081:
9082: To disable RELRO on a per-package basis, set the following in the package's
9083: Makefile before bsd.prefs.mk is included:
9084:
9085: RELRO_SUPPORTED= no
9086:
1.209 nia 9087: It is also possible to at most enable partial RELRO, by setting RELRO_SUPPORTED
9088: to partial.
9089:
1.207 leot 9090: B.2.4. Problems with PKGSRC_USE_SSP
9091:
9092: B.2.4.1. Packages failing to build
9093:
9094: The stack-smashing protection provided by this option does not work for some
9095: programs. The most common situation in which this happens is when the program
9096: allocates variables on the stack, with the size determined at run-time.
9097:
9098: B.2.4.2. Run-time crashes
9099:
9100: Again, this feature may cause some programs to crash via a SIGABRT, usually
9101: indicating an actual bug in the program.
9102:
9103: On NetBSD LOG_CRIT level syslog messages are sent and - by default - appended
9104: to /var/log/messages, e.g.:
9105:
9106: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
9107:
9108: (where hostname is the hostname(1) and program is the basename(1) of the
9109: program crashed).
9110:
9111: Patching the original program is then required.
9112:
9113: Rebuilding the package via:
9114:
9115: % env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace
9116:
9117: and inspecting the backtrace of the coredump via the debugger should point out
9118: the problematic call by inspecting the frame calling the _chk() (SSP) function.
9119:
9120: B.2.4.3. Performance impact
9121:
9122: The compiler emits extra code when using this feature: a check for buffer
9123: overflows is performed when entering and exiting functions, requiring an extra
9124: variable on the stack. The level of protection can otherwise be adjusted to
9125: affect only those functions considered more sensitive by the compiler (with
9126: -fstack-protector instead of -fstack-protector-all).
9127:
9128: The impact is not expected to be noticeable on modern hardware. However,
9129: programs with a hard requirement to run at the fastest possible speed should
9130: avoid using this feature, or using libraries built with this feature.
9131:
9132: B.2.4.4. Disabling SSP on a per-package basis
9133:
9134: Note
9135:
9136: SSP should not be disabled to work around runtime crashes in the program! This
9137: is a very bad idea and will expose you to security vulnerabilities.
9138:
9139: To disable SSP on a per-package basis, set the following in the package's
9140: Makefile before bsd.prefs.mk is included:
9141:
9142: SSP_SUPPORTED= no
9143:
9144: B.3. Auditing the system
9145:
9146: The illusion of security is worse than having no security at all. This section
9147: lists a number of ways to ensure the security features requested are actually
9148: effective.
9149:
9150: These instructions were obtained and tested on a system derived from NetBSD 7
9151: (amd64). YMMV.
9152:
9153: B.3.1. Checking for PIE
9154:
9155: The ELF executable type in use changes for binaries built as PIE; without:
9156:
9157: $ file /path/to/bin/ary
9158: /path/to/bin/ary: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for NetBSD 7.0, not stripped
9159:
9160: as opposed to the following binary, built as PIE:
9161:
9162: $ file /path/to/pie/bin/ary
9163: /path/to/pie/bin/ary: ELF 64-bit LSB shared object, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for NetBSD 7.0, not stripped
9164:
9165: The latter result is then what is expected.
9166:
9167: B.3.2. Checking for partial RELRO
9168:
9169: The following command should list a section called RELRO:
9170:
9171: $ objdump -p /path/to/bin/ary
9172:
9173: /path/to/bin/ary: file format elf64-x86-64
9174:
9175: Program Header:
9176: [...]
9177: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
9178:
9179: This check is now performed automatically if PKG_DEVELOPER is set and RELRO is
9180: enabled.
9181:
9182: B.3.3. Checking for full RELRO
9183:
9184: The dynamic loader will apply RELRO immediately when detecting the presence of
9185: the BIND_NOW flag:
9186:
9187: $ objdump -x /path/to/bin/ary
9188:
9189: /path/to/bin/ary: file format elf64-x86-64
9190:
9191: Dynamic Section:
9192: [...]
9193: BIND_NOW 0x0000000000000000
9194:
9195: This has to be combined with partial RELRO (see above) to be fully efficient.
9196:
9197: This check is now performed automatically (where supported) if PKG_DEVELOPER is
9198: set.
9199:
9200: B.3.4. Checking for SSP
9201:
1.208 nia 9202: Note
9203:
9204: Checking for SSP using this method only works where the operating system uses
9205: libssp. libssp is not used on recent NetBSD/FreeBSD/Linux versions.
9206:
1.207 leot 9207: Building objects, binaries and libraries with SSP will affect the presence of
9208: additional symbols in the resulting file:
9209:
9210: $ nm /path/to/bin/ary
9211: [...]
9212: U __stack_chk_fail
9213: 0000000000600ea0 B __stack_chk_guard
9214:
9215: This is an indicator that the program was indeed built with support for SSP.
9216:
9217: This check is now performed automatically (where supported) if PKG_DEVELOPER is
9218: set and SSP is enabled.
9219:
9220: Appendix C. Build logs
1.1 dsieger 9221:
9222: Table of Contents
9223:
1.207 leot 9224: C.1. Building figlet
9225: C.2. Packaging figlet
1.1 dsieger 9226:
1.207 leot 9227: C.1. Building figlet
1.1 dsieger 9228:
9229: # make
9230: ===> Checking for vulnerabilities in figlet-2.2.1nb2
9231: => figlet221.tar.gz doesn't seem to exist on this system.
9232: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
9233: => [172219 bytes]
9234: Connected to ftp.plig.net.
9235: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
9236: 331 Guest login ok, send your complete e-mail address as password.
9237: 230-You are user #5 of 500 simultaneous users allowed.
9238: 230-
9239: 230- ___ _ _ _
9240: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
9241: 230- | _| _| . |_| . | | | . |_| . | _| . |
9242: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
9243: 230- |_| |_| |___| |___|
9244: 230-
9245: 230-** Welcome to ftp.plig.org **
9246: 230-
9247: 230-Please note that all transfers from this FTP site are logged. If you
9248: 230-do not like this, please disconnect now.
9249: 230-
1.19 snj 9250: 230-This archive is available via
1.1 dsieger 9251: 230-
9252: 230-HTTP: http://ftp.plig.org/
9253: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
9254: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
9255: 230-
9256: 230-Please email comments, bug reports and requests for packages to be
9257: 230-mirrored to ftp-admin@plig.org.
9258: 230-
9259: 230-
9260: 230 Logged in anonymously.
9261: Remote system type is UNIX.
9262: Using binary mode to transfer files.
9263: 200 Type okay.
9264: 250 "/pub" is new cwd.
9265: 250-"/pub/figlet" is new cwd.
9266: 250-
9267: 250-Welcome to the figlet archive at ftp.figlet.org
9268: 250-
9269: 250- ftp://ftp.figlet.org/pub/figlet/
9270: 250-
9271: 250-The official FIGlet web page is:
9272: 250- http://www.figlet.org/
9273: 250-
9274: 250-If you have questions, please mailto:info@figlet.org. If you want to
9275: 250-contribute a font or something else, you can email us.
9276: 250
9277: 250 "/pub/figlet/program" is new cwd.
9278: 250 "/pub/figlet/program/unix" is new cwd.
9279: local: figlet221.tar.gz remote: figlet221.tar.gz
9280: 502 Unimplemented command.
9281: 227 Entering Passive Mode (195,40,6,41,246,104)
9282: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
9283: 38% |************** | 65800 64.16 KB/s 00:01 ETA
9284: 226 Transfer completed.
9285: 172219 bytes received in 00:02 (75.99 KB/s)
9286: 221 Goodbye.
9287: => Checksum OK for figlet221.tar.gz.
9288: ===> Extracting for figlet-2.2.1nb2
9289: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
9290: ===> Patching for figlet-2.2.1nb2
9291: ===> Applying pkgsrc patches for figlet-2.2.1nb2
9292: ===> Overriding tools for figlet-2.2.1nb2
9293: ===> Creating toolchain wrappers for figlet-2.2.1nb2
9294: ===> Configuring for figlet-2.2.1nb2
9295: ===> Building for figlet-2.2.1nb2
9296: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
9297: chmod a+x figlet
9298: gcc -O2 -o chkfont chkfont.c
9299: => Unwrapping files-to-be-installed.
9300: #
9301: # make install
9302: ===> Checking for vulnerabilities in figlet-2.2.1nb2
9303: ===> Installing for figlet-2.2.1nb2
9304: install -d -o root -g wheel -m 755 /usr/pkg/bin
9305: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
9306: mkdir -p /usr/pkg/share/figlet
9307: cp figlet /usr/pkg/bin
9308: cp chkfont /usr/pkg/bin
9309: chmod 555 figlist showfigfonts
9310: cp figlist /usr/pkg/bin
9311: cp showfigfonts /usr/pkg/bin
9312: cp fonts/*.flf /usr/pkg/share/figlet
9313: cp fonts/*.flc /usr/pkg/share/figlet
9314: cp figlet.6 /usr/pkg/man/man6
9315: ===> Registering installation for figlet-2.2.1nb2
9316: #
9317:
1.207 leot 9318: C.2. Packaging figlet
1.1 dsieger 9319:
9320: # make package
9321: ===> Checking for vulnerabilities in figlet-2.2.1nb2
9322: ===> Packaging figlet-2.2.1nb2
9323: ===> Building binary package for figlet-2.2.1nb2
9324: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
9325: Using SrcDir value of /usr/pkg
9326: Registering depends:.
9327: #
9328:
1.207 leot 9329: Appendix D. Directory layout of the pkgsrc FTP server
1.1 dsieger 9330:
9331: Table of Contents
9332:
1.207 leot 9333: D.1. distfiles: The distributed source files
9334: D.2. misc: Miscellaneous things
9335: D.3. packages: Binary packages
9336: D.4. reports: Bulk build reports
9337: D.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 9338:
9339: As in other big projects, the directory layout of pkgsrc is quite complex for
9340: newbies. This chapter explains where you find things on the FTP server. The
9341: base directory on ftp.NetBSD.org is /pub/pkgsrc/. On other servers it may be
9342: different, but inside this directory, everything should look the same, no
9343: matter on which server you are. This directory contains some subdirectories,
9344: which are explained below.
9345:
1.207 leot 9346: D.1. distfiles: The distributed source files
1.1 dsieger 9347:
9348: The directory distfiles contains lots of archive files from all pkgsrc
9349: packages, which are mirrored here. The subdirectories are called after their
9350: package names and are used when the distributed files have names that don't
9351: explicitly contain a version number or are otherwise too generic (for example
9352: release.tar.gz).
9353:
1.207 leot 9354: D.2. misc: Miscellaneous things
1.1 dsieger 9355:
9356: This directory contains things that individual pkgsrc developers find worth
9357: publishing.
9358:
1.207 leot 9359: D.3. packages: Binary packages
1.1 dsieger 9360:
1.3 rillig 9361: This directory contains binary packages for the various platforms that are
9362: supported by pkgsrc. Each subdirectory is of the form OPSYS/ARCH/OSVERSION_TAG.
9363: The meaning of these variables is:
9364:
9365: * OPSYS is the name of the operating system for which the packages have been
1.9 rillig 9366: built. The name is taken from the output of the uname command, so it may
9367: differ from the one you are used to hear.
1.3 rillig 9368:
1.8 rillig 9369: * ARCH is the hardware architecture of the platform for which the packages
1.10 hubertf 9370: have been built. It also includes the ABI (Application Binary Interface)
9371: for platforms that have several of them.
1.3 rillig 9372:
1.255 ! wiz 9373: * OSVERSION is the version of the operating system. Typically it is the
! 9374: version defining an ABI, e.g. 9.0.
! 9375:
! 9376: * TAG is either 20YYQN for a stable branch, or current for packages built
! 9377: from the HEAD branch. The latter should only be used when the packages are
! 9378: updated on a regular basis.
! 9379:
! 9380: The rationale for this scheme is that users can first search by OPSYS and ARCH,
! 9381: since these are more or less unchangeable. After that, there is a management
! 9382: set of directories with OSVERSION and TAG.
! 9383:
! 9384: See also README.md in packages for more details, including about symlinks.
1.3 rillig 9385:
9386: In each of these directories, there is a whole binary packages collection for a
9387: specific platform. It has a directory called All which contains all binary
1.255 ! wiz 9388: packages.
1.1 dsieger 9389:
1.207 leot 9390: D.4. reports: Bulk build reports
1.8 rillig 9391:
9392: Here are the reports from bulk builds, for those who want to fix packages that
9393: didn't build on some of the platforms. The structure of subdirectories should
1.207 leot 9394: look like the one in Section D.3, "packages: Binary packages".
1.8 rillig 9395:
1.207 leot 9396: D.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 9397:
9398: These directories contain the "real" pkgsrc, that is the files that define how
9399: to create binary packages from source archives.
9400:
1.149 leot 9401: Each of the current, stable and pkgsrc-20xxQy directories share the same
9402: structure. They each contain a pkgsrc directory and pkgsrc.tar.{bz,gz,xz} file.
9403:
1.1 dsieger 9404: The directory pkgsrc contains a snapshot of the CVS repository, which is
1.149 leot 9405: updated regularly. The file pkgsrc.tar.{bz,gz,xz} contains the same as the
9406: directory, ready to be downloaded as a whole.
1.1 dsieger 9407:
1.149 leot 9408: The current directory contains files related to the HEAD branch of the CVS
9409: repository. In this directory there is an additional file called
9410: pkgsrc-readmes.tar.{bz,gz,xz} that contains all pkgsrc READMEs with information
9411: about categories and packages.
9412:
9413: The stable directory is a symlink to the latest pkgsrc-20xxQy.
9414:
9415: The pkgsrc-20xxQy. directories contain files related to the -20xxQy stable
9416: branch of the CVS repository. In these directories there is an additional file
9417: called pkgsrc-20xxQy.tar.{bz,gz,xz}, which contains the state of pkgsrc when it
9418: was branched.
1.148 leot 9419:
1.207 leot 9420: Appendix E. Help topics
1.154 rillig 9421:
9422: The following list contains all help topics that are available when running
9423: bmake help topic=:index.
9424:
1.255 ! wiz 9425: #! -lintl
! 9426: 32bit 64bit
! 9427: ABI ACCEPTABLE_LICENSES
! 9428: ACROREAD_FONTPATH ADDITIONAL
! 9429: AFAIK AIX
! 9430: ALLOW_NETWORK_ACCESS ALLOW_NEWER_COMPILER
! 9431: ALLOW_VULNERABLE_PACKAGES ALL_ENV
! 9432: ALSA_PC ALTERNATIVES_SRC
! 9433: AMANDA_TMP AMANDA_USER
! 9434: AMANDA_VAR APACHE_GROUP
! 9435: APACHE_MODULE_NAME APACHE_MODULE_SRC
! 9436: APACHE_MODULE_SRCDIR APACHE_PKG_PREFIX
! 9437: APACHE_SUEXEC_CONFIGURE_ARGS APACHE_SUEXEC_DOCROOT
! 9438: APACHE_USER ARLA_CACHE
! 9439: AUDIT_PACKAGES_FLAGS AUTOCONF_REQD
! 9440: AUTOMAKE_OVERRIDE AUTOMAKE_REQD
! 9441: AUTO_MKDIRS AUX
! 9442: BDB185_DEFAULT BDBBASE
! 9443: BDB_ACCEPTED BDB_DEFAULT
! 9444: BDB_LIBS BDB_TYPE
! 9445: BINCIMAP_GROUP BINCIMAP_LOG_USER
! 9446: BINCIMAP_USER BIND_DIR
! 9447: BIND_GROUP BIND_USER
! 9448: BINOWN BINPKG_SITES
! 9449: BIN_INSTALL_FLAGS BISON_PKGDATADIR
! 9450: BLAS BLAS_ACCEPTED
! 9451: BLAS_C_INTERFACE BLAS_INCLUDES
! 9452: BLAS_INDEX64 BLAS_LIBS
! 9453: BLAS_PC BLAS_TYPE
! 9454: BOOTSTRAP_DEPENDS BROKEN
! 9455: BROKEN_EXCEPT_ON_PLATFORM BROKEN_ON_PLATFORM
! 9456: BSDSRCDIR BSDXSRCDIR
! 9457: BSD_MAKE_ENV BUILDLINK_AUTO_DIRS
! 9458: BUILDLINK_AUTO_VARS BUILDLINK_CFLAGS
! 9459: BUILDLINK_CONTENTS_FILTER BUILDLINK_CPPFLAGS
! 9460: BUILDLINK_DEPMETHOD BUILDLINK_FILES
! 9461: BUILDLINK_FILES_CMD BUILDLINK_FNAME_TRANSFORM
! 9462: BUILDLINK_LDFLAGS BUILDLINK_LIBS
! 9463: BUILDLINK_OPSYS_SUPPORT_PTHREAD BUILDLINK_PKGNAME
! 9464: BUILDLINK_PREFIX BUILDLINK_RPATHDIRS
! 9465: BUILDLINK_TREE BUILD_DEFS
! 9466: BUILD_DEFS_EFFECTS BUILD_DEPENDS
! 9467: BUILD_DIRS BUILD_ENV_SHELL
! 9468: BUILD_MAKE_CMD BUILD_MAKE_FLAGS
! 9469: BUILD_TARGET BUILTIN_FIND_FILES
! 9470: BUILTIN_FIND_FILES_VAR BUILTIN_FIND_GREP
! 9471: BUILTIN_FIND_HEADERS BUILTIN_FIND_HEADERS_VAR
! 9472: BUILTIN_FIND_PKGCONFIG BUILTIN_FIND_PKGCONFIG_VAR
! 9473: BUILTIN_PKG BUILTIN_TEST_CURSES_DEFINES
! 9474: BUILTIN_TEST_CURSES_FUNCS BUILTIN_VERSION_SCRIPT
! 9475: BUILTIN_X11_TYPE BUILTIN_X11_VERSION
! 9476: CACTI_GROUP CACTI_USER
! 9477: CANNA_GROUP CANNA_USER
! 9478: CAT CBLAS_LIBS
! 9479: CBLAS_PC CCACHE_BASE
! 9480: CCACHE_DIR CCACHE_LOGFILE
! 9481: CC_VERSION CC_VERSION_STRING
! 9482: CDRECORD_CONF CDROM_PKG_URL_DIR
! 9483: CDROM_PKG_URL_HOST CHANGES
! 9484: CHECKOUT_DATE CHECK_COMPILER
! 9485: CHECK_FAKEHOME CHECK_FILES
! 9486: CHECK_FILES_ONLY_PREFIX CHECK_FILES_SKIP
! 9487: CHECK_FILES_STRICT CHECK_HEADERS
! 9488: CHECK_HEADERS_SKIP CHECK_INTERPRETER
! 9489: CHECK_INTERPRETER_SKIP CHECK_PERMS
! 9490: CHECK_PERMS_AUTOFIX CHECK_PERMS_SKIP
! 9491: CHECK_PIE CHECK_PIE_SKIP
! 9492: CHECK_PIE_SUPPORTED CHECK_PORTABILITY
! 9493: CHECK_PORTABILITY_EXPERIMENTAL CHECK_PORTABILITY_SKIP
! 9494: CHECK_RELRO CHECK_RELRO_SKIP
! 9495: CHECK_RELRO_SUPPORTED CHECK_SHLIBS
! 9496: CHECK_SHLIBS_SKIP CHECK_SHLIBS_SUPPORTED
! 9497: CHECK_SHLIBS_TOXIC CHECK_SSP
! 9498: CHECK_SSP_SKIP CHECK_SSP_SUPPORTED
! 9499: CHECK_STRIPPED CHECK_STRIPPED_SKIP
! 9500: CHECK_WRKREF CHECK_WRKREF_EXTRA_DIRS
! 9501: CHECK_WRKREF_SKIP CLAMAV_DBDIR
! 9502: CLAMAV_GROUP CLAMAV_USER
! 9503: CLANGBASE CLEANDEPENDS
! 9504: CLT CMAKE_DEPENDENCIES_REWRITE
! 9505: CMAKE_INSTALL_NAME_DIR CMAKE_INSTALL_PREFIX
! 9506: CMAKE_MODULE_PATH_OVERRIDE CMAKE_PKGSRC_BUILD_FLAGS
! 9507: CMAKE_PREFIX_PATH CMAKE_USE_GNU_INSTALL_DIRS
! 9508: COMMON_LISP_DOCFILES COMMON_LISP_EXAMPLES
! 9509: COMMON_LISP_EXTRAFILES COMMON_LISP_PACKAGES
! 9510: COMMON_LISP_SYSTEM COMPILER_RPATH_FLAG
! 9511: COMPILER_USE_SYMLINKS CONFIGURE_ARGS
! 9512: CONFIGURE_DIRS CONFIGURE_ENV
! 9513: CONFIGURE_ENV_SHELL CONFIGURE_HAS_INFODIR
! 9514: CONFIGURE_HAS_MANDIR CONFIGURE_SCRIPT
! 9515: CONFIG_SHELL CONFIG_SHELL_FLAGS
! 9516: CONF_FILES CONF_FILES_MODE
! 9517: CONF_FILES_PERMS CONSERVER_DEFAULTHOST
! 9518: CONSERVER_DEFAULTPORT CP
! 9519: CPE CPE_EDITION
! 9520: CPE_LANG CPE_OTHER
! 9521: CPE_PART CPE_PRODUCT
! 9522: CPE_SW_EDITION CPE_TARGET_HW
! 9523: CPE_TARGET_SW CPE_UPDATE
! 9524: CPE_URI CPE_VENDOR
! 9525: CPE_VERSION CPP
! 9526: CPP_PRECOMP_FLAGS CREATE_WRKDIR_SYMLINK
! 9527: CROSSBASE CTFCONVERT
! 9528: CTF_FILES_SKIP CTF_SUPPORTED
! 9529: CTYPE CUPS_GROUP
! 9530: CUPS_SYSTEM_GROUPS CUPS_USER
! 9531: CURSES_DEFAULT CURSES_TYPE
! 9532: CVS_EXTRACTDIR CVS_MODULE
! 9533: CVS_PROJECT CVS_REPOSITORIES
! 9534: CVS_ROOT CVS_ROOT_GNU
! 9535: CVS_ROOT_NONGNU CVS_ROOT_SOURCEFORGE
! 9536: CVS_TAG CXX
! 9537: CYRUS_GROUP CYRUS_IDLE
! 9538: CYRUS_USER DAEMONTOOLS_GROUP
! 9539: DAEMONTOOLS_LOG_USER DARWIN_NO_SYSTEM_LIBS
! 9540: DARWIN_REQUIRES_FILTER DBUS_GROUP
! 9541: DBUS_USER DEFANG_GROUP
! 9542: DEFANG_USER DEFAULT_ACCEPTABLE_LICENSES
! 9543: DEFAULT_DISTFILES DEFAULT_IRC_SERVER
! 9544: DEFAULT_SERIAL_DEVICE DEF_UMASK
! 9545: DEINSTALLDEPENDS DEINSTALL_SRC
! 9546: DEINSTALL_TEMPLATES DELAYED_ERROR_MSG
! 9547: DELAYED_WARNING_MSG DEPENDS
! 9548: DEPENDS_TARGET DEPENDS_TYPE
! 9549: DESTDIR DESTDIR_VARNAME
! 9550: DIALER_GROUP DIGEST_REQD
! 9551: DISTDIR DISTFILES
! 9552: DISTINFO_FILE DISTNAME
! 9553: DIST_PATH DIST_SUBDIR
! 9554: DJBDNS_AXFR_USER DJBDNS_CACHE_USER
! 9555: DJBDNS_DJBDNS_GROUP DJBDNS_LOG_USER
! 9556: DJBDNS_RBL_USER DJBDNS_TINY_USER
! 9557: DLOPEN_REQUIRE_PTHREADS DL_AUTO_VARS
! 9558: DL_CFLAGS DL_LDFLAGS
! 9559: DL_LIBS DNS
! 9560: DOCOWN DOWNLOADED_DISTFILE
! 9561: DQCACHE_GROUP DQCACHE_USER
! 9562: DT_LAYOUT DYNAMIC_SITES_CMD
! 9563: DYNAMIC_SITES_SCRIPT ECHO
! 9564: ECHO_N ELK_GUI
! 9565: EMACS_TYPE EMULDIR
! 9566: EMULSUBDIR EMULSUBDIRSLASH
! 9567: EMUL_ARCH EMUL_DISTRO
! 9568: EMUL_EXEC_FMT EMUL_IS_NATIVE
! 9569: EMUL_MODULES EMUL_OPSYS
! 9570: EMUL_PKG_FMT EMUL_PLATFORM
! 9571: EMUL_PLATFORMS EMUL_PREFER
! 9572: EMUL_REQD EMUL_TYPE
! 9573: ERROR_MSG EXIM_GROUP
! 9574: EXIM_USER EXPORT_SYMBOLS_LDFLAGS
! 9575: EXTRACTOR EXTRACT_CMD
! 9576: EXTRACT_CMD_DEFAULT EXTRACT_DIR
! 9577: EXTRACT_ELEMENTS EXTRACT_ENV
! 9578: EXTRACT_ONLY EXTRACT_OPTS
! 9579: EXTRACT_SUFX EXTRACT_USING
! 9580: FAIL FAILOVER_FETCH
! 9581: FAIL_MSG FAKE_NCURSES
! 9582: FAM FAM_ACCEPTED
! 9583: FAM_DEFAULT FAM_SERVER
! 9584: FCPATH FEATURE_CPPFLAGS
! 9585: FEATURE_LDFLAGS FEATURE_LIBS
! 9586: FETCH_AFTER_ARGS FETCH_BEFORE_ARGS
! 9587: FETCH_CMD FETCH_OUTPUT_ARGS
! 9588: FETCH_PROXY FETCH_RESUME_ARGS
! 9589: FETCH_TIMEOUT FETCH_USE_IPV4_ONLY
! 9590: FETCH_USING FILES_SUBST
! 9591: FILES_SUBST_SED FIX_SYSTEM_HEADERS
! 9592: FONTDIR FONTS_DIRS
! 9593: FONTS_VERBOSE FOO_HACKS_MK
! 9594: FORCE_CXX_STD FORCE_C_STD
! 9595: FOSSIL_EXTRACTDIR FOSSIL_REPO
! 9596: FOSSIL_REPOSITORIES FOSSIL_VERSION
! 9597: FOX_USE_XUNICODE FREEWNN_GROUP
! 9598: FREEWNN_USER FTP_PKG_URL_DIR
! 9599: FTP_PKG_URL_HOST GAMEDATAMODE
! 9600: GAMEDATA_PERMS GAMEDIRMODE
! 9601: GAMEDIR_PERMS GAMEGRP
! 9602: GAMEMODE GAMEOWN
! 9603: GAMES_GROUP GAMES_USER
! 9604: GCC GCCBASE
! 9605: GCC_REQD GCC_VERSION_SUFFIX
! 9606: GEM_BUILD GEM_CLEANBUILD
! 9607: GEM_CLEANBUILD_EXTENSIONS GEM_DOCDIR
! 9608: GEM_EXTSDIR GEM_HOME
! 9609: GEM_KEEPBUILD GEM_LIBDIR
! 9610: GEM_NAME GEM_PATH
! 9611: GEM_PLUGINSDIR GEM_SPECFILE
! 9612: GENERATE_PLIST GHC
! 9613: GHOSTSCRIPT_REQD GITHUB_PROJECT
! 9614: GITHUB_RELEASE GITHUB_SUBMODULES
! 9615: GITHUB_TAG GITHUB_TYPE
! 9616: GITLAB_PROJECT GITLAB_RELEASE
! 9617: GITLAB_SUBMODULES GITLAB_TAG
! 9618: GITLAB_TYPE GIT_BRANCH
! 9619: GIT_ENV GIT_EXTRACTDIR
! 9620: GIT_REPO GIT_REPOSITORIES
! 9621: GIT_REVISION GIT_TAG
! 9622: GNU GNU_CONFIGURE
! 9623: GNU_CONFIGURE_INFODIR GNU_CONFIGURE_MANDIR
! 9624: GNU_CONFIGURE_QUIET GNU_CONFIGURE_STRICT
! 9625: GODEP_REDIRECTS GO_BUILD_PATTERN
! 9626: GO_DEPS GO_DIST_BASE
! 9627: GO_EXTRA_MOD_DIRS GO_MODULE_FILES
! 9628: GO_SRCPATH GROUP_SPECIFIC_PKGS
! 9629: GRUB_NETWORK_CARDS GRUB_PRESET_COMMAND
! 9630: GRUB_SCAN_ARGS GZIP
! 9631: HASKELL_COMPILER HASKELL_DISABLE_EXECUTABLES
! 9632: HASKELL_DISABLE_LIBRARIES HASKELL_ENABLE_DYNAMIC_EXECUTABLE
! 9633: HASKELL_ENABLE_HADDOCK_DOCUMENTATION HASKELL_ENABLE_LIBRARY_PROFILING
! 9634: HASKELL_ENABLE_SHARED_LIBRARY HASKELL_ENABLE_TESTS
! 9635: HASKELL_OPTIMIZATION_LEVEL HASKELL_PKG_NAME
! 9636: HASKELL_UNRESTRICT_DEPENDENCIES HEADER_TEMPLATES
! 9637: HG_REPO HG_REPOSITORIES
! 9638: HG_TAG HOMEPAGE
! 9639: HOST_PKGTOOLS_ARGS HOST_SPECIFIC_PKGS
! 9640: HOWL_GROUP HOWL_USER
! 9641: ICCBASE ICECAST_CHROOTDIR
! 9642: ICON_THEMES IDOBASE
! 9643: IGNORE_CCACHE IGNORE_INFO_DIRS
! 9644: IGNORE_INTERACTIVE_FETCH IMAKE
! 9645: IMAKEOPTS IMAKE_MAKE
! 9646: IMAKE_MANINSTALL IMAP_UW_CCLIENT_MBOX_FMT
! 9647: IMDICTDIR INCOMPAT_CURSES
! 9648: INFO_DIR INFO_FILES
! 9649: INFO_MSG INIT_SYSTEM
! 9650: INN_DATA_DIR INN_GROUP
! 9651: INN_USER INSTALLATION_DIRS
! 9652: INSTALLATION_DIRS_FROM_PLIST INSTALL_ENV
! 9653: INSTALL_SH_OVERRIDE INSTALL_SRC
! 9654: INSTALL_TEMPLATES INSTALL_UNSTRIPPED
! 9655: IRCD_HYBRID_IRC_GROUP IRCD_HYBRID_IRC_USER
! 9656: IRCD_HYBRID_MAXCONN IRCD_HYBRID_NICLEN
! 9657: IRCD_HYBRID_SYSLOG_EVENTS IRCD_HYBRID_SYSLOG_FACILITY
! 9658: IRCD_HYBRID_TOPICLEN IRIX
! 9659: IRRD_USE_PGP JABBERD_GROUP
! 9660: JABBERD_LOGDIR JABBERD_PIDDIR
! 9661: JABBERD_SPOOLDIR JABBERD_USER
! 9662: JAVA_APP_PATH JAVA_APP_TARGETS
! 9663: JAVA_BINPREFIX JAVA_CLASSPATH
! 9664: JAVA_HOME JAVA_LD_LIBRARY_PATH
! 9665: JAVA_NAME JAVA_UNLIMIT
! 9666: JAVA_WRAPPERS JPEG_ACCEPTED
! 9667: JPEG_DEFAULT KERBEROS
! 9668: KERMIT_SUID_UUCP KJS_USE_PCRE
! 9669: KNEWS_DOMAIN_FILE KNEWS_DOMAIN_NAME
! 9670: KRB5_ACCEPTED KRB5_DEFAULT
! 9671: LANGUAGES LAPACKE_LIBS
! 9672: LAPACKE_PC LAPACK_LIBS
! 9673: LAPACK_PC LATEX2HTML_ICONPATH
! 9674: LDCONFIG_ADD_CMD LDCONFIG_REMOVE_CMD
! 9675: LDD LEAFNODE_DATA_DIR
! 9676: LEAFNODE_GROUP LEAFNODE_USER
! 9677: LIBDVDCSS_HOMEPAGE LIBDVDCSS_MASTER_SITES
! 9678: LIBIMAGEQUANT_TYPE LIBRSVG_TYPE
! 9679: LIBTOOL LIBTOOLIZE_PLIST
! 9680: LIBTOOL_M4_OVERRIDE LIBUSB_TYPE
! 9681: LICENSE LINKER_RPATH_FLAG
! 9682: LINK_RPATH_FLAG LINUX_BASE_NODEPS
! 9683: LINUX_BASE_PREFERRED LINUX_BASE_REQUIRED
! 9684: LINUX_LOCALES LOCALBASE
! 9685: LOCALBASE_LOCKTYPE LOCALPATCHES
! 9686: LOVE_DATA LOVE_GAME
! 9687: LOVE_VERSION LOWER_OPSYS
! 9688: LOWER_OPSYS_VERSUFFIX LOWER_VARIANT_VERSION
! 9689: LOWER_VENDOR LP32PLATFORMS
! 9690: LP64PLATFORMS LUA_BUSTED_ARGS
! 9691: LUA_CDIR LUA_COMPILER
! 9692: LUA_DOCDIR LUA_EXAMPLESDIR
! 9693: LUA_INCDIR LUA_INTERPRETER
! 9694: LUA_LDIR LUA_LINKER_MAGIC
! 9695: LUA_PKGPREFIX LUA_SELF_CONFLICT
! 9696: LUA_USE_BUSTED LUA_VERSIONS_ACCEPTED
! 9697: LUA_VERSIONS_INCOMPATIBLE LUA_VERSION_DEFAULT
! 9698: LUA_VERSION_REQD Lua
! 9699: MACHINE_PLATFORM MAILAGENT_DOMAIN
! 9700: MAILAGENT_EMAIL MAILAGENT_FQDN
! 9701: MAILAGENT_ORGANIZATION MAJORDOMO_HOMEDIR
! 9702: MAJOR_OS_VERSION MAKEINFO_ARGS
! 9703: MAKE_DIRS MAKE_DIRS_PERMS
! 9704: MAKE_ENV MAKE_FILE
! 9705: MAKE_FLAGS MAKE_JOBS
! 9706: MAKE_JOBS_SAFE MAKE_PROGRAM
! 9707: MANCOMPRESSED_IF_MANZ MANINSTALL
! 9708: MANZ MARIADB_VERSIONS_ALL
! 9709: MASTER_SITES MASTER_SITE_BACKUP
! 9710: MASTER_SITE_LOCAL MASTER_SITE_MOZILLA
! 9711: MASTER_SITE_OVERRIDE MASTER_SITE_PERL_CPAN
! 9712: MASTER_SORT MASTER_SORT_RANDOM
! 9713: MASTER_SORT_REGEX MECAB_CHARSET
! 9714: MEDIATOMB_GROUP MEDIATOMB_USER
! 9715: MIPSPROBASE MIREDO_GROUP
! 9716: MIREDO_USER MISSING_FEATURES
! 9717: MKDIR MKPIE_SUPPORTED
! 9718: MLDONKEY_GROUP MLDONKEY_HOME
! 9719: MLDONKEY_USER MONOTONE_GROUP
! 9720: MONOTONE_USER MOTIFBASE
! 9721: MOTIF_TYPE MOTIF_TYPE_DEFAULT
! 9722: MPI_TYPE MSGFMT_STRIP_MSGCTXT
! 9723: MSGFMT_STRIP_MSGID_PLURAL MTOOLS_ENABLE_FLOPPYD
! 9724: MUST MV
! 9725: MYSQL_CHARSET MYSQL_DATADIR
! 9726: MYSQL_EXTRA_CHARSET MYSQL_GROUP
! 9727: MYSQL_USER MYSQL_VERSION
! 9728: MYSQL_VERSIONS_ACCEPTED MYSQL_VERSION_DEFAULT
! 9729: NAGIOSCMD_GROUP NAGIOSDIR
! 9730: NAGIOS_GROUP NAGIOS_USER
! 9731: NATIVE_EXEC_FMT NATIVE_LOWER_OPSYS
! 9732: NATIVE_LOWER_VENDOR NATIVE_MACHINE_PLATFORM
! 9733: NATIVE_OPSYS_VERSION NATIVE_OS_VARIANT
! 9734: NATIVE_OS_VERSION NBPAX_PROGRAM_PREFIX
! 9735: NETBSD_LOGIN_NAME NMH_EDITOR
! 9736: NMH_MTA NMH_PAGER
! 9737: NODE_VERSIONS_ACCEPTED NODE_VERSIONS_INCOMPATIBLE
! 9738: NODE_VERSION_DEFAULT NODE_VERSION_REQD
! 9739: NOLOGIN NOTE
! 9740: NOT_FOR_PLATFORM NOT_PAX_ASLR_SAFE
! 9741: NOT_PAX_MPROTECT_SAFE NO_BUILD
! 9742: NO_CHECKSUM NO_CONFIGURE
! 9743: NO_SKIP NS_PREFERRED
! 9744: NULLMAILER_GROUP NULLMAILER_USER
! 9745: OBJECT_FMT OBJHOSTNAME
! 9746: OBJMACHINE OCAML_FINDLIB_DIRS
! 9747: OCAML_FINDLIB_REGISTER OCAML_FINDLIB_REGISTER_VERBOSE
! 9748: OCAML_SITELIBDIR OMF
! 9749: ONLY_FOR_COMPILER ONLY_FOR_PLATFORM
! 9750: OPENSSH_CHROOT OPENSSH_GROUP
! 9751: OPENSSH_USER OPSYS
! 9752: OPSYS_EMULDIR OPSYS_VERSION
! 9753: OS OSS_TYPE
! 9754: OSX OSX_PATH_TO_M4
! 9755: OSX_PATH_TO_YACC OS_HAVE_ALSA
! 9756: OS_HAVE_RCD OS_VARIANT
! 9757: OS_VERSION OTF_FONTS_DIR
! 9758: OVERRIDE_DIRDEPTH OVERRIDE_GEMSPEC
! 9759: OVERRIDE_GNU_CONFIG_SCRIPTS OVERRIDE_ROCKSPEC
! 9760: OWN_DIRS OWN_DIRS_PERMS
! 9761: P4GROUP P4PORT
! 9762: P4ROOT P4USER
! 9763: PACKAGES PALMOS_DEFAULT_SDK
! 9764: PAMBASE PAM_DEFAULT
! 9765: PAPERSIZE PASSIVE_FETCH
! 9766: PATCHDIR PATCHFILES
! 9767: PATCH_ARGS PATCH_DEBUG
! 9768: PATCH_DIST_ARGS PATCH_DIST_CAT
! 9769: PATCH_DIST_STRIP PATCH_FUZZ_FACTOR
! 9770: PATCH_STRIP PATH
! 9771: PCCBASE PEAR
! 9772: PEAR_CHANNEL PEAR_CHANNEL_ALIAS
! 9773: PEAR_CHANNEL_VERSION PEAR_CMD
! 9774: PEAR_LIB PEAR_PACKAGE_XML
! 9775: PERL5 PERL5_CONFIGURE
! 9776: PERL5_CONFIGURE_DIRS PERL5_LDFLAGS
! 9777: PERL5_LICENSE PERL5_MODULE_TYPE
! 9778: PERL5_PACKLIST PERL5_PACKLIST_DIR
! 9779: PERL5_PERLBASE PERL5_SITEBASE
! 9780: PERL5_USE_PACKLIST PERL5_VENDORBASE
! 9781: PFCTL PFVAR_H
! 9782: PF_VERSION PGGROUP
! 9783: PGHOME PGPKGSRCDIR
! 9784: PGSQL_TYPE PGSQL_VERSION
! 9785: PGSQL_VERSIONS_ACCEPTED PGSQL_VERSION_DEFAULT
! 9786: PGUSER PG_LIB_EXT
! 9787: PHP PHPCOMMON_MK
! 9788: PHPPKGSRCDIR PHP_BASE_VERS
! 9789: PHP_CHECK_INSTALLED PHP_EXTENSION_DIR
! 9790: PHP_INITIAL_TEENY PHP_PKG_PREFIX
! 9791: PHP_VERSION PHP_VERSIONS_ACCEPTED
! 9792: PHP_VERSIONS_INCOMPATIBLE PHP_VERSION_DEFAULT
! 9793: PHP_VERSION_REQD PILRC_USE_GTK
! 9794: PKGCONFIG_BASE PKGCONFIG_FILE
! 9795: PKGCONFIG_OVERRIDE PKGCONFIG_OVERRIDE_STAGE
! 9796: PKGDIR PKGGNUDIR
! 9797: PKGINFODIR PKGLOCALEDIR
! 9798: PKGMANDIR PKGNAME
! 9799: PKGNAME_REQD PKGPATH
! 9800: PKGREVISION PKGSRC_BLAS_TYPES
! 9801: PKGSRC_CHANGES PKGSRC_COMPILER
! 9802: PKGSRC_KEEP_BIN_PKGS PKGSRC_LOCKTYPE
! 9803: PKGSRC_MAKE_ENV PKGSRC_MESSAGE_RECIPIENTS
! 9804: PKGSRC_MKPIE PKGSRC_MKREPRO
! 9805: PKGSRC_OVERRIDE_MKPIE PKGSRC_RUN_TEST
! 9806: PKGSRC_SETENV PKGSRC_SLEEPSECS
! 9807: PKGSRC_TODO PKGSRC_USE_CTF
! 9808: PKGSRC_USE_FORTIFY PKGSRC_USE_MKTOOLS
! 9809: PKGSRC_USE_RELRO PKGSRC_USE_SSP
! 9810: PKGSRC_USE_STACK_CHECK PKGTASKS_DATAFILE
! 9811: PKGTOOLS_ARGS PKGTOOLS_ENV
! 9812: PKG_ALTERNATIVES PKG_APACHE
! 9813: PKG_APACHE_ACCEPTED PKG_APACHE_DEFAULT
! 9814: PKG_BEST_EXISTS PKG_BUILD_OPTIONS
! 9815: PKG_COMPRESSION PKG_CONFIG
! 9816: PKG_CONFIG_PERMS PKG_CREATE_USERGROUP
! 9817: PKG_DBDIR PKG_DB_TMPDIR
! 9818: PKG_DEBUG_LEVEL PKG_DEFAULT_OPTIONS
! 9819: PKG_DESTDIR_SUPPORT PKG_DEVELOPER
! 9820: PKG_DISABLED_OPTIONS PKG_FATAL_ERRORS
! 9821: PKG_FC PKG_FILELIST_CMD
! 9822: PKG_GECOS PKG_GID
! 9823: PKG_GROUPS PKG_GROUPS_VARS
! 9824: PKG_HOME PKG_INIT_SCRIPTS
! 9825: PKG_JAVA_HOME PKG_JVM
! 9826: PKG_JVMS_ACCEPTED PKG_JVM_DEFAULT
! 9827: PKG_LEGACY_OPTIONS PKG_LIBTOOL
! 9828: PKG_MKSYMLINKS PKG_OPTIONS
! 9829: PKG_OPTIONS_DEPRECATED_WARNINGS PKG_OPTIONS_LEGACY_OPTS
! 9830: PKG_OPTIONS_LEGACY_VARS PKG_OPTIONS_NONEMPTY_SETS
! 9831: PKG_OPTIONS_OPTIONAL_GROUPS PKG_OPTIONS_REQUIRED_GROUPS
! 9832: PKG_OPTIONS_VAR PKG_PHP
! 9833: PKG_PHP_MAJOR_VERS PKG_PHP_VERSION
! 9834: PKG_RCD_SCRIPTS PKG_REFCOUNT_DBDIR
! 9835: PKG_REGISTER_SHELLS PKG_RESUME_TRANSFERS
! 9836: PKG_SHELL PKG_SUGGESTED_OPTIONS
! 9837: PKG_SUPPORTED_OPTIONS PKG_SYSCONFBASE
! 9838: PKG_SYSCONFBASEDIR PKG_SYSCONFDIR
! 9839: PKG_SYSCONFDIR_PERMS PKG_SYSCONFSUBDIR
! 9840: PKG_SYSCONFVAR PKG_TOOLS_BIN
! 9841: PKG_UID PKG_UPDATE_FONTS_DB
! 9842: PKG_USERS PKG_USERS_VARS
! 9843: PKG_VERBOSE PLEASE
! 9844: PLIST PLIST_AWK
! 9845: PLIST_AWK_ENV PLIST_SRC
! 9846: PLIST_SUBST PLIST_TYPE
! 9847: PLIST_VARS POPTOP_USE_MPPE
! 9848: POSSIBLE_GFORTRAN_VERSION POST_FETCH_HOOK
! 9849: PREFER PREFER_NATIVE
! 9850: PREFER_NATIVE_PTHREADS PREFER_PKGSRC
! 9851: PREFIX PREPEND_PATH
! 9852: PRE_ROOT_CMD PRIVILEGED_STAGES
! 9853: PS PTHREAD_AUTO_VARS
! 9854: PTHREAD_CFLAGS PTHREAD_LDFLAGS
! 9855: PTHREAD_LIBS PTHREAD_OPTS
! 9856: PTHREAD_TYPE PVM_SSH
! 9857: PYPKGPREFIX PYTHON_FOR_BUILD_ONLY
! 9858: PYTHON_SELF_CONFLICT PYTHON_VERSION
! 9859: PYTHON_VERSIONED_DEPENDENCIES PYTHON_VERSIONS_ACCEPTED
! 9860: PYTHON_VERSIONS_INCOMPATIBLE PYTHON_VERSION_DEFAULT
! 9861: PYTHON_VERSION_REQD PYVERSSUFFIX
! 9862: QMAILDIR QMAIL_ALIAS_USER
! 9863: QMAIL_DAEMON_USER QMAIL_LOG_USER
! 9864: QMAIL_NOFILES_GROUP QMAIL_PASSWD_USER
! 9865: QMAIL_QMAIL_GROUP QMAIL_QUEUE_DIR
! 9866: QMAIL_QUEUE_EXTRA QMAIL_QUEUE_USER
! 9867: QMAIL_REMOTE_USER QMAIL_ROOT_USER
! 9868: QMAIL_SEND_USER QORE_LATEST_MODULE_API
! 9869: QORE_MODULE_API QORE_MODULE_DIR
! 9870: QORE_USER_MODULE_DIR QORE_VERSION
! 9871: QPOPPER_FAC QPOPPER_SPOOL_DIR
! 9872: QPOPPER_USER RAKE_NAME
! 9873: RASMOL_DEPTH RCD_DIR
! 9874: RCD_ORDER RCD_SCRIPTS
! 9875: RCD_SCRIPTS_DIR RCD_SCRIPTS_EXAMPLEDIR
! 9876: RCD_SCRIPTS_MODE RCD_SCRIPTS_SHELL
! 9877: RCD_SCRIPT_SRC RCD_SUBR
! 9878: RDOC READLINE_DEFAULT
! 9879: READLINE_TYPE REAL_ROOT_GROUP
! 9880: REAL_ROOT_USER RECURSIVE_MAKE
! 9881: RELAY_CTRL_DIR RELRO_SUPPORTED
! 9882: REPLACE_AWK REPLACE_BASH
! 9883: REPLACE_CSH REPLACE_KSH
! 9884: REPLACE_LUA REPLACE_NODEJS
! 9885: REPLACE_OCTAVE REPLACE_PERL
! 9886: REPLACE_PERL6 REPLACE_PHP
! 9887: REPLACE_PYTHON REPLACE_QORE
! 9888: REPLACE_R REPLACE_RUBY
! 9889: REPLACE_RUBY_DIRS REPLACE_RUBY_PAT
! 9890: REPLACE_SH REPLACE_TEXLUA
! 9891: REPLACE_TOOL_PYTHON REPLACE_WISH
! 9892: REQD_DIRS REQD_DIRS_PERMS
! 9893: REQD_FILES REQD_FILES_MODE
! 9894: REQD_FILES_PERMS RESOLV_AUTO_VARS
! 9895: RESOLV_LDFLAGS RESOLV_LIBS
! 9896: RM ROCKSPEC_NAME
! 9897: ROCKSPEC_SPECFILE ROOT_CMD
! 9898: ROOT_GROUP ROOT_USER
! 9899: RPCGEN RPM
! 9900: RPM2PKG_PLIST RPM2PKG_PREFIX
! 9901: RPM2PKG_STAGE RPM2PKG_STRIP
! 9902: RPM2PKG_SUBPREFIX RPMFILES
! 9903: RPMIGNOREPATH RPM_DB_PREFIX
! 9904: RSSH_CVS_PATH RSSH_RDIST_PATH
! 9905: RSSH_RSYNC_PATH RSSH_SCP_PATH
! 9906: RSSH_SFTP_SERVER_PATH RUBY
! 9907: RUBYGEM RUBYGEM_MANPAGES
! 9908: RUBYGEM_NAME RUBYGEM_OPTIONS
! 9909: RUBYGEM_USE_MANPAGES RUBYGEM_VERBOSE
! 9910: RUBY_ABI_VERSION RUBY_ARCH
! 9911: RUBY_ARCHINC RUBY_ARCHLIB
! 9912: RUBY_BASE RUBY_BASERIDIR
! 9913: RUBY_BUILD_DOCUMENT RUBY_DLEXT
! 9914: RUBY_DOC RUBY_DYNAMIC_DIRS
! 9915: RUBY_EG RUBY_ENCODING_ARG
! 9916: RUBY_EXTCONF RUBY_EXTCONF_CHECK
! 9917: RUBY_EXTCONF_DEBUG RUBY_EXTCONF_MAKEFILE
! 9918: RUBY_GEM_ARCH RUBY_GEM_BASE
! 9919: RUBY_INC RUBY_LIB
! 9920: RUBY_LIB_BASE RUBY_NAME
! 9921: RUBY_NOVERSION RUBY_PKGPREFIX
! 9922: RUBY_RAILS RUBY_RAILS61_VERSION
! 9923: RUBY_RAILS70_VERSION RUBY_RAILS71_VERSION
! 9924: RUBY_RAILS_ACCEPTED RUBY_RAILS_DEFAULT
! 9925: RUBY_RAILS_REQD RUBY_RAILS_STRICT_DEP
! 9926: RUBY_RIDIR RUBY_SETUP
! 9927: RUBY_SHLIB RUBY_SHLIBALIAS
! 9928: RUBY_SHLIBVER RUBY_SIMPLE_INSTALL
! 9929: RUBY_SITEARCHLIB RUBY_SITELIB
! 9930: RUBY_SITELIB_BASE RUBY_SITERIDIR
! 9931: RUBY_SLEXT RUBY_SRCDIR
! 9932: RUBY_STATICLIB RUBY_SUFFIX
! 9933: RUBY_SYSRIDIR RUBY_USE_PTHREAD
! 9934: RUBY_VENDORARCHLIB RUBY_VENDORLIB
! 9935: RUBY_VENDORLIB_BASE RUBY_VER
! 9936: RUBY_VERSION RUBY_VERSIONS_ACCEPTED
! 9937: RUBY_VERSIONS_INCOMPATIBLE RUBY_VERSION_DEFAULT
! 9938: RUBY_VERSION_REQD RUBY_VER_DIR
! 9939: RUN RUN_LDCONFIG
! 9940: RUST_TYPE SCO
! 9941: SCREWS_GROUP SCREWS_USER
! 9942: SCRIPTS_ENV SCROLLKEEPER_DATADIR
! 9943: SCROLLKEEPER_REBUILDDB SCROLLKEEPER_UPDATEDB
! 9944: SDIST_PAWD SDL12_TYPE
! 9945: SERIAL_DEVICES SETGIDGAME
! 9946: SETGID_GAMES_PERMS SETUID_ROOT_PERMS
! 9947: SH SHLIB
! 9948: SHORTNAME SIGN_PACKAGES
! 9949: SILC_CLIENT_WITH_PERL SITE_SPECIFIC_PKGS
! 9950: SKIP_DEPENDS SMF_INSTANCES
! 9951: SMF_MANIFEST SMF_METHODS
! 9952: SMF_METHOD_SHELL SMF_METHOD_SRC
! 9953: SMF_NAME SMF_PREFIX
! 9954: SMF_SRCDIR SNIPROXY_GROUP
! 9955: SNIPROXY_USER SOURCE_BUFFSIZE
! 9956: SPECIAL_PERMS SPECIFIC_PKGS
! 9957: SSH_SUID SSP_SUPPORTED
! 9958: SSYNC_PAWD STEP_MSG
! 9959: STRIP STRIP_DBG
! 9960: STRIP_DEBUG STRIP_DEBUG_SUPPORTED
! 9961: STRIP_FILES_SKIP SU
! 9962: SUBDIR SUBST
! 9963: SUBST_CLASSES SUBST_FILES
! 9964: SUBST_FILTER_CMD SUBST_MESSAGE
! 9965: SUBST_NOOP_OK SUBST_SED
! 9966: SUBST_SHOW_DIFF SUBST_SKIP_TEXT_CHECK
! 9967: SUBST_STAGE SUBST_VARS
! 9968: SUNWSPROBASE SUSE_PREFER
! 9969: SU_CMD SVN_EXTRACTDIR
! 9970: SVN_REPO SVN_REPOSITORIES
! 9971: SVN_REVISION SYSCONFBASE
! 9972: TARGET_MACHINE_ARCH TBL
! 9973: TERMCAP_TYPE TERMINFO_DEFAULT
! 9974: TERMINFO_TYPE TEST
! 9975: TEST_DEPENDS TEST_DIRS
! 9976: TEST_ENV TEST_ENV_SHELL
! 9977: TEST_MAKE_CMD TEST_MAKE_FLAGS
! 9978: TEST_TARGET TEXLIVE_IGNORE_PATTERNS
! 9979: TEXLIVE_REV TEXLIVE_UNVERSIONED
! 9980: TEXMFSITE TEX_FORMATS
! 9981: TEX_HYPHEN_DAT TEX_HYPHEN_DEF
! 9982: TEX_TEXMF_DIRS THTTPD_LOG_FACILITY
! 9983: TINYDYN_USER TLSWRAPPER_CHROOT
! 9984: TO TOOLDIR
! 9985: TOOLS_ALIASES TOOLS_ALWAYS_WRAP
! 9986: TOOLS_ARGS TOOLS_BROKEN
! 9987: TOOLS_CMD TOOLS_CMDLINE_SED
! 9988: TOOLS_CREATE TOOLS_CROSS_DESTDIR
! 9989: TOOLS_DIR TOOLS_FAIL
! 9990: TOOLS_GNU_MISSING TOOLS_LDCONFIG
! 9991: TOOLS_NOOP TOOLS_PATH
! 9992: TOOLS_SCRIPT TOOLS_USE_CROSS_COMPILE
! 9993: TOOL_DEPENDS TTF_FONTDIR
! 9994: TTF_FONTS_DIR TYPE
! 9995: UAC_REQD_EXECS UCSPI_SSL_GROUP
! 9996: UCSPI_SSL_USER UNLIMIT_RESOURCES
! 9997: UNPRIVILEGED UNPRIVILEGED_GROUP
! 9998: UNPRIVILEGED_GROUPS UNPRIVILEGED_USER
! 9999: UNWRAP_FILES UNWRAP_PATTERNS
! 10000: UPDATE_GEMSPEC UPDATE_TARGET
! 10001: URI USERGROUP_PHASE
! 10002: USERPPP_GROUP USER_SPECIFIC_PKGS
! 10003: USE_ABI_DEPENDS USE_APR
! 10004: USE_BSD_MAKEFILE USE_BUILTIN
! 10005: USE_CC_FEATURES USE_CROSS_COMPILE
! 10006: USE_CURSES USE_CWRAPPERS
! 10007: USE_CXX_FEATURES USE_DB185
! 10008: USE_FEATURES USE_GAMESGROUP
! 10009: USE_GCC_RUNTIME USE_IMAKE
! 10010: USE_JAVA USE_JAVA2
! 10011: USE_LANGUAGES USE_LIBTOOL
! 10012: USE_NATIVE_GCC USE_NETBSD_REPO
! 10013: USE_PKGSRC_GCC USE_PKGSRC_GCC_RUNTIME
! 10014: USE_PKGTASKS USE_PKG_ADMIN_DIGEST
! 10015: USE_RUBY_EXTCONF USE_RUBY_INSTALL
! 10016: USE_RUBY_SETUP USE_RUBY_SETUP_PKG
! 10017: USE_TOOLS UUCP_GROUP
! 10018: UUCP_USER VARBASE
! 10019: VARNAME VIM_EXTRA_OPTS
! 10020: WARNING_MSG WCALC_CGIDIR
! 10021: WCALC_CGIPATH WCALC_HTMLDIR
! 10022: WCALC_HTMLPATH WDM_MANAGERS
! 10023: WRAPPER_CC WRAPPER_REORDER_CMDS
! 10024: WRKDIR WRKDIR_BASENAME
! 10025: WRKDIR_LOCKTYPE WRKLOG
! 10026: WRKOBJDIR WRKSRC
! 10027: X10_PORT X11
! 10028: X11BASE X11_PKGSRCDIR
! 10029: X11_TYPE X509_CERTIFICATE
! 10030: X509_KEY XAW_TYPE
! 10031: XLOCK_DEFAULT_MODE XMKMF
! 10032: XMKMF_FLAGS XXX
! 10033: XXXX YES
! 10034: ZSH_STATIC __stdc__
! 10035: _vargroups accept
! 10036: acquire-localbase-lock acquire-lock
! 10037: add added
! 10038: administrator alloca
! 10039: alternatives aslr
! 10040: asprintf atlas
! 10041: autoconf automake
! 10042: autoreconf awk
! 10043: bash big-endian
! 10044: bin-install bind
! 10045: binpkg-list blas
! 10046: bootstrap-depends broken
! 10047: broken_on_platform bsd
! 10048: bsd.prog.mk build
! 10049: build-env buildlink-directories
! 10050: buildlink-oss-soundcard-h built-in
! 10051: builtin c
! 10052: c++ ccache
! 10053: cce cdefs
! 10054: ceil changes
! 10055: changes-entry changes-entry-noupdate
! 10056: check check-clean
! 10057: check-files check-files-clean
! 10058: check-hackage check-vulnerable
! 10059: checksum checksum-phase
! 10060: clean clean-depends
! 10061: cleandir commit
! 10062: commit-changes-entry compact
! 10063: compiler conf
! 10064: config.guess config.sub
! 10065: configuration configure
! 10066: configure-env configure-help
! 10067: configure_args connect
! 10068: cos cpe
! 10069: cputime create-usergroup
! 10070: csh ctf
! 10071: cvs debug
! 10072: declaration declare
! 10073: defined depend
! 10074: dependencies depends
! 10075: depends-checksum depends-fetch
! 10076: deps describe
! 10077: destdir disable
! 10078: distclean distinfo
! 10079: dl dlopen
! 10080: do-buildlink do-clean
! 10081: do-configure do-configure-post-hook
! 10082: do-extract do-fetch
! 10083: do-install download
! 10084: emul emul-distinfo
! 10085: emul-fetch emulation
! 10086: emulator enable
! 10087: endian endif
! 10088: enomem ensurepip
! 10089: err errx
! 10090: etc exp
! 10091: extract-rpm fabs
! 10092: feature features
! 10093: fetch fetch-list
! 10094: follows forbids
! 10095: form format
! 10096: fortify fortify_source
! 10097: fossil friend
! 10098: fts fts_close
! 10099: fts_open fts_read
! 10100: fts_set gcc
! 10101: gethostbyaddr gethostbyname
! 10102: gethostbyname2 getopt_long
! 10103: getprogname getservbyname
! 10104: getservbyport getservent
! 10105: gettext git
! 10106: github gitlab
! 10107: glob gnu
! 10108: gnu_configure_strict go
! 10109: go-deps golang
! 10110: guess-license hashbang
! 10111: heimdal help
! 10112: hg imake
! 10113: in-tree increment
! 10114: indirect inet_aton
! 10115: interp interpreter
! 10116: intl ip4
! 10117: ip6 ipv4
! 10118: ipv6 iso
! 10119: kerberos krb
! 10120: krb5 ksh
! 10121: lapack latex
! 10122: libintl_bindtextdomain libintl_gettext
! 10123: libintl_textdomain libnbcompat
! 10124: libs libtool
! 10125: licence license
! 10126: lintl little-endian
! 10127: lock locking
! 10128: lua lvalue
! 10129: make makesum
! 10130: memory mercurial
! 10131: meta meta-package
! 10132: meta_package mit-krb5
! 10133: mk.conf mkl
! 10134: mount move
! 10135: moved mprotect
! 10136: mremap native
! 10137: nb nbcompat
! 10138: netlib network
! 10139: node node.js
! 10140: nodejs obstack
! 10141: obstack_ptr_grow occurs
! 10142: only openblas
! 10143: options options.mk
! 10144: order override
! 10145: override-intltool override-message-intltool
! 10146: package parallel
! 10147: path pax
! 10148: paxctl pbulk-index
! 10149: pc perl
! 10150: perl5 perms
! 10151: php pkg-build-options
! 10152: pkg-config pkg_build_options
! 10153: pkgsrc platform
! 10154: plist post-extract
! 10155: post-fetch post-wrapper
! 10156: pre-build-checks-hook pre-configure-checks-hook
! 10157: pre-extract pre-fetch
! 10158: print-go-deps print-plist
! 10159: print-summary-data privileged-install-hook
! 10160: pypi python
! 10161: r readme-all
! 10162: recursive recv
! 10163: recvfrom regcomp
! 10164: release-localbase-lock release-lock
! 10165: relro remove
! 10166: removed rename
! 10167: renamed reorder
! 10168: replace replace_interpreter
! 10169: reproducible resolv
! 10170: root ruby
! 10171: send sendfile
! 10172: sendto setenv
! 10173: setgid setprogname
! 10174: setuid sh
! 10175: shebang show
! 10176: show-all show-build-defs
! 10177: show-depends show-depends-dirs
! 10178: show-depends-pkgpaths show-depends-recursive
! 10179: show-deps show-distfiles
! 10180: show-downlevel show-subdir-var
! 10181: show-tools show-var
! 10182: show-vars snprintf
! 10183: socket ssp
! 10184: st_mode stage-install
! 10185: strcasestr strict
! 10186: strip strndup
! 10187: strnlen strsep
! 10188: subst substitutions
! 10189: subversion sun
! 10190: sunpro sunwspro
! 10191: svn symlink
! 10192: test test-env
! 10193: tex texlive
! 10194: tmp todo
! 10195: tool tools
! 10196: tools-libtool-m4-override transitive
! 10197: type ulimit
! 10198: undefined undo-replace
! 10199: unlimit unprivileged
! 10200: unprivileged-install-hook unstripped
! 10201: update updated
! 10202: upload upload-distfiles
! 10203: use_tools user
! 10204: utimes vasprintf
! 10205: verbose vsnprintf
! 10206: warn warning
! 10207: warnings warnx
! 10208: wattr_off wattr_on
! 10209: work wrapper
! 10210: wrkdir
1.154 rillig 10211:
1.207 leot 10212: Appendix F. Editing guidelines for the pkgsrc guide
1.1 dsieger 10213:
10214: Table of Contents
10215:
1.207 leot 10216: F.1. Make targets
10217: F.2. Procedure
1.1 dsieger 10218:
10219: This section contains information on editing the pkgsrc guide itself.
10220:
1.207 leot 10221: F.1. Make targets
1.1 dsieger 10222:
10223: The pkgsrc guide's source code is stored in pkgsrc/doc/guide/files, and several
10224: files are created from it:
10225:
10226: * pkgsrc/doc/pkgsrc.txt
10227:
10228: * pkgsrc/doc/pkgsrc.html
10229:
1.174 leot 10230: * https://www.NetBSD.org/docs/pkgsrc/
1.1 dsieger 10231:
1.174 leot 10232: * https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf: The PDF version of the
10233: pkgsrc guide.
1.1 dsieger 10234:
1.174 leot 10235: * https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps: PostScript version of the
1.2 rillig 10236: pkgsrc guide.
1.1 dsieger 10237:
1.207 leot 10238: F.2. Procedure
1.1 dsieger 10239:
10240: The procedure to edit the pkgsrc guide is:
10241:
1.190 bacon 10242: 1. Make sure you have checked out the htdocs repository into a sibling
10243: directory of your pkgsrc directory. You will need the ability to commit
10244: from both pkgsrc and htdocs.
10245:
10246: 2. Make sure you have the packages needed to regenerate the pkgsrc guide (and
1.46 obache 10247: other XML-based NetBSD documentation) installed. These are automatically
10248: installed when you install the meta-pkgs/pkgsrc-guide-tools package.
1.1 dsieger 10249:
1.190 bacon 10250: 3. Run cd doc/guide to get to the right directory. All further steps will take
1.1 dsieger 10251: place here.
10252:
1.190 bacon 10253: 4. Edit the XML file(s) in files/.
1.1 dsieger 10254:
1.190 bacon 10255: 5. Run bmake to check the pkgsrc guide for valid XML and to build the final
1.1 dsieger 10256: output files. If you get any errors at this stage, you can just edit the
10257: files, as there are only symbolic links in the working directory, pointing
10258: to the files in files/.
10259:
1.190 bacon 10260: 6. (cd files && cvs commit)
1.1 dsieger 10261:
1.190 bacon 10262: 7. Run bmake clean && bmake to regenerate the output files with the proper RCS
1.1 dsieger 10263: Ids.
10264:
1.190 bacon 10265: 8. Run bmake regen to install and commit the files in both pkgsrc/doc and
1.1 dsieger 10266: htdocs.
10267:
10268: Note
10269:
10270: If you have added, removed or renamed some chapters, you need to
10271: synchronize them using cvs add or cvs delete in the htdocs directory.
10272:
CVSweb <webmaster@jp.NetBSD.org>