Annotation of htdocs/docs/pkgsrc/pkgsrc.txt, revision 1.151
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.146 jnemeth 15: Copyright 1994-2019 The NetBSD Foundation, Inc
1.1 dsieger 16:
1.146 jnemeth 17: $NetBSD: pkgsrc.xml,v 1.33 2019/01/01 02:50:23 jnemeth Exp $
1.1 dsieger 18:
19: Abstract
20:
21: pkgsrc is a centralized package management system for Unix-like operating
22: systems. This guide provides information for users and developers of pkgsrc. It
23: covers installation of binary and source packages, creation of binary and
24: source packages and a high-level overview about the infrastructure.
25:
26: -------------------------------------------------------------------------------
27:
28: Table of Contents
29:
30: 1. What is pkgsrc?
31:
32: 1.1. Introduction
33:
34: 1.1.1. Why pkgsrc?
35: 1.1.2. Supported platforms
36:
37: 1.2. Overview
38: 1.3. Terminology
39:
40: 1.3.1. Roles involved in pkgsrc
41:
42: 1.4. Typography
43:
44: I. The pkgsrc user's guide
45:
46: 2. Where to get pkgsrc and how to keep it up-to-date
47:
48: 2.1. Getting pkgsrc for the first time
49:
1.52 asau 50: 2.1.1. As tar archive
1.24 wiz 51: 2.1.2. Via anonymous CVS
1.1 dsieger 52:
53: 2.2. Keeping pkgsrc up-to-date
54:
55: 2.2.1. Via tar files
56: 2.2.2. Via CVS
57:
58: 3. Using pkgsrc on systems other than NetBSD
59:
60: 3.1. Binary distribution
61: 3.2. Bootstrapping pkgsrc
62:
63: 4. Using pkgsrc
64:
65: 4.1. Using binary packages
66:
67: 4.1.1. Finding binary packages
68: 4.1.2. Installing binary packages
69: 4.1.3. Deinstalling packages
70: 4.1.4. Getting information about installed packages
71: 4.1.5. Checking for security vulnerabilities in installed packages
72: 4.1.6. Finding if newer versions of your installed packages are in
73: pkgsrc
74: 4.1.7. Other administrative functions
75:
76: 4.2. Building packages from source
77:
78: 4.2.1. Requirements
79: 4.2.2. Fetching distfiles
80: 4.2.3. How to build and install
81:
82: 5. Configuring pkgsrc
83:
84: 5.1. General configuration
85: 5.2. Variables affecting the build process
1.9 rillig 86: 5.3. Variables affecting the installation process
1.4 rillig 87: 5.4. Selecting and configuring the compiler
1.1 dsieger 88:
1.4 rillig 89: 5.4.1. Selecting the compiler
90: 5.4.2. Additional flags to the compiler (CFLAGS)
91: 5.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 92:
1.4 rillig 93: 5.5. Developer/advanced settings
94: 5.6. Selecting Build Options
1.1 dsieger 95:
96: 6. Creating binary packages
97:
98: 6.1. Building a single binary package
99: 6.2. Settings for creation of binary packages
100:
1.6 rillig 101: 7. Creating binary packages for everything in pkgsrc (bulk builds)
102:
1.71 wiz 103: 7.1. Preparations
104: 7.2. Running a pbulk-style bulk build
1.6 rillig 105:
1.71 wiz 106: 7.2.1. Configuration
1.6 rillig 107:
1.71 wiz 108: 7.3. Requirements of a full bulk build
1.66 asau 109: 7.4. Creating a multiple CD-ROM packages collection
1.6 rillig 110:
1.66 asau 111: 7.4.1. Example of cdpack
1.6 rillig 112:
113: 8. Directory layout of the installed files
114:
115: 8.1. File system layout in ${LOCALBASE}
116: 8.2. File system layout in ${VARBASE}
117:
118: 9. Frequently Asked Questions
119:
120: 9.1. Are there any mailing lists for pkg-related discussion?
1.84 wiz 121: 9.2. Utilities for package management (pkgtools)
122: 9.3. How to use pkgsrc as non-root
123: 9.4. How to resume transfers when fetching distfiles?
124: 9.5. How can I install/use modular X.org from pkgsrc?
125: 9.6. How to fetch files from behind a firewall
126: 9.7. How to fetch files from HTTPS sites
127: 9.8. How do I tell make fetch to do passive FTP?
128: 9.9. How to fetch all distfiles at once
129: 9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc"
1.24 wiz 130: mean?
1.84 wiz 131: 9.11. What does "Could not find bsd.own.mk" mean?
132: 9.12. Using 'sudo' with pkgsrc
133: 9.13. How do I change the location of configuration files?
134: 9.14. Automated security checks
135: 9.15. Why do some packages ignore my CFLAGS?
136: 9.16. A package does not build. What shall I do?
137: 9.17. What does "Makefile appears to contain unresolved cvs/rcs/???
1.24 wiz 138: merge conflicts" mean?
1.1 dsieger 139:
140: II. The pkgsrc developer's guide
141:
1.6 rillig 142: 10. Creating a new pkgsrc package from scratch
1.1 dsieger 143:
1.6 rillig 144: 10.1. Common types of packages
1.1 dsieger 145:
1.6 rillig 146: 10.1.1. Perl modules
1.132 wiz 147: 10.1.2. Python modules and programs
1.1 dsieger 148:
1.6 rillig 149: 10.2. Examples
1.1 dsieger 150:
1.6 rillig 151: 10.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 152:
1.6 rillig 153: 11. Package components - files, directories and contents
1.1 dsieger 154:
1.6 rillig 155: 11.1. Makefile
156: 11.2. distinfo
157: 11.3. patches/*
1.1 dsieger 158:
1.6 rillig 159: 11.3.1. Structure of a single patch file
160: 11.3.2. Creating patch files
161: 11.3.3. Sources where the patch files come from
162: 11.3.4. Patching guidelines
163: 11.3.5. Feedback to the author
1.1 dsieger 164:
1.6 rillig 165: 11.4. Other mandatory files
166: 11.5. Optional files
1.1 dsieger 167:
1.6 rillig 168: 11.5.1. Files affecting the binary package
169: 11.5.2. Files affecting the build process
170: 11.5.3. Files affecting nothing at all
1.1 dsieger 171:
1.6 rillig 172: 11.6. work*
173: 11.7. files/*
1.1 dsieger 174:
1.6 rillig 175: 12. Programming in Makefiles
1.1 dsieger 176:
1.6 rillig 177: 12.1. Caveats
178: 12.2. Makefile variables
1.1 dsieger 179:
1.6 rillig 180: 12.2.1. Naming conventions
1.1 dsieger 181:
1.6 rillig 182: 12.3. Code snippets
1.1 dsieger 183:
1.6 rillig 184: 12.3.1. Adding things to a list
1.117 sevan 185: 12.3.2. Echoing a string exactly as-is
1.108 rillig 186: 12.3.3. Passing CFLAGS to GNU configure scripts
187: 12.3.4. Handling possibly empty variables
1.1 dsieger 188:
1.6 rillig 189: 13. PLIST issues
1.1 dsieger 190:
1.6 rillig 191: 13.1. RCS ID
192: 13.2. Semi-automatic PLIST generation
193: 13.3. Tweaking output of make print-PLIST
194: 13.4. Variable substitution in PLIST
195: 13.5. Man page compression
196: 13.6. Changing PLIST source with PLIST_SRC
197: 13.7. Platform-specific and differing PLISTs
1.86 wiz 198: 13.8. Build-specific PLISTs
199: 13.9. Sharing directories between packages
1.1 dsieger 200:
1.6 rillig 201: 14. Buildlink methodology
1.1 dsieger 202:
1.6 rillig 203: 14.1. Converting packages to use buildlink3
204: 14.2. Writing buildlink3.mk files
1.1 dsieger 205:
1.6 rillig 206: 14.2.1. Anatomy of a buildlink3.mk file
1.27 wiz 207: 14.2.2. Updating BUILDLINK_API_DEPENDS.pkg and
208: BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files
1.1 dsieger 209:
1.6 rillig 210: 14.3. Writing builtin.mk files
1.1 dsieger 211:
1.6 rillig 212: 14.3.1. Anatomy of a builtin.mk file
213: 14.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 214:
1.6 rillig 215: 15. The pkginstall framework
1.1 dsieger 216:
1.6 rillig 217: 15.1. Files and directories outside the installation prefix
1.1 dsieger 218:
1.6 rillig 219: 15.1.1. Directory manipulation
220: 15.1.2. File manipulation
1.1 dsieger 221:
1.6 rillig 222: 15.2. Configuration files
1.1 dsieger 223:
1.6 rillig 224: 15.2.1. How PKG_SYSCONFDIR is set
225: 15.2.2. Telling the software where configuration files are
226: 15.2.3. Patching installations
227: 15.2.4. Disabling handling of configuration files
1.1 dsieger 228:
1.6 rillig 229: 15.3. System startup scripts
1.1 dsieger 230:
1.6 rillig 231: 15.3.1. Disabling handling of system startup scripts
1.1 dsieger 232:
1.6 rillig 233: 15.4. System users and groups
234: 15.5. System shells
1.1 dsieger 235:
1.6 rillig 236: 15.5.1. Disabling shell registration
1.1 dsieger 237:
1.6 rillig 238: 15.6. Fonts
1.1 dsieger 239:
1.6 rillig 240: 15.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 241:
1.6 rillig 242: 16. Options handling
1.1 dsieger 243:
1.6 rillig 244: 16.1. Global default options
245: 16.2. Converting packages to use bsd.options.mk
246: 16.3. Option Names
1.7 rillig 247: 16.4. Determining the options of dependencies
1.1 dsieger 248:
1.6 rillig 249: 17. The build process
1.1 dsieger 250:
1.6 rillig 251: 17.1. Introduction
252: 17.2. Program location
253: 17.3. Directories used during the build process
254: 17.4. Running a phase
255: 17.5. The fetch phase
1.1 dsieger 256:
1.6 rillig 257: 17.5.1. What to fetch and where to get it from
258: 17.5.2. How are the files fetched?
1.1 dsieger 259:
1.6 rillig 260: 17.6. The checksum phase
261: 17.7. The extract phase
262: 17.8. The patch phase
263: 17.9. The tools phase
264: 17.10. The wrapper phase
265: 17.11. The configure phase
266: 17.12. The build phase
267: 17.13. The test phase
268: 17.14. The install phase
269: 17.15. The package phase
270: 17.16. Cleaning up
271: 17.17. Other helpful targets
1.1 dsieger 272:
1.6 rillig 273: 18. Tools needed for building or running
1.1 dsieger 274:
1.6 rillig 275: 18.1. Tools for pkgsrc builds
276: 18.2. Tools needed by packages
277: 18.3. Tools provided by platforms
1.1 dsieger 278:
1.6 rillig 279: 19. Making your package work
1.1 dsieger 280:
1.6 rillig 281: 19.1. General operation
1.1 dsieger 282:
1.108 rillig 283: 19.1.1. How to pull in user-settable variables from mk.conf
284: 19.1.2. User interaction
285: 19.1.3. Handling licenses
286: 19.1.4. Restricted packages
287: 19.1.5. Handling dependencies
288: 19.1.6. Handling conflicts with other packages
289: 19.1.7. Packages that cannot or should not be built
290: 19.1.8. Packages which should not be deleted, once installed
291: 19.1.9. Handling packages with security problems
292: 19.1.10. How to handle incrementing versions when fixing an
1.1 dsieger 293: existing package
1.108 rillig 294: 19.1.11. Substituting variable text in the package files (the SUBST
1.1 dsieger 295: framework)
296:
1.108 rillig 297: 19.2. The fetch phase
1.1 dsieger 298:
1.6 rillig 299: 19.2.1. Packages whose distfiles aren't available for plain
1.1 dsieger 300: downloading
1.6 rillig 301: 19.2.2. How to handle modified distfiles with the 'old' name
1.88 tnn 302: 19.2.3. Packages hosted on github.com
1.1 dsieger 303:
1.108 rillig 304: 19.3. The configure phase
1.1 dsieger 305:
1.6 rillig 306: 19.3.1. Shared libraries - libtool
307: 19.3.2. Using libtool on GNU packages that already support libtool
308: 19.3.3. GNU Autoconf/Automake
309:
310: 19.4. Programming languages
311:
312: 19.4.1. C, C++, and Fortran
313: 19.4.2. Java
314: 19.4.3. Packages containing perl scripts
1.41 wiz 315: 19.4.4. Packages containing shell scripts
316: 19.4.5. Other programming languages
1.6 rillig 317:
1.108 rillig 318: 19.5. The build phase
1.6 rillig 319:
320: 19.5.1. Compiling C and C++ code conditionally
321: 19.5.2. How to handle compiler bugs
1.24 wiz 322: 19.5.3. Undefined reference to "..."
1.6 rillig 323: 19.5.4. Running out of memory
324:
1.108 rillig 325: 19.6. The install phase
1.6 rillig 326:
327: 19.6.1. Creating needed directories
328: 19.6.2. Where to install documentation
329: 19.6.3. Installing highscore files
330: 19.6.4. Adding DESTDIR support to packages
331: 19.6.5. Packages with hardcoded paths to other interpreters
332: 19.6.6. Packages installing perl modules
333: 19.6.7. Packages installing info files
334: 19.6.8. Packages installing man pages
1.7 rillig 335: 19.6.9. Packages installing GConf data files
1.18 mishka 336: 19.6.10. Packages installing scrollkeeper/rarian data files
1.6 rillig 337: 19.6.11. Packages installing X11 fonts
338: 19.6.12. Packages installing GTK2 modules
339: 19.6.13. Packages installing SGML or XML data
340: 19.6.14. Packages installing extensions to the MIME database
341: 19.6.15. Packages using intltool
342: 19.6.16. Packages installing startup scripts
343: 19.6.17. Packages installing TeX modules
344: 19.6.18. Packages supporting running binaries in emulation
345: 19.6.19. Packages installing hicolor theme icons
346: 19.6.20. Packages installing desktop files
347:
348: 19.7. Marking packages as having problems
349:
350: 20. Debugging
351: 21. Submitting and Committing
352:
353: 21.1. Submitting binary packages
354: 21.2. Submitting source packages (for non-NetBSD-developers)
355: 21.3. General notes when adding, updating, or removing packages
1.130 wiz 356: 21.4. Commit Messages
357: 21.5. Committing: Adding a package to CVS
358: 21.6. Updating a package to a newer version
359: 21.7. Renaming a package in pkgsrc
360: 21.8. Moving a package in pkgsrc
1.6 rillig 361:
362: 22. Frequently Asked Questions
363: 23. GNOME packaging and porting
364:
365: 23.1. Meta packages
366: 23.2. Packaging a GNOME application
367: 23.3. Updating GNOME to a newer version
368: 23.4. Patching guidelines
1.1 dsieger 369:
370: III. The pkgsrc infrastructure internals
371:
1.6 rillig 372: 24. Design of the pkgsrc infrastructure
1.1 dsieger 373:
1.6 rillig 374: 24.1. The meaning of variable definitions
375: 24.2. Avoiding problems before they arise
376: 24.3. Variable evaluation
1.1 dsieger 377:
1.6 rillig 378: 24.3.1. At load time
379: 24.3.2. At runtime
1.1 dsieger 380:
1.6 rillig 381: 24.4. How can variables be specified?
382: 24.5. Designing interfaces for Makefile fragments
1.1 dsieger 383:
1.6 rillig 384: 24.5.1. Procedures with parameters
385: 24.5.2. Actions taken on behalf of parameters
1.1 dsieger 386:
1.6 rillig 387: 24.6. The order in which files are loaded
1.1 dsieger 388:
1.6 rillig 389: 24.6.1. The order in bsd.prefs.mk
390: 24.6.2. The order in bsd.pkg.mk
1.1 dsieger 391:
1.6 rillig 392: 25. Regression tests
1.1 dsieger 393:
1.108 rillig 394: 25.1. Running the regression tests
395: 25.2. Adding a new regression test
1.1 dsieger 396:
1.108 rillig 397: 25.2.1. Overridable functions
398: 25.2.2. Helper functions
1.1 dsieger 399:
1.6 rillig 400: 26. Porting pkgsrc
1.1 dsieger 401:
1.6 rillig 402: 26.1. Porting pkgsrc to a new operating system
1.1 dsieger 403:
404: A. A simple example package: bison
405:
406: A.1. files
407:
408: A.1.1. Makefile
409: A.1.2. DESCR
410: A.1.3. PLIST
411: A.1.4. Checking a package with pkglint
412:
413: A.2. Steps for building, installing, packaging
414:
415: B. Build logs
416:
417: B.1. Building figlet
418: B.2. Packaging figlet
419:
420: C. Directory layout of the pkgsrc FTP server
421:
1.23 jakllsch 422: C.1. distfiles: The distributed source files
423: C.2. misc: Miscellaneous things
424: C.3. packages: Binary packages
425: C.4. reports: Bulk build reports
1.148 leot 426: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 427:
428: D. Editing guidelines for the pkgsrc guide
429:
430: D.1. Make targets
431: D.2. Procedure
432:
433: List of Tables
434:
435: 1.1. Platforms supported by pkgsrc
1.6 rillig 436: 11.1. Patching examples
437: 23.1. PLIST handling for GNOME packages
1.1 dsieger 438:
439: Chapter 1. What is pkgsrc?
440:
441: Table of Contents
442:
443: 1.1. Introduction
444:
445: 1.1.1. Why pkgsrc?
446: 1.1.2. Supported platforms
447:
448: 1.2. Overview
449: 1.3. Terminology
450:
451: 1.3.1. Roles involved in pkgsrc
452:
453: 1.4. Typography
454:
455: 1.1. Introduction
456:
457: There is a lot of software freely available for Unix-based systems, which is
458: usually available in form of the source code. Before such software can be used,
459: it needs to be configured to the local system, compiled and installed, and this
460: is exactly what The NetBSD Packages Collection (pkgsrc) does. pkgsrc also has
461: some basic commands to handle binary packages, so that not every user has to
462: build the packages for himself, which is a time-costly task.
463:
464: pkgsrc currently contains several thousand packages, including:
465:
1.104 sevan 466: * www/apache24 - The Apache web server
1.1 dsieger 467:
468: * www/firefox - The Firefox web browser
469:
470: * meta-pkgs/gnome - The GNOME Desktop Environment
471:
1.102 ryoon 472: * meta-pkgs/kde4 - The K Desktop Environment
1.1 dsieger 473:
1.108 rillig 474: ? just to name a few.
1.1 dsieger 475:
476: pkgsrc has built-in support for handling varying dependencies, such as pthreads
477: and X11, and extended features such as IPv6 support on a range of platforms.
478:
479: 1.1.1. Why pkgsrc?
480:
481: pkgsrc provides the following key features:
482:
483: * Easy building of software from source as well as the creation and
484: installation of binary packages. The source and latest patches are
485: retrieved from a master or mirror download site, checksum verified, then
486: built on your system. Support for binary-only distributions is available
487: for both native platforms and NetBSD emulated platforms.
488:
489: * All packages are installed in a consistent directory tree, including
490: binaries, libraries, man pages and other documentation.
491:
1.104 sevan 492: * Tracking of package dependencies automatically, including when performing
493: updates, to ensure required packages are installed. The configuration files
494: of various packages are handled automatically during updates, so local
495: changes are preserved.
1.1 dsieger 496:
497: * Like NetBSD, pkgsrc is designed with portability in mind and consists of
498: highly portable code. This allows the greatest speed of development when
1.26 spz 499: porting to a new platform. This portability also ensures that pkgsrc is
1.1 dsieger 500: consistent across all platforms.
501:
502: * The installation prefix, acceptable software licenses, international
503: encryption requirements and build-time options for a large number of
504: packages are all set in a simple, central configuration file.
505:
506: * The entire source (not including the distribution files) is freely
507: available under a BSD license, so you may extend and adapt pkgsrc to your
508: needs. Support for local packages and patches is available right out of the
509: box, so you can configure it specifically for your environment.
510:
511: The following principles are basic to pkgsrc:
512:
513: * "It should only work if it's right." ? That means, if a package contains
514: bugs, it's better to find them and to complain about them rather than to
515: just install the package and hope that it works. There are numerous checks
516: in pkgsrc that try to find such bugs: Static analysis tools (pkgtools/
517: pkglint), build-time checks (portability of shell scripts), and
518: post-installation checks (installed files, references to shared libraries,
519: script interpreters).
520:
521: * "If it works, it should work everywhere" ? Like NetBSD has been ported to
522: many hardware architectures, pkgsrc has been ported to many operating
523: systems. Care is taken that packages behave the same on all platforms.
524:
525: 1.1.2. Supported platforms
526:
527: pkgsrc consists of both a source distribution and a binary distribution for
528: these operating systems. After retrieving the required source or binaries, you
529: can be up and running with pkgsrc in just minutes!
530:
531: pkgsrc was derived from FreeBSD's ports system, and initially developed for
532: NetBSD only. Since then, pkgsrc has grown a lot, and now supports the following
533: platforms:
534:
535: Table 1.1. Platforms supported by pkgsrc
536:
1.92 sevan 537: +-----------------------------------------------------------------------------+
538: | Platform | Date Support | Notes |
539: | | Added | |
540: |--------------------------------------+---------------+----------------------|
541: |NetBSD | Aug 1997 | |
542: |--------------------------------------+---------------+----------------------|
543: |Solaris | Mar 1999 |README.Solaris |
544: |--------------------------------------+---------------+----------------------|
545: |Linux | Jun 1999 |README.Linux |
546: |--------------------------------------+---------------+----------------------|
1.118 sevan 547: |Darwin / Mac OS X / OS X / macOS | Oct 2001 |README.MacOSX |
1.92 sevan 548: |--------------------------------------+---------------+----------------------|
549: |FreeBSD | Nov 2002 |README.FreeBSD |
550: |--------------------------------------+---------------+----------------------|
551: |OpenBSD | Nov 2002 |README.OpenBSD |
552: |--------------------------------------+---------------+----------------------|
553: |IRIX | Dec 2002 |README.IRIX |
554: | | |README.IRIX5.3 |
555: |--------------------------------------+---------------+----------------------|
556: |BSD/OS | Dec 2003 | |
557: |--------------------------------------+---------------+----------------------|
558: |AIX | Dec 2003 |README.AIX |
559: |--------------------------------------+---------------+----------------------|
560: |Interix (Microsoft Windows Services | Mar 2004 |README.Interix |
561: |for Unix) | | |
562: |--------------------------------------+---------------+----------------------|
563: |DragonFlyBSD | Oct 2004 | |
564: |--------------------------------------+---------------+----------------------|
565: |OSF/1 | Nov 2004 |README.OSF1 |
566: |--------------------------------------+---------------+----------------------|
567: |HP-UX | Apr 2007 |README.HPUX |
568: |--------------------------------------+---------------+----------------------|
569: |Haiku | Sep 2010 |README.Haiku |
570: |--------------------------------------+---------------+----------------------|
571: |MirBSD | Jan 2011 | |
572: |--------------------------------------+---------------+----------------------|
573: |Minix3 | Nov 2011 |README.Minix3 |
574: |--------------------------------------+---------------+----------------------|
575: |Cygwin | Mar 2013 |README.Cygwin |
576: |--------------------------------------+---------------+----------------------|
577: |GNU/kFreeBSD | Jul 2013 |README.GNUkFreeBSD |
1.104 sevan 578: |--------------------------------------+---------------+----------------------|
579: |Bitrig | Jun 2014 |README.Bitrig |
1.92 sevan 580: +-----------------------------------------------------------------------------+
1.1 dsieger 581:
582:
583: 1.2. Overview
584:
585: This document is divided into three parts. The first, The pkgsrc user's guide,
586: describes how one can use one of the packages in the Package Collection, either
587: by installing a precompiled binary package, or by building one's own copy using
588: the NetBSD package system. The second part, The pkgsrc developer's guide,
589: explains how to prepare a package so it can be easily built by other NetBSD
590: users without knowing about the package's building details. The third part, The
591: pkgsrc infrastructure internals is intended for those who want to understand
592: how pkgsrc is implemented.
593:
594: This document is available in various formats: HTML, PDF, PS, TXT.
595:
596: 1.3. Terminology
597:
598: There has been a lot of talk about "ports", "packages", etc. so far. Here is a
599: description of all the terminology used within this document.
600:
601: Package
602:
603: A set of files and building instructions that describe what's necessary to
604: build a certain piece of software using pkgsrc. Packages are traditionally
1.123 wiz 605: stored under /usr/pkgsrc, but may be stored in any location, referred to as
606: PKGSRCDIR.
1.1 dsieger 607:
608: The NetBSD package system
609:
610: This is the former name of "pkgsrc". It is part of the NetBSD operating
611: system and can be bootstrapped to run on non-NetBSD operating systems as
612: well. It handles building (compiling), installing, and removing of
613: packages.
614:
615: Distfile
616:
617: This term describes the file or files that are provided by the author of
618: the piece of software to distribute his work. All the changes necessary to
619: build on NetBSD are reflected in the corresponding package. Usually the
620: distfile is in the form of a compressed tar-archive, but other types are
621: possible, too. Distfiles are usually stored below /usr/pkgsrc/distfiles.
622:
623: Port
624:
625: This is the term used by FreeBSD and OpenBSD people for what we call a
626: package. In NetBSD terminology, "port" refers to a different architecture.
627:
628: Precompiled/binary package
629:
630: A set of binaries built with pkgsrc from a distfile and stuffed together in
631: a single .tgz file so it can be installed on machines of the same machine
632: architecture without the need to recompile. Packages are usually generated
633: in /usr/pkgsrc/packages; there is also an archive on ftp.NetBSD.org.
634:
635: Sometimes, this is referred to by the term "package" too, especially in the
636: context of precompiled packages.
637:
638: Program
639:
640: The piece of software to be installed which will be constructed from all
641: the files in the distfile by the actions defined in the corresponding
642: package.
643:
644: 1.3.1. Roles involved in pkgsrc
645:
646: pkgsrc users
647:
648: The pkgsrc users are people who use the packages provided by pkgsrc.
649: Typically they are system administrators. The people using the software
650: that is inside the packages (maybe called "end users") are not covered by
651: the pkgsrc guide.
652:
653: There are two kinds of pkgsrc users: Some only want to install pre-built
654: binary packages. Others build the pkgsrc packages from source, either for
655: installing them directly or for building binary packages themselves. For
656: pkgsrc users Part I, "The pkgsrc user's guide" should provide all necessary
657: documentation.
658:
659: package maintainers
660:
661: A package maintainer creates packages as described in Part II, "The pkgsrc
662: developer's guide".
663:
664: infrastructure developers
665:
666: These people are involved in all those files that live in the mk/ directory
667: and below. Only these people should need to read through Part III, "The
668: pkgsrc infrastructure internals", though others might be curious, too.
669:
670: 1.4. Typography
671:
672: When giving examples for commands, shell prompts are used to show if the
673: command should/can be issued as root, or if "normal" user privileges are
1.115 sevan 674: sufficient. We use a # for root's shell prompt, a % for users' shell prompt,
675: assuming they use the C-shell or tcsh and a $ for bourne shell and derivatives.
1.1 dsieger 676:
677: Part I. The pkgsrc user's guide
678:
679: Table of Contents
680:
681: 2. Where to get pkgsrc and how to keep it up-to-date
682:
683: 2.1. Getting pkgsrc for the first time
684:
1.52 asau 685: 2.1.1. As tar archive
1.24 wiz 686: 2.1.2. Via anonymous CVS
1.1 dsieger 687:
688: 2.2. Keeping pkgsrc up-to-date
689:
690: 2.2.1. Via tar files
691: 2.2.2. Via CVS
692:
693: 3. Using pkgsrc on systems other than NetBSD
694:
695: 3.1. Binary distribution
696: 3.2. Bootstrapping pkgsrc
697:
698: 4. Using pkgsrc
699:
700: 4.1. Using binary packages
701:
702: 4.1.1. Finding binary packages
703: 4.1.2. Installing binary packages
704: 4.1.3. Deinstalling packages
705: 4.1.4. Getting information about installed packages
706: 4.1.5. Checking for security vulnerabilities in installed packages
707: 4.1.6. Finding if newer versions of your installed packages are in
708: pkgsrc
709: 4.1.7. Other administrative functions
710:
711: 4.2. Building packages from source
712:
713: 4.2.1. Requirements
714: 4.2.2. Fetching distfiles
715: 4.2.3. How to build and install
716:
717: 5. Configuring pkgsrc
718:
719: 5.1. General configuration
720: 5.2. Variables affecting the build process
1.9 rillig 721: 5.3. Variables affecting the installation process
1.4 rillig 722: 5.4. Selecting and configuring the compiler
1.1 dsieger 723:
1.4 rillig 724: 5.4.1. Selecting the compiler
725: 5.4.2. Additional flags to the compiler (CFLAGS)
726: 5.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 727:
1.4 rillig 728: 5.5. Developer/advanced settings
729: 5.6. Selecting Build Options
1.1 dsieger 730:
731: 6. Creating binary packages
732:
733: 6.1. Building a single binary package
734: 6.2. Settings for creation of binary packages
735:
1.6 rillig 736: 7. Creating binary packages for everything in pkgsrc (bulk builds)
737:
1.71 wiz 738: 7.1. Preparations
739: 7.2. Running a pbulk-style bulk build
1.6 rillig 740:
1.71 wiz 741: 7.2.1. Configuration
1.6 rillig 742:
1.71 wiz 743: 7.3. Requirements of a full bulk build
1.66 asau 744: 7.4. Creating a multiple CD-ROM packages collection
1.6 rillig 745:
1.66 asau 746: 7.4.1. Example of cdpack
1.6 rillig 747:
748: 8. Directory layout of the installed files
749:
750: 8.1. File system layout in ${LOCALBASE}
751: 8.2. File system layout in ${VARBASE}
752:
753: 9. Frequently Asked Questions
754:
755: 9.1. Are there any mailing lists for pkg-related discussion?
1.84 wiz 756: 9.2. Utilities for package management (pkgtools)
757: 9.3. How to use pkgsrc as non-root
758: 9.4. How to resume transfers when fetching distfiles?
759: 9.5. How can I install/use modular X.org from pkgsrc?
760: 9.6. How to fetch files from behind a firewall
761: 9.7. How to fetch files from HTTPS sites
762: 9.8. How do I tell make fetch to do passive FTP?
763: 9.9. How to fetch all distfiles at once
764: 9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
765: 9.11. What does "Could not find bsd.own.mk" mean?
766: 9.12. Using 'sudo' with pkgsrc
767: 9.13. How do I change the location of configuration files?
768: 9.14. Automated security checks
769: 9.15. Why do some packages ignore my CFLAGS?
770: 9.16. A package does not build. What shall I do?
771: 9.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.24 wiz 772: conflicts" mean?
1.1 dsieger 773:
774: Chapter 2. Where to get pkgsrc and how to keep it up-to-date
775:
776: Table of Contents
777:
778: 2.1. Getting pkgsrc for the first time
779:
1.52 asau 780: 2.1.1. As tar archive
1.24 wiz 781: 2.1.2. Via anonymous CVS
1.1 dsieger 782:
783: 2.2. Keeping pkgsrc up-to-date
784:
785: 2.2.1. Via tar files
786: 2.2.2. Via CVS
787:
788: Before you download and extract the files, you need to decide where you want to
789: extract them. When using pkgsrc as root user, pkgsrc is usually installed in /
790: usr/pkgsrc. You are though free to install the sources and binary packages
791: wherever you want in your filesystem, provided that the pathname does not
792: contain white-space or other characters that are interpreted specially by the
793: shell and some other programs. A safe bet is to use only letters, digits,
794: underscores and dashes.
795:
796: 2.1. Getting pkgsrc for the first time
797:
1.25 wiz 798: Before you download any pkgsrc files, you should decide whether you want the
1.1 dsieger 799: current branch or the stable branch. The latter is forked on a quarterly basis
800: from the current branch and only gets modified for security updates. The names
801: of the stable branches are built from the year and the quarter, for example
1.145 leot 802: 2018Q4.
1.1 dsieger 803:
804: The second step is to decide how you want to download pkgsrc. You can get it as
1.24 wiz 805: a tar file or via CVS. Both ways are described here.
1.1 dsieger 806:
1.52 asau 807: Note that tar archive contains CVS working copy. Thus you can switch to using
808: CVS at any later time.
1.1 dsieger 809:
1.52 asau 810: 2.1.1. As tar archive
811:
1.151 ! sevan 812: The primary download location for all pkgsrc files is https://cdn.NetBSD.org/
! 813: pub/pkgsrc/ or ftp://ftp.NetBSD.org/pub/pkgsrc/ (it points to the same
! 814: location). There are a number of subdirectories for different purposes, which
! 815: are described in detail in Appendix C, Directory layout of the pkgsrc FTP
! 816: server.
1.1 dsieger 817:
1.52 asau 818: The tar archive for the current branch is in the directory current and is
1.118 sevan 819: called pkgsrc.tar.gz. It is autogenerated weekly.
1.52 asau 820:
821: To save download time we provide bzip2- and xz-compressed archives which are
822: published at pkgsrc.tar.bz2 and pkgsrc.tar.xz respectively.
823:
824: You can fetch the same files using FTP.
1.1 dsieger 825:
1.145 leot 826: The tar file for the stable branch 2018Q4 is in the directory pkgsrc-2018Q4 and
1.59 jnemeth 827: is also called pkgsrc.tar.gz.
1.1 dsieger 828:
1.136 leot 829: To download the latest pkgsrc stable tarball, run:
1.12 weinem 830:
1.145 leot 831: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2018Q4/pkgsrc.tar.gz
1.12 weinem 832:
1.78 snj 833: If you prefer, you can also fetch it using "wget", "curl", or your web browser.
1.52 asau 834:
1.12 weinem 835: Then, extract it with:
836:
1.78 snj 837: $ tar -xzf pkgsrc.tar.gz -C /usr
1.12 weinem 838:
839: This will create the directory pkgsrc/ in /usr/ and all the package source will
840: be stored under /usr/pkgsrc/.
841:
842: To download pkgsrc-current, run:
843:
844: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz
1.1 dsieger 845:
1.24 wiz 846: 2.1.2. Via anonymous CVS
1.1 dsieger 847:
1.24 wiz 848: To fetch a specific pkgsrc stable branch, run:
1.1 dsieger 849:
1.145 leot 850: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2018Q4 -P pkgsrc
1.13 weinem 851:
1.24 wiz 852: This will create the directory pkgsrc/ in your /usr/ directory and all the
853: package source will be stored under /usr/pkgsrc/.
854:
855: To fetch the pkgsrc current branch, run:
1.1 dsieger 856:
1.40 wiz 857: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 858:
1.30 dholland 859: Refer to the list of available mirrors to choose a faster CVS mirror, if
860: needed.
1.1 dsieger 861:
1.24 wiz 862: If you get error messages from rsh, you need to set CVS_RSH variable. E.g.:
1.1 dsieger 863:
1.40 wiz 864: $ cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 865:
1.24 wiz 866: Refer to documentation on your command shell how to set CVS_RSH=ssh
867: permanently. For Bourne shells, you can set it in your .profile or better
868: globally in /etc/profile:
869:
870: # set CVS remote shell command
871: CVS_RSH=ssh
872: export CVS_RSH
1.12 weinem 873:
1.13 weinem 874: By default, CVS doesn't do things like most people would expect it to do. But
875: there is a way to convince CVS, by creating a file called .cvsrc in your home
1.12 weinem 876: directory and saving the following lines to it. This file will save you lots of
877: headache and some bug reports, so we strongly recommend it. You can find an
878: explanation of this file in the CVS documentation.
1.2 rillig 879:
880: # recommended CVS configuration file from the pkgsrc guide
1.40 wiz 881: cvs -q -z2
1.2 rillig 882: checkout -P
1.4 rillig 883: update -dP
884: diff -upN
1.2 rillig 885: rdiff -u
1.24 wiz 886: release -d
1.1 dsieger 887:
888: 2.2. Keeping pkgsrc up-to-date
889:
890: The preferred way to keep pkgsrc up-to-date is via CVS (which also works if you
891: have first installed it via a tar file). It saves bandwidth and hard disk
892: activity, compared to downloading the tar file again.
893:
894: 2.2.1. Via tar files
895:
896: Warning
897:
898: When updating from a tar file, you first need to completely remove the old
899: pkgsrc directory. Otherwise those files that have been removed from pkgsrc in
900: the mean time will not be removed on your local disk, resulting in
901: inconsistencies. When removing the old files, any changes that you have done to
902: the pkgsrc files will be lost after updating. Therefore updating via CVS is
903: strongly recommended.
904:
905: Note that by default the distfiles and the binary packages are saved in the
906: pkgsrc tree, so don't forget to rescue them before updating. You can also
1.78 snj 907: configure pkgsrc to store distfiles and packages in directories outside the
908: pkgsrc tree by setting the DISTDIR and PACKAGES variables. See Chapter 5,
909: Configuring pkgsrc for the details.
1.1 dsieger 910:
911: To update pkgsrc from a tar file, download the tar file as explained above.
912: Then, make sure that you have not made any changes to the files in the pkgsrc
913: directory. Remove the pkgsrc directory and extract the new tar file. Done.
914:
915: 2.2.2. Via CVS
916:
1.26 spz 917: To update pkgsrc via CVS, change to the pkgsrc directory and run cvs:
1.12 weinem 918:
1.26 spz 919: $ cd /usr/pkgsrc && cvs update -dP
920:
921: If you get error messages from rsh, you need to set CVS_RSH variable as
922: described above. E.g.:
923:
924: $ cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP
1.1 dsieger 925:
926: 2.2.2.1. Switching between different pkgsrc branches
927:
928: When updating pkgsrc, the CVS program keeps track of the branch you selected.
929: But if you, for whatever reason, want to switch from the stable branch to the
930: current one, you can do it by adding the option "-A" after the "update"
1.25 wiz 931: keyword. To switch from the current branch back to the stable branch, add the "
1.145 leot 932: -rpkgsrc-2018Q4" option.
1.1 dsieger 933:
934: 2.2.2.2. What happens to my changes when updating?
935:
936: When you update pkgsrc, the CVS program will only touch those files that are
937: registered in the CVS repository. That means that any packages that you created
938: on your own will stay unmodified. If you change files that are managed by CVS,
939: later updates will try to merge your changes with those that have been done by
940: others. See the CVS manual, chapter "update" for details.
941:
942: Chapter 3. Using pkgsrc on systems other than NetBSD
943:
944: Table of Contents
945:
946: 3.1. Binary distribution
947: 3.2. Bootstrapping pkgsrc
948:
949: 3.1. Binary distribution
950:
1.9 rillig 951: See Section 4.1, "Using binary packages".
1.1 dsieger 952:
953: 3.2. Bootstrapping pkgsrc
954:
1.44 asau 955: pkgsrc can be bootstrapped for use in two different modes: privileged and
956: unprivileged one. In unprivileged mode in contrast to privileged one all
1.45 asau 957: programs are installed under one particular user and cannot utilise privileged
1.44 asau 958: operations (packages don't create special users and all special file
959: permissions like setuid are ignored).
960:
1.1 dsieger 961: Installing the bootstrap kit from source should be as simple as:
962:
1.60 asau 963: # env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 964: # cd pkgsrc/bootstrap
965: # ./bootstrap
966:
967:
1.44 asau 968: To bootstrap in unprivileged mode pass "--unprivileged" flag to bootstrap
969:
970: By default, in privileged mode pkgsrc uses /usr/pkg for prefix where programs
1.118 sevan 971: will be installed in, and /usr/pkg/pkgdb for the package database directory
972: where pkgsrc will do its internal bookkeeping, /var is used as varbase, where
1.44 asau 973: packages install their persistent data. In unprivileged mode pkgsrc uses ~/pkg
1.118 sevan 974: for prefix, ~/pkg/pkgdb for the package database, and ~/pkg/var for varbase.
1.44 asau 975:
976: You can change default layout using command-line arguments. Run "./bootstrap
977: --help" to get details.
1.1 dsieger 978:
979: Note
980:
981: The bootstrap installs a bmake tool. Use this bmake when building via pkgsrc.
982: For examples in this guide, use bmake instead of "make".
983:
1.44 asau 984: Note
985:
986: It is possible to bootstrap multiple instances of pkgsrc using non-intersecting
987: directories. Use bmake corresponding to the installation you're working with to
988: build and install packages.
989:
1.1 dsieger 990: Chapter 4. Using pkgsrc
991:
992: Table of Contents
993:
994: 4.1. Using binary packages
995:
996: 4.1.1. Finding binary packages
997: 4.1.2. Installing binary packages
998: 4.1.3. Deinstalling packages
999: 4.1.4. Getting information about installed packages
1000: 4.1.5. Checking for security vulnerabilities in installed packages
1001: 4.1.6. Finding if newer versions of your installed packages are in pkgsrc
1002: 4.1.7. Other administrative functions
1003:
1004: 4.2. Building packages from source
1005:
1006: 4.2.1. Requirements
1007: 4.2.2. Fetching distfiles
1008: 4.2.3. How to build and install
1009:
1010: Basically, there are two ways of using pkgsrc. The first is to only install the
1011: package tools and to use binary packages that someone else has prepared. This
1012: is the "pkg" in pkgsrc. The second way is to install the "src" of pkgsrc, too.
1013: Then you are able to build your own packages, and you can still use binary
1014: packages from someone else.
1015:
1016: 4.1. Using binary packages
1017:
1.151 ! sevan 1018: On the cdn.NetBSD.org site and mirrors, there are collections of binary
1.9 rillig 1019: packages, ready to be installed. These binary packages have been built using
1020: the default settings for the directories, that is:
1021:
1022: * /usr/pkg for LOCALBASE, where most of the files are installed,
1023:
1024: * /usr/pkg/etc for configuration files,
1025:
1026: * /var for VARBASE, where those files are installed that may change after
1027: installation.
1028:
1029: If you cannot use these directories for whatever reasons (maybe because you're
1030: not root), you cannot use these binary packages, but have to build the packages
1031: yourself, which is explained in Section 3.2, "Bootstrapping pkgsrc".
1.1 dsieger 1032:
1033: 4.1.1. Finding binary packages
1034:
1.5 weinem 1035: To install binary packages, you first need to know from where to get them. The
1036: first place where you should look is on the main pkgsrc FTP server in the
1037: directory /pub/pkgsrc/packages.
1038:
1039: This directory contains binary packages for multiple platforms. First, select
1040: your operating system. (Ignore the directories with version numbers attached to
1041: it, they just exist for legacy reasons.) Then, select your hardware
1042: architecture, and in the third step, the OS version and the "version" of
1.9 rillig 1043: pkgsrc.
1044:
1045: In this directory, you often find a file called bootstrap.tar.gz which contains
1046: the package management tools. If the file is missing, it is likely that your
1047: operating system already provides those tools. Download the file and extract it
1048: in the / directory. It will create the directories /usr/pkg (containing the
1.118 sevan 1049: tools for managing binary packages and the database of installed packages).
1.1 dsieger 1050:
1051: 4.1.2. Installing binary packages
1052:
1.85 wiz 1053: In the directory from the last section, there is a subdirectory called All/,
1.9 rillig 1054: which contains all the binary packages that are available for the platform,
1055: excluding those that may not be distributed via FTP or CDROM (depending on
1.24 wiz 1056: which medium you are using).
1.9 rillig 1057:
1058: To install packages directly from an FTP or HTTP server, run the following
1059: commands in a Bourne-compatible shell (be sure to su to root first):
1060:
1061: # PATH="/usr/pkg/sbin:$PATH"
1.151 ! sevan 1062: # PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages/OPSYS/ARCH/VERSIONS/All/"
1.9 rillig 1063: # export PATH PKG_PATH
1064:
1065: Instead of URLs, you can also use local paths, for example if you are
1066: installing from a set of CDROMs, DVDs or an NFS-mounted repository. If you want
1067: to install packages from multiple sources, you can separate them by a semicolon
1068: in PKG_PATH.
1069:
1070: After these preparations, installing a package is very easy:
1071:
1.118 sevan 1072: # pkg_add libreoffice
1073: # pkg_add ap24-php71-*
1.1 dsieger 1074:
1075: Note that any prerequisite packages needed to run the package in question will
1076: be installed, too, assuming they are present where you install from.
1077:
1.25 wiz 1078: Adding packages might install vulnerable packages. Thus you should run
1.24 wiz 1079: pkg_admin audit regularly, especially after installing new packages, and verify
1080: that the vulnerabilities are acceptable for your configuration.
1.1 dsieger 1081:
1082: After you've installed packages, be sure to have /usr/pkg/bin and /usr/pkg/sbin
1083: in your PATH so you can actually start the just installed program.
1084:
1085: 4.1.3. Deinstalling packages
1086:
1087: To deinstall a package, it does not matter whether it was installed from source
1088: code or from a binary package. The pkg_delete command does not know it anyway.
1089: To delete a package, you can just run pkg_delete package-name. The package name
1090: can be given with or without version number. Wildcards can also be used to
1091: deinstall a set of packages, for example *emacs*. Be sure to include them in
1092: quotes, so that the shell does not expand them before pkg_delete sees them.
1093:
1094: The -r option is very powerful: it removes all the packages that require the
1095: package in question and then removes the package itself. For example:
1096:
1097: # pkg_delete -r jpeg
1098:
1099:
1100: will remove jpeg and all the packages that used it; this allows upgrading the
1101: jpeg package.
1102:
1103: 4.1.4. Getting information about installed packages
1104:
1105: The pkg_info shows information about installed packages or binary package
1106: files.
1107:
1108: 4.1.5. Checking for security vulnerabilities in installed packages
1109:
1110: The NetBSD Security-Officer and Packages Groups maintain a list of known
1111: security vulnerabilities to packages which are (or have been) included in
1.151 ! sevan 1112: pkgsrc. The list is available from the NetBSD FTP site at http://ftp.NetBSD.org
! 1113: /pub/pkgsrc/distfiles/vulnerabilities.
1.1 dsieger 1114:
1.23 jakllsch 1115: Through pkg_admin fetch-pkg-vulnerabilities, this list can be downloaded
1116: automatically, and a security audit of all packages installed on a system can
1117: take place.
1118:
1119: There are two components to auditing. The first step, pkg_admin
1120: fetch-pkg-vulnerabilities, is for downloading the list of vulnerabilities from
1121: the NetBSD FTP site. The second step, pkg_admin audit, checks to see if any of
1122: your installed packages are vulnerable. If a package is vulnerable, you will
1123: see output similar to the following:
1.1 dsieger 1124:
1125: Package samba-2.0.9 has a local-root-shell vulnerability, see
1126: http://www.samba.org/samba/whatsnew/macroexploit.html
1127:
1.23 jakllsch 1128: You may wish to have the vulnerabilities file downloaded daily so that it
1129: remains current. This may be done by adding an appropriate entry to the root
1130: users crontab(5) entry. For example the entry
1131:
1.121 sevan 1132: # Download vulnerabilities file
1.118 sevan 1133: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1134: # Audit the installed packages and email results to root
1135: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1136: root >/dev/null 2>&1
1.118 sevan 1137:
1138:
1139: will update the vulnerability list every day at 3AM, followed by an audit at
1140: 3:09AM. The result of the audit are then emailed to root. On NetBSD this may be
1141: accomplished instead by adding the following line to /etc/daily.conf:
1142:
1143: fetch_pkg_vulnerabilities=YES
1144:
1.23 jakllsch 1145:
1.118 sevan 1146: to fetch the vulnerability list from the daily security script. The system is
1147: set to audit the packages by default but can be set explicitly, if desired (not
1.123 wiz 1148: required), by adding the following line to /etc/security.conf:
1.23 jakllsch 1149:
1.118 sevan 1150: check_pkg_vulnerabilities=YES
1.23 jakllsch 1151:
1152:
1.118 sevan 1153: see daily.conf(5) and security.conf(5) for more details.
1.1 dsieger 1154:
1155: 4.1.6. Finding if newer versions of your installed packages are in pkgsrc
1156:
1.12 weinem 1157: Install pkgtools/lintpkgsrc and run lintpkgsrc with the "-i" argument to check
1158: if your packages are up-to-date, e.g.
1.1 dsieger 1159:
1160: % lintpkgsrc -i
1161: ...
1162: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1163:
1164:
1165: You can then use make update to update the package on your system and rebuild
1166: any dependencies.
1167:
1168: 4.1.7. Other administrative functions
1169:
1170: The pkg_admin executes various administrative functions on the package system.
1171:
1172: 4.2. Building packages from source
1173:
1174: After obtaining pkgsrc, the pkgsrc directory now contains a set of packages,
1.25 wiz 1175: organized into categories. You can browse the online index of packages, or run
1.1 dsieger 1176: make readme from the pkgsrc directory to build local README.html files for all
1177: packages, viewable with any web browser such as www/lynx or www/firefox.
1178:
1179: The default prefix for installed packages is /usr/pkg. If you wish to change
1180: this, you should do so by setting LOCALBASE in mk.conf. You should not try to
1181: use multiple different LOCALBASE definitions on the same system (inside a
1182: chroot is an exception).
1183:
1184: The rest of this chapter assumes that the package is already in pkgsrc. If it
1185: is not, see Part II, "The pkgsrc developer's guide" for instructions how to
1186: create your own packages.
1187:
1188: 4.2.1. Requirements
1189:
1190: To build packages from source, you need a working C compiler. On NetBSD, you
1191: need to install the "comp" and the "text" distribution sets. If you want to
1192: build X11-related packages, the "xbase" and "xcomp" distribution sets are
1193: required, too.
1194:
1195: 4.2.2. Fetching distfiles
1196:
1197: The first step for building a package is downloading the distfiles (i.e. the
1198: unmodified source). If they have not yet been downloaded, pkgsrc will fetch
1199: them automatically.
1200:
1201: If you have all files that you need in the distfiles directory, you don't need
1202: to connect. If the distfiles are on CD-ROM, you can mount the CD-ROM on /cdrom
1203: and add:
1204:
1205: DISTDIR=/cdrom/pkgsrc/distfiles
1206:
1207: to your mk.conf.
1208:
1209: By default a list of distribution sites will be randomly intermixed to prevent
1210: huge load on servers which holding popular packages (for example,
1211: SourceForge.net mirrors). Thus, every time when you need to fetch yet another
1212: distfile all the mirrors will be tried in new (random) order. You can turn this
1213: feature off by setting MASTER_SORT_RANDOM=NO (for PKG_DEVELOPERs it's already
1214: disabled).
1215:
1216: You can overwrite some of the major distribution sites to fit to sites that are
1217: close to your own. By setting one or two variables you can modify the order in
1218: which the master sites are accessed. MASTER_SORT contains a whitespace
1219: delimited list of domain suffixes. MASTER_SORT_REGEX is even more flexible, it
1220: contains a whitespace delimited list of regular expressions. It has higher
1221: priority than MASTER_SORT. Have a look at pkgsrc/mk/defaults/mk.conf to find
1222: some examples. This may save some of your bandwidth and time.
1223:
1224: You can change these settings either in your shell's environment, or, if you
1.4 rillig 1225: want to keep the settings, by editing the mk.conf file, and adding the
1.1 dsieger 1226: definitions there.
1227:
1.132 wiz 1228: If a package depends on many other packages (such as meta-pkgs/kde4), the build
1.1 dsieger 1229: process may alternate between periods of downloading source, and compiling. To
1230: ensure you have all the source downloaded initially you can run the command:
1231:
1232: % make fetch-list | sh
1233:
1234: which will output and run a set of shell commands to fetch the necessary files
1235: into the distfiles directory. You can also choose to download the files
1236: manually.
1237:
1238: 4.2.3. How to build and install
1239:
1240: Once the software has downloaded, any patches will be applied, then it will be
1241: compiled for you. This may take some time depending on your computer, and how
1242: many other packages the software depends on and their compile time.
1243:
1244: Note
1245:
1246: If using bootstrap or pkgsrc on a non-NetBSD system, use the pkgsrc bmake
1247: command instead of "make" in the examples in this guide.
1248:
1249: For example, type
1250:
1251: % cd misc/figlet
1252: % make
1253:
1254:
1255: at the shell prompt to build the various components of the package.
1256:
1257: The next stage is to actually install the newly compiled program onto your
1258: system. Do this by entering:
1259:
1260: % make install
1261:
1262:
1263: while you are still in the directory for whatever package you are installing.
1264:
1265: Installing the package on your system may require you to be root. However,
1266: pkgsrc has a just-in-time-su feature, which allows you to only become root for
1267: the actual installation step.
1268:
1269: That's it, the software should now be installed and setup for use. You can now
1270: enter:
1271:
1272: % make clean
1273:
1274:
1275: to remove the compiled files in the work directory, as you shouldn't need them
1276: any more. If other packages were also added to your system (dependencies) to
1277: allow your program to compile, you can tidy these up also with the command:
1278:
1279: % make clean-depends
1280:
1281:
1282: Taking the figlet utility as an example, we can install it on our system by
1283: building as shown in Appendix B, Build logs.
1284:
1285: The program is installed under the default root of the packages tree - /usr/
1286: pkg. Should this not conform to your tastes, set the LOCALBASE variable in your
1287: environment, and it will use that value as the root of your packages tree. So,
1288: to use /usr/local, set LOCALBASE=/usr/local in your environment. Please note
1289: that you should use a directory which is dedicated to packages and not shared
1290: with other programs (i.e., do not try and use LOCALBASE=/usr). Also, you should
1291: not try to add any of your own files or directories (such as src/, obj/, or
1292: pkgsrc/) below the LOCALBASE tree. This is to prevent possible conflicts
1293: between programs and other files installed by the package system and whatever
1294: else may have been installed there.
1295:
1.4 rillig 1296: Some packages look in mk.conf to alter some configuration options at build
1.1 dsieger 1297: time. Have a look at pkgsrc/mk/defaults/mk.conf to get an overview of what will
1298: be set there by default. Environment variables such as LOCALBASE can be set in
1.4 rillig 1299: mk.conf to save having to remember to set them each time you want to use
1.1 dsieger 1300: pkgsrc.
1301:
1302: Occasionally, people want to "look under the covers" to see what is going on
1303: when a package is building or being installed. This may be for debugging
1304: purposes, or out of simple curiosity. A number of utility values have been
1305: added to help with this.
1306:
1307: 1. If you invoke the make(1) command with PKG_DEBUG_LEVEL=2, then a huge
1308: amount of information will be displayed. For example,
1309:
1310: make patch PKG_DEBUG_LEVEL=2
1311:
1.25 wiz 1312: will show all the commands that are invoked, up to and including the "patch
1313: " stage.
1.1 dsieger 1314:
1315: 2. If you want to know the value of a certain make(1) definition, then the
1316: VARNAME definition should be used, in conjunction with the show-var target.
1317: e.g. to show the expansion of the make(1) variable LOCALBASE:
1318:
1319: % make show-var VARNAME=LOCALBASE
1320: /usr/pkg
1321: %
1322:
1323:
1324: If you want to install a binary package that you've either created yourself
1325: (see next section), that you put into pkgsrc/packages manually or that is
1326: located on a remote FTP server, you can use the "bin-install" target. This
1327: target will install a binary package - if available - via pkg_add(1), else do a
1328: make package. The list of remote FTP sites searched is kept in the variable
1329: BINPKG_SITES, which defaults to ftp.NetBSD.org. Any flags that should be added
1330: to pkg_add(1) can be put into BIN_INSTALL_FLAGS. See pkgsrc/mk/defaults/mk.conf
1331: for more details.
1332:
1333: A final word of warning: If you set up a system that has a non-standard setting
1334: for LOCALBASE, be sure to set that before any packages are installed, as you
1335: cannot use several directories for the same purpose. Doing so will result in
1336: pkgsrc not being able to properly detect your installed packages, and fail
1337: miserably. Note also that precompiled binary packages are usually built with
1338: the default LOCALBASE of /usr/pkg, and that you should not install any if you
1339: use a non-standard LOCALBASE.
1340:
1341: Chapter 5. Configuring pkgsrc
1342:
1343: Table of Contents
1344:
1345: 5.1. General configuration
1346: 5.2. Variables affecting the build process
1.9 rillig 1347: 5.3. Variables affecting the installation process
1.4 rillig 1348: 5.4. Selecting and configuring the compiler
1.1 dsieger 1349:
1.4 rillig 1350: 5.4.1. Selecting the compiler
1351: 5.4.2. Additional flags to the compiler (CFLAGS)
1352: 5.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 1353:
1.4 rillig 1354: 5.5. Developer/advanced settings
1355: 5.6. Selecting Build Options
1.1 dsieger 1356:
1357: The whole pkgsrc system is configured in a single file, usually called mk.conf.
1358: In which directory pkgsrc looks for that file depends on the installation. On
1359: NetBSD, when you use make(1) from the base system, it is in the directory /etc
1360: /. In all other cases the default location is ${PREFIX}/etc/, depending on
1361: where you told the bootstrap program to install the binary packages.
1362:
1363: The format of the configuration file is that of the usual BSD-style Makefiles.
1364: The whole pkgsrc configuration is done by setting variables in this file. Note
1365: that you can define all kinds of variables, and no special error checking (for
1.112 rillig 1366: example for spelling mistakes) takes place.
1.1 dsieger 1367:
1368: 5.1. General configuration
1369:
1.112 rillig 1370: The following variables apply to all pkgsrc packages. A complete list of the
1371: variables that can be configured by the user is available in mk/defaults/
1372: mk.conf, together with some comments that describe each variable's intent.
1.1 dsieger 1373:
1374: * LOCALBASE: Where packages will be installed. The default is /usr/pkg. Do
1375: not mix binary packages with different LOCALBASEs!
1376:
1377: * CROSSBASE: Where "cross" category packages will be installed. The default
1378: is ${LOCALBASE}/cross.
1379:
1.84 wiz 1380: * X11BASE: Where X11 is installed on the system. The default is /usr/X11R7.
1.1 dsieger 1381:
1382: * DISTDIR: Where to store the downloaded copies of the original source
1383: distributions used for building pkgsrc packages. The default is $
1384: {PKGSRCDIR}/distfiles.
1385:
1386: * PKG_DBDIR: Where the database about installed packages is stored. The
1.118 sevan 1387: default is /usr/pkg/pkgdb.
1.1 dsieger 1388:
1389: * MASTER_SITE_OVERRIDE: If set, override the packages' MASTER_SITES with this
1390: value.
1391:
1392: * MASTER_SITE_BACKUP: Backup location(s) for distribution files and patch
1393: files if not found locally or in ${MASTER_SITES} or ${PATCH_SITES}
1.118 sevan 1394: respectively. The defaults is ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/$
1.1 dsieger 1395: {DIST_SUBDIR}/.
1396:
1397: * BINPKG_SITES: List of sites carrying binary pkgs. rel and arch are replaced
1398: with OS release ("2.0", etc.) and architecture ("mipsel", etc.).
1399:
1.23 jakllsch 1400: * ACCEPTABLE_LICENSES: List of acceptable licenses. License names are
1401: case-sensitive. Whenever you try to build a package whose license is not in
1402: this list, you will get an error message. If the license condition is
1403: simple enough, the error message will include specific instructions on how
1404: to change this variable.
1.1 dsieger 1405:
1406: 5.2. Variables affecting the build process
1407:
1408: * PACKAGES: The top level directory for the binary packages. The default is $
1409: {PKGSRCDIR}/packages.
1410:
1411: * WRKOBJDIR: The top level directory where, if defined, the separate working
1412: directories will get created, and symbolically linked to from ${WRKDIR}
1413: (see below). This is useful for building packages on several architectures,
1414: then ${PKGSRCDIR} can be NFS-mounted while ${WRKOBJDIR} is local to every
1415: architecture. (It should be noted that PKGSRCDIR should not be set by the
1416: user ? it is an internal definition which refers to the root of the pkgsrc
1417: tree. It is possible to have many pkgsrc tree instances.)
1418:
1419: * LOCALPATCHES: Directory for local patches that aren't part of pkgsrc. See
1.6 rillig 1420: Section 11.3, "patches/*" for more information.
1.1 dsieger 1421:
1422: * PKGMAKECONF: Location of the mk.conf file used by a package's BSD-style
1423: Makefile. If this is not set, MAKECONF is set to /dev/null to avoid picking
1424: up settings used by builds in /usr/src.
1425:
1.143 maya 1426: 5.3. Variables affecting the installation process
1.1 dsieger 1427:
1.143 maya 1428: * PKGSRC_KEEP_BIN_PKGSRC: By default, binary packages of built packages are
1.150 leot 1429: preserved in ${PACKAGES}/All. Setting this variable to "no" prevents this.
1.1 dsieger 1430:
1.107 jnemeth 1431: Packages have to support installation into a subdirectory of WRKDIR. This
1432: allows a package to be built, before the actual filesystem is touched. DESTDIR
1433: support exists in two variations:
1.4 rillig 1434:
1435: * Basic DESTDIR support means that the package installation and packaging is
1436: still run as root.
1437:
1438: * Full DESTDIR support can run the complete build, installation and packaging
1439: as normal user. Root privileges are only needed to add packages.
1440:
1441: With basic DESTDIR support, make clean needs to be run as root.
1442:
1.17 imil 1443: Considering the foo/bar package, DESTDIR full support can be tested using the
1444: following commands
1445:
1446: $ id
1447: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1448: $ mkdir $HOME/packages
1449: $ cd $PKGSRCDIR/foo/bar
1450:
1451: Verify DESTDIR full support, no root privileges should be needed
1452:
1.66 asau 1453: $ make stage-install
1.17 imil 1454:
1455: Create a package without root privileges
1456:
1.66 asau 1457: $ make PACKAGES=$HOME/packages package
1.17 imil 1458:
1459: For the following command, you must be able to gain root privileges using su(1)
1460:
1.66 asau 1461: $ make PACKAGES=$HOME/packages install
1.17 imil 1462:
1463: Then, as a simple user
1464:
1465: $ make clean
1466:
1.4 rillig 1467: 5.4. Selecting and configuring the compiler
1468:
1469: 5.4.1. Selecting the compiler
1.1 dsieger 1470:
1471: By default, pkgsrc will use GCC to build packages. This may be overridden by
1472: setting the following variables in /etc/mk.conf:
1473:
1474: PKGSRC_COMPILER:
1475:
1476: This is a list of values specifying the chain of compilers to invoke when
1477: building packages. Valid values are:
1478:
1.66 asau 1479: + ccc: Compaq C Compilers (Tru64)
1480:
1481: + ccache: compiler cache (chainable)
1482:
1483: + clang: Clang C and Objective-C compiler
1484:
1.42 asau 1485: + distcc: distributed C/C++ (chainable)
1.1 dsieger 1486:
1.66 asau 1487: + f2c: Fortran 77 to C compiler (chainable)
1488:
1489: + icc: Intel C++ Compiler (Linux)
1490:
1491: + ido: SGI IRIS Development Option cc (IRIX 5)
1.1 dsieger 1492:
1.42 asau 1493: + gcc: GNU C/C++ Compiler
1.1 dsieger 1494:
1.66 asau 1495: + hp: HP-UX C/aC++ compilers
1496:
1.42 asau 1497: + mipspro: Silicon Graphics, Inc. MIPSpro (n32/n64)
1.1 dsieger 1498:
1.66 asau 1499: + mipspro-ucode: Silicon Graphics, Inc. MIPSpro (o32)
1.1 dsieger 1500:
1.42 asau 1501: + sunpro: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio
1.1 dsieger 1502:
1.118 sevan 1503: + xlc: IBM's XL C/C++ compiler suite
1.66 asau 1504:
1.1 dsieger 1505: The default is "gcc". You can use ccache and/or distcc with an appropriate
1506: PKGSRC_COMPILER setting, e.g. "ccache gcc". This variable should always be
1507: terminated with a value for a real compiler. Note that only one real
1508: compiler should be listed (e.g. "sunpro gcc" is not allowed).
1509:
1510: GCC_REQD:
1511:
1512: This specifies the minimum version of GCC to use when building packages. If
1513: the system GCC doesn't satisfy this requirement, then pkgsrc will build and
1514: install one of the GCC packages to use instead.
1515:
1.114 maya 1516: PYTHON_DEFAULT_VERSION:
1517:
1518: Specifies which version of python to use when several options are
1519: available.
1520:
1521: PKGSRC_FORTRAN:
1522:
1523: Specifies the fortran compiler to use. The default is g95, and gfortran is
1524: an alternative.
1525:
1526: GFORTRAN_VERSION:
1527:
1528: If PKGSRC_FORTRAN= gfortran is used, this option specifies which version to
1529: use.
1530:
1.4 rillig 1531: 5.4.2. Additional flags to the compiler (CFLAGS)
1.1 dsieger 1532:
1533: If you wish to set the CFLAGS variable, please make sure to use the += operator
1534: instead of the = operator:
1535:
1536: CFLAGS+= -your -flags
1537:
1538: Using CFLAGS= (i.e. without the "+") may lead to problems with packages that
1.16 jnemeth 1539: need to add their own flags. You may want to take a look at the devel/cpuflags
1.24 wiz 1540: package if you're interested in optimization specifically for the current CPU.
1.1 dsieger 1541:
1.4 rillig 1542: 5.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 1543:
1544: If you want to pass flags to the linker, both in the configure step and the
1545: build step, you can do this in two ways. Either set LDFLAGS or LIBS. The
1546: difference between the two is that LIBS will be appended to the command line,
1547: while LDFLAGS come earlier. LDFLAGS is pre-loaded with rpath settings for ELF
1548: machines depending on the setting of USE_IMAKE or the inclusion of mk/
1549: x11.buildlink3.mk. As with CFLAGS, if you do not wish to override these
1550: settings, use the += operator:
1551:
1552: LDFLAGS+= -your -linkerflags
1553:
1.4 rillig 1554: 5.5. Developer/advanced settings
1.1 dsieger 1555:
1556: * PKG_DEVELOPER: Run some sanity checks that package developers want:
1557:
1.42 asau 1558: + make sure patches apply with zero fuzz
1.1 dsieger 1559:
1.42 asau 1560: + run check-shlibs to see that all binaries will find their shared libs.
1.1 dsieger 1561:
1562: * PKG_DEBUG_LEVEL: The level of debugging output which is displayed whilst
1563: making and installing the package. The default value for this is 0, which
1564: will not display the commands as they are executed (normal, default, quiet
1565: operation); the value 1 will display all shell commands before their
1566: invocation, and the value 2 will display both the shell commands before
1.112 rillig 1567: their invocation, as well as their actual execution progress with set -x.
1.1 dsieger 1568:
1.4 rillig 1569: 5.6. Selecting Build Options
1.1 dsieger 1570:
1571: Some packages have build time options, usually to select between different
1572: dependencies, enable optional support for big dependencies or enable
1573: experimental features.
1574:
1575: To see which options, if any, a package supports, and which options are
1576: mutually exclusive, run make show-options, for example:
1577:
1578: The following options are supported by this package:
1579: ssl Enable SSL support.
1580: Exactly one of the following gecko options is required:
1581: firefox Use firefox as gecko rendering engine.
1582: mozilla Use mozilla as gecko rendering engine.
1583: At most one of the following database options may be selected:
1584: mysql Enable support for MySQL database.
1585: pgsql Enable support for PostgreSQL database.
1586:
1587: These options are enabled by default: firefox
1588: These options are currently enabled: mozilla ssl
1589:
1.4 rillig 1590: The following variables can be defined in mk.conf to select which options to
1591: enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
1.1 dsieger 1592: disable options for all packages that support them, and PKG_OPTIONS.pkgbase,
1593: which can be used to select or disable options specifically for package pkgbase
1594: . Options listed in these variables are selected, options preceded by "-" are
1595: disabled. A few examples:
1596:
1.4 rillig 1597: $ grep "PKG.*OPTION" mk.conf
1.1 dsieger 1598: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1599: PKG_OPTIONS.kdebase= debug -sasl
1600: PKG_OPTIONS.apache= suexec
1601:
1.11 rillig 1602: It is important to note that options that were specifically suggested by the
1.19 snj 1603: package maintainer must be explicitly removed if you do not wish to include the
1604: option. If you are unsure you can view the current state with make show-options
1605: .
1.11 rillig 1606:
1.1 dsieger 1607: The following settings are consulted in the order given, and the last setting
1608: that selects or disables an option is used:
1609:
1610: 1. the default options as suggested by the package maintainer
1611:
1612: 2. the options implied by the settings of legacy variables (see below)
1613:
1614: 3. PKG_DEFAULT_OPTIONS
1615:
1616: 4. PKG_OPTIONS.pkgbase
1617:
1618: For groups of mutually exclusive options, the last option selected is used, all
1619: others are automatically disabled. If an option of the group is explicitly
1620: disabled, the previously selected option, if any, is used. It is an error if no
1621: option from a required group of options is selected, and building the package
1622: will fail.
1623:
1624: Before the options framework was introduced, build options were selected by
1.4 rillig 1625: setting a variable (often named USE_FOO) in mk.conf for each option. To ease
1626: transition to the options framework for the user, these legacy variables are
1627: converted to the appropriate options setting (PKG_OPTIONS.pkgbase)
1628: automatically. A warning is issued to prompt the user to update mk.conf to use
1629: the options framework directly. Support for the legacy variables will be
1.1 dsieger 1630: removed eventually.
1631:
1632: Chapter 6. Creating binary packages
1633:
1634: Table of Contents
1635:
1636: 6.1. Building a single binary package
1637: 6.2. Settings for creation of binary packages
1638:
1639: 6.1. Building a single binary package
1640:
1641: Once you have built and installed a package, you can create a binary package
1642: which can be installed on another system with pkg_add(1). This saves having to
1643: build the same package on a group of hosts and wasting CPU time. It also
1644: provides a simple means for others to install your package, should you
1645: distribute it.
1646:
1647: To create a binary package, change into the appropriate directory in pkgsrc,
1648: and run make package:
1649:
1.112 rillig 1650: $ cd misc/figlet
1651: $ make package
1.1 dsieger 1652:
1653: This will build and install your package (if not already done), and then build
1654: a binary package from what was installed. You can then use the pkg_* tools to
1655: manipulate it. Binary packages are created by default in /usr/pkgsrc/packages,
1656: in the form of a gzipped tar file. See Section B.2, "Packaging figlet" for a
1657: continuation of the above misc/figlet example.
1658:
1.6 rillig 1659: See Chapter 21, Submitting and Committing for information on how to submit such
1.1 dsieger 1660: a binary package.
1661:
1662: 6.2. Settings for creation of binary packages
1663:
1.6 rillig 1664: See Section 17.17, "Other helpful targets".
1665:
1666: Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)
1667:
1668: Table of Contents
1669:
1.71 wiz 1670: 7.1. Preparations
1671: 7.2. Running a pbulk-style bulk build
1.6 rillig 1672:
1.71 wiz 1673: 7.2.1. Configuration
1.6 rillig 1674:
1.71 wiz 1675: 7.3. Requirements of a full bulk build
1.66 asau 1676: 7.4. Creating a multiple CD-ROM packages collection
1.6 rillig 1677:
1.66 asau 1678: 7.4.1. Example of cdpack
1.6 rillig 1679:
1.71 wiz 1680: For a number of reasons you may want to build binary packages for a large
1681: selected set of packages in pkgsrc or even for all pkgsrc packages. For
1682: instance, when you have multiple machines that should run the same software, it
1683: is wasted time if they all build their packages themselves from source. Or you
1684: may want to build a list of packages you want and check them before deploying
1685: onto production system. There is a way of getting a set of binary packages: The
1.112 rillig 1686: bulk build system, or pbulk ("p" stands for "parallel"). This chapter describes
1687: how to set it up.
1.71 wiz 1688:
1689: 7.1. Preparations
1690:
1691: First of all, you have to decide whether you build all packages or a limited
1692: set of them. Full bulk builds usually consume a lot more resources, both space
1693: and time, than builds for some practical sets of packages. There exists a
1694: number of particularly heavy packages that are not actually interesting to a
1695: wide audience. For a limited bulk builds you need to make a list of packages
1.112 rillig 1696: you want to build. Note that all their dependencies will be built, so you don't
1697: need to track them manually.
1.71 wiz 1698:
1699: During bulk builds various packages are installed and deinstalled in /usr/pkg
1700: (or whatever LOCALBASE is), so make sure that you don't need any package during
1.112 rillig 1701: the builds. Essentially, you should provide a fresh system, either a chroot
1.71 wiz 1702: environment or something even more restrictive, depending on what the operating
1703: system provides, or dedicate the whole physical machine. As a useful side
1704: effect this makes sure that bulk builds cannot break anything in your system.
1705: There have been numerous cases where certain packages tried to install files
1706: outside the LOCALBASE or wanted to edit some files in /etc.
1.6 rillig 1707:
1.71 wiz 1708: 7.2. Running a pbulk-style bulk build
1.6 rillig 1709:
1.15 rillig 1710: Running a pbulk-style bulk build works roughly as follows:
1711:
1712: * First, build the pbulk infrastructure in a fresh pkgsrc location.
1713:
1714: * Then, build each of the packages from a clean installation directory using
1715: the infrastructure.
1716:
1.71 wiz 1717: 7.2.1. Configuration
1.6 rillig 1718:
1.112 rillig 1719: To simplify configuration, we provide the helper script mk/pbulk/pbulk.sh.
1.6 rillig 1720:
1.68 asau 1721: In order to use it, prepare a clear system (real one, chroot environment, jail,
1722: zone, virtual machine). Configure network access to fetch distribution files.
1.112 rillig 1723: Create a user with name "pbulk".
1.68 asau 1724:
1725: Fetch and extract pkgsrc. Use a command like one of these:
1726:
1.151 ! sevan 1727: # (cd /usr && ftp -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
! 1728: # (cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1.72 wiz 1729: # (cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)
1.68 asau 1730:
1731: Or any other way that fits (e.g., curl, wget).
1732:
1733: Deploy and configure pbulk tools, e.g.:
1734:
1.118 sevan 1735: # sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)
1.68 asau 1736: # sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment
1737: # sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build
1738:
1739: Note
1740:
1741: mk.conf.frag is a fragment of mk.conf that contains settings you want to apply
1742: to packages you build. For instance,
1743:
1.112 rillig 1744: PKG_DEVELOPER= yes # perform more checks
1745: X11_TYPE= modular # use pkgsrc X11
1746: SKIP_LICENSE_CHECK= yes # accept all licences (useful
1747: # when building all packages)
1.68 asau 1748:
1749: If configured for limited list, replace the list in /usr/pbulk/etc/pbulk.list
1.112 rillig 1750: with your list of packages, one per line without empty lines or comments. E.g.:
1.68 asau 1751:
1752: www/firefox
1753: mail/thunderbird
1754: misc/libreoffice4
1755:
1.69 asau 1756: At this point you can also review configuration in /usr/pbulk/etc and make
1757: final amendments, if wanted.
1758:
1.68 asau 1759: Start it:
1760:
1761: # /usr/pbulk/bin/bulkbuild
1762:
1763: After it finishes, you'll have /mnt filled with distribution files, binary
1764: packages, and reports, plain text summary in /mnt/bulklog/meta/report.txt
1765:
1766: Note
1767:
1768: The pbulk.sh script does not cover all possible use cases. While being ready to
1769: run, it serves as a good starting point to understand and build more complex
1770: setups. The script is kept small enough for better understanding.
1771:
1772: Note
1773:
1774: The pbulk.sh script supports running unprivileged bulk build and helps
1775: configuring distributed bulk builds.
1.15 rillig 1776:
1.71 wiz 1777: 7.3. Requirements of a full bulk build
1778:
1779: A complete bulk build requires lots of disk space. Some of the disk space can
1780: be read-only, some other must be writable. Some can be on remote filesystems
1781: (such as NFS) and some should be local. Some can be temporary filesystems,
1782: others must survive a sudden reboot.
1783:
1784: * 40 GB for the distfiles (read-write, remote, temporary)
1785:
1786: * 30 GB for the binary packages (read-write, remote, permanent)
1787:
1788: * 1 GB for the pkgsrc tree (read-only, remote, permanent)
1789:
1790: * 5 GB for LOCALBASE (read-write, local, temporary)
1791:
1792: * 10 GB for the log files (read-write, remote, permanent)
1793:
1794: * 5 GB for temporary files (read-write, local, temporary)
1795:
1.66 asau 1796: 7.4. Creating a multiple CD-ROM packages collection
1.1 dsieger 1797:
1798: After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set
1799: of the resulting binary packages to assist in installing packages on other
1800: machines. The pkgtools/cdpack package provides a simple tool for creating the
1801: ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a way that
1802: keeps all the dependencies for a given package on the same CD as that package.
1803:
1.66 asau 1804: 7.4.1. Example of cdpack
1.1 dsieger 1805:
1806: Complete documentation for cdpack is found in the cdpack(1) man page. The
1807: following short example assumes that the binary packages are left in /usr/
1808: pkgsrc/packages/All and that sufficient disk space exists in /u2 to hold the
1809: ISO 9660 images.
1810:
1811: # mkdir /u2/images
1812: # pkg_add /usr/pkgsrc/packages/All/cdpack
1813: # cdpack /usr/pkgsrc/packages/All /u2/images
1814:
1815:
1816: If you wish to include a common set of files (COPYRIGHT, README, etc.) on each
1817: CD in the collection, then you need to create a directory which contains these
1818: files. e.g.
1819:
1820: # mkdir /tmp/common
1821: # echo "This is a README" > /tmp/common/README
1822: # echo "Another file" > /tmp/common/COPYING
1823: # mkdir /tmp/common/bin
1824: # echo "#!/bin/sh" > /tmp/common/bin/myscript
1825: # echo "echo Hello world" >> /tmp/common/bin/myscript
1826: # chmod 755 /tmp/common/bin/myscript
1827:
1828:
1829: Now create the images:
1830:
1831: # cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images
1832:
1833: Each image will contain README, COPYING, and bin/myscript in their root
1834: directories.
1835:
1.6 rillig 1836: Chapter 8. Directory layout of the installed files
1.1 dsieger 1837:
1838: Table of Contents
1839:
1.6 rillig 1840: 8.1. File system layout in ${LOCALBASE}
1841: 8.2. File system layout in ${VARBASE}
1.1 dsieger 1842:
1843: The files that are installed by pkgsrc are organized in a way that is similar
1844: to what you find in the /usr directory of the base system. But some details are
1845: different. This is because pkgsrc initially came from FreeBSD and had adopted
1846: its file system hierarchy. Later it was largely influenced by NetBSD. But no
1847: matter which operating system you are using pkgsrc with, you can expect the
1848: same layout for pkgsrc.
1849:
1850: There are mainly four root directories for pkgsrc, which are all configurable
1851: in the bootstrap/bootstrap script. When pkgsrc has been installed as root, the
1852: default locations are:
1853:
1854: LOCALBASE= /usr/pkg
1855: PKG_SYSCONFBASE= /usr/pkg/etc
1856: VARBASE= /var
1.119 sevan 1857: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 1858:
1859: In unprivileged mode (when pkgsrc has been installed as any other user), the
1860: default locations are:
1861:
1862: LOCALBASE= ${HOME}/pkg
1863: PKG_SYSCONFBASE= ${HOME}/pkg/etc
1864: VARBASE= ${HOME}/pkg/var
1.119 sevan 1865: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 1866:
1867: What these four directories are for, and what they look like is explained
1868: below.
1869:
1.25 wiz 1870: * LOCALBASE corresponds to the /usr directory in the base system. It is the "
1871: main" directory where the files are installed and contains the well-known
1.1 dsieger 1872: subdirectories like bin, include, lib, share and sbin.
1873:
1874: * VARBASE corresponds to /var in the base system. Some programs (especially
1875: games, network daemons) need write access to it during normal operation.
1876:
1877: * PKG_SYSCONFDIR corresponds to /etc in the base system. It contains
1878: configuration files of the packages, as well as pkgsrc's mk.conf itself.
1879:
1.6 rillig 1880: 8.1. File system layout in ${LOCALBASE}
1.1 dsieger 1881:
1882: The following directories exist in a typical pkgsrc installation in $
1883: {LOCALBASE}.
1884:
1885: bin
1886:
1887: Contains executable programs that are intended to be directly used by the
1888: end user.
1889:
1890: emul
1891:
1892: Contains files for the emulation layers of various other operating systems,
1893: especially for NetBSD.
1894:
1895: etc (the usual location of ${PKG_SYSCONFDIR})
1896:
1897: Contains the configuration files.
1898:
1899: include
1900:
1901: Contains headers for the C and C++ programming languages.
1902:
1903: info
1904:
1905: Contains GNU info files of various packages.
1906:
1907: lib
1908:
1909: Contains shared and static libraries.
1910:
1911: libdata
1912:
1913: Contains data files that don't change after installation. Other data files
1914: belong into ${VARBASE}.
1915:
1916: libexec
1917:
1918: Contains programs that are not intended to be used by end users, such as
1919: helper programs or network daemons.
1920:
1921: libexec/cgi-bin
1922:
1923: Contains programs that are intended to be executed as CGI scripts by a web
1924: server.
1925:
1926: man (the usual value of ${PKGMANDIR})
1927:
1928: Contains brief documentation in form of manual pages.
1929:
1930: sbin
1931:
1932: Contains programs that are intended to be used only by the super-user.
1933:
1934: share
1935:
1936: Contains platform-independent data files that don't change after
1937: installation.
1938:
1939: share/doc
1940:
1941: Contains documentation files provided by the packages.
1942:
1943: share/examples
1944:
1945: Contains example files provided by the packages. Among others, the original
1946: configuration files are saved here and copied to ${PKG_SYSCONFDIR} during
1947: installation.
1948:
1949: share/examples/rc.d
1950:
1951: Contains the original files for rc.d scripts.
1952:
1953: var (the usual location of ${VARBASE})
1954:
1955: Contains files that may be modified after installation.
1956:
1.6 rillig 1957: 8.2. File system layout in ${VARBASE}
1.1 dsieger 1958:
1959: db/pkg (the usual location of ${PKG_DBDIR})
1960:
1961: Contains information about the currently installed packages.
1962:
1963: games
1964:
1965: Contains highscore files.
1966:
1967: log
1968:
1969: Contains log files.
1970:
1971: run
1972:
1973: Contains informational files about daemons that are currently running.
1974:
1.6 rillig 1975: Chapter 9. Frequently Asked Questions
1.1 dsieger 1976:
1977: Table of Contents
1978:
1.6 rillig 1979: 9.1. Are there any mailing lists for pkg-related discussion?
1.84 wiz 1980: 9.2. Utilities for package management (pkgtools)
1981: 9.3. How to use pkgsrc as non-root
1982: 9.4. How to resume transfers when fetching distfiles?
1983: 9.5. How can I install/use modular X.org from pkgsrc?
1984: 9.6. How to fetch files from behind a firewall
1985: 9.7. How to fetch files from HTTPS sites
1986: 9.8. How do I tell make fetch to do passive FTP?
1987: 9.9. How to fetch all distfiles at once
1988: 9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
1989: 9.11. What does "Could not find bsd.own.mk" mean?
1990: 9.12. Using 'sudo' with pkgsrc
1991: 9.13. How do I change the location of configuration files?
1992: 9.14. Automated security checks
1993: 9.15. Why do some packages ignore my CFLAGS?
1994: 9.16. A package does not build. What shall I do?
1995: 9.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.24 wiz 1996: conflicts" mean?
1.1 dsieger 1997:
1998: This section contains hints, tips & tricks on special things in pkgsrc that we
1999: didn't find a better place for in the previous chapters, and it contains items
2000: for both pkgsrc users and developers.
2001:
1.6 rillig 2002: 9.1. Are there any mailing lists for pkg-related discussion?
1.1 dsieger 2003:
2004: The following mailing lists may be of interest to pkgsrc users:
2005:
2006: * pkgsrc-users: This is a general purpose list for most issues regarding
2007: pkgsrc, regardless of platform, e.g. soliciting user help for pkgsrc
2008: configuration, unexpected build failures, using particular packages,
2009: upgrading pkgsrc installations, questions regarding the pkgsrc release
2010: branches, etc. General announcements or proposals for changes that impact
2011: the pkgsrc user community, e.g. major infrastructure changes, new features,
2012: package removals, etc., may also be posted.
2013:
2014: * pkgsrc-bulk: A list where the results of pkgsrc bulk builds are sent and
2015: discussed.
2016:
2017: * pkgsrc-changes: This list is for those who are interested in getting a
2018: commit message for every change committed to pkgsrc. It is also available
2019: in digest form, meaning one daily message containing all commit messages
2020: for changes to the package source tree in that 24 hour period.
2021:
2022: To subscribe, do:
2023:
2024: % echo subscribe listname | mail majordomo@NetBSD.org
2025:
2026: Archives for all these mailing lists are available from http://
2027: mail-index.NetBSD.org/.
2028:
1.84 wiz 2029: 9.2. Utilities for package management (pkgtools)
1.1 dsieger 2030:
2031: The directory pkgsrc/pkgtools contains a number of useful utilities for both
2032: users and developers of pkgsrc. This section attempts only to make the reader
1.121 sevan 2033: aware of some of the utilities and when they might be useful, and not to
2034: duplicate the documentation that comes with each package.
1.1 dsieger 2035:
2036: Utilities used by pkgsrc (automatically installed when needed):
2037:
2038: * pkgtools/x11-links: Symlinks for use by buildlink.
2039:
2040: OS tool augmentation (automatically installed when needed):
2041:
1.121 sevan 2042: * pkgtools/digest: Calculates various kinds of checksums (including SHA3).
1.1 dsieger 2043:
2044: * pkgtools/libnbcompat: Compatibility library for pkgsrc tools.
2045:
2046: * pkgtools/mtree: Installed on non-BSD systems due to lack of native mtree.
2047:
2048: * pkgtools/pkg_install: Up-to-date replacement for /usr/sbin/pkg_install, or
2049: for use on operating systems where pkg_install is not present.
2050:
2051: Utilities used by pkgsrc (not automatically installed):
2052:
2053: * pkgtools/pkg_tarup: Create a binary package from an already-installed
2054: package. Used by make replace to save the old package.
2055:
2056: * pkgtools/dfdisk: Adds extra functionality to pkgsrc, allowing it to fetch
2057: distfiles from multiple locations. It currently supports the following
2058: methods: multiple CD-ROMs and network FTP/HTTP connections.
2059:
2060: * devel/cpuflags: Determine the best compiler flags to optimise code for your
1.24 wiz 2061: current CPU and compiler.
1.1 dsieger 2062:
2063: Utilities for keeping track of installed packages, being up to date, etc:
2064:
1.65 wiz 2065: * pkgtools/pkgin: A package update tool similar to apt(1). Download, install,
2066: and upgrade binary packages easily.
2067:
1.1 dsieger 2068: * pkgtools/pkg_chk: Reports on packages whose installed versions do not match
2069: the latest pkgsrc entries.
2070:
2071: * pkgtools/pkgdep: Makes dependency graphs of packages, to aid in choosing a
2072: strategy for updating.
2073:
2074: * pkgtools/pkgdepgraph: Makes graphs from the output of pkgtools/pkgdep (uses
2075: graphviz).
2076:
1.12 weinem 2077: * pkgtools/pkglint: The pkglint(1) program checks a pkgsrc entry for errors.
2078:
2079: * pkgtools/lintpkgsrc: The lintpkgsrc(1) program does various checks on the
2080: complete pkgsrc system.
1.1 dsieger 2081:
2082: * pkgtools/pkgsurvey: Report what packages you have installed.
2083:
2084: Utilities for people maintaining or creating individual packages:
2085:
2086: * pkgtools/pkgdiff: Automate making and maintaining patches for a package
2087: (includes pkgdiff, pkgvi, mkpatches, etc.).
2088:
1.65 wiz 2089: * pkgtools/url2pkg: Aids in converting to pkgsrc.
1.1 dsieger 2090:
2091: Utilities for people maintaining pkgsrc (or: more obscure pkg utilities)
2092:
2093: * pkgtools/pkg_comp: Build packages in a chrooted area.
2094:
2095: * pkgtools/libkver: Spoof kernel version for chrooted cross builds.
2096:
1.84 wiz 2097: 9.3. How to use pkgsrc as non-root
1.1 dsieger 2098:
1.108 rillig 2099: To install packages from source as a non-root user, download pkgsrc as
2100: described in Chapter 2, Where to get pkgsrc and how to keep it up-to-date, cd
2101: into that directory and run the command ./bootstrap/bootstrap --unprivileged.
2102:
2103: This will install the binary part of pkgsrc to ~/pkg and put the pkgsrc
2104: configuration mk.conf into ~/pkg/etc.
2105:
2106: For more details, see mk/unprivileged.mk.
1.1 dsieger 2107:
1.84 wiz 2108: 9.4. How to resume transfers when fetching distfiles?
1.1 dsieger 2109:
2110: By default, resuming transfers in pkgsrc is disabled, but you can enable this
1.4 rillig 2111: feature by adding the option PKG_RESUME_TRANSFERS=YES into mk.conf. If, during
2112: a fetch step, an incomplete distfile is found, pkgsrc will try to resume it.
1.1 dsieger 2113:
1.61 wiz 2114: You can also use a different program than the platform default program by
2115: changing the FETCH_USING variable. You can specify the program by using of ftp,
2116: fetch, wget or curl. Alternatively, fetching can be disabled by using the value
2117: manual. A value of custom disables the system defaults and dependency tracking
2118: for the fetch program. In that case you have to provide FETCH_CMD,
2119: FETCH_BEFORE_ARGS, FETCH_RESUME_ARGS, FETCH_OUTPUT_ARGS, FETCH_AFTER_ARGS.
1.1 dsieger 2120:
1.16 jnemeth 2121: For example, if you want to use wget to download, you'll have to use something
2122: like:
1.1 dsieger 2123:
1.16 jnemeth 2124: FETCH_USING= wget
1.1 dsieger 2125:
1.84 wiz 2126: 9.5. How can I install/use modular X.org from pkgsrc?
1.1 dsieger 2127:
1.4 rillig 2128: If you want to use modular X.org from pkgsrc instead of your system's own X11
2129: (/usr/X11R6, /usr/openwin, ...) you will have to add the following line into
1.1 dsieger 2130: mk.conf:
2131:
1.4 rillig 2132: X11_TYPE=modular
1.1 dsieger 2133:
1.84 wiz 2134: 9.6. How to fetch files from behind a firewall
1.1 dsieger 2135:
2136: If you are sitting behind a firewall which does not allow direct connections to
2137: Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This
2138: is done using an environment variable in the form of a URL, e.g. in Amdahl, the
2139: machine "orpheus.amdahl.com" is one of the firewalls, and it uses port 80 as
2140: the proxy port number. So the proxy environment variables are:
2141:
2142: ftp_proxy=ftp://orpheus.amdahl.com:80/
2143: http_proxy=http://orpheus.amdahl.com:80/
2144:
1.84 wiz 2145: 9.7. How to fetch files from HTTPS sites
1.65 wiz 2146:
2147: Some fetch tools are not prepared to support HTTPS by default (for example, the
2148: one in NetBSD 6.0), or the one installed by the pkgsrc bootstrap (to avoid an
2149: openssl dependency that low in the dependency graph).
2150:
2151: Usually you won't notice, because distribution files are mirrored weekly to "
2152: ftp.NetBSD.org", but that might not be often enough if you are following
2153: pkgsrc-current. In that case, set FETCH_USING in your mk.conf file to "curl" or
2154: "wget", which are both compiled with HTTPS support by default. Of course, these
2155: tools need to be installed before you can use them this way.
2156:
1.84 wiz 2157: 9.8. How do I tell make fetch to do passive FTP?
1.1 dsieger 2158:
2159: This depends on which utility is used to retrieve distfiles. From bsd.pkg.mk,
2160: FETCH_CMD is assigned the first available command from the following list:
2161:
2162: * ${LOCALBASE}/bin/ftp
2163:
2164: * /usr/bin/ftp
2165:
2166: On a default NetBSD installation, this will be /usr/bin/ftp, which
2167: automatically tries passive connections first, and falls back to active
2168: connections if the server refuses to do passive. For the other tools, add the
1.4 rillig 2169: following to your mk.conf file: PASSIVE_FETCH=1.
1.1 dsieger 2170:
2171: Having that option present will prevent /usr/bin/ftp from falling back to
2172: active transfers.
2173:
1.84 wiz 2174: 9.9. How to fetch all distfiles at once
1.1 dsieger 2175:
2176: You would like to download all the distfiles in a single batch from work or
2177: university, where you can't run a make fetch. There is an archive of distfiles
2178: on ftp.NetBSD.org, but downloading the entire directory may not be appropriate.
2179:
2180: The answer here is to do a make fetch-list in /usr/pkgsrc or one of its
2181: subdirectories, carry the resulting list to your machine at work/school and use
2182: it there. If you don't have a NetBSD-compatible ftp(1) (like tnftp) at work,
2183: don't forget to set FETCH_CMD to something that fetches a URL:
2184:
2185: At home:
2186:
2187: % cd /usr/pkgsrc
2188: % make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh
2189: % scp /tmp/fetch.sh work:/tmp
2190:
2191: At work:
2192:
2193: % sh /tmp/fetch.sh
2194:
2195: then tar up /tmp/distfiles and take it home.
2196:
2197: If you have a machine running NetBSD, and you want to get all distfiles (even
2198: ones that aren't for your machine architecture), you can do so by using the
2199: above-mentioned make fetch-list approach, or fetch the distfiles directly by
2200: running:
2201:
2202: % make mirror-distfiles
2203:
2204: If you even decide to ignore NO_{SRC,BIN}_ON_{FTP,CDROM}, then you can get
2205: everything by running:
2206:
2207: % make fetch NO_SKIP=yes
2208:
1.84 wiz 2209: 9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
1.1 dsieger 2210:
2211: When compiling the pkgtools/pkg_install package, you get the error from make
2212: that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates
2213: that you don't have installed the "text" set (nroff, ...) from the NetBSD base
2214: distribution on your machine. It is recommended to do that to format man pages.
2215:
2216: In the case of the pkgtools/pkg_install package, you can get away with setting
1.4 rillig 2217: NOMAN=YES either in the environment or in mk.conf.
1.1 dsieger 2218:
1.84 wiz 2219: 9.11. What does "Could not find bsd.own.mk" mean?
1.1 dsieger 2220:
2221: You didn't install the compiler set, comp.tgz, when you installed your NetBSD
2222: machine. Please get and install it, by extracting it in /:
2223:
2224: # cd /
2225: # tar --unlink -zxvpf .../comp.tgz
2226:
2227: comp.tgz is part of every NetBSD release. Get the one that corresponds to your
2228: release (determine via uname -r).
2229:
1.84 wiz 2230: 9.12. Using 'sudo' with pkgsrc
1.1 dsieger 2231:
2232: When installing packages as non-root user and using the just-in-time su(1)
2233: feature of pkgsrc, it can become annoying to type in the root password for each
2234: required package installed. To avoid this, the sudo package can be used, which
2235: does password caching over a limited time. To use it, install sudo (either as
1.4 rillig 2236: binary package or from security/sudo) and then put the following into your
2237: mk.conf, somewhere after the definition of the LOCALBASE variable:
1.1 dsieger 2238:
2239: .if exists(${LOCALBASE}/bin/sudo)
2240: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2241: .endif
2242:
1.84 wiz 2243: 9.13. How do I change the location of configuration files?
1.1 dsieger 2244:
2245: As the system administrator, you can choose where configuration files are
2246: installed. The default settings make all these files go into ${PREFIX}/etc or
2247: some of its subdirectories; this may be suboptimal depending on your
2248: expectations (e.g., a read-only, NFS-exported PREFIX with a need of per-machine
2249: configuration of the provided packages).
2250:
2251: In order to change the defaults, you can modify the PKG_SYSCONFBASE variable
1.4 rillig 2252: (in mk.conf) to point to your preferred configuration directory; some common
2253: examples include /etc or /etc/pkg.
1.1 dsieger 2254:
2255: Furthermore, you can change this value on a per-package basis by setting the
2256: PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. PKG_SYSCONFVAR's value usually
2257: matches the name of the package you would like to modify, that is, the contents
2258: of PKGBASE.
2259:
2260: Note that after changing these settings, you must rebuild and reinstall any
2261: affected packages.
2262:
1.84 wiz 2263: 9.14. Automated security checks
1.1 dsieger 2264:
2265: Please be aware that there can often be bugs in third-party software, and some
2266: of these bugs can leave a machine vulnerable to exploitation by attackers. In
2267: an effort to lessen the exposure, the NetBSD packages team maintains a database
2268: of known-exploits to packages which have at one time been included in pkgsrc.
2269: The database can be downloaded automatically, and a security audit of all
1.14 jmcneill 2270: packages installed on a system can take place. To do this, refer to the
2271: following two tools (installed as part of the pkgtools/pkg_install package):
1.1 dsieger 2272:
1.21 snj 2273: 1. pkg_admin fetch-pkg-vulnerabilities, an easy way to download a list of the
2274: security vulnerabilities information. This list is kept up to date by the
1.26 spz 2275: pkgsrc security team, and is distributed from the NetBSD ftp server:
1.1 dsieger 2276:
1.26 spz 2277: ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities
1.1 dsieger 2278:
1.21 snj 2279: 2. pkg_admin audit, an easy way to audit the current machine, checking each
1.24 wiz 2280: known vulnerability. If a vulnerable package is installed, it will be shown
2281: by output to stdout, including a description of the type of vulnerability,
2282: and a URL containing more information.
1.1 dsieger 2283:
1.121 sevan 2284: Use of these tools is strongly recommended! See Section 4.1.5, "Checking for
2285: security vulnerabilities in installed packages" for instructions on how to
2286: automate checking and reporting.
2287:
2288: If this database is installed, pkgsrc builds will use it to perform a security
2289: check before building any package.
1.1 dsieger 2290:
1.84 wiz 2291: 9.15. Why do some packages ignore my CFLAGS?
1.1 dsieger 2292:
2293: When you add your own preferences to the CFLAGS variable in your mk.conf, these
2294: flags are passed in environment variables to the ./configure scripts and to
2295: make(1). Some package authors ignore the CFLAGS from the environment variable
2296: by overriding them in the Makefiles of their package.
2297:
2298: Currently there is no solution to this problem. If you really need the package
2299: to use your CFLAGS you should run make patch in the package directory and then
2300: inspect any Makefile and Makefile.in for whether they define CFLAGS explicitly.
2301: Usually you can remove these lines. But be aware that some "smart" programmers
2302: write so bad code that it only works for the specific combination of CFLAGS
2303: they have chosen.
2304:
1.84 wiz 2305: 9.16. A package does not build. What shall I do?
1.1 dsieger 2306:
2307: 1. Make sure that your copy of pkgsrc is consistent. A case that occurs often
2308: is that people only update pkgsrc in parts, because of performance reasons.
2309: Since pkgsrc is one large system, not a collection of many small systems,
2310: there are sometimes changes that only work when the whole pkgsrc tree is
2311: updated.
2312:
1.25 wiz 2313: 2. Make sure that you don't have any CVS conflicts. Search for "<<<<<<" or "
2314: >>>>>>" in all your pkgsrc files.
1.1 dsieger 2315:
1.25 wiz 2316: 3. Make sure that you don't have old copies of the packages extracted. Run
1.1 dsieger 2317: make clean clean-depends to verify this.
2318:
1.108 rillig 2319: 4. If you are a package developer who wants to invest some work, have a look
2320: at Chapter 19, Making your package work.
2321:
2322: 5. If the problem still exists, write a mail to the pkgsrc-users mailing list.
1.1 dsieger 2323:
1.84 wiz 2324: 9.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.1 dsieger 2325: conflicts" mean?
2326:
2327: You have modified a file from pkgsrc, and someone else has modified that same
2328: file afterwards in the CVS repository. Both changes are in the same region of
2329: the file, so when you updated pkgsrc, the cvs command marked the conflicting
2330: changes in the file. Because of these markers, the file is no longer a valid
2331: Makefile.
2332:
2333: Have a look at that file, and if you don't need your local changes anymore, you
2334: can remove that file and run cvs -q update -dP in that directory to download
2335: the current version.
2336:
2337: Part II. The pkgsrc developer's guide
2338:
2339: This part of the book deals with creating and modifying packages. It starts
2340: with a "HOWTO"-like guide on creating a new package. The remaining chapters are
2341: more like a reference manual for pkgsrc.
2342:
2343: Table of Contents
2344:
1.6 rillig 2345: 10. Creating a new pkgsrc package from scratch
1.1 dsieger 2346:
1.6 rillig 2347: 10.1. Common types of packages
1.1 dsieger 2348:
1.6 rillig 2349: 10.1.1. Perl modules
1.132 wiz 2350: 10.1.2. Python modules and programs
1.1 dsieger 2351:
1.6 rillig 2352: 10.2. Examples
1.1 dsieger 2353:
1.6 rillig 2354: 10.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 2355:
1.6 rillig 2356: 11. Package components - files, directories and contents
1.1 dsieger 2357:
1.6 rillig 2358: 11.1. Makefile
2359: 11.2. distinfo
2360: 11.3. patches/*
1.1 dsieger 2361:
1.6 rillig 2362: 11.3.1. Structure of a single patch file
2363: 11.3.2. Creating patch files
2364: 11.3.3. Sources where the patch files come from
2365: 11.3.4. Patching guidelines
2366: 11.3.5. Feedback to the author
1.1 dsieger 2367:
1.6 rillig 2368: 11.4. Other mandatory files
2369: 11.5. Optional files
1.1 dsieger 2370:
1.6 rillig 2371: 11.5.1. Files affecting the binary package
2372: 11.5.2. Files affecting the build process
2373: 11.5.3. Files affecting nothing at all
1.1 dsieger 2374:
1.6 rillig 2375: 11.6. work*
2376: 11.7. files/*
1.1 dsieger 2377:
1.6 rillig 2378: 12. Programming in Makefiles
1.1 dsieger 2379:
1.6 rillig 2380: 12.1. Caveats
2381: 12.2. Makefile variables
1.1 dsieger 2382:
1.6 rillig 2383: 12.2.1. Naming conventions
1.1 dsieger 2384:
1.6 rillig 2385: 12.3. Code snippets
1.1 dsieger 2386:
1.6 rillig 2387: 12.3.1. Adding things to a list
1.117 sevan 2388: 12.3.2. Echoing a string exactly as-is
1.108 rillig 2389: 12.3.3. Passing CFLAGS to GNU configure scripts
2390: 12.3.4. Handling possibly empty variables
1.1 dsieger 2391:
1.6 rillig 2392: 13. PLIST issues
1.1 dsieger 2393:
1.6 rillig 2394: 13.1. RCS ID
2395: 13.2. Semi-automatic PLIST generation
2396: 13.3. Tweaking output of make print-PLIST
2397: 13.4. Variable substitution in PLIST
2398: 13.5. Man page compression
2399: 13.6. Changing PLIST source with PLIST_SRC
2400: 13.7. Platform-specific and differing PLISTs
1.86 wiz 2401: 13.8. Build-specific PLISTs
2402: 13.9. Sharing directories between packages
1.1 dsieger 2403:
1.6 rillig 2404: 14. Buildlink methodology
1.1 dsieger 2405:
1.6 rillig 2406: 14.1. Converting packages to use buildlink3
2407: 14.2. Writing buildlink3.mk files
1.1 dsieger 2408:
1.6 rillig 2409: 14.2.1. Anatomy of a buildlink3.mk file
1.27 wiz 2410: 14.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.
2411: pkg in buildlink3.mk files
1.1 dsieger 2412:
1.6 rillig 2413: 14.3. Writing builtin.mk files
1.1 dsieger 2414:
1.6 rillig 2415: 14.3.1. Anatomy of a builtin.mk file
2416: 14.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 2417:
1.6 rillig 2418: 15. The pkginstall framework
1.1 dsieger 2419:
1.6 rillig 2420: 15.1. Files and directories outside the installation prefix
1.1 dsieger 2421:
1.6 rillig 2422: 15.1.1. Directory manipulation
2423: 15.1.2. File manipulation
1.1 dsieger 2424:
1.6 rillig 2425: 15.2. Configuration files
1.1 dsieger 2426:
1.6 rillig 2427: 15.2.1. How PKG_SYSCONFDIR is set
2428: 15.2.2. Telling the software where configuration files are
2429: 15.2.3. Patching installations
2430: 15.2.4. Disabling handling of configuration files
1.1 dsieger 2431:
1.6 rillig 2432: 15.3. System startup scripts
1.1 dsieger 2433:
1.6 rillig 2434: 15.3.1. Disabling handling of system startup scripts
1.1 dsieger 2435:
1.6 rillig 2436: 15.4. System users and groups
2437: 15.5. System shells
1.1 dsieger 2438:
1.6 rillig 2439: 15.5.1. Disabling shell registration
1.1 dsieger 2440:
1.6 rillig 2441: 15.6. Fonts
1.1 dsieger 2442:
1.6 rillig 2443: 15.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 2444:
1.6 rillig 2445: 16. Options handling
1.1 dsieger 2446:
1.6 rillig 2447: 16.1. Global default options
2448: 16.2. Converting packages to use bsd.options.mk
2449: 16.3. Option Names
1.7 rillig 2450: 16.4. Determining the options of dependencies
1.1 dsieger 2451:
1.6 rillig 2452: 17. The build process
1.1 dsieger 2453:
1.6 rillig 2454: 17.1. Introduction
2455: 17.2. Program location
2456: 17.3. Directories used during the build process
2457: 17.4. Running a phase
2458: 17.5. The fetch phase
1.1 dsieger 2459:
1.6 rillig 2460: 17.5.1. What to fetch and where to get it from
2461: 17.5.2. How are the files fetched?
1.1 dsieger 2462:
1.6 rillig 2463: 17.6. The checksum phase
2464: 17.7. The extract phase
2465: 17.8. The patch phase
2466: 17.9. The tools phase
2467: 17.10. The wrapper phase
2468: 17.11. The configure phase
2469: 17.12. The build phase
2470: 17.13. The test phase
2471: 17.14. The install phase
2472: 17.15. The package phase
2473: 17.16. Cleaning up
2474: 17.17. Other helpful targets
1.1 dsieger 2475:
1.6 rillig 2476: 18. Tools needed for building or running
1.1 dsieger 2477:
1.6 rillig 2478: 18.1. Tools for pkgsrc builds
2479: 18.2. Tools needed by packages
2480: 18.3. Tools provided by platforms
1.1 dsieger 2481:
1.6 rillig 2482: 19. Making your package work
1.1 dsieger 2483:
1.6 rillig 2484: 19.1. General operation
1.1 dsieger 2485:
1.108 rillig 2486: 19.1.1. How to pull in user-settable variables from mk.conf
2487: 19.1.2. User interaction
2488: 19.1.3. Handling licenses
2489: 19.1.4. Restricted packages
2490: 19.1.5. Handling dependencies
2491: 19.1.6. Handling conflicts with other packages
2492: 19.1.7. Packages that cannot or should not be built
2493: 19.1.8. Packages which should not be deleted, once installed
2494: 19.1.9. Handling packages with security problems
2495: 19.1.10. How to handle incrementing versions when fixing an existing
1.1 dsieger 2496: package
1.108 rillig 2497: 19.1.11. Substituting variable text in the package files (the SUBST
1.1 dsieger 2498: framework)
2499:
1.108 rillig 2500: 19.2. The fetch phase
1.1 dsieger 2501:
1.6 rillig 2502: 19.2.1. Packages whose distfiles aren't available for plain downloading
2503: 19.2.2. How to handle modified distfiles with the 'old' name
1.88 tnn 2504: 19.2.3. Packages hosted on github.com
1.1 dsieger 2505:
1.108 rillig 2506: 19.3. The configure phase
1.1 dsieger 2507:
1.6 rillig 2508: 19.3.1. Shared libraries - libtool
2509: 19.3.2. Using libtool on GNU packages that already support libtool
2510: 19.3.3. GNU Autoconf/Automake
2511:
2512: 19.4. Programming languages
2513:
2514: 19.4.1. C, C++, and Fortran
2515: 19.4.2. Java
2516: 19.4.3. Packages containing perl scripts
1.41 wiz 2517: 19.4.4. Packages containing shell scripts
2518: 19.4.5. Other programming languages
1.6 rillig 2519:
1.108 rillig 2520: 19.5. The build phase
1.6 rillig 2521:
2522: 19.5.1. Compiling C and C++ code conditionally
2523: 19.5.2. How to handle compiler bugs
1.24 wiz 2524: 19.5.3. Undefined reference to "..."
1.6 rillig 2525: 19.5.4. Running out of memory
2526:
1.108 rillig 2527: 19.6. The install phase
1.6 rillig 2528:
2529: 19.6.1. Creating needed directories
2530: 19.6.2. Where to install documentation
2531: 19.6.3. Installing highscore files
2532: 19.6.4. Adding DESTDIR support to packages
2533: 19.6.5. Packages with hardcoded paths to other interpreters
2534: 19.6.6. Packages installing perl modules
2535: 19.6.7. Packages installing info files
2536: 19.6.8. Packages installing man pages
1.7 rillig 2537: 19.6.9. Packages installing GConf data files
1.18 mishka 2538: 19.6.10. Packages installing scrollkeeper/rarian data files
1.6 rillig 2539: 19.6.11. Packages installing X11 fonts
2540: 19.6.12. Packages installing GTK2 modules
2541: 19.6.13. Packages installing SGML or XML data
2542: 19.6.14. Packages installing extensions to the MIME database
2543: 19.6.15. Packages using intltool
2544: 19.6.16. Packages installing startup scripts
2545: 19.6.17. Packages installing TeX modules
2546: 19.6.18. Packages supporting running binaries in emulation
2547: 19.6.19. Packages installing hicolor theme icons
2548: 19.6.20. Packages installing desktop files
2549:
2550: 19.7. Marking packages as having problems
2551:
2552: 20. Debugging
2553: 21. Submitting and Committing
2554:
2555: 21.1. Submitting binary packages
2556: 21.2. Submitting source packages (for non-NetBSD-developers)
2557: 21.3. General notes when adding, updating, or removing packages
1.130 wiz 2558: 21.4. Commit Messages
2559: 21.5. Committing: Adding a package to CVS
2560: 21.6. Updating a package to a newer version
2561: 21.7. Renaming a package in pkgsrc
2562: 21.8. Moving a package in pkgsrc
1.6 rillig 2563:
2564: 22. Frequently Asked Questions
2565: 23. GNOME packaging and porting
2566:
2567: 23.1. Meta packages
2568: 23.2. Packaging a GNOME application
2569: 23.3. Updating GNOME to a newer version
2570: 23.4. Patching guidelines
1.1 dsieger 2571:
1.6 rillig 2572: Chapter 10. Creating a new pkgsrc package from scratch
1.1 dsieger 2573:
2574: Table of Contents
2575:
1.6 rillig 2576: 10.1. Common types of packages
1.1 dsieger 2577:
1.6 rillig 2578: 10.1.1. Perl modules
1.132 wiz 2579: 10.1.2. Python modules and programs
1.1 dsieger 2580:
1.6 rillig 2581: 10.2. Examples
1.1 dsieger 2582:
1.6 rillig 2583: 10.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 2584:
2585: When you find a package that is not yet in pkgsrc, you most likely have a URL
2586: from where you can download the source code. Starting with this URL, creating a
2587: package involves only a few steps.
2588:
2589: 1. First, install the packages pkgtools/url2pkg and pkgtools/pkglint.
2590:
2591: 2. Then, choose one of the top-level directories as the category in which you
2592: want to place your package. You can also create a directory of your own
2593: (maybe called local). In that category directory, create another directory
2594: for your package and change into it.
2595:
2596: 3. Run the program url2pkg, which will ask you for a URL. Enter the URL of the
2597: distribution file (in most cases a .tar.gz file) and watch how the basic
2598: ingredients of your package are created automatically. The distribution
2599: file is extracted automatically to fill in some details in the Makefile
2600: that would otherwise have to be done manually.
2601:
2602: 4. Examine the extracted files to determine the dependencies of your package.
2603: Ideally, this is mentioned in some README file, but things may differ. For
2604: each of these dependencies, look where it exists in pkgsrc, and if there is
2605: a file called buildlink3.mk in that directory, add a line to your package
2606: Makefile which includes that file just before the last line. If the
1.26 spz 2607: buildlink3.mk file does not exist, it must be created first. The
2608: buildlink3.mk file makes sure that the package's include files and
2609: libraries are provided.
2610:
2611: If you just need binaries from a package, add a DEPENDS line to the
2612: Makefile, which specifies the version of the dependency and where it can be
2613: found in pkgsrc. This line should be placed in the third paragraph. If the
1.1 dsieger 2614: dependency is only needed for building the package, but not when using it,
2615: use BUILD_DEPENDS instead of DEPENDS. Your package may then look like this:
2616:
2617: [...]
2618:
1.66 asau 2619: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 2620: DEPENDS+= screen-[0-9]*:../../misc/screen
2621: DEPENDS+= screen>=4.0:../../misc/screen
2622:
2623: [...]
2624:
2625: .include "../../category/package/buildlink3.mk"
2626: .include "../../devel/glib2/buildlink3.mk"
2627: .include "../../mk/bsd.pkg.mk"
2628:
2629: 5. Run pkglint to see what things still need to be done to make your package a
2630: "good" one. If you don't know what pkglint's warnings want to tell you, try
2631: pkglint --explain or pkglint -e, which outputs additional explanations.
2632:
2633: 6. In many cases the package is not yet ready to build. You can find
1.6 rillig 2634: instructions for the most common cases in the next section, Section 10.1,
1.1 dsieger 2635: "Common types of packages". After you have followed the instructions over
2636: there, you can hopefully continue here.
2637:
2638: 7. Run bmake clean to clean the working directory from the extracted files.
2639: Besides these files, a lot of cache files and other system information has
2640: been saved in the working directory, which may become wrong after you
2641: edited the Makefile.
2642:
2643: 8. Now, run bmake to build the package. For the various things that can go
1.6 rillig 2644: wrong in this phase, consult Chapter 19, Making your package work.
1.1 dsieger 2645:
1.25 wiz 2646: 9. When the package builds fine, the next step is to install the package. Run
1.1 dsieger 2647: bmake install and hope that everything works.
2648:
2649: 10. Up to now, the file PLIST, which contains a list of the files that are
2650: installed by the package, is nearly empty. Run bmake print-PLIST >PLIST to
2651: generate a probably correct list. Check the file using your preferred text
2652: editor to see if the list of files looks plausible.
2653:
2654: 11. Run pkglint again to see if the generated PLIST contains garbage or not.
2655:
2656: 12. When you ran bmake install, the package has been registered in the database
2657: of installed files, but with an empty list of files. To fix this, run bmake
2658: deinstall and bmake install again. Now the package is registered with the
2659: list of files from PLIST.
2660:
2661: 13. Run bmake package to create a binary package from the set of installed
2662: files.
2663:
1.6 rillig 2664: 10.1. Common types of packages
1.1 dsieger 2665:
1.6 rillig 2666: 10.1.1. Perl modules
1.1 dsieger 2667:
2668: Simple Perl modules are handled automatically by url2pkg, including
2669: dependencies.
2670:
1.132 wiz 2671: 10.1.2. Python modules and programs
1.17 imil 2672:
2673: Python modules and programs packages are easily created using a set of
2674: predefined variables.
2675:
1.63 wiz 2676: If some Python versions are not supported by the software, set the
2677: PYTHON_VERSIONS_INCOMPATIBLE variable to the Python versions that are not
2678: supported, e.g.
1.17 imil 2679:
1.93 sevan 2680: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 2681:
1.103 wiz 2682: If the packaged software is a Python module, include one of ../../lang/python/
2683: egg.mk, ../../lang/python/distutils.mk, or ../../lang/python/extension.mk.
2684:
2685: Most Python packages use either "distutils" or easy-setup/setuptools ("eggs").
2686: if the packaged software is using setuptools, you only need to include "../../
2687: lang/python/egg.mk". Otherwise, if the software uses "distutils", include "..
2688: /../lang/python/distutils.mk". so pkgsrc will use this framework. "distutils"
2689: uses a script called setup.py, if the "distutils" driver is not called
2690: setup.py, set the PYSETUP variable to the name of the script.
2691:
2692: Either way, the package directory should be called "py-software" and PKGNAME
2693: should be set to "${PYPKGPREFIX}-${DISTNAME}", e.g.
1.17 imil 2694:
2695: DISTNAME= foopymodule-1.2.10
2696: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
2697:
1.63 wiz 2698: If it is an application, include "../../lang/python/application.mk". In order
2699: to correctly set the path to the Python interpreter, use the REPLACE_PYTHON
2700: variable and set it to the list of files (paths relative to WRKSRC) that must
2701: be corrected. For example:
1.17 imil 2702:
1.63 wiz 2703: REPLACE_PYTHON= *.py
1.17 imil 2704:
1.63 wiz 2705: Some Python modules have separate distributions for Python-2.x and Python-3.x
2706: support. In pkgsrc this is handled by the versioned_dependencies.mk file. Set
2707: PYTHON_VERSIONED_DEPENDENCIES to the list of packages that should be depended
2708: upon and include "../../lang/python/versioned_dependencies.mk", then the pkgsrc
2709: infrastructure will depend on the appropriate package version. For example:
1.17 imil 2710:
1.135 wiz 2711: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.63 wiz 2712:
2713: Look inside versioned_dependencies.mk for a list of supported packages.
1.17 imil 2714:
1.6 rillig 2715: 10.2. Examples
1.1 dsieger 2716:
1.6 rillig 2717: 10.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 2718:
1.6 rillig 2719: 10.2.1.1. The initial package
1.1 dsieger 2720:
2721: Looking at the file pkgsrc/doc/TODO, I saw that the "nvu" package has not yet
2722: been imported into pkgsrc. As the description says it has to do with the web,
2723: the obvious choice for the category is "www".
2724:
2725: $ mkdir www/nvu
2726: $ cd www/nvu
2727:
2728: The web site says that the sources are available as a tar file, so I fed that
2729: URL to the url2pkg program:
2730:
2731: $ url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
2732:
2733: My editor popped up, and I added a PKGNAME line below the DISTNAME line, as the
2734: package name should not have the word "sources" in it. I also filled in the
2735: MAINTAINER, HOMEPAGE and COMMENT fields. Then the package Makefile looked like
2736: that:
2737:
1.121 sevan 2738: # $NetBSD $
1.1 dsieger 2739: #
2740:
2741: DISTNAME= nvu-1.0-sources
2742: PKGNAME= nvu-1.0
2743: CATEGORIES= www
2744: MASTER_SITES= http://cvs.nvu.com/download/
2745: EXTRACT_SUFX= .tar.bz2
2746:
2747: MAINTAINER= rillig@NetBSD.org
2748: HOMEPAGE= http://cvs.nvu.com/
2749: COMMENT= Web Authoring System
2750:
2751: # url2pkg-marker (please do not remove this line.)
2752: .include "../../mk/bsd.pkg.mk"
2753:
1.124 wiz 2754: On the first line of output above, an artificial space has been added between
1.121 sevan 2755: NetBSD and $, this is a workaround to prevent CVS expanding to the filename of
2756: the guide.
2757:
1.1 dsieger 2758: Then, I quit the editor and watched pkgsrc downloading a large source archive:
2759:
2760: url2pkg> Running "make makesum" ...
2761: => Required installed package digest>=20010302: digest-20060826 found
2762: => Fetching nvu-1.0-sources.tar.bz2
2763: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
2764: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
2765: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
2766: url2pkg> Running "make extract" ...
2767: => Required installed package digest>=20010302: digest-20060826 found
2768: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
2769: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
2770: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
2771: ===> Installing dependencies for nvu-1.0
2772: ===> Overriding tools for nvu-1.0
2773: ===> Extracting for nvu-1.0
2774: url2pkg> Adjusting the Makefile.
2775:
2776: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
2777:
2778: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
2779:
1.6 rillig 2780: 10.2.1.2. Fixing all kinds of problems to make the package work
1.1 dsieger 2781:
2782: Now that the package has been extracted, let's see what's inside it. The
2783: package has a README.txt, but that only says something about mozilla, so it's
2784: probably useless for seeing what dependencies this package has. But since there
2785: is a GNU configure script in the package, let's hope that it will complain
2786: about everything it needs.
2787:
2788: $ bmake
2789: => Required installed package digest>=20010302: digest-20060826 found
2790: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
2791: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
2792: ===> Patching for nvu-1.0
2793: ===> Creating toolchain wrappers for nvu-1.0
2794: ===> Configuring for nvu-1.0
2795: [...]
2796: configure: error: Perl 5.004 or higher is required.
2797: [...]
2798: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
2799: [...]
2800:
2801: That worked quite well. So I opened the package Makefile in my editor, and
2802: since it already has a USE_TOOLS line, I just appended "perl" to it. Since the
2803: dependencies of the package have changed now, and since a perl wrapper is
2804: automatically installed in the "tools" phase, I need to build the package from
2805: scratch.
2806:
2807: $ bmake clean
2808: ===> Cleaning for nvu-1.0
2809: $ bmake
2810: [...]
2811: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
2812: GNU Make. You will not be able to build Mozilla without GNU Make.
2813: [...]
2814:
2815: So I added "gmake" to the USE_TOOLS line and tried again (from scratch).
2816:
2817: [...]
2818: checking for GTK - version >= 1.2.0... no
2819: *** Could not run GTK test program, checking why...
2820: [...]
2821:
2822: Now to the other dependencies. The first question is: Where is the GTK package
2823: hidden in pkgsrc?
2824:
2825: $ echo ../../*/gtk*
2826: [many packages ...]
2827: $ echo ../../*/gtk
2828: ../../x11/gtk
2829: $ echo ../../*/gtk2
2830: ../../x11/gtk2
2831: $ echo ../../*/gtk2/bui*
2832: ../../x11/gtk2/buildlink3.mk
2833:
2834: The first try was definitely too broad. The second one had exactly one result,
2835: which is very good. But there is one pitfall with GNOME packages. Before GNOME
2836: 2 had been released, there were already many GNOME 1 packages in pkgsrc. To be
2837: able to continue to use these packages, the GNOME 2 packages were imported as
2838: separate packages, and their names usually have a "2" appended. So I checked
2839: whether this was the case here, and indeed it was.
2840:
2841: Since the GTK2 package has a buildlink3.mk file, adding the dependency is very
2842: easy. I just inserted an .include line before the last line of the package
2843: Makefile, so that it now looks like this:
2844:
2845: [...]
2846: .include "../../x11/gtk2/buildlink3.mk"
2847: .include "../../mk/bsd.pkg.mk
2848:
2849: After another bmake clean && bmake, the answer was:
2850:
2851: [...]
2852: checking for gtk-config... /home/roland/pkg/bin/gtk-config
2853: checking for GTK - version >= 1.2.0... no
2854: *** Could not run GTK test program, checking why...
2855: *** The test program failed to compile or link. See the file config.log for the
2856: *** exact error that occured. This usually means GTK was incorrectly installed
2857: *** or that you have moved GTK since it was installed. In the latter case, you
2858: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
2859: configure: error: Test for GTK failed.
2860: [...]
2861:
2862: In this particular case, the assumption that "every package prefers GNOME 2"
2863: had been wrong. The first of the lines above told me that this package really
2864: wanted to have the GNOME 1 version of GTK. If the package had looked for GTK2,
2865: it would have looked for pkg-config instead of gtk-config. So I changed the x11
2866: /gtk2 to x11/gtk in the package Makefile, and tried again.
2867:
2868: [...]
1.59 jnemeth 2869: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 2870: In file included from xpidl.c:42:
2871: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
2872: In file included from xpidl.c:42:
2873: xpidl.h:132: error: parse error before "IDL_ns"
2874: [...]
2875:
2876: The package still does not find all of its dependencies. Now the question is:
2877: Which package provides the libIDL/IDL.h header file?
2878:
2879: $ echo ../../*/*idl*
2880: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
2881: $ echo ../../*/*IDL*
2882: ../../net/libIDL
2883:
2884: Let's take the one from the second try. So I included the ../../net/libIDL/
2885: buildlink3.mk file and tried again. But the error didn't change. After digging
2886: through some of the code, I concluded that the build process of the package was
2887: broken and couldn't have ever worked, but since the Mozilla source tree is
2888: quite large, I didn't want to fix it. So I added the following to the package
2889: Makefile and tried again:
2890:
2891: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.139 leot 2892: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.1 dsieger 2893:
2894: The latter line is needed because the package expects the library libIDL.so,
2895: but only libIDL-2.so is available. So I told the compiler wrapper to rewrite
2896: that on the fly.
2897:
2898: The next problem was related to a recent change of the FreeType interface. I
2899: looked up in www/seamonkey which patch files were relevant for this issue and
2900: copied them to the patches directory. Then I retried, fixed the patches so that
2901: they applied cleanly and retried again. This time, everything worked.
2902:
1.6 rillig 2903: 10.2.1.3. Installing the package
1.1 dsieger 2904:
2905: $ bmake CHECK_FILES=no install
2906: [...]
2907: $ bmake print-PLIST >PLIST
2908: $ bmake deinstall
2909: $ bmake install
2910:
1.6 rillig 2911: Chapter 11. Package components - files, directories and contents
1.1 dsieger 2912:
2913: Table of Contents
2914:
1.6 rillig 2915: 11.1. Makefile
2916: 11.2. distinfo
2917: 11.3. patches/*
2918:
2919: 11.3.1. Structure of a single patch file
2920: 11.3.2. Creating patch files
2921: 11.3.3. Sources where the patch files come from
2922: 11.3.4. Patching guidelines
2923: 11.3.5. Feedback to the author
2924:
2925: 11.4. Other mandatory files
2926: 11.5. Optional files
2927:
2928: 11.5.1. Files affecting the binary package
2929: 11.5.2. Files affecting the build process
2930: 11.5.3. Files affecting nothing at all
1.1 dsieger 2931:
1.6 rillig 2932: 11.6. work*
2933: 11.7. files/*
1.1 dsieger 2934:
2935: Whenever you're preparing a package, there are a number of files involved which
2936: are described in the following sections.
2937:
1.6 rillig 2938: 11.1. Makefile
1.1 dsieger 2939:
2940: Building, installation and creation of a binary package are all controlled by
2941: the package's Makefile. The Makefile describes various things about a package,
2942: for example from where to get it, how to configure, build, and install it.
2943:
2944: A package Makefile contains several sections that describe the package.
2945:
2946: In the first section there are the following variables, which should appear
2947: exactly in the order given here. The order and grouping of the variables is
2948: mostly historical and has no further meaning.
2949:
2950: * DISTNAME is the basename of the distribution file to be downloaded from the
2951: package's website.
2952:
1.66 asau 2953: * PKGNAME is the name of the package, as used by pkgsrc. You need to provide
2954: it if DISTNAME (which is the default) is not a good name for the package in
2955: pkgsrc or DISTNAME is not provided (no distribution file is required).
2956: Usually it is the pkgsrc directory name together with the version number.
2957: It must match the regular expression ^[A-Za-z0-9][A-Za-z0-9-_.+]*$, that
2958: is, it starts with a letter or digit, and contains only letters, digits,
2959: dashes, underscores, dots and plus signs.
1.1 dsieger 2960:
2961: * CATEGORIES is a list of categories which the package fits in. You can
2962: choose any of the top-level directories of pkgsrc for it.
2963:
2964: Currently the following values are available for CATEGORIES. If more than
2965: one is used, they need to be separated by spaces:
2966:
2967: archivers cross geography meta-pkgs security
2968: audio databases graphics misc shells
2969: benchmarks devel ham multimedia sysutils
2970: biology editors inputmethod net textproc
2971: cad emulators lang news time
2972: chat finance mail parallel wm
2973: comms fonts math pkgtools www
2974: converters games mbone print x11
2975:
2976: * MASTER_SITES, DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES
1.6 rillig 2977: are discussed in detail in Section 17.5, "The fetch phase".
1.1 dsieger 2978:
2979: The second section contains information about separately downloaded patches, if
2980: any.
2981:
2982: * PATCHFILES: Name(s) of additional files that contain distribution patches.
2983: There is no default. pkgsrc will look for them at PATCH_SITES. They will
2984: automatically be uncompressed before patching if the names end with .gz or
2985: .Z.
2986:
2987: * PATCH_SITES: Primary location(s) for distribution patch files (see
1.80 wiz 2988: PATCHFILES above) if not found locally.
2989:
2990: * PATCH_DIST_STRIP: an argument to patch(1) that sets the pathname strip
2991: count to help find the correct files to patch. It defaults to -p0.
1.1 dsieger 2992:
2993: The third section contains the following variables.
2994:
2995: * MAINTAINER is the email address of the person who feels responsible for
2996: this package, and who is most likely to look at problems or questions
2997: regarding this package which have been reported with send-pr(1). Other
1.14 jmcneill 2998: developers may contact the MAINTAINER before making changes to the package,
2999: but are not required to do so. When packaging a new program, set MAINTAINER
3000: to yourself. If you really can't maintain the package for future updates,
3001: set it to <pkgsrc-users@NetBSD.org>.
3002:
3003: * OWNER should be used instead of MAINTAINER when you do not want other
3004: developers to update or change the package without contacting you first. A
3005: package Makefile should contain one of MAINTAINER or OWNER, but not both.
1.1 dsieger 3006:
3007: * HOMEPAGE is a URL where users can find more information about the package.
3008:
3009: * COMMENT is a one-line description of the package (should not include the
3010: package name).
3011:
1.122 leot 3012: * LICENSE indicates the license(s) applicable for the package. See
3013: Section 19.1.3, "Handling licenses" for further details.
3014:
1.1 dsieger 3015: Other variables that affect the build:
3016:
3017: * WRKSRC: The directory where the interesting distribution files of the
3018: package are found. The default is ${WRKDIR}/${DISTNAME}, which works for
3019: most packages.
3020:
3021: If a package doesn't create a subdirectory for itself (most GNU software
3022: does, for instance), but extracts itself in the current directory, you
3023: should set WRKSRC=${WRKDIR}.
3024:
3025: If a package doesn't create a subdirectory with the name of DISTNAME but
3026: some different name, set WRKSRC to point to the proper name in ${WRKDIR},
3027: for example WRKSRC=${WRKDIR}/${DISTNAME}/unix. See lang/tcl and x11/tk for
3028: other examples.
3029:
3030: The name of the working directory created by pkgsrc is taken from the
3031: WRKDIR_BASENAME variable. By default, its value is work. If you want to use
3032: the same pkgsrc tree for building different kinds of binary packages, you
3033: can change the variable according to your needs. Two other variables handle
3034: common cases of setting WRKDIR_BASENAME individually. If OBJHOSTNAME is
1.4 rillig 3035: defined in mk.conf, the first component of the host's name is attached to
3036: the directory name. If OBJMACHINE is defined, the platform name is
1.1 dsieger 3037: attached, which might look like work.i386 or work.sparc.
3038:
3039: Please pay attention to the following gotchas:
3040:
3041: * Add MANCOMPRESSED if man pages are installed in compressed form by the
3042: package. For packages using BSD-style makefiles which honor MANZ, there is
3043: MANCOMPRESSED_IF_MANZ.
3044:
3045: * Replace /usr/local with "${PREFIX}" in all files (see patches, below).
3046:
1.6 rillig 3047: * If the package installs any info files, see Section 19.6.7, "Packages
1.1 dsieger 3048: installing info files".
3049:
1.6 rillig 3050: 11.2. distinfo
1.1 dsieger 3051:
3052: The distinfo file contains the message digest, or checksum, of each distfile
3053: needed for the package. This ensures that the distfiles retrieved from the
3054: Internet have not been corrupted during transfer or altered by a malign force
1.108 rillig 3055: to introduce a security hole. To provide maximum security, all distfiles are
3056: protected using three different message digest algorithms (SHA1, RMD160,
3057: SHA512), as well as the file size.
1.1 dsieger 3058:
3059: The distinfo file also contains the checksums for all the patches found in the
1.145 leot 3060: patches directory (see Section 11.3, "patches/*"). These checksums ensure that
3061: patches are only applied intentionally and that they don't accidentally change,
3062: e.g. when merging different changes together. They also make sure that new
3063: patches are actually added to CVS and old ones are removed. Too see whether the
3064: patches and the distinfo file match, run pkglint after changing the patches.
1.1 dsieger 3065:
1.108 rillig 3066: To regenerate the distinfo file, use the make distinfo command.
1.1 dsieger 3067:
3068: Some packages have different sets of distfiles depending on the platform, for
1.24 wiz 3069: example lang/openjdk7. These are kept in the same distinfo file and care should
3070: be taken when upgrading such a package to ensure distfile information is not
3071: lost.
1.1 dsieger 3072:
1.6 rillig 3073: 11.3. patches/*
1.1 dsieger 3074:
1.108 rillig 3075: Some packages don't work out-of-the box on the various platforms that are
3076: supported by pkgsrc. These packages need to be patched to make them work. The
3077: patch files can be found in the patches/ directory.
1.1 dsieger 3078:
3079: In the patch phase, these patches are applied to the files in WRKSRC directory
1.25 wiz 3080: after extracting them, in alphabetic order.
1.1 dsieger 3081:
1.6 rillig 3082: 11.3.1. Structure of a single patch file
1.1 dsieger 3083:
3084: The patch-* files should be in diff -bu format, and apply without a fuzz to
3085: avoid problems. (To force patches to apply with fuzz you can set
3086: PATCH_FUZZ_FACTOR=-F2). Furthermore, each patch should contain only changes for
3087: a single file, and no file should be patched by more than one patch file. This
3088: helps to keep future modifications simple.
3089:
3090: Each patch file is structured as follows: In the first line, there is the RCS
3091: Id of the patch itself. The second line should be empty for aesthetic reasons.
3092: After that, there should be a comment for each change that the patch does.
3093: There are a number of standard cases:
3094:
3095: * Patches for commonly known vulnerabilities should mention the vulnerability
3096: ID (CAN, CVE).
3097:
3098: * Patches that change source code should mention the platform and other
3099: environment (for example, the compiler) that the patch is needed for.
3100:
1.108 rillig 3101: The patch should be commented so that any developer who knows the code of the
3102: application can make some use of the patch. Special care should be taken for
3103: the upstream developers, since we generally want that they accept our patches,
3104: so we have less work in the future.
1.1 dsieger 3105:
1.6 rillig 3106: 11.3.2. Creating patch files
1.1 dsieger 3107:
3108: One important thing to mention is to pay attention that no RCS IDs get stored
3109: in the patch files, as these will cause problems when later checked into the
3110: NetBSD CVS tree. Use the pkgdiff command from the pkgtools/pkgdiff package to
3111: avoid these problems.
3112:
3113: For even more automation, we recommend using mkpatches from the same package to
3114: make a whole set of patches. You just have to backup files before you edit them
1.25 wiz 3115: to filename.orig, e.g. with cp -p filename filename.orig or, easier, by using
1.1 dsieger 3116: pkgvi again from the same package. If you upgrade a package this way, you can
1.25 wiz 3117: easily compare the new set of patches with the previously existing one with
3118: patchdiff. The files in patches are replaced by new files, so carefully check
3119: if you want to take all the changes.
1.1 dsieger 3120:
3121: When you have finished a package, remember to generate the checksums for the
1.6 rillig 3122: patch files by using the make makepatchsum command, see Section 11.2,
1.1 dsieger 3123: "distinfo".
3124:
3125: When adding a patch that corrects a problem in the distfile (rather than e.g.
3126: enforcing pkgsrc's view of where man pages should go), send the patch as a bug
3127: report to the maintainer. This benefits non-pkgsrc users of the package, and
3128: usually makes it possible to remove the patch in future version.
3129:
1.25 wiz 3130: The file names of the patch files are usually of the form patch-
3131: path_to_file__with__underscores.c. Many packages still use the previous
3132: convention patch-[a-z][a-z], but new patches should be of the form containing
3133: the filename. mkpatches included in pkgtools/pkgdiff takes care of the name
3134: automatically.
1.2 rillig 3135:
1.6 rillig 3136: 11.3.3. Sources where the patch files come from
1.1 dsieger 3137:
3138: If you want to share patches between multiple packages in pkgsrc, e.g. because
3139: they use the same distfiles, set PATCHDIR to the path where the patch files can
3140: be found, e.g.:
3141:
3142: PATCHDIR= ${.CURDIR}/../xemacs/patches
3143:
3144: Patch files that are distributed by the author or other maintainers can be
3145: listed in PATCHFILES.
3146:
3147: If it is desired to store any patches that should not be committed into pkgsrc,
3148: they can be kept outside the pkgsrc tree in the $LOCALPATCHES directory. The
3149: directory tree there is expected to have the same "category/package" structure
3150: as pkgsrc, and patches are expected to be stored inside these dirs (also known
3151: as $LOCALPATCHES/$PKGPATH). For example, if you want to keep a private patch
3152: for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All
3153: files in the named directory are expected to be patch files, and they are
3154: applied after pkgsrc patches are applied.
3155:
1.6 rillig 3156: 11.3.4. Patching guidelines
1.1 dsieger 3157:
3158: When fixing a portability issue in the code do not use preprocessor magic to
3159: check for the current operating system nor platform. Doing so hurts portability
3160: to other platforms because the OS-specific details are not abstracted
3161: appropriately.
3162:
3163: The general rule to follow is: instead of checking for the operating system the
3164: application is being built on, check for the specific features you need. For
3165: example, instead of assuming that kqueue is available under NetBSD and using
3166: the __NetBSD__ macro to conditionalize kqueue support, add a check that detects
3167: kqueue itself ? yes, this generally involves patching the configure script.
3168: There is absolutely nothing that prevents some OSes from adopting interfaces
3169: from other OSes (e.g. Linux implementing kqueue), something that the above
3170: checks cannot take into account.
3171:
3172: Of course, checking for features generally involves more work on the
3173: developer's side, but the resulting changes are cleaner and there are chances
3174: they will work on many other platforms. Not to mention that there are higher
3175: chances of being later integrated into the mainstream sources. Remember: It
3176: doesn't work unless it is right!
3177:
3178: Some typical examples:
3179:
1.6 rillig 3180: Table 11.1. Patching examples
1.1 dsieger 3181:
3182: +-------------------------------------------------------------------------------------------+
3183: | Where | Incorrect | Correct |
3184: |---------+--------------------------+------------------------------------------------------|
3185: | |case ${target_os} in | |
3186: |configure|netbsd*) have_kvm=yes ;; |AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)|
3187: |script |*) have_kvm=no ;; | |
3188: | |esac | |
3189: |---------+--------------------------+------------------------------------------------------|
1.2 rillig 3190: |C source |#if defined(__NetBSD__) |#if defined(HAVE_SYS_EVENT_H) |
3191: |file |# include <sys/event.h> |# include <sys/event.h> |
3192: | |#endif |#endif |
1.1 dsieger 3193: |---------+--------------------------+------------------------------------------------------|
3194: | |int |int |
3195: | |monitor_file(...) |monitor_file(...) |
3196: | |{ |{ |
3197: | |#if defined(__NetBSD__) |#if defined(HAVE_KQUEUE) |
3198: |C source | int fd = kqueue();| int fd = kqueue(); |
3199: |file | ... | ... |
3200: | |#else |#else |
3201: | | ... | ... |
3202: | |#endif |#endif |
3203: | |} |} |
3204: +-------------------------------------------------------------------------------------------+
3205:
3206:
1.6 rillig 3207: 11.3.5. Feedback to the author
1.1 dsieger 3208:
3209: Always, always, always feed back any portability fixes or improvements you do
3210: to a package to the mainstream developers. This is the only way to get their
3211: attention on portability issues and to ensure that future versions can be built
3212: out-of-the box on NetBSD. Furthermore, any user that gets newer distfiles will
3213: get the fixes straight from the packaged code.
3214:
3215: This generally involves cleaning up the patches (because sometimes the patches
1.41 wiz 3216: that are added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 3217: appropriate trackers for the projects and working with the mainstream authors
3218: to accept your changes. It is extremely important that you do it so that the
3219: packages in pkgsrc are kept simple and thus further changes can be done without
3220: much hassle.
3221:
1.25 wiz 3222: When you have done this, please add a URL to the upstream bug report to the
3223: patch comment.
3224:
1.1 dsieger 3225: Support the idea of free software!
3226:
1.6 rillig 3227: 11.4. Other mandatory files
1.1 dsieger 3228:
3229: DESCR
3230:
3231: A multi-line description of the piece of software. This should include any
3232: credits where they are due. Please bear in mind that others do not share
3233: your sense of humour (or spelling idiosyncrasies), and that others will
3234: read everything that you write here.
3235:
3236: PLIST
3237:
3238: This file governs the files that are installed on your system: all the
3239: binaries, manual pages, etc. There are other directives which may be
3240: entered in this file, to control the creation and deletion of directories,
1.6 rillig 3241: and the location of inserted files. See Chapter 13, PLIST issues for more
1.1 dsieger 3242: information.
3243:
1.6 rillig 3244: 11.5. Optional files
1.1 dsieger 3245:
1.6 rillig 3246: 11.5.1. Files affecting the binary package
1.1 dsieger 3247:
3248: INSTALL
3249:
3250: This shell script is invoked twice by pkg_add(1). First time after package
3251: extraction and before files are moved in place, the second time after the
3252: files to install are moved in place. This can be used to do any custom
3253: procedures not possible with @exec commands in PLIST. See pkg_add(1) and
1.6 rillig 3254: pkg_create(1) for more information. See also Section 15.1, "Files and
1.29 wiz 3255: directories outside the installation prefix". Please note that you can
3256: modify variables in it easily by using FILES_SUBST in the package's
3257: Makefile:
3258:
3259: FILES_SUBST+= SOMEVAR="somevalue"
3260:
3261: replaces "@SOMEVAR@" with "somevalue" in the INSTALL. By default,
3262: substitution is performed for PREFIX, LOCALBASE, X11BASE, VARBASE, and a
3263: few others, type make help topic=FILES_SUBST for a complete list.
1.1 dsieger 3264:
3265: DEINSTALL
3266:
3267: This script is executed before and after any files are removed. It is this
3268: script's responsibility to clean up any additional messy details around the
3269: package's installation, since all pkg_delete knows is how to delete the
3270: files created in the original distribution. See pkg_delete(1) and
1.29 wiz 3271: pkg_create(1) for more information. The same methods to replace variables
3272: can be used as for the INSTALL file.
1.1 dsieger 3273:
3274: MESSAGE
3275:
3276: This file is displayed after installation of the package. Useful for things
3277: like legal notices on almost-free software and hints for updating config
3278: files after installing modules for apache, PHP etc. Please note that you
3279: can modify variables in it easily by using MESSAGE_SUBST in the package's
3280: Makefile:
3281:
3282: MESSAGE_SUBST+= SOMEVAR="somevalue"
3283:
3284: replaces "${SOMEVAR}" with "somevalue" in MESSAGE. By default, substitution
1.99 sevan 3285: is performed for PKGNAME, PKGBASE, PREFIX, LOCALBASE, X11BASE,
1.16 jnemeth 3286: PKG_SYSCONFDIR, ROOT_GROUP, and ROOT_USER.
1.1 dsieger 3287:
3288: You can display a different or additional files by setting the MESSAGE_SRC
3289: variable. Its default is MESSAGE, if the file exists.
3290:
3291: ALTERNATIVES
3292:
1.66 asau 3293: This file is used by the alternatives framework. It creates, configures,
3294: and destroys generic wrappers used to run programs with similar interfaces.
3295: See pkg_alternatives(8) from pkgtools/pkg_alternatives for more
3296: information.
3297:
3298: Each line of the file contains two filenames, first the wrapper and then
3299: the alternative provided by the package. Both paths are relative to PREFIX.
1.1 dsieger 3300:
1.6 rillig 3301: 11.5.2. Files affecting the build process
1.1 dsieger 3302:
3303: Makefile.common
3304:
3305: This file contains arbitrary things that could also go into a Makefile, but
3306: its purpose is to be used by more than one package. This file should only
3307: be used when the packages that will use the file are known in advance. For
3308: other purposes it is often better to write a *.mk file and give it a good
3309: name that describes what it does.
3310:
3311: buildlink3.mk
3312:
3313: This file contains the dependency information for the buildlink3 framework
1.6 rillig 3314: (see Chapter 14, Buildlink methodology).
1.1 dsieger 3315:
3316: hacks.mk
3317:
3318: This file contains workarounds for compiler bugs and similar things. It is
3319: included automatically by the pkgsrc infrastructure, so you don't need an
3320: extra .include line for it.
3321:
3322: options.mk
3323:
3324: This file contains the code for the package-specific options (see
1.6 rillig 3325: Chapter 16, Options handling) that can be selected by the user. If a
1.1 dsieger 3326: package has only one or two options, it is equally acceptable to put the
3327: code directly into the Makefile.
3328:
1.6 rillig 3329: 11.5.3. Files affecting nothing at all
1.1 dsieger 3330:
3331: README*
3332:
3333: These files do not take place in the creation of a package and thus are
3334: purely informative to the package developer.
3335:
3336: TODO
3337:
3338: This file contains things that need to be done to make the package even
3339: better.
3340:
1.6 rillig 3341: 11.6. work*
1.1 dsieger 3342:
3343: When you type make, the distribution files are unpacked into the directory
3344: denoted by WRKDIR. It can be removed by running make clean. Besides the
3345: sources, this directory is also used to keep various timestamp files. The
3346: directory gets removed completely on clean. The default is ${.CURDIR}/work or $
3347: {.CURDIR}/work.${MACHINE_ARCH} if OBJMACHINE is set.
3348:
1.6 rillig 3349: 11.7. files/*
1.1 dsieger 3350:
3351: If you have any files that you wish to be placed in the package prior to
3352: configuration or building, you could place these files here and use a ${CP}
3353: command in the "pre-configure" target to achieve this. Alternatively, you could
3354: simply diff the file against /dev/null and use the patch mechanism to manage
3355: the creation of this file.
3356:
3357: If you want to share files in this way with other packages, set the FILESDIR
3358: variable to point to the other package's files directory, e.g.:
3359:
3360: FILESDIR=${.CURDIR}/../xemacs/files
3361:
1.6 rillig 3362: Chapter 12. Programming in Makefiles
1.1 dsieger 3363:
3364: Table of Contents
3365:
1.6 rillig 3366: 12.1. Caveats
3367: 12.2. Makefile variables
1.1 dsieger 3368:
1.6 rillig 3369: 12.2.1. Naming conventions
1.1 dsieger 3370:
1.6 rillig 3371: 12.3. Code snippets
1.1 dsieger 3372:
1.6 rillig 3373: 12.3.1. Adding things to a list
1.117 sevan 3374: 12.3.2. Echoing a string exactly as-is
1.108 rillig 3375: 12.3.3. Passing CFLAGS to GNU configure scripts
3376: 12.3.4. Handling possibly empty variables
1.1 dsieger 3377:
3378: Pkgsrc consists of many Makefile fragments, each of which forms a well-defined
3379: part of the pkgsrc system. Using the make(1) system as a programming language
3380: for a big system like pkgsrc requires some discipline to keep the code correct
3381: and understandable.
3382:
3383: The basic ingredients for Makefile programming are variables (which are
3384: actually macros) and shell commands. Among these shell commands may even be
3385: more complex ones like awk(1) programs. To make sure that every shell command
3386: runs as intended it is necessary to quote all variables correctly when they are
3387: used.
3388:
3389: This chapter describes some patterns, that appear quite often in Makefiles,
3390: including the pitfalls that come along with them.
3391:
1.6 rillig 3392: 12.1. Caveats
1.1 dsieger 3393:
3394: * When you are creating a file as a target of a rule, always write the data
3395: to a temporary file first and finally rename that file. Otherwise there
3396: might occur an error in the middle of generating the file, and when the
3397: user runs make(1) for the second time, the file exists and will not be
3398: regenerated properly. Example:
3399:
3400: wrong:
3401: @echo "line 1" > ${.TARGET}
3402: @echo "line 2" >> ${.TARGET}
3403: @false
3404:
3405: correct:
3406: @echo "line 1" > ${.TARGET}.tmp
3407: @echo "line 2" >> ${.TARGET}.tmp
3408: @false
3409: @mv ${.TARGET}.tmp ${.TARGET}
3410:
3411: When you run make wrong twice, the file wrong will exist, although there
3412: was an error message in the first run. On the other hand, running make
3413: correct gives an error message twice, as expected.
3414:
3415: You might remember that make(1) sometimes removes ${.TARGET} in case of
3416: error, but this only happens when it is interrupted, for example by
3417: pressing ^C. This does not happen when one of the commands fails (like
3418: false(1) above).
3419:
1.6 rillig 3420: 12.2. Makefile variables
1.1 dsieger 3421:
3422: Makefile variables contain strings that can be processed using the five
3423: operators ``='', ``+='', ``?='', ``:='', and ``!='', which are described in the
3424: make(1) man page.
3425:
3426: When a variable's value is parsed from a Makefile, the hash character ``#'' and
3427: the backslash character ``\'' are handled specially. If a backslash is followed
3428: by a newline, any whitespace immediately in front of the backslash, the
3429: backslash, the newline, and any whitespace immediately behind the newline are
3430: replaced with a single space. A backslash character and an immediately
3431: following hash character are replaced with a single hash character. Otherwise,
3432: the backslash is passed as is. In a variable assignment, any hash character
1.138 leot 3433: that is not preceded by a backslash starts a comment that continues up to the
1.1 dsieger 3434: end of the logical line.
3435:
1.108 rillig 3436: The evaluation of variables either happens immediately or lazy. It happens
3437: immediately when the variable occurs on the right-hand side of the ``:='' or
3438: the ``!='' operator, in a .if condition or a .for loop. In the other cases, it
3439: is evaluated lazily.
1.1 dsieger 3440:
3441: Some of the modifiers split the string into words and then operate on the
3442: words, others operate on the string as a whole. When a string is split into
1.108 rillig 3443: words, it is split like in sh(1).
1.1 dsieger 3444:
3445: There are several types of variables that should be handled differently.
3446: Strings and two types of lists.
3447:
3448: * Strings can contain arbitrary characters. Nevertheless, you should restrict
3449: yourself to only using printable characters. Examples are PREFIX and
3450: COMMENT.
3451:
3452: * Internal lists are lists that are never exported to any shell command.
3453: Their elements are separated by whitespace. Therefore, the elements
3454: themselves cannot have embedded whitespace. Any other characters are
3455: allowed. Internal lists can be used in .for loops. Examples are DEPENDS and
3456: BUILD_DEPENDS.
3457:
3458: * External lists are lists that may be exported to a shell command. Their
3459: elements can contain any characters, including whitespace. That's why they
3460: cannot be used in .for loops. Examples are DISTFILES and MASTER_SITES.
3461:
1.6 rillig 3462: 12.2.1. Naming conventions
1.1 dsieger 3463:
3464: * All variable names starting with an underscore are reserved for use by the
3465: pkgsrc infrastructure. They shall not be used by package Makefiles.
3466:
3467: * In .for loops you should use lowercase variable names for the iteration
3468: variables.
3469:
3470: * All list variables should have a ``plural'' name, e.g. PKG_OPTIONS or
3471: DISTFILES.
3472:
1.6 rillig 3473: 12.3. Code snippets
1.1 dsieger 3474:
1.108 rillig 3475: 12.3.1. Adding things to a list
3476:
3477: When adding a string that possibly contains whitespace or quotes to a list
3478: (example 1), it must be quoted using the :Q modifier.
1.1 dsieger 3479:
1.108 rillig 3480: When adding another list to a list (example 2), it must not be quoted, since
3481: its elements are already quoted.
1.1 dsieger 3482:
1.108 rillig 3483: STRING= foo * bar `date`
3484: LIST= # empty
3485: ANOTHER_LIST= a=b c=d
1.1 dsieger 3486:
1.108 rillig 3487: LIST+= ${STRING:Q} # 1
3488: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 3489:
1.117 sevan 3490: 12.3.2. Echoing a string exactly as-is
1.1 dsieger 3491:
1.108 rillig 3492: Echoing a string containing special characters needs special work.
1.1 dsieger 3493:
3494: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 3495: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 3496:
3497: all:
3498: echo ${STRING} # 1
1.108 rillig 3499: echo ${STRING:Q} # 2
3500: printf '%s\n' ${STRING:Q}'' # 3
3501: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 3502:
3503: Example 1 leads to a syntax error in the shell, as the characters are just
3504: copied.
3505:
1.108 rillig 3506: Example 2 quotes the string so that the shell interprets it correctly. But the
3507: echo command may additionally interpret strings with a leading dash or those
3508: containing backslashes.
3509:
3510: Example 3 can handle arbitrary strings, since printf(1) only interprets the
1.139 leot 3511: format string, but not the next argument. The trailing single quotes handle the
3512: case when the string is empty. In that case, the :Q modifier would result in an
3513: empty string too, which would then be skipped by the shell. For printf(1) this
3514: doesn't make a difference, but other programs may care.
1.108 rillig 3515:
3516: In example 4, the EXAMPLE_ENV does not need to be quoted because the quoting
3517: has already been done when adding elements to the list.
3518:
3519: 12.3.3. Passing CFLAGS to GNU configure scripts
3520:
3521: When passing CFLAGS or similar variables to a GNU-style configure script
3522: (especially those that call other configure scripts), it must not have leading
3523: or trailing whitespace, since otherwise the configure script gets confused. To
3524: trim leading and trailing whitespace, use the :M modifier, as in the following
3525: example:
3526:
3527: CPPFLAGS= # empty
3528: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
3529: CPPFLAGS+= ${MY_CPPFLAGS}
3530:
3531: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
3532:
3533: all:
3534: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
3535: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
3536:
3537: In this example, CPPFLAGS has both leading and trailing whitespace because the
3538: += operator always adds a space.
3539:
3540: 12.3.4. Handling possibly empty variables
3541:
3542: When a possibly empty variable is used in a shell program, it may lead to a
3543: syntax error.
3544:
3545: EGFILES= # empty
3546:
3547: install-examples: # produces a syntax error in the shell
3548: for egfile in ${EGFILES}; do \
3549: echo "Installing $$egfile"; \
3550: done
3551:
3552: The shell only sees the text for egfile in ; do, since ${EGFILES} is replaced
3553: with an empty string by make(1). To fix this syntax error, use one of the
3554: snippets below.
3555:
3556: EMPTY= # empty
3557:
3558: install-examples:
3559: for egfile in ${EGFILES} ""; do \
3560: [ -n "$$egfile" ] || continue; \
3561: echo "Installing $$egfile"; \
3562: done
3563:
3564: In this case, an empty string is appended to the iteration list (to prevent the
3565: syntax error) and filtered out later.
1.1 dsieger 3566:
1.108 rillig 3567: EGFILES= # empty
1.1 dsieger 3568:
1.108 rillig 3569: install-examples:
3570: .for egfile in ${EGFILES}
3571: echo "Installing ${egfile}"
3572: .endfor
3573:
3574: This variant only works when EGFILES does not contain filenames with spaces,
3575: since the .for loop splits on simple whitespace.
3576:
3577: To have a shell command test whether a make variable is empty, use the
3578: following code: ${TEST} -z ${POSSIBLY_EMPTY:Q}"".
1.1 dsieger 3579:
1.6 rillig 3580: Chapter 13. PLIST issues
1.1 dsieger 3581:
3582: Table of Contents
3583:
1.6 rillig 3584: 13.1. RCS ID
3585: 13.2. Semi-automatic PLIST generation
3586: 13.3. Tweaking output of make print-PLIST
3587: 13.4. Variable substitution in PLIST
3588: 13.5. Man page compression
3589: 13.6. Changing PLIST source with PLIST_SRC
3590: 13.7. Platform-specific and differing PLISTs
1.86 wiz 3591: 13.8. Build-specific PLISTs
3592: 13.9. Sharing directories between packages
1.1 dsieger 3593:
3594: The PLIST file contains a package's "packing list", i.e. a list of files that
3595: belong to the package (relative to the ${PREFIX} directory it's been installed
3596: in) plus some additional statements - see the pkg_create(1) man page for a full
3597: list. This chapter addresses some issues that need attention when dealing with
3598: the PLIST file (or files, see below!).
3599:
1.6 rillig 3600: 13.1. RCS ID
1.1 dsieger 3601:
3602: Be sure to add a RCS ID line as the first thing in any PLIST file you write:
3603:
1.121 sevan 3604: @comment $NetBSD $
3605:
1.123 wiz 3606: An artificial space has been added between NetBSD and $, this is a workaround
1.121 sevan 3607: here to prevent CVS expanding to the filename of the guide. When adding the RCS
1.125 leot 3608: ID the space should be omitted.
1.1 dsieger 3609:
1.6 rillig 3610: 13.2. Semi-automatic PLIST generation
1.1 dsieger 3611:
3612: You can use the make print-PLIST command to output a PLIST that matches any new
1.6 rillig 3613: files since the package was extracted. See Section 17.17, "Other helpful
1.1 dsieger 3614: targets" for more information on this target.
3615:
1.6 rillig 3616: 13.3. Tweaking output of make print-PLIST
1.1 dsieger 3617:
3618: The PRINT_PLIST_AWK variable takes a set of AWK patterns and actions that are
3619: used to filter the output of print-PLIST. You can append any chunk of AWK
3620: scripting you like to it, but be careful with quoting.
3621:
3622: For example, to get all files inside the libdata/foo directory removed from the
3623: resulting PLIST:
3624:
3625: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
3626:
1.6 rillig 3627: 13.4. Variable substitution in PLIST
1.1 dsieger 3628:
3629: A number of variables are substituted automatically in PLISTs when a package is
3630: installed on a system. This includes the following variables:
3631:
3632: ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
3633:
3634: Some packages like emacs and perl embed information about which
3635: architecture they were built on into the pathnames where they install their
3636: files. To handle this case, PLIST will be preprocessed before actually
3637: used, and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p
3638: gives. The same is done if the string ${MACHINE_GNU_ARCH} is embedded in
3639: PLIST somewhere - use this on packages that have GNU autoconf-created
3640: configure scripts.
3641:
3642: Legacy note
3643:
3644: There used to be a symbol "$ARCH" that was replaced by the output of uname
3645: -m, but that's no longer supported and has been removed.
3646:
3647: ${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}
3648:
3649: Some packages want to embed the OS name and version into some paths. To do
3650: this, use these variables in the PLIST:
3651:
1.42 asau 3652: + ${OPSYS} - output of "uname -s"
1.1 dsieger 3653:
1.42 asau 3654: + ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
1.1 dsieger 3655:
1.42 asau 3656: + ${OS_VERSION} - "uname -r"
1.1 dsieger 3657:
1.88 tnn 3658: For a list of values which are replaced by default, the output of make help
3659: topic=PLIST_SUBST as well as searching the pkgsrc/mk directory with grep for
3660: PLIST_SUBST should help.
1.1 dsieger 3661:
3662: If you want to change other variables not listed above, you can add variables
3663: and their expansions to this variable in the following way, similar to
1.6 rillig 3664: MESSAGE_SUBST (see Section 11.5, "Optional files"):
1.1 dsieger 3665:
3666: PLIST_SUBST+= SOMEVAR="somevalue"
3667:
3668: This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue".
3669:
1.19 snj 3670: The PLIST_VARS variable can be used to simplify the common case of
3671: conditionally including some PLIST entries. It can be done by adding
3672: PLIST_VARS+=foo and setting the corresponding PLIST.foo variable to yes if the
3673: entry should be included. This will substitute "${PLIST.foo}" in the PLIST with
3674: either """" or ""@comment "". For example, in Makefile:
1.18 mishka 3675:
3676: PLIST_VARS+= foo
3677: .if condition
3678: PLIST.foo= yes
3679: .else
3680:
3681: And then in PLIST:
3682:
1.121 sevan 3683: @comment $NetBSD $
1.18 mishka 3684: bin/bar
3685: man/man1/bar.1
3686: ${PLIST.foo}bin/foo
3687: ${PLIST.foo}man/man1/foo.1
3688: ${PLIST.foo}share/bar/foo.data
3689:
1.123 wiz 3690: An artificial space has been added between NetBSD and $, this is a workaround
1.121 sevan 3691: here to prevent CVS expanding to the filename of the guide. When adding the RCS
3692: ID the space should be ommited.
3693:
1.6 rillig 3694: 13.5. Man page compression
1.1 dsieger 3695:
3696: Man pages should be installed in compressed form if MANZ is set (in
3697: bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the
3698: suffix ".gz" is appended/removed automatically for man pages according to MANZ
3699: and MANCOMPRESSED being set or not, see above for details. This modification of
3700: the PLIST file is done on a copy of it, not PLIST itself.
3701:
1.6 rillig 3702: 13.6. Changing PLIST source with PLIST_SRC
1.1 dsieger 3703:
3704: To use one or more files as source for the PLIST used in generating the binary
3705: package, set the variable PLIST_SRC to the names of that file(s). The files are
3706: later concatenated using cat(1), and the order of things is important. The
3707: default for PLIST_SRC is ${PKGDIR}/PLIST.
3708:
1.6 rillig 3709: 13.7. Platform-specific and differing PLISTs
1.1 dsieger 3710:
3711: Some packages decide to install a different set of files based on the operating
3712: system being used. These differences can be automatically handled by using the
3713: following files:
3714:
3715: * PLIST.common
3716:
3717: * PLIST.${OPSYS}
3718:
3719: * PLIST.${MACHINE_ARCH}
3720:
3721: * PLIST.${OPSYS}-${MACHINE_ARCH}
3722:
3723: * PLIST.common_end
3724:
1.86 wiz 3725: 13.8. Build-specific PLISTs
3726:
3727: Some packages decide to generate hard-to-guess file names during installation
3728: that are hard to wire down.
3729:
3730: In such cases, you can set the GENERATE_PLIST variable to shell code terminated
3731: (with a semicolon) that will output PLIST entries which will be appended to the
3732: PLIST
3733:
3734: You can find one example in editors/xemacs:
3735:
1.111 sevan 3736: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
1.86 wiz 3737:
3738: which will append something like bin/xemacs-21.4.23-54e8ea71.dmp to the PLIST.
3739:
3740: 13.9. Sharing directories between packages
1.1 dsieger 3741:
3742: A "shared directory" is a directory where multiple (and unrelated) packages
1.23 jakllsch 3743: install files. These directories were problematic because you had to add
1.1 dsieger 3744: special tricks in the PLIST to conditionally remove them, or have some
3745: centralized package handle them.
3746:
1.23 jakllsch 3747: In pkgsrc, it is now easy: Each package should create directories and install
3748: files as needed; pkg_delete will remove any directories left empty after
3749: uninstalling a package.
1.1 dsieger 3750:
1.23 jakllsch 3751: If a package needs an empty directory to work, create the directory during
3752: installation as usual, and also add an entry to the PLIST:
1.1 dsieger 3753:
1.23 jakllsch 3754: @pkgdir path/to/empty/directory
1.1 dsieger 3755:
1.86 wiz 3756: or take a look at MAKE_DIRS and OWN_DIRS.
3757:
1.6 rillig 3758: Chapter 14. Buildlink methodology
1.1 dsieger 3759:
3760: Table of Contents
3761:
1.6 rillig 3762: 14.1. Converting packages to use buildlink3
3763: 14.2. Writing buildlink3.mk files
1.1 dsieger 3764:
1.6 rillig 3765: 14.2.1. Anatomy of a buildlink3.mk file
1.27 wiz 3766: 14.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
3767: buildlink3.mk files
1.1 dsieger 3768:
1.6 rillig 3769: 14.3. Writing builtin.mk files
1.1 dsieger 3770:
1.6 rillig 3771: 14.3.1. Anatomy of a builtin.mk file
3772: 14.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 3773:
3774: Buildlink is a framework in pkgsrc that controls what headers and libraries are
3775: seen by a package's configure and build processes. This is implemented in a two
3776: step process:
3777:
3778: 1. Symlink headers and libraries for dependencies into BUILDLINK_DIR, which by
3779: default is a subdirectory of WRKDIR.
3780:
3781: 2. Create wrapper scripts that are used in place of the normal compiler tools
3782: that translate -I${LOCALBASE}/include and -L${LOCALBASE}/lib into
3783: references to BUILDLINK_DIR. The wrapper scripts also make native compiler
3784: on some operating systems look like GCC, so that packages that expect GCC
3785: won't require modifications to build with those native compilers.
3786:
3787: This normalizes the environment in which a package is built so that the package
3788: may be built consistently despite what other software may be installed. Please
3789: note that the normal system header and library paths, e.g. /usr/include, /usr/
3790: lib, etc., are always searched -- buildlink3 is designed to insulate the
3791: package build from non-system-supplied software.
3792:
1.6 rillig 3793: 14.1. Converting packages to use buildlink3
1.1 dsieger 3794:
1.25 wiz 3795: The process of converting packages to use the buildlink3 framework ("bl3ifying"
3796: ) is fairly straightforward. The things to keep in mind are:
1.1 dsieger 3797:
3798: 1. Ensure that the build always calls the wrapper scripts instead of the
3799: actual toolchain. Some packages are tricky, and the only way to know for
3800: sure is the check ${WRKDIR}/.work.log to see if the wrappers are being
3801: invoked.
3802:
3803: 2. Don't override PREFIX from within the package Makefile, e.g. Java VMs,
3804: standalone shells, etc., because the code to symlink files into $
3805: {BUILDLINK_DIR} looks for files relative to "pkg_info -qp pkgname".
3806:
3807: 3. Remember that only the buildlink3.mk files that you list in a package's
3808: Makefile are added as dependencies for that package.
3809:
3810: If a dependency on a particular package is required for its libraries and
3811: headers, then we replace:
3812:
3813: DEPENDS+= foo>=1.1.0:../../category/foo
3814:
3815: with
3816:
3817: .include "../../category/foo/buildlink3.mk"
3818:
3819: The buildlink3.mk files usually define the required dependencies. If you need a
3820: newer version of the dependency when using buildlink3.mk files, then you can
3821: define it in your Makefile; for example:
3822:
3823: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
3824: .include "../../category/foo/buildlink3.mk"
3825:
3826: There are several buildlink3.mk files in pkgsrc/mk that handle special package
3827: issues:
3828:
3829: * bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB
3830: implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT.
3831:
3832: * curses.buildlink3.mk: If the system comes with neither Curses nor NCurses,
3833: this will take care to install the devel/ncurses package.
3834:
3835: * krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding
3836: a dependency on Heimdal or MIT-krb5 for packages that require a Kerberos 5
3837: implementation.
3838:
3839: * motif.buildlink3.mk checks for a system-provided Motif installation or adds
1.126 leot 3840: a dependency on x11/lesstif or x11/motif. The user can set MOTIF_TYPE to "
3841: dt", "lesstif" or "motif" to choose which Motif version will be used.
1.1 dsieger 3842:
1.57 wiz 3843: * readline.buildlink3.mk checks for a system-provided GNU readline or
3844: editline (libedit) installation, or adds a dependency on devel/readline,
3845: devel/editline. The user can set READLINE_DEFAULT to choose readline
1.56 ryoon 3846: implementation. If your package really needs GNU readline library, its
3847: Makefile should include devel/readline/buildlink3.mk instead of
3848: readline.buildlink3.mk.
3849:
1.1 dsieger 3850: * oss.buildlink3.mk defines several variables that may be used by packages
3851: that use the Open Sound System (OSS) API.
3852:
1.36 wiz 3853: * pgsql.buildlink3.mk will accept any of the Postgres versions in the
3854: variable PGSQL_VERSIONS_ACCEPTED and default to the version
3855: PGSQL_VERSION_DEFAULT. See the file for more information.
1.1 dsieger 3856:
3857: * pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native
3858: pthreads or adds a dependency on devel/pth as needed.
3859:
3860: * xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena
3861: widgets library.
3862:
3863: The comments in those buildlink3.mk files provide a more complete description
3864: of how to use them properly.
3865:
1.6 rillig 3866: 14.2. Writing buildlink3.mk files
1.1 dsieger 3867:
3868: A package's buildlink3.mk file is included by Makefiles to indicate the need to
3869: compile and link against header files and libraries provided by the package. A
3870: buildlink3.mk file should always provide enough information to add the correct
3871: type of dependency relationship and include any other buildlink3.mk files that
3872: it needs to find headers and libraries that it needs in turn.
3873:
3874: To generate an initial buildlink3.mk file for further editing, Rene Hexel's
3875: pkgtools/createbuildlink package is highly recommended. For most packages, the
3876: following command will generate a good starting point for buildlink3.mk files:
3877:
3878: % cd pkgsrc/category/pkgdir
3879: % createbuildlink >buildlink3.mk
3880:
3881:
1.6 rillig 3882: 14.2.1. Anatomy of a buildlink3.mk file
1.1 dsieger 3883:
3884: The following real-life example buildlink3.mk is taken from pkgsrc/graphics/
3885: tiff:
3886:
1.19 snj 3887: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 3888:
1.19 snj 3889: BUILDLINK_TREE+= tiff
1.1 dsieger 3890:
1.19 snj 3891: .if !defined(TIFF_BUILDLINK3_MK)
3892: TIFF_BUILDLINK3_MK:=
1.1 dsieger 3893:
1.19 snj 3894: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
3895: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
1.1 dsieger 3896: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
3897:
3898: .include "../../devel/zlib/buildlink3.mk"
3899: .include "../../graphics/jpeg/buildlink3.mk"
1.19 snj 3900: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 3901:
1.19 snj 3902: BUILDLINK_TREE+= -tiff
1.1 dsieger 3903:
1.19 snj 3904: The header and footer manipulate BUILDLINK_TREE, which is common across all
3905: buildlink3.mk files and is used to track the dependency tree.
1.1 dsieger 3906:
1.19 snj 3907: The main section is protected from multiple inclusion and controls how the
1.1 dsieger 3908: dependency on pkg is added. Several important variables are set in the section:
3909:
3910: * BUILDLINK_API_DEPENDS.pkg is the actual dependency recorded in the
3911: installed package; this should always be set using += to ensure that we're
3912: appending to any pre-existing list of values. This variable should be set
1.27 wiz 3913: to the first version of the package that had an backwards-incompatible API
3914: change.
1.1 dsieger 3915:
3916: * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory.
3917:
3918: * BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use
3919: BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency
3920: is selected by setting BUILDLINK_DEPMETHOD.pkg to "build". By default, the
3921: full dependency is used.
3922:
3923: * BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS.pkg (not shown above) are lists
3924: of subdirectories of ${BUILDLINK_PREFIX.pkg} to add to the header and
3925: library search paths. These default to "include" and "lib" respectively.
3926:
3927: * BUILDLINK_CPPFLAGS.pkg (not shown above) is the list of preprocessor flags
3928: to add to CPPFLAGS, which are passed on to the configure and build phases.
3929: The "-I" option should be avoided and instead be handled using
3930: BUILDLINK_INCDIRS.pkg as above.
3931:
3932: The following variables are all optionally defined within this second section
3933: (protected against multiple inclusion) and control which package files are
3934: symlinked into ${BUILDLINK_DIR} and how their names are transformed during the
3935: symlinking:
3936:
3937: * BUILDLINK_FILES.pkg (not shown above) is a shell glob pattern relative to $
3938: {BUILDLINK_PREFIX.pkg} to be symlinked into ${BUILDLINK_DIR}, e.g. include/
3939: *.h.
3940:
3941: * BUILDLINK_FILES_CMD.pkg (not shown above) is a shell pipeline that outputs
3942: to stdout a list of files relative to ${BUILDLINK_PREFIX.pkg}. The
3943: resulting files are to be symlinked into ${BUILDLINK_DIR}. By default, this
3944: takes the +CONTENTS of a pkg and filters it through $
3945: {BUILDLINK_CONTENTS_FILTER.pkg}.
3946:
3947: * BUILDLINK_CONTENTS_FILTER.pkg (not shown above) is a filter command that
3948: filters +CONTENTS input into a list of files relative to $
1.84 wiz 3949: {BUILDLINK_PREFIX.pkg} on stdout. By default, BUILDLINK_CONTENTS_FILTER.pkg
3950: outputs the contents of the include and lib directories in the package
3951: +CONTENTS.
1.1 dsieger 3952:
3953: * BUILDLINK_FNAME_TRANSFORM.pkg (not shown above) is a list of sed arguments
3954: used to transform the name of the source filename into a destination
3955: filename, e.g. -e "s|/curses.h|/ncurses.h|g".
3956:
1.19 snj 3957: This section can additionally include any buildlink3.mk needed for pkg's
3958: library dependencies. Including these buildlink3.mk files means that the
3959: headers and libraries for these dependencies are also symlinked into $
3960: {BUILDLINK_DIR} whenever the pkg buildlink3.mk file is included. Dependencies
3961: are only added for directly include buildlink3.mk files.
1.1 dsieger 3962:
1.48 wiz 3963: When providing a buildlink3.mk and including other buildlink3.mk files in it,
1.51 wiz 3964: please only add necessary ones, i.e., those whose libraries or header files are
1.48 wiz 3965: automatically exposed when the package is use.
3966:
3967: In particular, if only an executable (bin/foo) is linked against a library,
3968: that library does not need to be propagated in the buildlink3.mk file.
3969:
3970: The following steps should help you decide if a buildlink3.mk file needs to be
3971: included:
3972:
3973: * Look at the installed header files: What headers do they include? The
3974: packages providing these files must be buildlinked.
3975:
1.50 wiz 3976: * Run ldd on all installed libraries and look against what other libraries
3977: they link. Some of the packages providing these probably need to be
3978: buildlinked; however, it's not automatic, since e.g. GTK on some systems
3979: pulls in the X libraries, so they will show up in the ldd output, while on
1.51 wiz 3980: others (like OS X) it won't. ldd output can thus only be used as a hint.
1.50 wiz 3981:
1.27 wiz 3982: 14.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
3983: buildlink3.mk files
1.1 dsieger 3984:
1.27 wiz 3985: These two variables differ in that one describes source compatibility (API) and
3986: the other binary compatibility (ABI). The difference is that a change in the
3987: API breaks compilation of programs while changes in the ABI stop compiled
3988: programs from running.
3989:
1.28 wiz 3990: Changes to the BUILDLINK_API_DEPENDS.pkg variable in a buildlink3.mk file
3991: happen very rarely. One possible reason is that all packages depending on this
3992: already need a newer version. In case it is bumped see the description below.
1.27 wiz 3993:
3994: The most common example of an ABI change is that the major version of a shared
3995: library is increased. In this case, BUILDLINK_ABI_DEPENDS.pkg should be
3996: adjusted to require at least the new package version. Then the packages that
3997: depend on this package need their PKGREVISIONs increased and, if they have
3998: buildlink3.mk files, their BUILDLINK_ABI_DEPENDS.pkg adjusted, too. This is
3999: needed so pkgsrc will require the correct package dependency and not settle for
4000: an older one when building the source.
1.1 dsieger 4001:
1.108 rillig 4002: See Section 19.1.5, "Handling dependencies" for more information about
1.1 dsieger 4003: dependencies on other packages, including the BUILDLINK_ABI_DEPENDS and
4004: ABI_DEPENDS definitions.
4005:
4006: Please take careful consideration before adjusting BUILDLINK_API_DEPENDS.pkg or
4007: BUILDLINK_ABI_DEPENDS.pkg as we don't want to cause unneeded package deletions
4008: and rebuilds. In many cases, new versions of packages work just fine with older
4009: dependencies.
4010:
4011: Also it is not needed to set BUILDLINK_ABI_DEPENDS.pkg when it is identical to
4012: BUILDLINK_API_DEPENDS.pkg.
4013:
1.6 rillig 4014: 14.3. Writing builtin.mk files
1.1 dsieger 4015:
4016: Some packages in pkgsrc install headers and libraries that coincide with
4017: headers and libraries present in the base system. Aside from a buildlink3.mk
4018: file, these packages should also include a builtin.mk file that includes the
4019: necessary checks to decide whether using the built-in software or the pkgsrc
4020: software is appropriate.
4021:
4022: The only requirements of a builtin.mk file for pkg are:
4023:
4024: 1. It should set USE_BUILTIN.pkg to either "yes" or "no" after it is included.
4025:
4026: 2. It should not override any USE_BUILTIN.pkg which is already set before the
4027: builtin.mk file is included.
4028:
4029: 3. It should be written to allow multiple inclusion. This is very important
4030: and takes careful attention to Makefile coding.
4031:
1.6 rillig 4032: 14.3.1. Anatomy of a builtin.mk file
1.1 dsieger 4033:
4034: The following is the recommended template for builtin.mk files:
4035:
4036: .if !defined(IS_BUILTIN.foo)
4037: #
4038: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4039: # genuinely exists in the system or not.
4040: #
4041: IS_BUILTIN.foo?= no
4042:
4043: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4044: # version can be determined.
4045: #
4046: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4047: BUILTIN_PKG.foo?= foo-1.0
4048: . endif
4049: .endif # IS_BUILTIN.foo
4050:
4051: .if !defined(USE_BUILTIN.foo)
4052: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4053: . if defined(BUILTIN_PKG.foo)
4054: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4055: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4056: USE_BUILTIN.foo!= \
4057: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4058: && ${ECHO} "yes" || ${ECHO} "no"
4059: . endif
4060: . endfor
4061: . endif
4062: .endif # USE_BUILTIN.foo
4063:
4064: CHECK_BUILTIN.foo?= no
4065: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4066: #
4067: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4068: # "yes" or "no".
4069: #
4070: .endif # CHECK_BUILTIN.foo
4071:
4072: The first section sets IS_BUILTIN.pkg depending on if pkg really exists in the
4073: base system. This should not be a base system software with similar
4074: functionality to pkg; it should only be "yes" if the actual package is included
4075: as part of the base system. This variable is only used internally within the
4076: builtin.mk file.
4077:
4078: The second section sets BUILTIN_PKG.pkg to the version of pkg in the base
4079: system if it exists (if IS_BUILTIN.pkg is "yes"). This variable is only used
4080: internally within the builtin.mk file.
4081:
4082: The third section sets USE_BUILTIN.pkg and is required in all builtin.mk files.
4083: The code in this section must make the determination whether the built-in
4084: software is adequate to satisfy the dependencies listed in
4085: BUILDLINK_API_DEPENDS.pkg. This is typically done by comparing BUILTIN_PKG.pkg
1.25 wiz 4086: against each of the dependencies in BUILDLINK_API_DEPENDS.pkg. USE_BUILTIN.pkg
1.1 dsieger 4087: must be set to the correct value by the end of the builtin.mk file. Note that
4088: USE_BUILTIN.pkg may be "yes" even if IS_BUILTIN.pkg is "no" because we may make
4089: the determination that the built-in version of the software is similar enough
4090: to be used as a replacement.
4091:
4092: The last section is guarded by CHECK_BUILTIN.pkg, and includes code that uses
4093: the value of USE_BUILTIN.pkg set in the previous section. This typically
4094: includes, e.g., adding additional dependency restrictions and listing
4095: additional files to symlink into ${BUILDLINK_DIR} (via BUILDLINK_FILES.pkg).
4096:
1.6 rillig 4097: 14.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 4098:
4099: When building packages, it's possible to choose whether to set a global
4100: preference for using either the built-in (native) version or the pkgsrc version
4101: of software to satisfy a dependency. This is controlled by setting
1.25 wiz 4102: PREFER_PKGSRC and PREFER_NATIVE. These variables take values of either "yes", "
4103: no", or a list of packages. PREFER_PKGSRC tells pkgsrc to use the pkgsrc
1.1 dsieger 4104: versions of software, while PREFER_NATIVE tells pkgsrc to use the built-in
4105: versions. Preferences are determined by the most specific instance of the
4106: package in either PREFER_PKGSRC or PREFER_NATIVE. If a package is specified in
4107: neither or in both variables, then PREFER_PKGSRC has precedence over
4108: PREFER_NATIVE. For example, to require using pkgsrc versions of software for
4109: all but the most basic bits on a NetBSD system, you can set:
4110:
4111: PREFER_PKGSRC= yes
4112: PREFER_NATIVE= getopt skey tcp_wrappers
4113:
4114: A package must have a builtin.mk file to be listed in PREFER_NATIVE, otherwise
4115: it is simply ignored in that list.
4116:
1.117 sevan 4117: Setting PREFER_NATIVE should be performed straight after bootstrap and
4118: PREFER_PKGSRC during bootstrap. Switching between settings globally at a later
4119: date can introduce complications with dependency resolution. This is caused by
4120: packages built with the opposite preference being installed alongside each
4121: other.
4122:
4123: # ./bootstrap --prefer-pkgsrc yes
4124:
1.6 rillig 4125: Chapter 15. The pkginstall framework
1.1 dsieger 4126:
4127: Table of Contents
4128:
1.6 rillig 4129: 15.1. Files and directories outside the installation prefix
1.1 dsieger 4130:
1.6 rillig 4131: 15.1.1. Directory manipulation
4132: 15.1.2. File manipulation
1.1 dsieger 4133:
1.6 rillig 4134: 15.2. Configuration files
1.1 dsieger 4135:
1.6 rillig 4136: 15.2.1. How PKG_SYSCONFDIR is set
4137: 15.2.2. Telling the software where configuration files are
4138: 15.2.3. Patching installations
4139: 15.2.4. Disabling handling of configuration files
1.1 dsieger 4140:
1.6 rillig 4141: 15.3. System startup scripts
1.1 dsieger 4142:
1.6 rillig 4143: 15.3.1. Disabling handling of system startup scripts
1.1 dsieger 4144:
1.6 rillig 4145: 15.4. System users and groups
4146: 15.5. System shells
1.1 dsieger 4147:
1.6 rillig 4148: 15.5.1. Disabling shell registration
1.1 dsieger 4149:
1.6 rillig 4150: 15.6. Fonts
1.1 dsieger 4151:
1.6 rillig 4152: 15.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 4153:
4154: This chapter describes the framework known as pkginstall, whose key features
4155: are:
4156:
4157: * Generic installation and manipulation of directories and files outside the
4158: pkgsrc-handled tree, LOCALBASE.
4159:
4160: * Automatic handling of configuration files during installation, provided
4161: that packages are correctly designed.
4162:
4163: * Generation and installation of system startup scripts.
4164:
4165: * Registration of system users and groups.
4166:
4167: * Registration of system shells.
4168:
4169: * Automatic updating of fonts databases.
4170:
4171: The following sections inspect each of the above points in detail.
4172:
4173: You may be thinking that many of the things described here could be easily done
4174: with simple code in the package's post-installation target (post-install). This
4175: is incorrect, as the code in them is only executed when building from source.
4176: Machines using binary packages could not benefit from it at all (as the code
4177: itself could be unavailable). Therefore, the only way to achieve any of the
4178: items described above is by means of the installation scripts, which are
4179: automatically generated by pkginstall.
4180:
1.6 rillig 4181: 15.1. Files and directories outside the installation prefix
1.1 dsieger 4182:
4183: As you already know, the PLIST file holds a list of files and directories that
4184: belong to a package. The names used in it are relative to the installation
4185: prefix (${PREFIX}), which means that it cannot register files outside this
4186: directory (absolute path names are not allowed). Despite this restriction, some
4187: packages need to install files outside this location; e.g., under ${VARBASE} or
4188: ${PKG_SYSCONFDIR}. The only way to achieve this is to create such files during
4189: installation time by using installation scripts.
4190:
4191: The generic installation scripts are shell scripts that can contain arbitrary
4192: code. The list of scripts to execute is taken from the INSTALL_FILE variable,
4193: which defaults to INSTALL. A similar variable exists for package removal
4194: (DEINSTALL_FILE, whose default is DEINSTALL). These scripts can run arbitrary
4195: commands, so they have the potential to create and manage files anywhere in the
4196: file system.
4197:
4198: Using these general installation files is not recommended, but may be needed in
4199: some special cases. One reason for avoiding them is that the user has to trust
4200: the packager that there is no unwanted or simply erroneous code included in the
4201: installation script. Also, previously there were many similar scripts for the
4202: same functionality, and fixing a common error involved finding and changing all
4203: of them.
4204:
4205: The pkginstall framework offers another, standardized way. It provides generic
4206: scripts to abstract the manipulation of such files and directories based on
4207: variables set in the package's Makefile. The rest of this section describes
4208: these variables.
4209:
1.6 rillig 4210: 15.1.1. Directory manipulation
1.1 dsieger 4211:
4212: The following variables can be set to request the creation of directories
4213: anywhere in the file system:
4214:
4215: * MAKE_DIRS and OWN_DIRS contain a list of directories that should be created
4216: and should attempt to be destroyed by the installation scripts. The
4217: difference between the two is that the latter prompts the administrator to
4218: remove any directories that may be left after deinstallation (because they
1.108 rillig 4219: were not empty), while the former does not. Example:
4220:
4221: MAKE_DIRS+= ${VARBASE}/foo/private
1.1 dsieger 4222:
4223: * MAKE_DIRS_PERMS and OWN_DIRS_PERMS contain a list of tuples describing
4224: which directories should be created and should attempt to be destroyed by
4225: the installation scripts. Each tuple holds the following values, separated
4226: by spaces: the directory name, its owner, its group and its numerical mode.
4227: For example:
4228:
1.108 rillig 4229: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
4230: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 4231:
4232: The difference between the two is exactly the same as their non-PERMS
4233: counterparts.
4234:
1.6 rillig 4235: 15.1.2. File manipulation
1.1 dsieger 4236:
4237: Creating non-empty files outside the installation prefix is tricky because the
4238: PLIST forces all files to be inside it. To overcome this problem, the only
4239: solution is to extract the file in the known place (i.e., inside the
4240: installation prefix) and copy it to the appropriate location during
4241: installation (done by the installation scripts generated by pkginstall). We
4242: will call the former the master file in the following paragraphs, which
4243: describe the variables that can be used to automatically and consistently
4244: handle files outside the installation prefix:
4245:
1.31 wiz 4246: * CONF_FILES and REQD_FILES are pairs of master and target files. During
1.1 dsieger 4247: installation time, the master file is copied to the target one if and only
4248: if the latter does not exist. Upon deinstallation, the target file is
4249: removed provided that it was not modified by the installation.
4250:
4251: The difference between the two is that the latter prompts the administrator
4252: to remove any files that may be left after deinstallation (because they
4253: were not empty), while the former does not.
4254:
1.31 wiz 4255: * CONF_FILES_PERMS and REQD_FILES_PERMS contain tuples describing master
1.1 dsieger 4256: files as well as their target locations. For each of them, it also
4257: specifies their owner, their group and their numeric permissions, in this
4258: order. For example:
4259:
1.108 rillig 4260: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
4261: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 4262:
4263: The difference between the two is exactly the same as their non-PERMS
4264: counterparts.
4265:
1.6 rillig 4266: 15.2. Configuration files
1.1 dsieger 4267:
4268: Configuration files are special in the sense that they are installed in their
4269: own specific directory, PKG_SYSCONFDIR, and need special treatment during
4270: installation (most of which is automated by pkginstall). The main concept you
4271: must bear in mind is that files marked as configuration files are automatically
4272: copied to the right place (somewhere inside PKG_SYSCONFDIR) during installation
4273: if and only if they didn't exist before. Similarly, they will not be removed if
4274: they have local modifications. This ensures that administrators never lose any
4275: custom changes they may have made.
4276:
1.6 rillig 4277: 15.2.1. How PKG_SYSCONFDIR is set
1.1 dsieger 4278:
4279: As said before, the PKG_SYSCONFDIR variable specifies where configuration files
4280: shall be installed. Its contents are set based upon the following variables:
4281:
4282: * PKG_SYSCONFBASE: The configuration's root directory. Defaults to ${PREFIX}/
4283: etc although it may be overridden by the user to point to his preferred
4284: location (e.g., /etc, /etc/pkg, etc.). Packages must not use it directly.
4285:
4286: * PKG_SYSCONFSUBDIR: A subdirectory of PKG_SYSCONFBASE under which the
4287: configuration files for the package being built shall be installed. The
4288: definition of this variable only makes sense in the package's Makefile
4289: (i.e., it is not user-customizable).
4290:
1.68 asau 4291: As an example, consider the Apache package, www/apache24, which places its
1.1 dsieger 4292: configuration files under the httpd/ subdirectory of PKG_SYSCONFBASE. This
4293: should be set in the package Makefile.
4294:
4295: * PKG_SYSCONFVAR: Specifies the name of the variable that holds this
4296: package's configuration directory (if different from PKG_SYSCONFBASE). It
4297: defaults to PKGBASE's value, and is always prefixed with PKG_SYSCONFDIR.
4298:
4299: * PKG_SYSCONFDIR.${PKG_SYSCONFVAR}: Holds the directory where the
4300: configuration files for the package identified by PKG_SYSCONFVAR's shall be
4301: placed.
4302:
4303: Based on the above variables, pkginstall determines the value of
4304: PKG_SYSCONFDIR, which is the only variable that can be used within a package to
4305: refer to its configuration directory. The algorithm used to set its value is
4306: basically the following:
4307:
4308: 1. If PKG_SYSCONFDIR.${PKG_SYSCONFVAR} is set, its value is used.
4309:
4310: 2. If the previous variable is not defined but PKG_SYSCONFSUBDIR is set in the
4311: package's Makefile, the resulting value is ${PKG_SYSCONFBASE}/$
4312: {PKG_SYSCONFSUBDIR}.
4313:
4314: 3. Otherwise, it is set to ${PKG_SYSCONFBASE}.
4315:
4316: It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to
1.16 jnemeth 4317: OWN_DIRS. See Section 15.1.1, "Directory manipulation" what this means. This
4318: does not apply to subdirectories of ${PKG_SYSCONFDIR}, they still have to be
4319: created with OWN_DIRS or MAKE_DIRS.
1.1 dsieger 4320:
1.6 rillig 4321: 15.2.2. Telling the software where configuration files are
1.1 dsieger 4322:
4323: Given that pkgsrc (and users!) expect configuration files to be in a known
4324: place, you need to teach each package where it shall install its files. In some
4325: cases you will have to patch the package Makefiles to achieve it. If you are
4326: lucky, though, it may be as easy as passing an extra flag to the configuration
4327: script; this is the case of GNU Autoconf- generated files:
4328:
4329: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
4330:
4331: Note that this specifies where the package has to look for its configuration
4332: files, not where they will be originally installed (although the difference is
4333: never explicit, unfortunately).
4334:
1.6 rillig 4335: 15.2.3. Patching installations
1.1 dsieger 4336:
4337: As said before, pkginstall automatically handles configuration files. This
4338: means that the packages themselves must not touch the contents of $
4339: {PKG_SYSCONFDIR} directly. Bad news is that many software installation scripts
4340: will, out of the box, mess with the contents of that directory. So what is the
4341: correct procedure to fix this issue?
4342:
4343: You must teach the package (usually by manually patching it) to install any
4344: configuration files under the examples hierarchy, share/examples/${PKGBASE}/.
4345: This way, the PLIST registers them and the administrator always has the
4346: original copies available.
4347:
4348: Once the required configuration files are in place (i.e., under the examples
4349: hierarchy), the pkginstall framework can use them as master copies during the
4350: package installation to update what is in ${PKG_SYSCONFDIR}. To achieve this,
4351: the variables CONF_FILES and CONF_FILES_PERMS are used. Check out
1.6 rillig 4352: Section 15.1.2, "File manipulation" for information about their syntax and
1.1 dsieger 4353: their purpose. Here is an example, taken from the mail/mutt package:
4354:
4355: EGDIR= ${PREFIX}/share/doc/mutt/samples
4356: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
4357:
4358: Note that the EGDIR variable is specific to that package and has no meaning
4359: outside it.
4360:
1.6 rillig 4361: 15.2.4. Disabling handling of configuration files
1.1 dsieger 4362:
4363: The automatic copying of config files can be toggled by setting the environment
4364: variable PKG_CONFIG prior to package installation.
4365:
1.6 rillig 4366: 15.3. System startup scripts
1.1 dsieger 4367:
4368: System startup scripts are special files because they must be installed in a
4369: place known by the underlying OS, usually outside the installation prefix.
1.6 rillig 4370: Therefore, the same rules described in Section 15.1, "Files and directories
1.1 dsieger 4371: outside the installation prefix" apply, and the same solutions can be used.
4372: However, pkginstall provides a special mechanism to handle these files.
4373:
4374: In order to provide system startup scripts, the package has to:
4375:
4376: 1. Store the script inside ${FILESDIR}, with the .sh suffix appended.
4377: Considering the print/cups package as an example, it has a cupsd.sh in its
4378: files directory.
4379:
4380: 2. Tell pkginstall to handle it, appending the name of the script, without its
4381: extension, to the RCD_SCRIPTS variable. Continuing the previous example:
4382:
4383: RCD_SCRIPTS+= cupsd
4384:
4385: Once this is done, pkginstall will do the following steps for each script in an
4386: automated fashion:
4387:
4388: 1. Process the file found in the files directory applying all the
4389: substitutions described in the FILES_SUBST variable.
4390:
4391: 2. Copy the script from the files directory to the examples hierarchy, $
4392: {PREFIX}/share/examples/rc.d/. Note that this master file must be
4393: explicitly registered in the PLIST.
4394:
4395: 3. Add code to the installation scripts to copy the startup script from the
4396: examples hierarchy into the system-wide startup scripts directory.
4397:
1.6 rillig 4398: 15.3.1. Disabling handling of system startup scripts
1.1 dsieger 4399:
4400: The automatic copying of config files can be toggled by setting the environment
4401: variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts
4402: will be always copied inside the examples hierarchy, ${PREFIX}/share/examples/
4403: rc.d/, no matter what the value of this variable is.
4404:
1.6 rillig 4405: 15.4. System users and groups
1.1 dsieger 4406:
4407: If a package needs to create special users and/or groups during installation,
4408: it can do so by using the pkginstall framework.
4409:
4410: Users can be created by adding entries to the PKG_USERS variable. Each entry
4411: has the following syntax:
4412:
4413: user:group
4414:
4415: Further specification of user details may be done by setting per-user
4416: variables. PKG_UID.user is the numeric UID for the user. PKG_GECOS.user is the
4417: user's description or comment. PKG_HOME.user is the user's home directory, and
4418: defaults to /nonexistent if not specified. PKG_SHELL.user is the user's shell,
4419: and defaults to /sbin/nologin if not specified.
4420:
4421: Similarly, groups can be created by adding entries to the PKG_GROUPS variable,
4422: whose syntax is:
4423:
4424: group
4425:
4426: The numeric GID of the group may be set by defining PKG_GID.group.
4427:
4428: If a package needs to create the users and groups at an earlier stage, then it
1.116 wiz 4429: can set USERGROUP_PHASE to either configure,build, or pre-install to indicate
4430: the phase before which the users and groups are created. In this case, the
4431: numeric UIDs and GIDs of the created users and groups are automatically
4432: hardcoded into the final installation scripts.
1.1 dsieger 4433:
1.6 rillig 4434: 15.5. System shells
1.1 dsieger 4435:
4436: Packages that install system shells should register them in the shell database,
4437: /etc/shells, to make things easier to the administrator. This must be done from
4438: the installation scripts to keep binary packages working on any system.
4439: pkginstall provides an easy way to accomplish this task.
4440:
4441: When a package provides a shell interpreter, it has to set the PKG_SHELL
4442: variable to its absolute file name. This will add some hooks to the
4443: installation scripts to handle it. Consider the following example, taken from
4444: shells/zsh:
4445:
4446: PKG_SHELL= ${PREFIX}/bin/zsh
4447:
1.6 rillig 4448: 15.5.1. Disabling shell registration
1.1 dsieger 4449:
4450: The automatic registration of shell interpreters can be disabled by the
4451: administrator by setting the PKG_REGISTER_SHELLS environment variable to NO.
4452:
1.6 rillig 4453: 15.6. Fonts
1.1 dsieger 4454:
4455: Packages that install X11 fonts should update the database files that index the
4456: fonts within each fonts directory. This can easily be accomplished within the
4457: pkginstall framework.
4458:
4459: When a package installs X11 fonts, it must list the directories in which fonts
4460: are installed in the FONTS_DIRS.type variables, where type can be one of "ttf",
4461: "type1" or "x11". This will add hooks to the installation scripts to run the
4462: appropriate commands to update the fonts database files within each of those
4463: directories. For convenience, if the directory path is relative, it is taken to
4464: be relative to the package's installation prefix. Consider the following
4465: example, taken from fonts/dbz-ttf:
4466:
1.67 wiz 4467: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 4468:
1.6 rillig 4469: 15.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 4470:
4471: The automatic update of fonts databases can be disabled by the administrator by
4472: setting the PKG_UPDATE_FONTS_DB environment variable to NO.
4473:
1.6 rillig 4474: Chapter 16. Options handling
1.1 dsieger 4475:
4476: Table of Contents
4477:
1.6 rillig 4478: 16.1. Global default options
4479: 16.2. Converting packages to use bsd.options.mk
4480: 16.3. Option Names
1.7 rillig 4481: 16.4. Determining the options of dependencies
1.1 dsieger 4482:
4483: Many packages have the ability to be built to support different sets of
4484: features. bsd.options.mk is a framework in pkgsrc that provides generic
4485: handling of those options that determine different ways in which the packages
4486: can be built. It's possible for the user to specify exactly which sets of
4487: options will be built into a package or to allow a set of global default
4488: options apply.
4489:
1.7 rillig 4490: There are two broad classes of behaviors that one might want to control via
4491: options. One is whether some particular feature is enabled in a program that
4492: will be built anyway, often by including or not including a dependency on some
4493: other package. The other is whether or not an additional program will be built
4494: as part of the package. Generally, it is better to make a split package for
4495: such additional programs instead of using options, because it enables binary
4496: packages to be built which can then be added separately. For example, the foo
4497: package might have minimal dependencies (those packages without which foo
4498: doesn't make sense), and then the foo-gfoo package might include the GTK
4499: frontend program gfoo. This is better than including a gtk option to foo that
4500: adds gfoo, because either that option is default, in which case binary users
4501: can't get foo without gfoo, or not default, in which case they can't get gfoo.
4502: With split packages, they can install foo without having GTK, and later decide
4503: to install gfoo (pulling in GTK at that time). This is an advantage to source
4504: users too, avoiding the need for rebuilds.
4505:
4506: Plugins with widely varying dependencies should usually be split instead of
4507: options.
4508:
4509: It is often more work to maintain split packages, especially if the upstream
4510: package does not support this. The decision of split vs. option should be made
4511: based on the likelihood that users will want or object to the various pieces,
4512: the size of the dependencies that are included, and the amount of work.
4513:
4514: A further consideration is licensing. Non-free parts, or parts that depend on
4515: non-free dependencies (especially plugins) should almost always be split if
4516: feasible.
4517:
1.6 rillig 4518: 16.1. Global default options
1.1 dsieger 4519:
4520: Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of
4521: the options that should be built into every package if that option is
1.4 rillig 4522: supported. This variable should be set in mk.conf.
1.1 dsieger 4523:
1.6 rillig 4524: 16.2. Converting packages to use bsd.options.mk
1.1 dsieger 4525:
4526: The following example shows how bsd.options.mk should be used by the
4527: hypothetical ``wibble'' package, either in the package Makefile, or in a file,
4528: e.g. options.mk, that is included by the main package Makefile.
4529:
4530: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
4531: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
4532: PKG_OPTIONS_OPTIONAL_GROUPS= database
4533: PKG_OPTIONS_GROUP.database= mysql pgsql
4534: PKG_SUGGESTED_OPTIONS= wibble-foo
4535: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
4536: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
4537:
4538: .include "../../mk/bsd.prefs.mk"
4539:
4540: # this package was previously named wibble2
4541: .if defined(PKG_OPTIONS.wibble2)
4542: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
4543: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
4544: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
4545: .endif
4546:
4547: .include "../../mk/bsd.options.mk"
4548:
4549: # Package-specific option-handling
4550:
4551: ###
4552: ### FOO support
4553: ###
4554: .if !empty(PKG_OPTIONS:Mwibble-foo)
4555: CONFIGURE_ARGS+= --enable-foo
4556: .endif
4557:
4558: ###
4559: ### LDAP support
4560: ###
4561: .if !empty(PKG_OPTIONS:Mldap)
4562: . include "../../databases/openldap-client/buildlink3.mk"
4563: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
4564: .endif
4565:
4566: ###
4567: ### database support
4568: ###
4569: .if !empty(PKG_OPTIONS:Mmysql)
4570: . include "../../mk/mysql.buildlink3.mk"
4571: .endif
4572: .if !empty(PKG_OPTIONS:Mpgsql)
4573: . include "../../mk/pgsql.buildlink3.mk"
4574: .endif
4575:
4576: The first section contains the information about which build options are
4577: supported by the package, and any default options settings if needed.
4578:
4579: 1. PKG_OPTIONS_VAR is the name of the make(1) variable that the user can set
4580: to override the default options. It should be set to PKG_OPTIONS.pkgbase.
4581: Do not set it to PKG_OPTIONS.${PKGBASE}, since PKGBASE is not defined at
4582: the point where the options are processed.
4583:
4584: 2. PKG_SUPPORTED_OPTIONS is a list of build options supported by the package.
4585:
4586: 3. PKG_OPTIONS_OPTIONAL_GROUPS is a list of names of groups of mutually
4587: exclusive options. The options in each group are listed in
4588: PKG_OPTIONS_GROUP.groupname. The most specific setting of any option from
4589: the group takes precedence over all other options in the group. Options
4590: from the groups will be automatically added to PKG_SUPPORTED_OPTIONS.
4591:
4592: 4. PKG_OPTIONS_REQUIRED_GROUPS is like PKG_OPTIONS_OPTIONAL_GROUPS, but
4593: building the packages will fail if no option from the group is selected.
4594:
4595: 5. PKG_OPTIONS_NONEMPTY_SETS is a list of names of sets of options. At least
4596: one option from each set must be selected. The options in each set are
4597: listed in PKG_OPTIONS_SET.setname. Options from the sets will be
4598: automatically added to PKG_SUPPORTED_OPTIONS. Building the package will
4599: fail if no option from the set is selected.
4600:
4601: 6. PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
4602: default.
4603:
4604: 7. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE:option" pairs that map
1.4 rillig 4605: legacy mk.conf variables to their option counterparts. Pairs should be
1.1 dsieger 4606: added with "+=" to keep the listing of global legacy variables. A warning
4607: will be issued if the user uses a legacy variable.
4608:
4609: 8. PKG_OPTIONS_LEGACY_OPTS is a list of "old-option:new-option" pairs that map
4610: options that have been renamed to their new counterparts. Pairs should be
4611: added with "+=" to keep the listing of global legacy options. A warning
4612: will be issued if the user uses a legacy option.
4613:
4614: 9. PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
4615: used. This can be used for cases that neither PKG_OPTIONS_LEGACY_VARS nor
4616: PKG_OPTIONS_LEGACY_OPTS can handle, e. g. when PKG_OPTIONS_VAR is renamed.
4617:
4618: 10. PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
4619: variables or options used, and what to use instead.
4620:
4621: A package should never modify PKG_DEFAULT_OPTIONS or the variable named in
4622: PKG_OPTIONS_VAR. These are strictly user-settable. To suggest a default set of
4623: options, use PKG_SUGGESTED_OPTIONS.
4624:
4625: PKG_OPTIONS_VAR must be defined before including bsd.options.mk. If none of
4626: PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and
4627: PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform-specific
4628: options if none of them is supported on the current platform), PKG_OPTIONS is
4629: set to the empty list and the package is otherwise treated as not using the
4630: options framework.
4631:
4632: After the inclusion of bsd.options.mk, the variable PKG_OPTIONS contains the
4633: list of selected build options, properly filtered to remove unsupported and
4634: duplicate options.
4635:
4636: The remaining sections contain the logic that is specific to each option. The
4637: correct way to check for an option is to check whether it is listed in
4638: PKG_OPTIONS:
4639:
4640: .if !empty(PKG_OPTIONS:Moption)
4641:
1.6 rillig 4642: 16.3. Option Names
1.1 dsieger 4643:
4644: Options that enable similar features in different packages (like optional
4645: support for a library) should use a common name in all packages that support it
4646: (like the name of the library). If another package already has an option with
4647: the same meaning, use the same name.
4648:
4649: Options that enable features specific to one package, where it's unlikely that
4650: another (unrelated) package has the same (or a similar) optional feature,
4651: should use a name prefixed with pkgname-.
4652:
4653: If a group of related packages share an optional feature specific to that
4654: group, prefix it with the name of the "main" package (e. g.
4655: djbware-errno-hack).
4656:
4657: For new options, add a line to mk/defaults/options.description. Lines have two
4658: fields, separated by tab. The first field is the option name, the second its
4659: description. The description should be a whole sentence (starting with an
4660: uppercase letter and ending with a period) that describes what enabling the
4661: option does. E. g. "Enable ispell support." The file is sorted by option names.
4662:
1.7 rillig 4663: 16.4. Determining the options of dependencies
4664:
4665: When writing buildlink3.mk files, it is often necessary to list different
4666: dependencies based on the options with which the package was built. For
4667: querying these options, the file pkgsrc/mk/pkg-build-options.mk should be used.
4668: A typical example looks like this:
4669:
4670: pkgbase := libpurple
4671: .include "../../mk/pkg-build-options.mk"
4672:
4673: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
4674: ...
4675: .endif
4676:
4677: Including pkg-build-options.mk here will set the variable
4678: PKG_BUILD_OPTIONS.libpurple to the build options of the libpurple package,
4679: which can then be queried like PKG_OPTIONS in the options.mk file. See the file
4680: pkg-build-options.mk for more details.
4681:
1.6 rillig 4682: Chapter 17. The build process
1.1 dsieger 4683:
4684: Table of Contents
4685:
1.6 rillig 4686: 17.1. Introduction
4687: 17.2. Program location
4688: 17.3. Directories used during the build process
4689: 17.4. Running a phase
4690: 17.5. The fetch phase
4691:
4692: 17.5.1. What to fetch and where to get it from
4693: 17.5.2. How are the files fetched?
4694:
4695: 17.6. The checksum phase
4696: 17.7. The extract phase
4697: 17.8. The patch phase
4698: 17.9. The tools phase
4699: 17.10. The wrapper phase
4700: 17.11. The configure phase
4701: 17.12. The build phase
4702: 17.13. The test phase
4703: 17.14. The install phase
4704: 17.15. The package phase
4705: 17.16. Cleaning up
4706: 17.17. Other helpful targets
1.1 dsieger 4707:
1.6 rillig 4708: 17.1. Introduction
1.1 dsieger 4709:
4710: This chapter gives a detailed description on how a package is built. Building a
4711: package is separated into different phases (for example fetch, build, install),
1.19 snj 4712: all of which are described in the following sections. Each phase is split into
4713: so-called stages, which take the name of the containing phase, prefixed by one
4714: of pre-, do- or post-. (Examples are pre-configure, post-build.) Most of the
4715: actual work is done in the do-* stages.
1.1 dsieger 4716:
4717: Never override the regular targets (like fetch), if you have to, override the
4718: do-* ones instead.
4719:
4720: The basic steps for building a program are always the same. First the program's
4721: source (distfile) must be brought to the local system and then extracted. After
4722: any pkgsrc-specific patches to compile properly are applied, the software can
4723: be configured, then built (usually by compiling), and finally the generated
4724: binaries, etc. can be put into place on the system.
4725:
4726: To get more details about what is happening at each step, you can set the
4727: PKG_VERBOSE variable, or the PATCH_DEBUG variable if you are just interested in
4728: more details about the patch step.
4729:
1.6 rillig 4730: 17.2. Program location
1.1 dsieger 4731:
4732: Before outlining the process performed by the NetBSD package system in the next
4733: section, here's a brief discussion on where programs are installed, and which
4734: variables influence this.
4735:
4736: The automatic variable PREFIX indicates where all files of the final program
4737: shall be installed. It is usually set to LOCALBASE (/usr/pkg), or CROSSBASE for
4738: pkgs in the cross category. The value of PREFIX needs to be put into the
4739: various places in the program's source where paths to these files are encoded.
1.6 rillig 4740: See Section 11.3, "patches/*" and Section 19.3.1, "Shared libraries - libtool"
1.1 dsieger 4741: for more details.
4742:
4743: When choosing which of these variables to use, follow the following rules:
4744:
4745: * PREFIX always points to the location where the current pkg will be
1.25 wiz 4746: installed. When referring to a pkg's own installation path, use "${PREFIX}"
4747: .
1.1 dsieger 4748:
4749: * LOCALBASE is where all non-X11 pkgs are installed. If you need to construct
4750: a -I or -L argument to the compiler to find includes and libraries
4751: installed by another non-X11 pkg, use "${LOCALBASE}". The name LOCALBASE
4752: stems from FreeBSD, which installed all packages in /usr/local. As pkgsrc
4753: leaves /usr/local for the system administrator, this variable is a
4754: misnomer.
4755:
4756: * X11BASE is where the actual X11 distribution (from xsrc, etc.) is
4757: installed. When looking for standard X11 includes (not those installed by a
4758: package), use "${X11BASE}".
4759:
1.99 sevan 4760: * X11-based packages using imake must set USE_IMAKE to be installed correctly
4761: under LOCALBASE.
1.1 dsieger 4762:
4763: * Within ${PREFIX}, packages should install files according to hier(7), with
4764: the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/
4765: man.
4766:
1.6 rillig 4767: 17.3. Directories used during the build process
1.1 dsieger 4768:
1.14 jmcneill 4769: When building a package, various directories are used to store source files,
1.1 dsieger 4770: temporary files, pkgsrc-internal files, and so on. These directories are
4771: explained here.
4772:
4773: Some of the directory variables contain relative pathnames. There are two
4774: common base directories for these relative directories: PKGSRCDIR/PKGPATH is
4775: used for directories that are pkgsrc-specific. WRKSRC is used for directories
4776: inside the package itself.
4777:
4778: PKGSRCDIR
4779:
4780: This is an absolute pathname that points to the pkgsrc root directory.
4781: Generally, you don't need it.
4782:
4783: PKGDIR
4784:
4785: This is an absolute pathname that points to the current package.
4786:
4787: PKGPATH
4788:
4789: This is a pathname relative to PKGSRCDIR that points to the current
4790: package.
4791:
4792: WRKDIR
4793:
4794: This is an absolute pathname pointing to the directory where all work takes
4795: place. The distfiles are extracted to this directory. It also contains
4796: temporary directories and log files used by the various pkgsrc frameworks,
4797: like buildlink or the wrappers.
4798:
4799: WRKSRC
4800:
4801: This is an absolute pathname pointing to the directory where the distfiles
4802: are extracted. It is usually a direct subdirectory of WRKDIR, and often
4803: it's the only directory entry that isn't hidden. This variable may be
4804: changed by a package Makefile.
4805:
1.14 jmcneill 4806: The CREATE_WRKDIR_SYMLINK definition takes either the value yes or no and
1.15 rillig 4807: defaults to no. It indicates whether a symbolic link to the WRKDIR is to be
1.14 jmcneill 4808: created in the pkgsrc entry's directory. If users would like to have their
4809: pkgsrc trees behave in a read-only manner, then the value of
4810: CREATE_WRKDIR_SYMLINK should be set to no.
4811:
1.6 rillig 4812: 17.4. Running a phase
1.1 dsieger 4813:
4814: You can run a particular phase by typing make phase, where phase is the name of
4815: the phase. This will automatically run all phases that are required for this
4816: phase. The default phase is build, that is, when you run make without
4817: parameters in a package directory, the package will be built, but not
4818: installed.
4819:
1.6 rillig 4820: 17.5. The fetch phase
1.1 dsieger 4821:
4822: The first step in building a package is to fetch the distribution files
1.25 wiz 4823: (distfiles) from the sites that are providing them. This is the task of the
1.1 dsieger 4824: fetch phase.
4825:
1.6 rillig 4826: 17.5.1. What to fetch and where to get it from
1.1 dsieger 4827:
4828: In simple cases, MASTER_SITES defines all URLs from where the distfile, whose
4829: name is derived from the DISTNAME variable, is fetched. The more complicated
4830: cases are described below.
4831:
4832: The variable DISTFILES specifies the list of distfiles that have to be fetched.
1.66 asau 4833: Its value defaults to ${DEFAULT_DISTFILES} and its value is ${DISTNAME}$
4834: {EXTRACT_SUFX}, so that most packages don't need to define it at all.
4835: EXTRACT_SUFX is .tar.gz by default, but can be changed freely. Note that if
4836: your package requires additional distfiles to the default one, you cannot just
4837: append the additional filenames using the += operator, but you have write for
4838: example:
1.1 dsieger 4839:
1.66 asau 4840: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 4841:
4842: Each distfile is fetched from a list of sites, usually MASTER_SITES. If the
4843: package has multiple DISTFILES or multiple PATCHFILES from different sites, you
4844: can set SITES.distfile to the list of URLs where the file distfile (including
4845: the suffix) can be found.
4846:
4847: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4848: DISTFILES+= foo-file.tar.gz
4849: SITES.foo-file.tar.gz= \
4850: http://www.somewhere.com/somehow/ \
4851: http://www.somewhereelse.com/mirror/somehow/
4852:
4853: When actually fetching the distfiles, each item from MASTER_SITES or SITES.*
4854: gets the name of each distfile appended to it, without an intermediate slash.
4855: Therefore, all site values have to end with a slash or other separator
4856: character. This allows for example to set MASTER_SITES to a URL of a CGI script
4857: that gets the name of the distfile as a parameter. In this case, the definition
4858: would look like:
4859:
4860: MASTER_SITES= http://www.example.com/download.cgi?file=
4861:
1.23 jakllsch 4862: The exception to this rule are URLs starting with a dash. In that case the URL
4863: is taken as is, fetched and the result stored under the name of the distfile.
1.66 asau 4864: You can use this style for the case when the download URL style does not match
4865: the above common case. For example, if permanent download URL is a redirector
4866: to the real download URL, or the download file name is offered by an HTTP
4867: Content-Disposition header. In the following example, foo-1.0.0.tar.gz will be
4868: created instead of the default v1.0.0.tar.gz.
4869:
4870: DISTNAME= foo-1.0.0
4871: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
1.23 jakllsch 4872:
1.1 dsieger 4873: There are some predefined values for MASTER_SITES, which can be used in
4874: packages. The names of the variables should speak for themselves.
4875:
4876: ${MASTER_SITE_APACHE}
4877: ${MASTER_SITE_BACKUP}
4878: ${MASTER_SITE_CYGWIN}
4879: ${MASTER_SITE_DEBIAN}
4880: ${MASTER_SITE_FREEBSD}
4881: ${MASTER_SITE_FREEBSD_LOCAL}
4882: ${MASTER_SITE_GENTOO}
4883: ${MASTER_SITE_GNOME}
4884: ${MASTER_SITE_GNU}
4885: ${MASTER_SITE_GNUSTEP}
1.66 asau 4886: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 4887: ${MASTER_SITE_IFARCHIVE}
4888: ${MASTER_SITE_KDE}
4889: ${MASTER_SITE_MOZILLA}
1.66 asau 4890: ${MASTER_SITE_MOZILLA_ALL}
4891: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 4892: ${MASTER_SITE_MYSQL}
1.66 asau 4893: ${MASTER_SITE_NETLIB}
1.1 dsieger 4894: ${MASTER_SITE_OPENOFFICE}
1.98 ryoon 4895: ${MASTER_SITE_OSDN}
1.1 dsieger 4896: ${MASTER_SITE_PERL_CPAN}
4897: ${MASTER_SITE_PGSQL}
1.66 asau 4898: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 4899: ${MASTER_SITE_R_CRAN}
4900: ${MASTER_SITE_SOURCEFORGE}
4901: ${MASTER_SITE_SUNSITE}
4902: ${MASTER_SITE_SUSE}
4903: ${MASTER_SITE_TEX_CTAN}
4904: ${MASTER_SITE_XCONTRIB}
4905: ${MASTER_SITE_XEMACS}
1.66 asau 4906: ${MASTER_SITE_XORG}
1.1 dsieger 4907:
4908: Some explanations for the less self-explaining ones: MASTER_SITE_BACKUP
4909: contains backup sites for packages that are maintained in ftp://ftp.NetBSD.org/
1.27 wiz 4910: pub/pkgsrc/distfiles/${DIST_SUBDIR}. MASTER_SITE_LOCAL contains local package
1.26 spz 4911: source distributions that are maintained in ftp://ftp.NetBSD.org/pub/pkgsrc/
4912: distfiles/LOCAL_PORTS/.
1.1 dsieger 4913:
4914: If you choose one of these predefined sites, you may want to specify a
4915: subdirectory of that site. Since these macros may expand to more than one
4916: actual site, you must use the following construct to specify a subdirectory:
4917:
4918: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4919: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
4920:
4921: Note the trailing slash after the subdirectory name.
4922:
1.6 rillig 4923: 17.5.2. How are the files fetched?
1.1 dsieger 4924:
4925: The fetch phase makes sure that all the distfiles exist in a local directory
4926: (DISTDIR, which can be set by the pkgsrc user). If the files do not exist, they
4927: are fetched using commands of the form
4928:
4929: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4930:
4931: where ${site} varies through several possibilities in turn: first,
4932: MASTER_SITE_OVERRIDE is tried, then the sites specified in either SITES.file if
4933: defined, else MASTER_SITES or PATCH_SITES, as applies, then finally the value
4934: of MASTER_SITE_BACKUP. The order of all except the first and the last can be
4935: optionally sorted by the user, via setting either MASTER_SORT_RANDOM, and
4936: MASTER_SORT_AWK or MASTER_SORT_REGEX.
4937:
1.16 jnemeth 4938: The specific command and arguments used depend on the FETCH_USING parameter.
4939: The example above is for FETCH_USING=custom.
4940:
1.1 dsieger 4941: The distfiles mirror run by the NetBSD Foundation uses the mirror-distfiles
4942: target to mirror the distfiles, if they are freely distributable. Packages
4943: setting NO_SRC_ON_FTP (usually to "${RESTRICTED}") will not have their
4944: distfiles mirrored.
4945:
1.6 rillig 4946: 17.6. The checksum phase
1.1 dsieger 4947:
4948: After the distfile(s) are fetched, their checksum is generated and compared
4949: with the checksums stored in the distinfo file. If the checksums don't match,
4950: the build is aborted. This is to ensure the same distfile is used for building,
4951: and that the distfile wasn't changed, e.g. by some malign force, deliberately
4952: changed distfiles on the master distribution site or network lossage.
4953:
1.6 rillig 4954: 17.7. The extract phase
1.1 dsieger 4955:
4956: When the distfiles are present on the local system, they need to be extracted,
4957: as they usually come in the form of some compressed archive format.
4958:
4959: By default, all DISTFILES are extracted. If you only need some of them, you can
4960: set the EXTRACT_ONLY variable to the list of those files.
4961:
4962: Extracting the files is usually done by a little program, mk/extract/extract,
4963: which already knows how to extract various archive formats, so most likely you
4964: will not need to change anything here. But if you need, the following variables
4965: may help you:
4966:
4967: EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}
4968:
4969: Use these variables to override the default options for an extract command,
4970: which are defined in mk/extract/extract.
4971:
4972: EXTRACT_USING
4973:
1.14 jmcneill 4974: This variable can be set to bsdtar, gtar, nbtar (which is the default
4975: value), pax, or an absolute pathname pointing to the command with which tar
4976: archives should be extracted. It is preferred to choose bsdtar over gtar if
4977: NetBSD's pax-as-tar is not good enough.
1.1 dsieger 4978:
4979: If the extract program doesn't serve your needs, you can also override the
4980: EXTRACT_CMD variable, which holds the command used for extracting the files.
4981: This command is executed in the ${WRKSRC} directory. During execution of this
4982: command, the shell variable extract_file holds the absolute pathname of the
4983: file that is going to be extracted.
4984:
4985: And if that still does not suffice, you can override the do-extract target in
4986: the package Makefile.
4987:
1.6 rillig 4988: 17.8. The patch phase
1.1 dsieger 4989:
4990: After extraction, all the patches named by the PATCHFILES, those present in the
4991: patches subdirectory of the package as well as in $LOCALPATCHES/$PKGPATH (e.g.
4992: /usr/local/patches/graphics/png) are applied. Patchfiles ending in .Z or .gz
4993: are uncompressed before they are applied, files ending in .orig or .rej are
4994: ignored. Any special options to patch(1) can be handed in PATCH_DIST_ARGS. See
1.6 rillig 4995: Section 11.3, "patches/*" for more details.
1.1 dsieger 4996:
4997: By default patch(1) is given special args to make it fail if the patches apply
4998: with some lines of fuzz. Please fix (regen) the patches so that they apply
4999: cleanly. The rationale behind this is that patches that don't apply cleanly may
5000: end up being applied in the wrong place, and cause severe harm there.
5001:
1.6 rillig 5002: 17.9. The tools phase
1.1 dsieger 5003:
1.6 rillig 5004: This is covered in Chapter 18, Tools needed for building or running.
1.1 dsieger 5005:
1.6 rillig 5006: 17.10. The wrapper phase
1.1 dsieger 5007:
5008: This phase creates wrapper programs for the compilers and linkers. The
5009: following variables can be used to tweak the wrappers.
5010:
5011: ECHO_WRAPPER_MSG
5012:
5013: The command used to print progress messages. Does nothing by default. Set
5014: to ${ECHO} to see the progress messages.
5015:
5016: WRAPPER_DEBUG
5017:
5018: This variable can be set to yes (default) or no, depending on whether you
5019: want additional information in the wrapper log file.
5020:
5021: WRAPPER_UPDATE_CACHE
5022:
5023: This variable can be set to yes or no, depending on whether the wrapper
5024: should use its cache, which will improve the speed. The default value is
5025: yes, but is forced to no if the platform does not support it.
5026:
5027: WRAPPER_REORDER_CMDS
5028:
5029: A list of reordering commands. A reordering command has the form reorder:l:
5030: lib1:lib2. It ensures that that -llib1 occurs before -llib2.
5031:
5032: WRAPPER_TRANSFORM_CMDS
5033:
5034: A list of transformation commands. [TODO: investigate further]
5035:
1.6 rillig 5036: 17.11. The configure phase
1.1 dsieger 5037:
5038: Most pieces of software need information on the header files, system calls, and
5039: library routines which are available on the platform they run on. The process
5040: of determining this information is known as configuration, and is usually
5041: automated. In most cases, a script is supplied with the distfiles, and its
5042: invocation results in generation of header files, Makefiles, etc.
5043:
5044: If the package contains a configure script, this can be invoked by setting
5045: HAS_CONFIGURE to "yes". If the configure script is a GNU autoconf script, you
5046: should set GNU_CONFIGURE to "yes" instead. What happens in the configure phase
5047: is roughly:
5048:
5049: .for d in ${CONFIGURE_DIRS}
5050: cd ${WRKSRC} \
5051: && cd ${d} \
5052: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
5053: .endfor
5054:
5055: CONFIGURE_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In
5056: each of these directories, the configure script is run with the environment
5057: CONFIGURE_ENV and arguments CONFIGURE_ARGS. The variables CONFIGURE_ENV,
5058: CONFIGURE_SCRIPT (default: "./configure") and CONFIGURE_ARGS may all be changed
5059: by the package.
5060:
1.38 wiz 5061: If the program uses the Perl way of configuration (mainly Perl modules, but not
5062: only), i.e. a file called Makefile.PL, it should include ../../lang/perl5/
5063: module.mk. To set any parameter for Makefile.PL use the MAKE_PARAMS variable
5064: (e.g., MAKE_PARAMS+=foo=bar
5065:
1.1 dsieger 5066: If the program uses an Imakefile for configuration, the appropriate steps can
1.99 sevan 5067: be invoked by setting USE_IMAKE to "yes". If you only need xmkmf, add it to
5068: USE_TOOLS. You can add variables to xmkmf's environment by adding them to the
5069: SCRIPTS_ENV variable.
1.1 dsieger 5070:
1.11 rillig 5071: If the program uses cmake for configuration, the appropriate steps can be
5072: invoked by setting USE_CMAKE to "yes". You can add variables to cmake's
5073: environment by adding them to the CONFIGURE_ENV variable and arguments to cmake
5074: by adding them to the CMAKE_ARGS variable. The top directory argument is given
5075: by the CMAKE_ARG_PATH variable, that defaults to "." (relative to
5076: CONFIGURE_DIRS)
5077:
1.1 dsieger 5078: If there is no configure step at all, set NO_CONFIGURE to "yes".
5079:
1.6 rillig 5080: 17.12. The build phase
1.1 dsieger 5081:
5082: For building a package, a rough equivalent of the following code is executed.
5083:
5084: .for d in ${BUILD_DIRS}
5085: cd ${WRKSRC} \
5086: && cd ${d} \
5087: && env ${MAKE_ENV} \
5088: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
5089: -f ${MAKE_FILE} \
5090: ${BUILD_TARGET}
5091: .endfor
5092:
5093: BUILD_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In each of
5094: these directories, MAKE_PROGRAM is run with the environment MAKE_ENV and
5095: arguments BUILD_MAKE_FLAGS. The variables MAKE_ENV, BUILD_MAKE_FLAGS, MAKE_FILE
5096: and BUILD_TARGET may all be changed by the package.
5097:
1.25 wiz 5098: The default value of MAKE_PROGRAM is "gmake" if USE_TOOLS contains "gmake", "
5099: make" otherwise. The default value of MAKE_FILE is "Makefile", and BUILD_TARGET
5100: defaults to "all".
1.1 dsieger 5101:
5102: If there is no build step at all, set NO_BUILD to "yes".
5103:
1.6 rillig 5104: 17.13. The test phase
1.1 dsieger 5105:
5106: [TODO]
5107:
1.6 rillig 5108: 17.14. The install phase
1.1 dsieger 5109:
5110: Once the build stage has completed, the final step is to install the software
5111: in public directories, so users can access the programs and files.
5112:
5113: In the install phase, a rough equivalent of the following code is executed.
5114: Additionally, before and after this code, much magic is performed to do
5115: consistency checks, registering the package, and so on.
5116:
5117: .for d in ${INSTALL_DIRS}
5118: cd ${WRKSRC} \
5119: && cd ${d} \
5120: && env ${MAKE_ENV} \
5121: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
5122: -f ${MAKE_FILE} \
5123: ${INSTALL_TARGET}
5124: .endfor
5125:
5126: The variable's meanings are analogous to the ones in the build phase.
5127: INSTALL_DIRS defaults to BUILD_DIRS. INSTALL_TARGET is "install" by default,
5128: plus "install.man" if USE_IMAKE is defined and NO_INSTALL_MANPAGES is not
5129: defined.
5130:
5131: In the install phase, the following variables are useful. They are all
5132: variations of the install(1) command that have the owner, group and permissions
5133: preset. INSTALL is the plain install command. The specialized variants,
5134: together with their intended use, are:
5135:
5136: INSTALL_PROGRAM_DIR
5137:
5138: directories that contain binaries
5139:
5140: INSTALL_SCRIPT_DIR
5141:
5142: directories that contain scripts
5143:
5144: INSTALL_LIB_DIR
5145:
5146: directories that contain shared and static libraries
5147:
5148: INSTALL_DATA_DIR
5149:
5150: directories that contain data files
5151:
5152: INSTALL_MAN_DIR
5153:
5154: directories that contain man pages
5155:
1.100 leot 5156: INSTALL_GAME_DIR
5157:
5158: directories that contain data files for games
5159:
1.1 dsieger 5160: INSTALL_PROGRAM
5161:
5162: binaries that can be stripped from debugging symbols
5163:
5164: INSTALL_SCRIPT
5165:
5166: binaries that cannot be stripped
5167:
5168: INSTALL_GAME
5169:
5170: game binaries
5171:
5172: INSTALL_LIB
5173:
5174: shared and static libraries
5175:
5176: INSTALL_DATA
5177:
5178: data files
5179:
5180: INSTALL_GAME_DATA
5181:
5182: data files for games
5183:
5184: INSTALL_MAN
5185:
5186: man pages
5187:
5188: Some other variables are:
5189:
1.106 tnn 5190: INSTALL_UNSTRIPPED
5191:
5192: If set to yes, do not run strip(1) when installing binaries. Any debugging
5193: sections and symbols present in binaries will be preserved.
5194:
1.1 dsieger 5195: INSTALLATION_DIRS
5196:
5197: A list of directories relative to PREFIX that are created by pkgsrc at the
5198: beginning of the install phase. The package is supposed to create all
5199: needed directories itself before installing files to it and list all other
5200: directories here.
5201:
1.25 wiz 5202: In the rare cases that a package shouldn't install anything, set NO_INSTALL to
1.1 dsieger 5203: "yes". This is mostly relevant for packages in the regress category.
5204:
1.6 rillig 5205: 17.15. The package phase
1.1 dsieger 5206:
5207: Once the install stage has completed, a binary package of the installed files
5208: can be built. These binary packages can be used for quick installation without
5209: previous compilation, e.g. by the make bin-install or by using pkg_add.
5210:
5211: By default, the binary packages are created in ${PACKAGES}/All and symlinks are
5212: created in ${PACKAGES}/category, one for each category in the CATEGORIES
5213: variable. PACKAGES defaults to pkgsrc/packages.
5214:
1.6 rillig 5215: 17.16. Cleaning up
1.1 dsieger 5216:
5217: Once you're finished with a package, you can clean the work directory by
5218: running make clean. If you want to clean the work directories of all
5219: dependencies too, use make clean-depends.
5220:
1.6 rillig 5221: 17.17. Other helpful targets
1.1 dsieger 5222:
5223: pre/post-*
5224:
5225: For any of the main targets described in the previous section, two
5226: auxiliary targets exist with "pre-" and "post-" used as a prefix for the
5227: main target's name. These targets are invoked before and after the main
5228: target is called, allowing extra configuration or installation steps be
5229: performed from a package's Makefile, for example, which a program's
5230: configure script or install target omitted.
5231:
5232: do-*
5233:
5234: Should one of the main targets do the wrong thing, and should there be no
5235: variable to fix this, you can redefine it with the do-* target. (Note that
5236: redefining the target itself instead of the do-* target is a bad idea, as
5237: the pre-* and post-* targets won't be called anymore, etc.) You will not
5238: usually need to do this.
5239:
5240: reinstall
5241:
5242: If you did a make install and you noticed some file was not installed
5243: properly, you can repeat the installation with this target, which will
5244: ignore the "already installed" flag.
5245:
5246: This is the default value of DEPENDS_TARGET except in the case of make
5247: update and make package, where the defaults are "package" and "update",
5248: respectively.
5249:
5250: deinstall
5251:
5252: This target does a pkg_delete(1) in the current directory, effectively
5253: de-installing the package. The following variables can be used to tune the
5254: behaviour:
5255:
5256: PKG_VERBOSE
5257:
5258: Add a "-v" to the pkg_delete(1) command.
5259:
5260: DEINSTALLDEPENDS
5261:
5262: Remove all packages that require (depend on) the given package. This
5263: can be used to remove any packages that may have been pulled in by a
5264: given package, e.g. if make deinstall DEINSTALLDEPENDS=1 is done in
1.25 wiz 5265: pkgsrc/x11/kde, this is likely to remove whole KDE. Works by adding "-R
5266: " to the pkg_delete(1) command line.
1.1 dsieger 5267:
5268: bin-install
5269:
5270: Install a binary package from local disk and via FTP from a list of sites
5271: (see the BINPKG_SITES variable), and do a make package if no binary package
5272: is available anywhere. The arguments given to pkg_add can be set via
5273: BIN_INSTALL_FLAGS e.g., to do verbose operation, etc.
5274:
1.95 wiz 5275: install-clean
5276:
5277: This target removes the state files for the "install" and later phases so
5278: that the "install" target may be re-invoked. This can be used after editing
5279: the PLIST to install the package without rebuilding it.
5280:
5281: build-clean
5282:
5283: This target removes the state files for the "build" and later phases so
5284: that the "build" target may be re-invoked.
5285:
1.1 dsieger 5286: update
5287:
5288: This target causes the current package to be updated to the latest version.
5289: The package and all depending packages first get de-installed, then current
5290: versions of the corresponding packages get compiled and installed. This is
5291: similar to manually noting which packages are currently installed, then
5292: performing a series of make deinstall and make install (or whatever
5293: UPDATE_TARGET is set to) for these packages.
5294:
5295: You can use the "update" target to resume package updating in case a
5296: previous make update was interrupted for some reason. However, in this
5297: case, make sure you don't call make clean or otherwise remove the list of
5298: dependent packages in WRKDIR. Otherwise, you lose the ability to
5299: automatically update the current package along with the dependent packages
5300: you have installed.
5301:
5302: Resuming an interrupted make update will only work as long as the package
5303: tree remains unchanged. If the source code for one of the packages to be
5304: updated has been changed, resuming make update will most certainly fail!
5305:
1.4 rillig 5306: The following variables can be used either on the command line or in
1.1 dsieger 5307: mk.conf to alter the behaviour of make update:
5308:
5309: UPDATE_TARGET
5310:
5311: Install target to recursively use for the updated package and the
5312: dependent packages. Defaults to DEPENDS_TARGET if set, "install"
1.25 wiz 5313: otherwise for make update. Other good targets are "package" or "
5314: bin-install". Do not set this to "update" or you will get stuck in an
1.1 dsieger 5315: endless loop!
5316:
5317: NOCLEAN
5318:
5319: Don't clean up after updating. Useful if you want to leave the work
5320: sources of the updated packages around for inspection or other
1.25 wiz 5321: purposes. Be sure you eventually clean up the source tree (see the "
5322: clean-update" target below) or you may run into troubles with old
1.1 dsieger 5323: source code still lying around on your next make or make update.
5324:
5325: REINSTALL
5326:
5327: Deinstall each package before installing (making DEPENDS_TARGET). This
5328: may be necessary if the "clean-update" target (see below) was called
5329: after interrupting a running make update.
5330:
5331: DEPENDS_TARGET
5332:
5333: Allows you to disable recursion and hardcode the target for packages.
5334: The default is "update" for the update target, facilitating a recursive
5335: update of prerequisite packages. Only set DEPENDS_TARGET if you want to
5336: disable recursive updates. Use UPDATE_TARGET instead to just set a
5337: specific target for each package to be installed during make update
5338: (see above).
5339:
5340: clean-update
5341:
5342: Clean the source tree for all packages that would get updated if make
5343: update was called from the current directory. This target should not be
5344: used if the current package (or any of its depending packages) have already
5345: been de-installed (e.g., after calling make update) or you may lose some
1.25 wiz 5346: packages you intended to update. As a rule of thumb: only use this target
1.1 dsieger 5347: before the first time you run make update and only if you have a dirty
5348: package tree (e.g., if you used NOCLEAN).
5349:
5350: If you are unsure about whether your tree is clean, you can either perform
5351: a make clean at the top of the tree, or use the following sequence of
5352: commands from the directory of the package you want to update (before
5353: running make update for the first time, otherwise you lose all the packages
5354: you wanted to update!):
5355:
5356: # make clean-update
5357: # make clean CLEANDEPENDS=YES
5358: # make update
5359:
5360:
1.4 rillig 5361: The following variables can be used either on the command line or in
1.1 dsieger 5362: mk.conf to alter the behaviour of make clean-update:
5363:
5364: CLEAR_DIRLIST
5365:
5366: After make clean, do not reconstruct the list of directories to update
5367: for this package. Only use this if make update successfully installed
5368: all packages you wanted to update. Normally, this is done automatically
5369: on make update, but may have been suppressed by the NOCLEAN variable
5370: (see above).
5371:
5372: replace
5373:
5374: Update the installation of the current package. This differs from update in
5375: that it does not replace dependent packages. You will need to install
5376: pkgtools/pkg_tarup for this target to work.
5377:
5378: Be careful when using this target! There are no guarantees that dependent
5379: packages will still work, in particular they will most certainly break if
5380: you make replace a library package whose shared library major version
5381: changed between your installed version and the new one. For this reason,
5382: this target is not officially supported and only recommended for advanced
5383: users.
5384:
5385: info
5386:
5387: This target invokes pkg_info(1) for the current package. You can use this
5388: to check which version of a package is installed.
5389:
5390: index
5391:
5392: This is a top-level command, i.e. it should be used in the pkgsrc
5393: directory. It creates a database of all packages in the local pkgsrc tree,
5394: including dependencies, comment, maintainer, and some other useful
5395: information. Individual entries are created by running make describe in the
5396: packages' directories. This index file is saved as pkgsrc/INDEX. It can be
5397: displayed in verbose format by running make print-index. You can search in
5398: it with make search key=something. You can extract a list of all packages
5399: that depend on a particular one by running make show-deps PKG=somepackage.
5400:
5401: Running this command takes a very long time, some hours even on fast
5402: machines!
5403:
5404: readme
5405:
5406: This target generates a README.html file, which can be viewed using a
5407: browser such as www/firefox or www/links. The generated files contain
5408: references to any packages which are in the PACKAGES directory on the local
5409: host. The generated files can be made to refer to URLs based on
5410: FTP_PKG_URL_HOST and FTP_PKG_URL_DIR. For example, if I wanted to generate
5411: README.html files which pointed to binary packages on the local machine, in
5412: the directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
5413: FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
5414: subdirectories will be searched for all the binary packages.
5415:
5416: The target can be run at the toplevel or in category directories, in which
5417: case it descends recursively.
5418:
5419: readme-all
5420:
5421: This is a top-level command, run it in pkgsrc. Use this target to create a
5422: file README-all.html which contains a list of all packages currently
5423: available in the NetBSD Packages Collection, together with the category
5424: they belong to and a short description. This file is compiled from the
5425: pkgsrc/*/README.html files, so be sure to run this after a make readme.
5426:
5427: cdrom-readme
5428:
5429: This is very much the same as the "readme" target (see above), but is to be
5430: used when generating a pkgsrc tree to be written to a CD-ROM. This target
5431: also produces README.html files, and can be made to refer to URLs based on
5432: CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
5433:
5434: show-distfiles
5435:
5436: This target shows which distfiles and patchfiles are needed to build the
5437: package (ALLFILES, which contains all DISTFILES and PATCHFILES, but not
5438: patches/*).
5439:
5440: show-downlevel
5441:
5442: This target shows nothing if the package is not installed. If a version of
5443: this package is installed, but is not the version provided in this version
5444: of pkgsrc, then a warning message is displayed. This target can be used to
5445: show which of your installed packages are downlevel, and so the old
5446: versions can be deleted, and the current ones added.
5447:
5448: show-pkgsrc-dir
5449:
5450: This target shows the directory in the pkgsrc hierarchy from which the
5451: package can be built and installed. This may not be the same directory as
5452: the one from which the package was installed. This target is intended to be
5453: used by people who may wish to upgrade many packages on a single host, and
1.25 wiz 5454: can be invoked from the top-level pkgsrc Makefile by using the "
5455: show-host-specific-pkgs" target.
1.1 dsieger 5456:
5457: show-installed-depends
5458:
5459: This target shows which installed packages match the current package's
5460: DEPENDS. Useful if out of date dependencies are causing build problems.
5461:
1.95 wiz 5462: print-build-depends-list
5463:
5464: This target shows the list of packages that the current package depends on
5465: for building.
5466:
5467: print-run-depends-list
5468:
5469: This target shows the list of packages that the current package depends on
5470: for running.
5471:
1.1 dsieger 5472: check-shlibs
5473:
5474: After a package is installed, check all its binaries and (on ELF platforms)
5475: shared libraries to see if they find the shared libs they need. Run by
1.4 rillig 5476: default if PKG_DEVELOPER is set in mk.conf.
1.1 dsieger 5477:
5478: print-PLIST
5479:
5480: After a "make install" from a new or upgraded pkg, this prints out an
5481: attempt to generate a new PLIST from a find -newer work/.extract_done. An
5482: attempt is made to care for shared libs etc., but it is strongly
5483: recommended to review the result before putting it into PLIST. On upgrades,
5484: it's useful to diff the output of this command against an already existing
5485: PLIST file.
5486:
5487: If the package installs files via tar(1) or other methods that don't update
5488: file access times, be sure to add these files manually to your PLIST, as
5489: the "find -newer" command used by this target won't catch them!
5490:
1.6 rillig 5491: See Section 13.3, "Tweaking output of make print-PLIST" for more
1.1 dsieger 5492: information on this target.
5493:
5494: bulk-package
5495:
5496: Used to do bulk builds. If an appropriate binary package already exists, no
5497: action is taken. If not, this target will compile, install and package it
1.66 asau 5498: (and its depends, if PKG_DEPENDS is set properly. See Chapter 7, Creating
5499: binary packages for everything in pkgsrc (bulk builds)). After creating the
5500: binary package, the sources, the just-installed package and its required
5501: packages are removed, preserving free disk space.
1.1 dsieger 5502:
5503: Beware that this target may deinstall all packages installed on a system!
5504:
5505: bulk-install
5506:
5507: Used during bulk-installs to install required packages. If an up-to-date
1.25 wiz 5508: binary package is available, it will be installed via pkg_add(1). If not,
1.1 dsieger 5509: make bulk-package will be executed, but the installed binary won't be
5510: removed.
5511:
5512: A binary package is considered "up-to-date" to be installed via pkg_add(1)
5513: if:
5514:
1.42 asau 5515: + None of the package's files (Makefile, ...) were modified since it was
1.1 dsieger 5516: built.
5517:
1.42 asau 5518: + None of the package's required (binary) packages were modified since it
1.1 dsieger 5519: was built.
5520:
5521: Beware that this target may deinstall all packages installed on a system!
5522:
1.6 rillig 5523: Chapter 18. Tools needed for building or running
1.1 dsieger 5524:
5525: Table of Contents
5526:
1.6 rillig 5527: 18.1. Tools for pkgsrc builds
5528: 18.2. Tools needed by packages
5529: 18.3. Tools provided by platforms
1.1 dsieger 5530:
5531: The USE_TOOLS definition is used both internally by pkgsrc and also for
5532: individual packages to define what commands are needed for building a package
5533: (like BUILD_DEPENDS) or for later run-time of an installed packaged (such as
5534: DEPENDS). If the native system provides an adequate tool, then in many cases, a
5535: pkgsrc package will not be used.
5536:
5537: When building a package, the replacement tools are made available in a
5538: directory (as symlinks or wrapper scripts) that is early in the executable
5539: search path. Just like the buildlink system, this helps with consistent builds.
5540:
5541: A tool may be needed to help build a specific package. For example, perl, GNU
5542: make (gmake) or yacc may be needed.
5543:
5544: Also a tool may be needed, for example, because the native system's supplied
5545: tool may be inefficient for building a package with pkgsrc. For example, a
5546: package may need GNU awk, bison (instead of yacc) or a better sed.
5547:
5548: The tools used by a package can be listed by running make show-tools.
5549:
1.6 rillig 5550: 18.1. Tools for pkgsrc builds
1.1 dsieger 5551:
5552: The default set of tools used by pkgsrc is defined in bsd.pkg.mk. This includes
5553: standard Unix tools, such as: cat, awk, chmod, test, and so on. These can be
5554: seen by running: make show-var VARNAME=USE_TOOLS.
5555:
5556: If a package needs a specific program to build then the USE_TOOLS variable can
5557: be used to define the tools needed.
5558:
1.6 rillig 5559: 18.2. Tools needed by packages
1.1 dsieger 5560:
1.29 wiz 5561: In the following examples, the :run means that it is needed at run-time (and
5562: becomes a DEPENDS). The default is a build dependency which can be set with
5563: :build. (So in this example, it is the same as gmake:build and
5564: pkg-config:build.)
1.1 dsieger 5565:
5566: USE_TOOLS+= gmake perl:run pkg-config
5567:
5568: When using the tools framework, a TOOLS_PATH.foo variable is defined which
5569: contains the full path to the appropriate tool. For example, TOOLS_PATH.bash
5570: could be "/bin/bash" on Linux systems.
5571:
5572: If you always need a pkgsrc version of the tool at run-time, then just use
5573: DEPENDS instead.
5574:
1.6 rillig 5575: 18.3. Tools provided by platforms
1.1 dsieger 5576:
5577: When improving or porting pkgsrc to a new platform, have a look at (or create)
5578: the corresponding platform specific make file fragment under pkgsrc/mk/tools/
5579: tools.${OPSYS}.mk which defines the name of the common tools. For example:
5580:
5581: .if exists(/usr/bin/bzcat)
5582: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
5583: .elif exists(/usr/bin/bzip2)
5584: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
5585: .endif
5586:
5587: TOOLS_PLATFORM.true?= true # shell builtin
5588:
1.6 rillig 5589: Chapter 19. Making your package work
1.1 dsieger 5590:
5591: Table of Contents
5592:
1.6 rillig 5593: 19.1. General operation
1.1 dsieger 5594:
1.108 rillig 5595: 19.1.1. How to pull in user-settable variables from mk.conf
5596: 19.1.2. User interaction
5597: 19.1.3. Handling licenses
5598: 19.1.4. Restricted packages
5599: 19.1.5. Handling dependencies
5600: 19.1.6. Handling conflicts with other packages
5601: 19.1.7. Packages that cannot or should not be built
5602: 19.1.8. Packages which should not be deleted, once installed
5603: 19.1.9. Handling packages with security problems
5604: 19.1.10. How to handle incrementing versions when fixing an existing
1.1 dsieger 5605: package
1.108 rillig 5606: 19.1.11. Substituting variable text in the package files (the SUBST
1.1 dsieger 5607: framework)
5608:
1.108 rillig 5609: 19.2. The fetch phase
1.1 dsieger 5610:
1.6 rillig 5611: 19.2.1. Packages whose distfiles aren't available for plain downloading
5612: 19.2.2. How to handle modified distfiles with the 'old' name
1.88 tnn 5613: 19.2.3. Packages hosted on github.com
1.1 dsieger 5614:
1.108 rillig 5615: 19.3. The configure phase
1.1 dsieger 5616:
1.6 rillig 5617: 19.3.1. Shared libraries - libtool
5618: 19.3.2. Using libtool on GNU packages that already support libtool
5619: 19.3.3. GNU Autoconf/Automake
5620:
5621: 19.4. Programming languages
5622:
5623: 19.4.1. C, C++, and Fortran
5624: 19.4.2. Java
5625: 19.4.3. Packages containing perl scripts
1.41 wiz 5626: 19.4.4. Packages containing shell scripts
5627: 19.4.5. Other programming languages
1.6 rillig 5628:
1.108 rillig 5629: 19.5. The build phase
1.6 rillig 5630:
5631: 19.5.1. Compiling C and C++ code conditionally
5632: 19.5.2. How to handle compiler bugs
1.24 wiz 5633: 19.5.3. Undefined reference to "..."
1.6 rillig 5634: 19.5.4. Running out of memory
5635:
1.108 rillig 5636: 19.6. The install phase
1.6 rillig 5637:
5638: 19.6.1. Creating needed directories
5639: 19.6.2. Where to install documentation
5640: 19.6.3. Installing highscore files
5641: 19.6.4. Adding DESTDIR support to packages
5642: 19.6.5. Packages with hardcoded paths to other interpreters
5643: 19.6.6. Packages installing perl modules
5644: 19.6.7. Packages installing info files
5645: 19.6.8. Packages installing man pages
1.7 rillig 5646: 19.6.9. Packages installing GConf data files
1.18 mishka 5647: 19.6.10. Packages installing scrollkeeper/rarian data files
1.6 rillig 5648: 19.6.11. Packages installing X11 fonts
5649: 19.6.12. Packages installing GTK2 modules
5650: 19.6.13. Packages installing SGML or XML data
5651: 19.6.14. Packages installing extensions to the MIME database
5652: 19.6.15. Packages using intltool
5653: 19.6.16. Packages installing startup scripts
5654: 19.6.17. Packages installing TeX modules
5655: 19.6.18. Packages supporting running binaries in emulation
5656: 19.6.19. Packages installing hicolor theme icons
5657: 19.6.20. Packages installing desktop files
1.1 dsieger 5658:
1.6 rillig 5659: 19.7. Marking packages as having problems
1.1 dsieger 5660:
1.6 rillig 5661: 19.1. General operation
1.1 dsieger 5662:
5663: One appealing feature of pkgsrc is that it runs on many different platforms. As
5664: a result, it is important to ensure, where possible, that packages in pkgsrc
5665: are portable. This chapter mentions some particular details you should pay
5666: attention to while working on pkgsrc.
5667:
1.108 rillig 5668: 19.1.1. How to pull in user-settable variables from mk.conf
1.1 dsieger 5669:
5670: The pkgsrc user can configure pkgsrc by overriding several variables in the
1.4 rillig 5671: file pointed to by MAKECONF, which is mk.conf by default. When you want to use
5672: those variables in the preprocessor directives of make(1) (for example .if or
5673: .for), you need to include the file ../../mk/bsd.prefs.mk before, which in turn
5674: loads the user preferences.
1.1 dsieger 5675:
5676: But note that some variables may not be completely defined after ../../mk/
5677: bsd.prefs.mk has been included, as they may contain references to variables
1.108 rillig 5678: that are not yet defined. In shell commands (the lines in Makefile that are
5679: indented with a tab) this is no problem, since variables are only expanded when
5680: they are used. But in the preprocessor directives mentioned above and in
5681: dependency lines (of the form target: dependencies) the variables are expanded
5682: at load time.
1.1 dsieger 5683:
5684: Note
5685:
1.108 rillig 5686: To check whether a variable can be used at load time, run pkglint -Wall on your
5687: package.
1.1 dsieger 5688:
1.108 rillig 5689: 19.1.2. User interaction
1.1 dsieger 5690:
5691: Occasionally, packages require interaction from the user, and this can be in a
5692: number of ways:
5693:
5694: * When fetching the distfiles, some packages require user interaction such as
5695: entering username/password or accepting a license on a web page.
5696:
5697: * When extracting the distfiles, some packages may ask for passwords.
5698:
5699: * help to configure the package before it is built
5700:
5701: * help during the build process
5702:
5703: * help during the installation of a package
5704:
1.108 rillig 5705: A package can set the INTERACTIVE_STAGE variable to define which stages need
5706: interaction. This should be done in the package's Makefile, e.g.:
1.1 dsieger 5707:
5708: INTERACTIVE_STAGE= configure install
5709:
5710: The user can then decide to skip this package by setting the BATCH variable.
1.108 rillig 5711: Packages that require interaction are also excluded from bulk builds.
1.1 dsieger 5712:
1.108 rillig 5713: 19.1.3. Handling licenses
1.1 dsieger 5714:
5715: Authors of software can choose the licence under which software can be copied.
1.111 sevan 5716: The Free Software Foundation has declared some licenses "Free", and the Open
5717: Source Initiative has a definition of "Open Source".
5718:
5719: By default, pkgsrc allows packages with Free or Open Source licenses to be
5720: built. To allow packages with other licenses to be built as well, the pkgsrc
5721: user needs to add these licenses to the ACCEPTABLE_LICENSES variable in mk.conf
5722: . Note that this variable only affects which packages may be built, while the
5723: license terms often also restrict the actual use of the package and its
5724: redistribution.
1.1 dsieger 5725:
5726: One might want to only install packages with a BSD license, or the GPL, and not
1.20 jnemeth 5727: the other. The free licenses are added to the default ACCEPTABLE_LICENSES
1.111 sevan 5728: variable. The pkgsrc user can override the default by setting the
5729: ACCEPTABLE_LICENSES variable with "=" instead of "+=". The licenses accepted by
5730: default are defined in the DEFAULT_ACCEPTABLE_LICENSES variable in the file
5731: pkgsrc/mk/license.mk.
1.1 dsieger 5732:
5733: The license tag mechanism is intended to address copyright-related issues
5734: surrounding building, installing and using a package, and not to address
1.20 jnemeth 5735: redistribution issues (see RESTRICTED and NO_SRC_ON_FTP, etc.). Packages with
5736: redistribution restrictions should set these tags.
1.1 dsieger 5737:
5738: Denoting that a package may be copied according to a particular license is done
5739: by placing the license in pkgsrc/licenses and setting the LICENSE variable to a
5740: string identifying the license, e.g. in graphics/xv:
5741:
5742: LICENSE= xv-license
5743:
5744: When trying to build, the user will get a notice that the package is covered by
5745: a license which has not been placed in the ACCEPTABLE_LICENSES variable:
5746:
5747: % make
5748: ===> xv-3.10anb9 has an unacceptable license: xv-license.
5749: ===> To view the license, enter "/usr/bin/make show-license".
5750: ===> To indicate acceptance, add this line to your /etc/mk.conf:
5751: ===> ACCEPTABLE_LICENSES+=xv-license
5752: *** Error code 1
5753:
5754: The license can be viewed with make show-license, and if the user so chooses,
1.4 rillig 5755: the line printed above can be added to mk.conf to convey to pkgsrc that it
1.1 dsieger 5756: should not in the future fail because of that license:
5757:
5758: ACCEPTABLE_LICENSES+=xv-license
5759:
1.111 sevan 5760: The use of LICENSE=shareware, LICENSE=no-commercial-use, and similar language
5761: is deprecated because it does not crisply refer to a particular license text.
5762: Another problem with such usage is that it does not enable a user to tell
5763: pkgsrc to proceed for a single package without also telling pkgsrc to proceed
5764: for all packages with that tag.
5765:
5766: 19.1.3.1. Adding a package with a new license
1.1 dsieger 5767:
1.49 rodent 5768: When adding a package with a new license, the following steps are required:
5769:
1.111 sevan 5770: 1. Check whether the license qualifies as Free or Open Source by referencing
5771: Various Licenses and Comments about Them and Licenses by Name | Open Source
5772: Initiative. If this is the case, the filename in pkgsrc/licenses/ does not
5773: need the -license suffix, and the license name should be added to:
1.49 rodent 5774:
5775: + DEFAULT_ACCEPTABLE_LICENSES in pkgsrc/mk/license.mk
5776:
5777: + default_acceptable_licenses in pkgsrc/pkgtools/pkg_install/files/lib/
5778: license.c
5779:
5780: 2. The license text should be added to pkgsrc/licenses for displaying. A list
5781: of known licenses can be seen in this directory.
1.1 dsieger 5782:
1.111 sevan 5783: 19.1.3.2. Change to the license
1.1 dsieger 5784:
1.111 sevan 5785: When the license changes (in a way other than formatting), make sure that the
5786: new license has a different name (e.g., append the version number if it exists,
5787: or the date). Just because a user told pkgsrc to build programs under a
5788: previous version of a license does not mean that pkgsrc should build programs
5789: under the new licenses. The higher-level point is that pkgsrc does not evaluate
5790: licenses for reasonableness; the only test is a mechanistic test of whether a
5791: particular text has been approved by either of two bodies (FSF or OSI).
1.1 dsieger 5792:
1.108 rillig 5793: 19.1.4. Restricted packages
1.1 dsieger 5794:
1.111 sevan 5795: Some licenses restrict how software may be re-distributed. By declaring the
5796: restrictions, package tools can automatically refrain from e.g. placing binary
5797: packages on FTP sites.
5798:
5799: There are four possible restrictions, which are the cross product of sources
5800: (distfiles) and binaries not being placed on FTP sites and CD-ROMs. Because
5801: this is rarely the exact language in any license, and because non-Free licenses
5802: tend to be different from each other, pkgsrc adopts a definition of FTP and
5803: CD-ROM. "FTP" means making the source or binary file available over the
5804: Internet at no charge. "CD-ROM" means making the source or binary available on
5805: some kind of media, together with other source and binary packages, which is
5806: sold for a distribution charge.
1.1 dsieger 5807:
5808: In order to encode these restrictions, the package system defines five make
5809: variables that can be set to note these restrictions:
5810:
5811: * RESTRICTED
5812:
5813: This variable should be set whenever a restriction exists (regardless of
5814: its kind). Set this variable to a string containing the reason for the
5815: restriction. It should be understood that those wanting to understand the
5816: restriction will have to read the license, and perhaps seek advice of
5817: counsel.
5818:
5819: * NO_BIN_ON_CDROM
5820:
5821: Binaries may not be placed on CD-ROM containing other binary packages, for
5822: which a distribution charge may be made. In this case, set this variable to
5823: ${RESTRICTED}.
5824:
5825: * NO_BIN_ON_FTP
5826:
5827: Binaries may not made available on the Internet without charge. In this
5828: case, set this variable to ${RESTRICTED}. If this variable is set, binary
5829: packages will not be included on ftp.NetBSD.org.
5830:
5831: * NO_SRC_ON_CDROM
5832:
5833: Distfiles may not be placed on CD-ROM, together with other distfiles, for
5834: which a fee may be charged. In this case, set this variable to $
5835: {RESTRICTED}.
5836:
5837: * NO_SRC_ON_FTP
5838:
5839: Distfiles may not made available via FTP at no charge. In this case, set
5840: this variable to ${RESTRICTED}. If this variable is set, the distfile(s)
5841: will not be mirrored on ftp.NetBSD.org.
5842:
1.111 sevan 5843: Please note that packages will be removed from pkgsrc when the distfiles are
1.33 wiz 5844: not distributable and cannot be obtained for a period of one full quarter
1.111 sevan 5845: branch. Packages with manual/interactive fetch must have a maintainer and it is
5846: his/her responsibility to ensure this.
1.33 wiz 5847:
1.108 rillig 5848: 19.1.5. Handling dependencies
1.1 dsieger 5849:
5850: Your package may depend on some other package being present - and there are
5851: various ways of expressing this dependency. pkgsrc supports the BUILD_DEPENDS
5852: and DEPENDS definitions, the USE_TOOLS definition, as well as dependencies via
5853: buildlink3.mk, which is the preferred way to handle dependencies, and which
1.6 rillig 5854: uses the variables named above. See Chapter 14, Buildlink methodology for more
1.1 dsieger 5855: information.
5856:
5857: The basic difference between the two variables is as follows: The DEPENDS
5858: definition registers that pre-requisite in the binary package so it will be
5859: pulled in when the binary package is later installed, whilst the BUILD_DEPENDS
5860: definition does not, marking a dependency that is only needed for building the
5861: package.
5862:
5863: This means that if you only need a package present whilst you are building, it
5864: should be noted as a BUILD_DEPENDS.
5865:
5866: The format for a BUILD_DEPENDS and a DEPENDS definition is:
5867:
5868: <pre-req-package-name>:../../<category>/<pre-req-package>
5869:
5870: Please note that the "pre-req-package-name" may include any of the wildcard
5871: version numbers recognized by pkg_info(1).
5872:
1.55 wiz 5873: 1. If your package needs another package's binaries or libraries to build and
1.1 dsieger 5874: run, and if that package has a buildlink3.mk file available, use it:
5875:
5876: .include "../../graphics/jpeg/buildlink3.mk"
5877:
1.55 wiz 5878: 2. If your package needs another package's binaries or libraries only for
5879: building, and if that package has a buildlink3.mk file available, use it:
5880:
5881: .include "../../graphics/jpeg/buildlink3.mk"
5882:
5883: but set BUILDLINK_DEPMETHOD.jpeg?=build to make it a build dependency only.
5884: This case is rather rare.
5885:
5886: 3. If your package needs binaries from another package to build, use the
1.26 spz 5887: BUILD_DEPENDS definition:
1.1 dsieger 5888:
1.147 tnn 5889: BUILD_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.1 dsieger 5890:
1.55 wiz 5891: 4. If your package needs a library with which to link and there is no
1.26 spz 5892: buildlink3.mk file available, create one. Using DEPENDS won't be sufficient
5893: because the include files and libraries will be hidden from the compiler.
1.1 dsieger 5894:
1.55 wiz 5895: 5. If your package needs some executable to be able to run correctly and if
1.26 spz 5896: there's no buildlink3.mk file, this is specified using the DEPENDS
5897: variable. The print/lyx package needs to be able to execute the latex
1.129 wiz 5898: binary from the tex-latex-bin package when it runs, and that is specified:
1.1 dsieger 5899:
1.129 wiz 5900: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.1 dsieger 5901:
1.55 wiz 5902: 6. You can use wildcards in package dependencies. Note that such wildcard
1.26 spz 5903: dependencies are retained when creating binary packages. The dependency is
5904: checked when installing the binary package and any package which matches
5905: the pattern will be used. Wildcard dependencies should be used with care.
1.1 dsieger 5906:
5907: The "-[0-9]*" should be used instead of "-*" to avoid potentially ambiguous
5908: matches such as "tk-postgresql" matching a "tk-*" DEPENDS.
5909:
5910: Wildcards can also be used to specify that a package will only build
5911: against a certain minimum version of a pre-requisite:
5912:
1.26 spz 5913: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 5914:
1.26 spz 5915: This means that the package will build using version 6.0 of ImageMagick or
5916: newer. Such a dependency may be warranted if, for example, the command line
5917: options of an executable have changed.
5918:
5919: If you need to depend on minimum versions of libraries, see the buildlink
5920: section of the pkgsrc guide.
1.1 dsieger 5921:
5922: For security fixes, please update the package vulnerabilities file. See
1.108 rillig 5923: Section 19.1.9, "Handling packages with security problems" for more
1.1 dsieger 5924: information.
5925:
5926: If your package needs files from another package to build, add the relevant
5927: distribution files to DISTFILES, so they will be extracted automatically. See
5928: the print/ghostscript package for an example. (It relies on the jpeg sources
5929: being present in source form during the build.)
5930:
1.108 rillig 5931: 19.1.6. Handling conflicts with other packages
1.1 dsieger 5932:
5933: Your package may conflict with other packages a user might already have
5934: installed on his system, e.g. if your package installs the same set of files as
1.80 wiz 5935: another package in the pkgsrc tree or has the same PKGNAME.
1.1 dsieger 5936:
1.142 leot 5937: For example, x11/libXaw3d and x11/Xaw-Xpm install the same shared library, thus
5938: you set in pkgsrc/x11/libXaw3d/Makefile:
1.1 dsieger 5939:
1.142 leot 5940: CONFLICTS= Xaw-Xpm-[0-9]*
1.1 dsieger 5941:
5942:
1.142 leot 5943: and in pkgsrc/x11/Xaw-Xpm/Makefile:
1.1 dsieger 5944:
1.142 leot 5945: CONFLICTS= libXaw3d-[0-9]*
1.1 dsieger 5946:
1.142 leot 5947:
5948: pkg_add(1) is able to detect attempts to install packages that conflict with
5949: existing packages and abort. However, in many situations this is too late in
5950: the process. Binary package managers will not know about the conflict until
5951: they attempt to install the package after already downloading it and all its
5952: dependencies. Users may also waste time building a package and its dependencies
5953: only to find out at the end that it conflicts with another package they have
5954: installed.
5955:
5956: To avoid these issues CONFLICTS entries should be added in all cases where it
5957: is known that packages conflict with each other. These CONFLICTS entries are
5958: exported in pkg_summary(5) files and consumed by binary package managers to
5959: inform users that packages cannot be installed onto the target system.
1.1 dsieger 5960:
1.108 rillig 5961: 19.1.7. Packages that cannot or should not be built
1.1 dsieger 5962:
5963: There are several reasons why a package might be instructed to not build under
5964: certain circumstances. If the package builds and runs on most platforms, the
1.83 dholland 5965: exceptions should be noted with BROKEN_ON_PLATFORM. If the package builds and
5966: runs on a small handful of platforms, set BROKEN_EXCEPT_ON_PLATFORM instead.
5967: Both BROKEN_ON_PLATFORM and BROKEN_EXCEPT_ON_PLATFORM are OS triples
5968: (OS-version-platform) that can use glob-style wildcards.
5969:
1.114 maya 5970: If a package is not appropriate for some platforms (as opposed to merely
1.83 dholland 5971: broken), a different set of variables should be used as this affects failure
5972: reporting and statistics. If the package is appropriate for most platforms, the
5973: exceptions should be noted with NOT_FOR_PLATFORM. If the package is appropriate
5974: for only a small handful of platforms (often exactly one), set
5975: ONLY_FOR_PLATFORM instead. Both ONLY_FOR_PLATFORM and NOT_FOR_PLATFORM are OS
5976: triples (OS-version-platform) that can use glob-style wildcards.
1.1 dsieger 5977:
5978: Some packages are tightly bound to a specific version of an operating system,
5979: e.g. LKMs or sysutils/lsof. Such binary packages are not backwards compatible
5980: with other versions of the OS, and should be uploaded to a version specific
5981: directory on the FTP server. Mark these packages by setting OSVERSION_SPECIFIC
5982: to "yes". This variable is not currently used by any of the package system
5983: internals, but may be used in the future.
5984:
5985: If the package should be skipped (for example, because it provides
5986: functionality already provided by the system), set PKG_SKIP_REASON to a
5987: descriptive message. If the package should fail because some preconditions are
5988: not met, set PKG_FAIL_REASON to a descriptive message.
5989:
1.108 rillig 5990: 19.1.8. Packages which should not be deleted, once installed
1.1 dsieger 5991:
5992: To ensure that a package may not be deleted, once it has been installed, the
5993: PKG_PRESERVE definition should be set in the package Makefile. This will be
1.25 wiz 5994: carried into any binary package that is made from this pkgsrc entry. A "
5995: preserved" package will not be deleted using pkg_delete(1) unless the "-f"
1.1 dsieger 5996: option is used.
5997:
1.108 rillig 5998: 19.1.9. Handling packages with security problems
1.1 dsieger 5999:
6000: When a vulnerability is found, this should be noted in localsrc/security/
1.32 wiz 6001: advisories/pkg-vulnerabilities, and after committing that file, ask
6002: pkgsrc-security@NetBSD.org to update the file on ftp.NetBSD.org.
1.1 dsieger 6003:
6004: After fixing the vulnerability by a patch, its PKGREVISION should be increased
6005: (this is of course not necessary if the problem is fixed by using a newer
1.32 wiz 6006: release of the software), and the pattern in the pkg-vulnerabilities file must
6007: be updated.
1.1 dsieger 6008:
6009: Also, if the fix should be applied to the stable pkgsrc branch, be sure to
6010: submit a pullup request!
6011:
6012: Binary packages already on ftp.NetBSD.org will be handled semi-automatically by
6013: a weekly cron job.
6014:
1.108 rillig 6015: 19.1.10. How to handle incrementing versions when fixing an existing package
1.1 dsieger 6016:
6017: When making fixes to an existing package it can be useful to change the version
6018: number in PKGNAME. To avoid conflicting with future versions by the original
6019: author, a "nb1", "nb2", ... suffix can be used on package versions by setting
6020: PKGREVISION=1 (2, ...). The "nb" is treated like a "." by the package tools.
6021: e.g.
6022:
6023: DISTNAME= foo-17.42
6024: PKGREVISION= 9
6025:
6026: will result in a PKGNAME of "foo-17.42nb9". If you want to use the original
6027: value of PKGNAME without the "nbX" suffix, e.g. for setting DIST_SUBDIR, use
6028: PKGNAME_NOREV.
6029:
6030: When a new release of the package is released, the PKGREVISION should be
6031: removed, e.g. on a new minor release of the above package, things should be
6032: like:
6033:
6034: DISTNAME= foo-17.43
6035:
6036: PKGREVISION should be incremented for any non-trivial change in the resulting
6037: binary package. Without a PKGREVISION bump, someone with the previous version
6038: installed has no way of knowing that their package is out of date. Thus,
6039: changes without increasing PKGREVISION are essentially labeled "this is so
6040: trivial that no reasonable person would want to upgrade", and this is the rough
6041: test for when increasing PKGREVISION is appropriate. Examples of changes that
6042: do not merit increasing PKGREVISION are:
6043:
1.14 jmcneill 6044: * Changing HOMEPAGE, MAINTAINER, OWNER, or comments in Makefile.
1.1 dsieger 6045:
6046: * Changing build variables if the resulting binary package is the same.
6047:
6048: * Changing DESCR.
6049:
6050: * Adding PKG_OPTIONS if the default options don't change.
6051:
6052: Examples of changes that do merit an increase to PKGREVISION include:
6053:
6054: * Security fixes
6055:
6056: * Changes or additions to a patch file
6057:
6058: * Changes to the PLIST
6059:
1.12 weinem 6060: * A dependency is changed or renamed.
6061:
1.1 dsieger 6062: PKGREVISION must also be incremented when dependencies have ABI changes.
6063:
1.108 rillig 6064: 19.1.11. Substituting variable text in the package files (the SUBST framework)
1.1 dsieger 6065:
6066: When you want to replace the same text in multiple files or when the
6067: replacement text varies, patches alone cannot help. This is where the SUBST
6068: framework comes in. It provides an easy-to-use interface for replacing text in
6069: files. Example:
6070:
6071: SUBST_CLASSES+= fix-paths
6072: SUBST_STAGE.fix-paths= pre-configure
6073: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
6074: SUBST_FILES.fix-paths= src/*.c
6075: SUBST_FILES.fix-paths+= scripts/*.sh
6076: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
6077: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
6078:
6079: SUBST_CLASSES is a list of identifiers that are used to identify the different
6080: SUBST blocks that are defined. The SUBST framework is heavily used by pkgsrc,
6081: so it is important to always use the += operator with this variable. Otherwise
6082: some substitutions may be skipped.
6083:
6084: The remaining variables of each SUBST block are parameterized with the
6085: identifier from the first line (fix-paths in this case.) They can be seen as
6086: parameters to a function call.
6087:
6088: SUBST_STAGE.* specifies the stage at which the replacement will take place. All
6089: combinations of pre-, do- and post- together with a phase name are possible,
6090: though only few are actually used. Most commonly used are post-patch and
6091: pre-configure. Of these two, pre-configure should be preferred because then it
6092: is possible to run bmake patch and have the state after applying the patches
6093: but before making any other changes. This is especially useful when you are
6094: debugging a package in order to create new patches for it. Similarly,
6095: post-build is preferred over pre-install, because the install phase should
6096: generally be kept as simple as possible. When you use post-build, you have the
6097: same files in the working directory that will be installed later, so you can
6098: check if the substitution has succeeded.
6099:
6100: SUBST_MESSAGE.* is an optional text that is printed just before the
6101: substitution is done.
6102:
6103: SUBST_FILES.* is the list of shell globbing patterns that specifies the files
6104: in which the substitution will take place. The patterns are interpreted
6105: relatively to the WRKSRC directory.
6106:
6107: SUBST_SED.* is a list of arguments to sed(1) that specify the actual
6108: substitution. Every sed command should be prefixed with -e, so that all SUBST
6109: blocks look uniform.
6110:
6111: There are some more variables, but they are so seldomly used that they are only
6112: documented in the mk/subst.mk file.
6113:
1.108 rillig 6114: 19.2. The fetch phase
1.1 dsieger 6115:
1.6 rillig 6116: 19.2.1. Packages whose distfiles aren't available for plain downloading
1.1 dsieger 6117:
6118: If you need to download from a dynamic URL you can set DYNAMIC_MASTER_SITES and
6119: a make fetch will call files/getsite.sh with the name of each file to download
6120: as an argument, expecting it to output the URL of the directory from which to
6121: download it. graphics/ns-cult3d is an example of this usage.
6122:
6123: If the download can't be automated, because the user must submit personal
6124: information to apply for a password, or must pay for the source, or whatever,
6125: you can set FETCH_MESSAGE to a list of lines that are displayed to the user
6126: before aborting the build. Example:
6127:
6128: FETCH_MESSAGE= "Please download the files"
6129: FETCH_MESSAGE+= " "${DISTFILES:Q}
6130: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
6131:
1.6 rillig 6132: 19.2.2. How to handle modified distfiles with the 'old' name
1.1 dsieger 6133:
6134: Sometimes authors of a software package make some modifications after the
6135: software was released, and they put up a new distfile without changing the
6136: package's version number. If a package is already in pkgsrc at that time, the
6137: checksum will no longer match. The contents of the new distfile should be
6138: compared against the old one before changing anything, to make sure the
6139: distfile was really updated on purpose, and that no trojan horse or so crept
6140: in. Please mention that the distfiles were compared and what was found in your
1.54 rodent 6141: commit message.
6142:
6143: Then, the correct way to work around this is to set DIST_SUBDIR to a unique
1.109 wiz 6144: directory name, usually based on PKGNAME_NOREV (but take care with python or
6145: ruby packages, where PKGNAME includes a variable prefix). All DISTFILES and
6146: PATCHFILES for this package will be put in that subdirectory of the local
6147: distfiles directory. (See Section 19.1.10, "How to handle incrementing versions
6148: when fixing an existing package" for more details.) In case this happens more
6149: often, PKGNAME can be used (thus including the nbX suffix) or a date stamp can
6150: be appended, like ${PKGNAME_NOREV}-YYYYMMDD.
1.54 rodent 6151:
6152: DIST_SUBDIR is also used when a distfile's name does not contain a version and
6153: the distfile is apt to change. In cases where the likelihood of this is very
6154: small, DIST_SUBDIR might not be required. Additionally, DIST_SUBDIR must not be
6155: removed unless the distfile name changes, even if a package is being moved or
6156: renamed.
6157:
6158: Do not forget regenerating the distinfo file after that, since it contains the
6159: DIST_SUBDIR path in the filenames. Also, increase the PKGREVISION if the
6160: installed package is different. Furthermore, a mail to the package's authors
6161: seems appropriate telling them that changing distfiles after releases without
6162: changing the file names is not good practice.
1.1 dsieger 6163:
1.88 tnn 6164: 19.2.3. Packages hosted on github.com
6165:
1.90 tnn 6166: Helper methods exist for packages hosted on github.com which will often have
6167: distfile names that clash with other packages, for example 1.0.tar.gz. Use one
6168: of the three recipes from below:
1.88 tnn 6169:
6170: 19.2.3.1. Fetch based on a tagged release
6171:
6172: If your distfile URL looks similar to http://github.com/username/exampleproject
6173: /archive/v1.0.zip, then you are packaging a tagged release.
6174:
6175: DISTNAME= exampleproject-1.0
1.90 tnn 6176: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6177: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
6178: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 6179: EXTRACT_SUFX= .zip
6180:
6181: 19.2.3.2. Fetch based on a specific commit
6182:
6183: If your distfile URL looks similar to http://github.com/example/example/archive
6184: /988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz, then you are packaging a
6185: specific commit not tied to a release.
6186:
6187: DISTNAME= example-1.0
1.107 jnemeth 6188: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 6189: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
6190: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.88 tnn 6191:
6192: 19.2.3.3. Fetch based on release
6193:
6194: If your distfile URL looks similar to http://github.com/username/exampleproject
6195: /releases/download/rel-1.6/offensive-1.6.zip, then you are packaging a release.
6196:
1.90 tnn 6197: DISTNAME= offensive-1.6
1.88 tnn 6198: PKGNAME= ${DISTNAME:S/offensive/proper/}
1.90 tnn 6199: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6200: GITHUB_PROJECT= exampleproject
6201: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
6202: EXTRACT_SUFX= .zip
1.88 tnn 6203:
1.108 rillig 6204: 19.3. The configure phase
1.1 dsieger 6205:
1.6 rillig 6206: 19.3.1. Shared libraries - libtool
1.1 dsieger 6207:
6208: pkgsrc supports many different machines, with different object formats like
6209: a.out and ELF, and varying abilities to do shared library and dynamic loading
6210: at all. To accompany this, varying commands and options have to be passed to
6211: the compiler, linker, etc. to get the Right Thing, which can be pretty annoying
6212: especially if you don't have all the machines at your hand to test things. The
6213: devel/libtool pkg can help here, as it just "knows" how to build both static
6214: and dynamic libraries from a set of source files, thus being
6215: platform-independent.
6216:
6217: Here's how to use libtool in a package in seven simple steps:
6218:
6219: 1. Add USE_LIBTOOL=yes to the package Makefile.
6220:
6221: 2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of "$
6222: {CC}". You could even add it to the definition of CC, if only libraries are
6223: being built in a given Makefile. This one command will build both PIC and
6224: non-PIC library objects, so you need not have separate shared and
6225: non-shared library rules.
6226:
6227: 3. For the linking of the library, remove any "ar", "ranlib", and "ld
6228: -Bshareable" commands, and instead use:
6229:
6230: ${LIBTOOL} --mode=link \
6231: ${CC} -o ${.TARGET:.a=.la} \
6232: ${OBJS:.o=.lo} \
6233: -rpath ${PREFIX}/lib \
6234: -version-info major:minor
6235:
6236: Note that the library is changed to have a .la extension, and the objects
6237: are changed to have a .lo extension. Change OBJS as necessary. This
6238: automatically creates all of the .a, .so.major.minor, and ELF symlinks (if
6239: necessary) in the build directory. Be sure to include "-version-info",
6240: especially when major and minor are zero, as libtool will otherwise strip
6241: off the shared library version.
6242:
6243: From the libtool manual:
6244:
6245: So, libtool library versions are described by three integers:
6246:
6247: CURRENT
6248: The most recent interface number that this library implements.
6249:
6250: REVISION
6251: The implementation number of the CURRENT interface.
6252:
6253: AGE
6254: The difference between the newest and oldest interfaces that
6255: this library implements. In other words, the library implements
6256: all the interface numbers in the range from number `CURRENT -
6257: AGE' to `CURRENT'.
6258:
6259: If two libraries have identical CURRENT and AGE numbers, then the
6260: dynamic linker chooses the library with the greater REVISION number.
6261:
6262: The "-release" option will produce different results for a.out and ELF
1.25 wiz 6263: (excluding symlinks) in only one case. An ELF library of the form "
6264: libfoo-release.so.x.y" will have a symlink of "libfoo.so.x.y" on an a.out
1.1 dsieger 6265: platform. This is handled automatically.
6266:
6267: The "-rpath argument" is the install directory of the library being built.
6268:
6269: In the PLIST, include only the .la file, the other files will be added
6270: automatically.
6271:
6272: 4. When linking shared object (.so) files, i.e. files that are loaded via
6273: dlopen(3), NOT shared libraries, use "-module -avoid-version" to prevent
6274: them getting version tacked on.
6275:
6276: The PLIST file gets the foo.so entry.
6277:
6278: 5. When linking programs that depend on these libraries before they are
6279: installed, preface the cc(1) or ld(1) line with "${LIBTOOL} --mode=link",
6280: and it will find the correct libraries (static or shared), but please be
6281: aware that libtool will not allow you to specify a relative path in -L
6282: (such as "-L../somelib"), because it expects you to change that argument to
6283: be the .la file. e.g.
6284:
6285: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
6286:
6287: should be changed to:
6288:
6289: ${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
6290:
6291: and it will do the right thing with the libraries.
6292:
6293: 6. When installing libraries, preface the install(1) or cp(1) command with "$
6294: {LIBTOOL} --mode=install", and change the library name to .la. e.g.
6295:
1.23 jakllsch 6296: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 6297:
6298: This will install the static .a, shared library, any needed symlinks, and
6299: run ldconfig(8).
6300:
6301: 7. In your PLIST, include only the .la file (this is a change from previous
6302: behaviour).
6303:
1.6 rillig 6304: 19.3.2. Using libtool on GNU packages that already support libtool
1.1 dsieger 6305:
6306: Add USE_LIBTOOL=yes to the package Makefile. This will override the package's
6307: own libtool in most cases. For older libtool using packages, libtool is made by
6308: ltconfig script during the do-configure step; you can check the libtool script
6309: location by doing make configure; find work*/ -name libtool.
6310:
6311: LIBTOOL_OVERRIDE specifies which libtool scripts, relative to WRKSRC, to
6312: override. By default, it is set to "libtool */libtool */*/libtool". If this
6313: does not match the location of the package's libtool script(s), set it as
6314: appropriate.
6315:
6316: If you do not need *.a static libraries built and installed, then use
6317: SHLIBTOOL_OVERRIDE instead.
6318:
6319: If your package makes use of the platform-independent library for loading
6320: dynamic shared objects, that comes with libtool (libltdl), you should include
6321: devel/libltdl/buildlink3.mk.
6322:
6323: Some packages use libtool incorrectly so that the package may not work or build
6324: in some circumstances. Some of the more common errors are:
6325:
6326: * The inclusion of a shared object (-module) as a dependent library in an
6327: executable or library. This in itself isn't a problem if one of two things
6328: has been done:
6329:
6330: 1. The shared object is named correctly, i.e. libfoo.la, not foo.la
6331:
6332: 2. The -dlopen option is used when linking an executable.
6333:
6334: * The use of libltdl without the correct calls to initialisation routines.
6335: The function lt_dlinit() should be called and the macro
6336: LTDL_SET_PRELOADED_SYMBOLS included in executables.
6337:
1.6 rillig 6338: 19.3.3. GNU Autoconf/Automake
1.1 dsieger 6339:
6340: If a package needs GNU autoconf or automake to be executed to regenerate the
6341: configure script and Makefile.in makefile templates, then they should be
6342: executed in a pre-configure target.
6343:
6344: For packages that need only autoconf:
6345:
6346: AUTOCONF_REQD= 2.50 # if default version is not good enough
6347: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
6348: ...
6349:
6350: pre-configure:
6351: cd ${WRKSRC} && autoconf
6352:
6353: ...
6354:
6355: and for packages that need automake and autoconf:
6356:
6357: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
6358: USE_TOOLS+= automake # use "automake14" for automake-1.4
6359: ...
6360:
6361: pre-configure:
6362: set -e; cd ${WRKSRC}; \
6363: aclocal; autoheader; automake -a --foreign -i; autoconf
6364:
6365: ...
6366:
6367: Packages which use GNU Automake will almost certainly require GNU Make.
6368:
6369: There are times when the configure process makes additional changes to the
6370: generated files, which then causes the build process to try to re-execute the
6371: automake sequence. This is prevented by touching various files in the configure
6372: stage. If this causes problems with your package you can set AUTOMAKE_OVERRIDE=
6373: NO in the package Makefile.
6374:
1.6 rillig 6375: 19.4. Programming languages
1.1 dsieger 6376:
1.6 rillig 6377: 19.4.1. C, C++, and Fortran
1.1 dsieger 6378:
6379: Compilers for the C, C++, and Fortran languages comes with the NetBSD base
6380: system. By default, pkgsrc assumes that a package is written in C and will hide
1.6 rillig 6381: all other compilers (via the wrapper framework, see Chapter 14, Buildlink
1.1 dsieger 6382: methodology).
6383:
6384: To declare which language's compiler a package needs, set the USE_LANGUAGES
6385: variable. Allowed values currently are "c", "c++", and "fortran" (and any
6386: combination). The default is "c". Packages using GNU configure scripts, even if
6387: written in C++, usually need a C compiler for the configure phase.
6388:
1.6 rillig 6389: 19.4.2. Java
1.1 dsieger 6390:
6391: If a program is written in Java, use the Java framework in pkgsrc. The package
6392: must include ../../mk/java-vm.mk. This Makefile fragment provides the following
6393: variables:
6394:
6395: * USE_JAVA defines if a build dependency on the JDK is added. If USE_JAVA is
6396: set to "run", then there is only a runtime dependency on the JDK. The
6397: default is "yes", which also adds a build dependency on the JDK.
6398:
6399: * Set USE_JAVA2 to declare that a package needs a Java2 implementation. The
6400: supported values are "yes", "1.4", and "1.5". "yes" accepts any Java2
6401: implementation, "1.4" insists on versions 1.4 or above, and "1.5" only
6402: accepts versions 1.5 or above. This variable is not set by default.
6403:
1.25 wiz 6404: * PKG_JAVA_HOME is automatically set to the runtime location of the used Java
6405: implementation dependency. It may be used to set JAVA_HOME to a good value
6406: if the program needs this variable to be defined.
6407:
1.6 rillig 6408: 19.4.3. Packages containing perl scripts
1.1 dsieger 6409:
6410: If your package contains interpreted perl scripts, add "perl" to the USE_TOOLS
6411: variable and set REPLACE_PERL to ensure that the proper interpreter path is
6412: set. REPLACE_PERL should contain a list of scripts, relative to WRKSRC, that
1.74 wiz 6413: you want adjusted. Every occurrence of */bin/perl in a she-bang line will be
6414: replaced with the full path to the perl executable.
1.1 dsieger 6415:
6416: If a particular version of perl is needed, set the PERL5_REQD variable to the
6417: version number. The default is "5.0".
6418:
1.6 rillig 6419: See Section 19.6.6, "Packages installing perl modules" for information about
1.1 dsieger 6420: handling perl modules.
6421:
1.41 wiz 6422: 19.4.4. Packages containing shell scripts
6423:
6424: REPLACE_SH, REPLACE_BASH, REPLACE_CSH, and REPLACE_KSH can be used to replace
6425: shell hash bangs in files. Please use the appropriate one, prefering REPLACE_SH
1.74 wiz 6426: in case this shell is sufficient. Each should contain a list of scripts,
6427: relative to WRKSRC, that you want adjusted. Every occurrence of the matching
6428: shell in a she-bang line will be replaced with the full path to the shell
6429: executable. When using REPLACE_BASH, don't forget to add bash to USE_TOOLS.
1.41 wiz 6430:
6431: 19.4.5. Other programming languages
1.1 dsieger 6432:
6433: Currently, there is no special handling for other languages in pkgsrc. If a
6434: compiler package provides a buildlink3.mk file, include that, otherwise just
6435: add a (build) dependency on the appropriate compiler package.
6436:
1.108 rillig 6437: 19.5. The build phase
1.1 dsieger 6438:
6439: The most common failures when building a package are that some platforms do not
6440: provide certain header files, functions or libraries, or they provide the
6441: functions in a library that the original package author didn't know. To work
6442: around this, you can rewrite the source code in most cases so that it does not
6443: use the missing functions or provides a replacement function.
6444:
1.6 rillig 6445: 19.5.1. Compiling C and C++ code conditionally
1.1 dsieger 6446:
6447: If a package already comes with a GNU configure script, the preferred way to
6448: fix the build failure is to change the configure script, not the code. In the
6449: other cases, you can utilize the C preprocessor, which defines certain macros
6450: depending on the operating system and hardware architecture it compiles for.
6451: These macros can be queried using for example #if defined(__i386). Almost every
6452: operating system, hardware architecture and compiler has its own macro. For
6453: example, if the macros __GNUC__, __i386__ and __NetBSD__ are all defined, you
6454: know that you are using NetBSD on an i386 compatible CPU, and your compiler is
6455: GCC.
6456:
6457: The list of the following macros for hardware and operating system depends on
6458: the compiler that is used. For example, if you want to conditionally compile
6459: code on Solaris, don't use __sun__, as the SunPro compiler does not define it.
6460: Use __sun instead.
6461:
1.6 rillig 6462: 19.5.1.1. C preprocessor macros to identify the operating system
1.1 dsieger 6463:
6464: To distinguish between 4.4 BSD-derived systems and the rest of the world, you
6465: should use the following code.
6466:
6467: #include <sys/param.h>
6468: #if (defined(BSD) && BSD >= 199306)
6469: /* BSD-specific code goes here */
6470: #else
6471: /* non-BSD-specific code goes here */
6472: #endif
6473:
6474: If this distinction is not fine enough, you can also test for the following
6475: macros.
6476:
1.46 obache 6477: Cygwin __CYGWIN__
6478: DragonFly __DragonFly__
1.1 dsieger 6479: FreeBSD __FreeBSD__
1.46 obache 6480: Haiku __HAIKU__
1.1 dsieger 6481: Interix __INTERIX
6482: IRIX __sgi (TODO: get a definite source for this)
6483: Linux linux, __linux, __linux__
1.83 dholland 6484: Mac OS X __APPLE__
1.46 obache 6485: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
6486: Minix3 __minix
1.1 dsieger 6487: NetBSD __NetBSD__
6488: OpenBSD __OpenBSD__
6489: Solaris sun, __sun
6490:
1.6 rillig 6491: 19.5.1.2. C preprocessor macros to identify the hardware architecture
1.1 dsieger 6492:
6493: i386 i386, __i386, __i386__
6494: MIPS __mips
6495: SPARC sparc, __sparc
6496:
1.6 rillig 6497: 19.5.1.3. C preprocessor macros to identify the compiler
1.1 dsieger 6498:
6499: GCC __GNUC__ (major version), __GNUC_MINOR__
6500: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
6501: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
6502: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
6503:
1.6 rillig 6504: 19.5.2. How to handle compiler bugs
1.1 dsieger 6505:
6506: Some source files trigger bugs in the compiler, based on combinations of
6507: compiler version and architecture and almost always relation to optimisation
6508: being enabled. Common symptoms are gcc internal errors or never finishing
6509: compiling a file.
6510:
6511: Typically, a workaround involves testing the MACHINE_ARCH and compiler version,
1.87 tnn 6512: disabling optimisation for that combination of file, MACHINE_ARCH and compiler.
6513:
6514: This used to be a big problem in the past, but is rarely needed now as compiler
6515: technology has matured. If you still need to add a compiler specific
6516: workaround, please do so in the file hacks.mk and describe the symptom and
6517: compiler version as detailed as possible.
1.1 dsieger 6518:
1.6 rillig 6519: 19.5.3. Undefined reference to "..."
1.1 dsieger 6520:
6521: This error message often means that a package did not link to a shared library
6522: it needs. The following functions are known to cause this error message over
6523: and over.
6524:
6525: +-----------------------------------------------------+
6526: | Function |Library |Affected platforms|
6527: |-------------------------+--------+------------------|
6528: |accept, bind, connect |-lsocket|Solaris |
6529: |-------------------------+--------+------------------|
6530: |crypt |-lcrypt |DragonFly, NetBSD |
6531: |-------------------------+--------+------------------|
6532: |dlopen, dlsym |-ldl |Linux |
6533: |-------------------------+--------+------------------|
6534: |gethost* |-lnsl |Solaris |
6535: |-------------------------+--------+------------------|
6536: |inet_aton |-lresolv|Solaris |
6537: |-------------------------+--------+------------------|
6538: |nanosleep, sem_*, timer_*|-lrt |Solaris |
6539: |-------------------------+--------+------------------|
6540: |openpty |-lutil |Linux |
6541: +-----------------------------------------------------+
6542:
6543: To fix these linker errors, it is often sufficient to say LIBS.OperatingSystem+
6544: = -lfoo to the package Makefile and then say bmake clean; bmake.
6545:
1.6 rillig 6546: 19.5.3.1. Special issue: The SunPro compiler
1.1 dsieger 6547:
6548: When you are using the SunPro compiler, there is another possibility. That
6549: compiler cannot handle the following code:
6550:
6551: extern int extern_func(int);
6552:
6553: static inline int
6554: inline_func(int x)
6555: {
6556: return extern_func(x);
6557: }
6558:
6559: int main(void)
6560: {
6561: return 0;
6562: }
6563:
6564: It generates the code for inline_func even if that function is never used. This
6565: code then refers to extern_func, which can usually not be resolved. To solve
6566: this problem you can try to tell the package to disable inlining of functions.
6567:
1.6 rillig 6568: 19.5.4. Running out of memory
1.1 dsieger 6569:
6570: Sometimes packages fail to build because the compiler runs into an operating
6571: system specific soft limit. With the UNLIMIT_RESOURCES variable pkgsrc can be
1.94 wiz 6572: told to unlimit the resources. Currently, the allowed values are any
6573: combination of "cputime", "datasize", "memorysize", and "stacksize". Setting
6574: this variable is similar to running the shell builtin ulimit command to raise
6575: the maximum data segment size or maximum stack size of a process, respectively,
6576: to their hard limits.
1.1 dsieger 6577:
1.108 rillig 6578: 19.6. The install phase
1.1 dsieger 6579:
1.6 rillig 6580: 19.6.1. Creating needed directories
1.1 dsieger 6581:
6582: The BSD-compatible install supplied with some operating systems cannot create
6583: more than one directory at a time. As such, you should call ${INSTALL_*_DIR}
6584: like this:
6585:
6586: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
6587: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
6588:
6589: You can also just append "dir1 dir2" to the INSTALLATION_DIRS variable, which
6590: will automatically do the right thing.
6591:
1.6 rillig 6592: 19.6.2. Where to install documentation
1.1 dsieger 6593:
6594: In general, documentation should be installed into ${PREFIX}/share/doc/$
6595: {PKGBASE} or ${PREFIX}/share/doc/${PKGNAME} (the latter includes the version
6596: number of the package).
6597:
6598: Many modern packages using GNU autoconf allow to set the directory where HTML
6599: documentation is installed with the "--with-html-dir" option. Sometimes using
6600: this flag is needed because otherwise the documentation ends up in ${PREFIX}/
6601: share/doc/html or other places.
6602:
6603: An exception to the above is that library API documentation generated with the
6604: textproc/gtk-doc tools, for use by special browsers (devhelp) should be left at
6605: their default location, which is ${PREFIX}/share/gtk-doc. Such documentation
6606: can be recognized from files ending in .devhelp or .devhelp2. (It is also
6607: acceptable to install such files in ${PREFIX}/share/doc/${PKGBASE} or ${PREFIX}
6608: /share/doc/${PKGNAME}; the .devhelp* file must be directly in that directory
6609: then, no additional subdirectory level is allowed in this case. This is usually
6610: achieved by using "--with-html-dir=${PREFIX}/share/doc". ${PREFIX}/share/
6611: gtk-doc is preferred though.)
6612:
1.6 rillig 6613: 19.6.3. Installing highscore files
1.1 dsieger 6614:
6615: Certain packages, most of them in the games category, install a score file that
6616: allows all users on the system to record their highscores. In order for this to
6617: work, the binaries need to be installed setgid and the score files owned by the
1.36 wiz 6618: appropriate group and/or owner (traditionally the "games" user/group). Set
6619: USE_GAMESGROUP to yes to support this. The following variables, documented in
6620: more detail in mk/defaults/mk.conf, control this behaviour: GAMEDATAMODE,
1.100 leot 6621: GAMEDIRMODE, GAMES_GROUP, GAMEMODE, GAME_USER. Other useful variables are:
6622: GAMEDIR_PERMS, GAMEDATA_PERMS and SETGID_GAMES_PERMS.
6623:
6624: An example that illustrates some of the variables described above is games/
6625: moon-buggy. OWN_DIRS_PERMS is used to properly set directory permissions of the
6626: directory where the scorefile is saved, REQD_FILES_PERMS is used to create a
6627: dummy scorefile (mbscore) with the proper permissions and SPECIAL_PERMS is used
6628: to install setgid the game binary:
6629:
6630: USE_GAMESGROUP= yes
6631:
6632: BUILD_DEFS+= VARBASE
6633:
6634: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
6635: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
6636: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
6637:
6638: Various INSTALL_* variables are also available: INSTALL_GAME to install setgid
6639: game binaries, INSTALL_GAME_DIR to install game directories that are needed to
6640: be accessed by setgid games and INSTALL_GAME_DATA to install scorefiles.
1.1 dsieger 6641:
1.14 jmcneill 6642: A package should therefore never hard code file ownership or access permissions
1.100 leot 6643: but rely on *_PERMS as described above or alternatively on INSTALL_GAME,
6644: INSTALL_GAME_DATA and INSTALL_GAME_DIR to set these correctly.
1.1 dsieger 6645:
1.6 rillig 6646: 19.6.4. Adding DESTDIR support to packages
1.4 rillig 6647:
1.14 jmcneill 6648: DESTDIR support means that a package installs into a staging directory, not the
6649: final location of the files. Then a binary package is created which can be used
6650: for installation as usual. There are two ways: Either the package must install
1.25 wiz 6651: as root ("destdir") or the package can install as non-root user ("user-destdir"
6652: ).
1.14 jmcneill 6653:
1.113 leot 6654: * PKG_DESTDIR_SUPPORT has to be set to "destdir" or "user-destdir". By
6655: default PKG_DESTDIR_SUPPORT is set to "user-destdir" to help catching more
6656: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
6657: PKG_DESTDIR_SUPPORT needs to be set before the inclusion.
1.14 jmcneill 6658:
1.4 rillig 6659: * All installation operations have to be prefixed with ${DESTDIR}.
6660:
6661: * automake gets this DESTDIR mostly right automatically. Many manual rules
6662: and pre/post-install often are incorrect; fix them.
6663:
1.17 imil 6664: * If files are installed with special owner/group use SPECIAL_PERMS.
1.4 rillig 6665:
6666: * In general, packages should support UNPRIVILEGED to be able to use DESTDIR.
6667:
1.6 rillig 6668: 19.6.5. Packages with hardcoded paths to other interpreters
1.1 dsieger 6669:
6670: Your package may also contain scripts with hardcoded paths to other
6671: interpreters besides (or as well as) perl. To correct the full pathname to the
6672: script interpreter, you need to set the following definitions in your Makefile
6673: (we shall use tclsh in this example):
6674:
6675: REPLACE_INTERPRETER+= tcl
6676: REPLACE.tcl.old= .*/bin/tclsh
6677: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
6678: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
6679: # relative to ${WRKSRC}, just as in REPLACE_PERL
6680:
6681: Note
6682:
6683: Before March 2006, these variables were called _REPLACE.* and _REPLACE_FILES.*.
6684:
1.6 rillig 6685: 19.6.6. Packages installing perl modules
1.1 dsieger 6686:
6687: Makefiles of packages providing perl5 modules should include the Makefile
6688: fragment ../../lang/perl5/module.mk. It provides a do-configure target for the
6689: standard perl configuration for such modules as well as various hooks to tune
6690: this configuration. See comments in this file for details.
6691:
6692: Perl5 modules will install into different places depending on the version of
6693: perl used during the build process. To address this, pkgsrc will append lines
6694: to the PLIST corresponding to the files listed in the installed .packlist file
6695: generated by most perl5 modules. This is invoked by defining PERL5_PACKLIST to
1.48 wiz 6696: a space-separated list of packlist files relative to PERL5_PACKLIST_DIR
6697: (PERL5_INSTALLVENDORARCH by default), e.g.:
1.1 dsieger 6698:
1.48 wiz 6699: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 6700:
1.48 wiz 6701: The perl5 config variables installarchlib, installscript, installvendorbin,
6702: installvendorscript, installvendorarch, installvendorlib, installvendorman1dir,
6703: and installvendorman3dir represent those locations in which components of perl5
6704: modules may be installed, provided as variable with uppercase and prefixed with
6705: PERL5_, e.g. PERL5_INSTALLARCHLIB and may be used by perl5 packages that don't
6706: have a packlist. These variables are also substituted for in the PLIST as
6707: uppercase prefixed with PERL5_SUB_.
1.1 dsieger 6708:
1.6 rillig 6709: 19.6.7. Packages installing info files
1.1 dsieger 6710:
6711: Some packages install info files or use the "makeinfo" or "install-info"
6712: commands. INFO_FILES should be defined in the package Makefile so that INSTALL
6713: and DEINSTALL scripts will be generated to handle registration of the info
6714: files in the Info directory file. The "install-info" command used for the info
6715: files registration is either provided by the system, or by a special purpose
6716: package automatically added as dependency if needed.
6717:
6718: PKGINFODIR is the directory under ${PREFIX} where info files are primarily
6719: located. PKGINFODIR defaults to "info" and can be overridden by the user.
6720:
6721: The info files for the package should be listed in the package PLIST; however
6722: any split info files need not be listed.
6723:
6724: A package which needs the "makeinfo" command at build time must add "makeinfo"
6725: to USE_TOOLS in its Makefile. If a minimum version of the "makeinfo" command is
6726: needed it should be noted with the TEXINFO_REQD variable in the package
6727: Makefile. By default, a minimum version of 3.12 is required. If the system does
6728: not provide a makeinfo command or if it does not match the required minimum, a
6729: build dependency on the devel/gtexinfo package will be added automatically.
6730:
6731: The build and installation process of the software provided by the package
6732: should not use the install-info command as the registration of info files is
1.25 wiz 6733: the task of the package INSTALL script, and it must use the appropriate
1.1 dsieger 6734: makeinfo command.
6735:
6736: To achieve this goal, the pkgsrc infrastructure creates overriding scripts for
6737: the install-info and makeinfo commands in a directory listed early in PATH.
6738:
6739: The script overriding install-info has no effect except the logging of a
6740: message. The script overriding makeinfo logs a message and according to the
6741: value of TEXINFO_REQD either runs the appropriate makeinfo command or exit on
6742: error.
6743:
1.6 rillig 6744: 19.6.8. Packages installing man pages
1.1 dsieger 6745:
6746: All packages that install manual pages should install them into the same
6747: directory, so that there is one common place to look for them. In pkgsrc, this
6748: place is ${PREFIX}/${PKGMANDIR}, and this expression should be used in
1.25 wiz 6749: packages. The default for PKGMANDIR is "man". Another often-used value is "
6750: share/man".
1.1 dsieger 6751:
6752: Note
6753:
6754: The support for a custom PKGMANDIR is far from complete.
6755:
6756: The PLIST files can just use man/ as the top level directory for the man page
6757: file entries, and the pkgsrc framework will convert as needed. In all other
6758: places, the correct PKGMANDIR must be used.
6759:
6760: Packages that are configured with GNU_CONFIGURE set as "yes", by default will
6761: use the ./configure --mandir switch to set where the man pages should be
6762: installed. The path is GNU_CONFIGURE_MANDIR which defaults to ${PREFIX}/$
6763: {PKGMANDIR}.
6764:
6765: Packages that use GNU_CONFIGURE but do not use --mandir, can set
6766: CONFIGURE_HAS_MANDIR to "no". Or if the ./configure script uses a non-standard
6767: use of --mandir, you can set GNU_CONFIGURE_MANDIR as needed.
6768:
1.6 rillig 6769: See Section 13.5, "Man page compression" for information on installation of
1.1 dsieger 6770: compressed manual pages.
6771:
1.7 rillig 6772: 19.6.9. Packages installing GConf data files
1.1 dsieger 6773:
1.7 rillig 6774: If a package installs .schemas or .entries files, used by GConf, you need to
1.1 dsieger 6775: take some extra steps to make sure they get registered in the database:
6776:
1.7 rillig 6777: 1. Include ../../devel/GConf/schemas.mk instead of its buildlink3.mk file.
6778: This takes care of rebuilding the GConf database at installation and
6779: deinstallation time, and tells the package where to install GConf data
1.1 dsieger 6780: files using some standard configure arguments. It also disallows any access
6781: to the database directly from the package.
6782:
6783: 2. Ensure that the package installs its .schemas files under ${PREFIX}/share/
6784: gconf/schemas. If they get installed under ${PREFIX}/etc, you will need to
6785: manually patch the package.
6786:
6787: 3. Check the PLIST and remove any entries under the etc/gconf directory, as
1.84 wiz 6788: they will be handled automatically. See Section 9.13, "How do I change the
1.1 dsieger 6789: location of configuration files?" for more information.
6790:
1.7 rillig 6791: 4. Define the GCONF_SCHEMAS variable in your Makefile with a list of all
1.1 dsieger 6792: .schemas files installed by the package, if any. Names must not contain any
6793: directories in them.
6794:
1.7 rillig 6795: 5. Define the GCONF_ENTRIES variable in your Makefile with a list of all
1.1 dsieger 6796: .entries files installed by the package, if any. Names must not contain any
6797: directories in them.
6798:
1.18 mishka 6799: 19.6.10. Packages installing scrollkeeper/rarian data files
1.1 dsieger 6800:
1.18 mishka 6801: If a package installs .omf files, used by scrollkeeper/rarian, you need to take
6802: some extra steps to make sure they get registered in the database:
1.1 dsieger 6803:
1.18 mishka 6804: 1. Include ../../mk/omf-scrollkeeper.mk instead of rarian's buildlink3.mk
6805: file. This takes care of rebuilding the scrollkeeper database at
6806: installation and deinstallation time, and disallows any access to it
6807: directly from the package.
1.1 dsieger 6808:
6809: 2. Check the PLIST and remove any entries under the libdata/scrollkeeper
6810: directory, as they will be handled automatically.
6811:
6812: 3. Remove the share/omf directory from the PLIST. It will be handled by
1.18 mishka 6813: rarian. (make print-PLIST does this automatically.)
1.1 dsieger 6814:
1.6 rillig 6815: 19.6.11. Packages installing X11 fonts
1.1 dsieger 6816:
6817: If a package installs font files, you will need to rebuild the fonts database
6818: in the directory where they get installed at installation and deinstallation
6819: time. This can be automatically done by using the pkginstall framework.
6820:
6821: You can list the directories where fonts are installed in the FONTS_DIRS.type
6822: variables, where type can be one of "ttf", "type1" or "x11". Also make sure
6823: that the database file fonts.dir is not listed in the PLIST.
6824:
6825: Note that you should not create new directories for fonts; instead use the
6826: standard ones to avoid that the user needs to manually configure his X server
6827: to find them.
6828:
1.6 rillig 6829: 19.6.12. Packages installing GTK2 modules
1.1 dsieger 6830:
6831: If a package installs GTK2 immodules or loaders, you need to take some extra
6832: steps to get them registered in the GTK2 database properly:
6833:
6834: 1. Include ../../x11/gtk2/modules.mk instead of its buildlink3.mk file. This
6835: takes care of rebuilding the database at installation and deinstallation
6836: time.
6837:
6838: 2. Set GTK2_IMMODULES=YES if your package installs GTK2 immodules.
6839:
6840: 3. Set GTK2_LOADERS=YES if your package installs GTK2 loaders.
6841:
6842: 4. Patch the package to not touch any of the GTK2 databases directly. These
6843: are:
6844:
1.42 asau 6845: + libdata/gtk-2.0/gdk-pixbuf.loaders
1.1 dsieger 6846:
1.42 asau 6847: + libdata/gtk-2.0/gtk.immodules
1.1 dsieger 6848:
6849: 5. Check the PLIST and remove any entries under the libdata/gtk-2.0 directory,
6850: as they will be handled automatically.
6851:
1.6 rillig 6852: 19.6.13. Packages installing SGML or XML data
1.1 dsieger 6853:
6854: If a package installs SGML or XML data files that need to be registered in
6855: system-wide catalogs (like DTDs, sub-catalogs, etc.), you need to take some
6856: extra steps:
6857:
6858: 1. Include ../../textproc/xmlcatmgr/catalogs.mk in your Makefile, which takes
6859: care of registering those files in system-wide catalogs at installation and
6860: deinstallation time.
6861:
6862: 2. Set SGML_CATALOGS to the full path of any SGML catalogs installed by the
6863: package.
6864:
6865: 3. Set XML_CATALOGS to the full path of any XML catalogs installed by the
6866: package.
6867:
6868: 4. Set SGML_ENTRIES to individual entries to be added to the SGML catalog.
6869: These come in groups of three strings; see xmlcatmgr(1) for more
6870: information (specifically, arguments recognized by the 'add' action). Note
6871: that you will normally not use this variable.
6872:
6873: 5. Set XML_ENTRIES to individual entries to be added to the XML catalog. These
6874: come in groups of three strings; see xmlcatmgr(1) for more information
6875: (specifically, arguments recognized by the 'add' action). Note that you
6876: will normally not use this variable.
6877:
1.6 rillig 6878: 19.6.14. Packages installing extensions to the MIME database
1.1 dsieger 6879:
6880: If a package provides extensions to the MIME database by installing .xml files
6881: inside ${PREFIX}/share/mime/packages, you need to take some extra steps to
6882: ensure that the database is kept consistent with respect to these new files:
6883:
6884: 1. Include ../../databases/shared-mime-info/mimedb.mk (avoid using the
6885: buildlink3.mk file from this same directory, which is reserved for
6886: inclusion from other buildlink3.mk files). It takes care of rebuilding the
6887: MIME database at installation and deinstallation time, and disallows any
6888: access to it directly from the package.
6889:
1.25 wiz 6890: 2. Check the PLIST and remove any entries under the share/mime directory,
1.1 dsieger 6891: except for files saved under share/mime/packages. The former are handled
6892: automatically by the update-mime-database program, but the latter are
6893: package-dependent and must be removed by the package that installed them in
6894: the first place.
6895:
6896: 3. Remove any share/mime/* directories from the PLIST. They will be handled by
6897: the shared-mime-info package.
6898:
1.6 rillig 6899: 19.6.15. Packages using intltool
1.1 dsieger 6900:
6901: If a package uses intltool during its build, add intltool to the USE_TOOLS,
6902: which forces it to use the intltool package provided by pkgsrc, instead of the
6903: one bundled with the distribution file.
6904:
6905: This tracks intltool's build-time dependencies and uses the latest available
6906: version; this way, the package benefits of any bug fixes that may have appeared
6907: since it was released.
6908:
1.6 rillig 6909: 19.6.16. Packages installing startup scripts
1.1 dsieger 6910:
6911: If a package contains a rc.d script, it won't be copied into the startup
6912: directory by default, but you can enable it, by adding the option
1.4 rillig 6913: PKG_RCD_SCRIPTS=YES in mk.conf. This option will copy the scripts into /etc/
6914: rc.d when a package is installed, and it will automatically remove the scripts
6915: when the package is deinstalled.
1.1 dsieger 6916:
1.6 rillig 6917: 19.6.17. Packages installing TeX modules
1.1 dsieger 6918:
6919: If a package installs TeX packages into the texmf tree, the ls-R database of
6920: the tree needs to be updated.
6921:
6922: Note
6923:
1.23 jakllsch 6924: Except the main TeX packages such as kpathsea, packages should install files
6925: into ${PREFIX}/share/texmf-dist, not ${PREFIX}/share/texmf.
1.1 dsieger 6926:
1.23 jakllsch 6927: 1. Include ../../print/kpathsea/texmf.mk. This takes care of rebuilding the
6928: ls-R database at installation and deinstallation time.
1.1 dsieger 6929:
1.23 jakllsch 6930: 2. If your package installs files into a texmf tree other than the one at $
6931: {PREFIX}/share/texmf-dist, set TEX_TEXMF_DIRS to the list of all texmf
6932: trees that need database update.
1.1 dsieger 6933:
6934: If your package also installs font map files that need to be registered
1.30 dholland 6935: using updmap, include ../../print/tex-tetex/map.mk and set TEX_MAP_FILES
6936: and/or TEX_MIXEDMAP_FILES to the list of all such font map files. Then
6937: updmap will be run automatically at installation/deinstallation to enable/
6938: disable font map files for TeX output drivers.
1.1 dsieger 6939:
6940: 3. Make sure that none of ls-R databases are included in PLIST, as they will
1.30 dholland 6941: be removed only by the kpathsea package.
1.1 dsieger 6942:
1.6 rillig 6943: 19.6.18. Packages supporting running binaries in emulation
1.1 dsieger 6944:
6945: There are some packages that provide libraries and executables for running
6946: binaries from a one operating system on a different one (if the latter supports
6947: it). One example is running Linux binaries on NetBSD.
6948:
6949: The pkgtools/rpm2pkg helps in extracting and packaging Linux rpm packages.
6950:
6951: The CHECK_SHLIBS can be set to no to avoid the check-shlibs target, which tests
6952: if all libraries for each installed executable can be found by the dynamic
6953: linker. Since the standard dynamic linker is run, this fails for emulation
6954: packages, because the libraries used by the emulation are not in the standard
6955: directories.
6956:
1.6 rillig 6957: 19.6.19. Packages installing hicolor theme icons
1.1 dsieger 6958:
6959: If a package installs images under the share/icons/hicolor and/or updates the
6960: share/icons/hicolor/icon-theme.cache database, you need to take some extra
6961: steps to make sure that the shared theme directory is handled appropriately and
6962: that the cache database is rebuilt:
6963:
6964: 1. Include ../../graphics/hicolor-icon-theme/buildlink3.mk.
6965:
6966: 2. Check the PLIST and remove the entry that refers to the theme cache.
6967:
6968: 3. Ensure that the PLIST does not remove the shared icon directories from the
6969: share/icons/hicolor hierarchy because they will be handled automatically.
6970:
6971: The best way to verify that the PLIST is correct with respect to the last two
6972: points is to regenerate it using make print-PLIST.
6973:
1.6 rillig 6974: 19.6.20. Packages installing desktop files
1.1 dsieger 6975:
6976: If a package installs .desktop files under share/applications and these include
1.54 rodent 6977: MIME information (MimeType key), you need to take extra steps to ensure that
6978: they are registered into the MIME database:
1.1 dsieger 6979:
6980: 1. Include ../../sysutils/desktop-file-utils/desktopdb.mk.
6981:
6982: 2. Check the PLIST and remove the entry that refers to the share/applications/
6983: mimeinfo.cache file. It will be handled automatically.
6984:
6985: The best way to verify that the PLIST is correct with respect to the last point
6986: is to regenerate it using make print-PLIST.
6987:
1.6 rillig 6988: 19.7. Marking packages as having problems
1.1 dsieger 6989:
1.23 jakllsch 6990: In some cases one does not have the time to solve a problem immediately. In
6991: this case, one can plainly mark a package as broken. For this, one just sets
6992: the variable BROKEN to the reason why the package is broken (similar to the
6993: RESTRICTED variable). A user trying to build the package will immediately be
6994: shown this message, and the build will not be even tried.
1.1 dsieger 6995:
1.23 jakllsch 6996: BROKEN packages are removed from pkgsrc in irregular intervals.
1.1 dsieger 6997:
1.6 rillig 6998: Chapter 20. Debugging
1.1 dsieger 6999:
7000: To check out all the gotchas when building a package, here are the steps that I
7001: do in order to get a package working. Please note this is basically the same as
7002: what was explained in the previous sections, only with some debugging aids.
7003:
1.4 rillig 7004: * Be sure to set PKG_DEVELOPER=yes in mk.conf.
1.1 dsieger 7005:
7006: * Install pkgtools/url2pkg, create a directory for a new package, change into
7007: it, then run url2pkg:
7008:
7009: % mkdir /usr/pkgsrc/category/examplepkg
7010: % cd /usr/pkgsrc/category/examplepkg
7011: % url2pkg http://www.example.com/path/to/distfile.tar.gz
7012:
7013: * Edit the Makefile as requested.
7014:
7015: * Fill in the DESCR file
7016:
7017: * Run make configure
7018:
7019: * Add any dependencies glimpsed from documentation and the configure step to
7020: the package's Makefile.
7021:
7022: * Make the package compile, doing multiple rounds of
7023:
7024: % make
7025: % pkgvi ${WRKSRC}/some/file/that/does/not/compile
7026: % mkpatches
7027: % patchdiff
7028: % mv ${WRKDIR}/.newpatches/* patches
7029: % make mps
7030: % make clean
7031:
7032: Doing this step as non-root user will ensure that no files are modified
7033: that shouldn't be, especially during the build phase. mkpatches, patchdiff
7034: and pkgvi are from the pkgtools/pkgdiff package.
7035:
1.6 rillig 7036: * Look at the Makefile, fix if necessary; see Section 11.1, "Makefile".
1.1 dsieger 7037:
7038: * Generate a PLIST:
7039:
7040: # make install
7041: # make print-PLIST >PLIST
7042: # make deinstall
7043: # make install
7044: # make deinstall
7045:
7046: You usually need to be root to do this. Look if there are any files left:
7047:
7048: # make print-PLIST
7049:
7050: If this reveals any files that are missing in PLIST, add them.
7051:
7052: * Now that the PLIST is OK, install the package again and make a binary
7053: package:
7054:
7055: # make reinstall
7056: # make package
7057:
7058: * Delete the installed package:
7059:
7060: # pkg_delete examplepkg
7061:
7062: * Repeat the above make print-PLIST command, which shouldn't find anything
7063: now:
7064:
7065: # make print-PLIST
7066:
7067: * Reinstall the binary package:
7068:
7069: # pkg_add .../examplepkg.tgz
7070:
7071: * Play with it. Make sure everything works.
7072:
7073: * Run pkglint from pkgtools/pkglint, and fix the problems it reports:
7074:
7075: # pkglint
7076:
1.6 rillig 7077: * Submit (or commit, if you have cvs access); see Chapter 21, Submitting and
1.1 dsieger 7078: Committing.
7079:
1.6 rillig 7080: Chapter 21. Submitting and Committing
1.1 dsieger 7081:
7082: Table of Contents
7083:
1.6 rillig 7084: 21.1. Submitting binary packages
7085: 21.2. Submitting source packages (for non-NetBSD-developers)
7086: 21.3. General notes when adding, updating, or removing packages
1.130 wiz 7087: 21.4. Commit Messages
7088: 21.5. Committing: Adding a package to CVS
7089: 21.6. Updating a package to a newer version
7090: 21.7. Renaming a package in pkgsrc
7091: 21.8. Moving a package in pkgsrc
1.1 dsieger 7092:
1.6 rillig 7093: 21.1. Submitting binary packages
1.1 dsieger 7094:
7095: Our policy is that we accept binaries only from pkgsrc developers to guarantee
7096: that the packages don't contain any trojan horses etc. This is not to annoy
7097: anyone but rather to protect our users! You're still free to put up your
7098: home-made binary packages and tell the world where to get them. NetBSD
1.66 asau 7099: developers doing bulk builds and wanting to upload them please see Chapter 7,
7100: Creating binary packages for everything in pkgsrc (bulk builds).
1.1 dsieger 7101:
1.6 rillig 7102: 21.2. Submitting source packages (for non-NetBSD-developers)
1.1 dsieger 7103:
7104: First, check that your package is complete, compiles and runs well; see
1.6 rillig 7105: Chapter 20, Debugging and the rest of this document. Next, generate an
1.1 dsieger 7106: uuencoded gzipped tar(1) archive that contains all files that make up the
7107: package. Finally, send this package to the pkgsrc bug tracking system, either
7108: with the send-pr(1) command, or if you don't have that, go to the web page
1.4 rillig 7109: http://www.NetBSD.org/support/send-pr.html, which contains some instructions
1.22 snj 7110: and a link to a form where you can submit packages. The sysutils/gtk-send-pr
7111: package is also available as a substitute for either of the above two tools.
1.1 dsieger 7112:
7113: In the form of the problem report, the category should be "pkg", the synopsis
7114: should include the package name and version number, and the description field
7115: should contain a short description of your package (contents of the COMMENT
1.25 wiz 7116: variable or DESCR file are OK). The uuencoded package data should go into the "
7117: fix" field.
1.1 dsieger 7118:
7119: If you want to submit several packages, please send a separate PR for each one,
7120: it's easier for us to track things that way.
7121:
7122: Alternatively, you can also import new packages into pkgsrc-wip ("pkgsrc
1.105 wiz 7123: work-in-progress"); see the homepage at http://pkgsrc.org/wip/ for details.
1.1 dsieger 7124:
1.6 rillig 7125: 21.3. General notes when adding, updating, or removing packages
1.1 dsieger 7126:
7127: Please note all package additions, updates, moves, and removals in pkgsrc/doc/
7128: CHANGES-YYYY. It's very important to keep this file up to date and conforming
7129: to the existing format, because it will be used by scripts to automatically
7130: update pages on www.NetBSD.org and other sites. Additionally, check the pkgsrc/
7131: doc/TODO file and remove the entry for the package you updated or removed, in
7132: case it was mentioned there.
7133:
7134: When the PKGREVISION of a package is bumped, the change should appear in pkgsrc
7135: /doc/CHANGES-YYYY if it is security related or otherwise relevant. Mass bumps
7136: that result from a dependency being updated should not be mentioned. In all
7137: other cases it's the developer's decision.
7138:
7139: There is a make target that helps in creating proper CHANGES-YYYY entries: make
7140: changes-entry. It uses the optional CTYPE and NETBSD_LOGIN_NAME variables. The
7141: general usage is to first make sure that your CHANGES-YYYY file is up-to-date
7142: (to avoid having to resolve conflicts later-on) and then to cd to the package
7143: directory. For package updates, make changes-entry is enough. For new packages,
7144: or package moves or removals, set the CTYPE variable on the command line to
1.4 rillig 7145: "Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in mk.conf if
1.23 jakllsch 7146: your local login name is not the same as your NetBSD login name. The target
7147: also automatically removes possibly existing entries for the package in the
7148: TODO file. Don't forget to commit the changes, e.g. by using make
1.66 asau 7149: commit-changes-entry! If you are not using a checkout directly from
1.23 jakllsch 7150: cvs.NetBSD.org, but e.g. a local copy of the repository, you can set
7151: USE_NETBSD_REPO=yes. This makes the cvs commands use the main repository.
1.1 dsieger 7152:
1.130 wiz 7153: 21.4. Commit Messages
7154:
7155: For several years, there have been mirrors of pkgsrc in fossil, git, and hg.
7156: Standard practise when using these tools is to make the first line of a commit
7157: message function as a summary that can be read without the rest, such as is
7158: commonly done with "git log --oneline". For this reason, we have the following
7159: guidelines for pkgsrc commit messages:
7160:
1.131 wiz 7161: * Start the commit message with a line that explains the big picture in 65
1.130 wiz 7162: characters or less. When a commit is for one package, include the name of
7163: the package. For updates, include the version to which it is updated.
7164:
7165: * Leave the next line empty.
7166:
7167: * Then come the details for the commit (changes in that package, reason for a
7168: change) and any relevant PRs. Wrap this section.
7169:
7170: Here is an example:
7171:
7172: libxslt: update to 1.0.30
7173:
7174: Changes since 1.0.29:
7175: ...
7176:
7177:
7178: Here is another example:
7179:
7180: mk/bsd.pkg.mk: enable SSP by default on NetBSD
7181:
7182: (rationale)
7183:
7184:
7185: Commit messages are final: no "cvs admin" is allowed on the pkgsrc repository
7186: to change commit messages.
7187:
7188: 21.5. Committing: Adding a package to CVS
1.1 dsieger 7189:
7190: This section is only of interest for pkgsrc developers with write access to the
1.34 wiz 7191: pkgsrc repository.
7192:
7193: When the package is finished, "cvs add" the files. Start by adding the
7194: directory and then files in the directory. Don't forget to add the new package
7195: to the category's Makefile. Make sure you don't forget any files; you can check
7196: by running "cvs status". An example:
7197:
7198: $ cd .../pkgsrc/category
7199: $ cvs add pkgname
7200: $ cd pkgname
7201: $ cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
7202: $ cvs add patches/p*
7203: $ cvs status | less
1.35 wiz 7204: $ cvs commit
1.34 wiz 7205: $ cd ..
7206: $ vi Makefile # add SUBDIRS+=pkgname line
1.35 wiz 7207: $ cvs commit Makefile
1.66 asau 7208: $ cd pkgname
1.73 jnemeth 7209: $ make CTYPE=Added commit-changes-entry
1.1 dsieger 7210:
7211: The commit message of the initial import should include part of the DESCR file,
7212: so people reading the mailing lists know what the package is/does.
7213:
1.34 wiz 7214: Also mention the new package in pkgsrc/doc/CHANGES-20xx.
7215:
7216: Previously, "cvs import" was suggested, but it was much easier to get wrong
7217: than "cvs add".
1.1 dsieger 7218:
1.130 wiz 7219: 21.6. Updating a package to a newer version
1.1 dsieger 7220:
7221: Please always put a concise, appropriate and relevant summary of the changes
7222: between old and new versions into the commit log when updating a package. There
7223: are various reasons for this:
7224:
7225: * A URL is volatile, and can change over time. It may go away completely or
7226: its information may be overwritten by newer information.
7227:
7228: * Having the change information between old and new versions in our CVS
7229: repository is very useful for people who use either cvs or anoncvs.
7230:
7231: * Having the change information between old and new versions in our CVS
7232: repository is very useful for people who read the pkgsrc-changes mailing
7233: list, so that they can make tactical decisions about when to upgrade the
7234: package.
7235:
7236: Please also recognize that, just because a new version of a package has been
7237: released, it should not automatically be upgraded in the CVS repository. We
7238: prefer to be conservative in the packages that are included in pkgsrc -
7239: development or beta packages are not really the best thing for most places in
7240: which pkgsrc is used. Please use your judgement about what should go into
7241: pkgsrc, and bear in mind that stability is to be preferred above new and
7242: possibly untested features.
7243:
1.130 wiz 7244: 21.7. Renaming a package in pkgsrc
1.21 snj 7245:
7246: Renaming packages is not recommended.
7247:
7248: When renaming packages, be sure to fix any references to old name in other
7249: Makefiles, options, buildlink files, etc.
7250:
7251: Also When renaming a package, please define SUPERSEDES to the package name and
7252: dewey version pattern(s) of the previous package name. This may be repeated for
7253: multiple renames. The new package would be an exact replacement.
7254:
7255: Note that "successor" in the CHANGES-YYYY file doesn't necessarily mean that it
7256: supersedes, as that successor may not be an exact replacement but is a
7257: suggestion for the replaced functionality.
7258:
1.130 wiz 7259: 21.8. Moving a package in pkgsrc
1.21 snj 7260:
7261: It is preferred that packages are not renamed or moved, but if needed please
7262: follow these steps.
1.1 dsieger 7263:
7264: 1. Make a copy of the directory somewhere else.
7265:
7266: 2. Remove all CVS dirs.
7267:
7268: Alternatively to the first two steps you can also do:
7269:
7270: % cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package
7271:
7272: and use that for further work.
7273:
1.25 wiz 7274: 3. Fix CATEGORIES and any DEPENDS paths that just did "../package" instead of
1.1 dsieger 7275: "../../category/package".
7276:
1.21 snj 7277: 4. In the modified package's Makefile, consider setting PREV_PKGPATH to the
7278: previous category/package pathname. The PREV_PKGPATH can be used by tools
7279: for doing an update using pkgsrc building; for example, it can search the
7280: pkg_summary(5) database for PREV_PKGPATH (if no SUPERSEDES) and then use
7281: the corresponding new PKGPATH for that moved package. Note that it may have
7282: multiple matches, so the tool should also check on the PKGBASE too. The
7283: PREV_PKGPATH probably has no value unless SUPERSEDES is not set, i.e.
7284: PKGBASE stays the same.
7285:
7286: 5. cvs import the modified package in the new place.
1.1 dsieger 7287:
1.21 snj 7288: 6. Check if any package depends on it:
1.1 dsieger 7289:
7290: % cd /usr/pkgsrc
7291: % grep /package */*/Makefile* */*/buildlink*
7292:
1.21 snj 7293: 7. Fix paths in packages from step 5 to point to new location.
1.1 dsieger 7294:
1.21 snj 7295: 8. cvs rm (-f) the package at the old location.
1.1 dsieger 7296:
1.21 snj 7297: 9. Remove from oldcategory/Makefile.
1.1 dsieger 7298:
1.21 snj 7299: 10. Add to newcategory/Makefile.
1.1 dsieger 7300:
1.21 snj 7301: 11. Commit the changed and removed files:
1.1 dsieger 7302:
7303: % cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile
7304:
7305: (and any packages from step 5, of course).
7306:
1.6 rillig 7307: Chapter 22. Frequently Asked Questions
1.1 dsieger 7308:
7309: This section contains the answers to questions that may arise when you are
7310: writing a package. If you don't find your question answered here, first have a
7311: look in the other chapters, and if you still don't have the answer, ask on the
7312: pkgsrc-users mailing list.
7313:
1.6 rillig 7314: 22.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
7315: 22.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
7316: 22.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
7317: 22.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
1.1 dsieger 7318: BUILDLINK_LIBS?
1.6 rillig 7319: 22.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
7320: 22.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 7321: the := inside it.
1.6 rillig 7322: 22.7. Which mailing lists are there for package developers?
7323: 22.8. Where is the pkgsrc documentation?
7324: 22.9. I have a little time to kill. What shall I do?
1.1 dsieger 7325:
1.6 rillig 7326: 22.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
1.1 dsieger 7327:
7328: MAKEFLAGS are the flags passed to the pkgsrc-internal invocations of make
7329: (1), while MAKE_FLAGS are the flags that are passed to the MAKE_PROGRAM
7330: when building the package. [FIXME: What is .MAKEFLAGS for?]
7331:
1.6 rillig 7332: 22.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
1.1 dsieger 7333:
7334: MAKE is the path to the make(1) program that is used in the pkgsrc
7335: infrastructure. GMAKE is the path to GNU Make, but you need to say
7336: USE_TOOLS+=gmake to use that. MAKE_PROGRAM is the path to the Make
7337: program that is used for building the package.
7338:
1.6 rillig 7339: 22.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
1.1 dsieger 7340:
7341: CC is the path to the real C compiler, which can be configured by the
7342: pkgsrc user. PKG_CC is the path to the compiler wrapper. PKGSRC_COMPILER
7343: is not a path to a compiler, but the type of compiler that should be
7344: used. See mk/compiler.mk for more information about the latter variable.
7345:
1.6 rillig 7346: 22.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
1.1 dsieger 7347: BUILDLINK_LIBS?
7348:
7349: [FIXME]
7350:
1.6 rillig 7351: 22.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
1.1 dsieger 7352:
1.25 wiz 7353: For optimization reasons, some variables are only available in the "
7354: wrapper" phase and later. To "simulate" the wrapper phase, append
1.1 dsieger 7355: PKG_PHASE=wrapper to the above command.
7356:
1.6 rillig 7357: 22.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 7358: the := inside it.
7359:
1.108 rillig 7360: The := is not really an assignment operator, although it looks like it.
7361: Instead, it is a degenerate form of ${LIST:old_string=new_string}, which
7362: is documented in the make(1) man page and which is commonly used in the
7363: form ${SRCS:.c=.o}. In the case of MASTER_SITE_*, old_string is the empty
7364: string and new_string is package/. That's where the : and the = fall
7365: together.
1.1 dsieger 7366:
1.6 rillig 7367: 22.7. Which mailing lists are there for package developers?
1.1 dsieger 7368:
7369: tech-pkg
7370:
7371: This is a list for technical discussions related to pkgsrc
7372: development, e.g. soliciting feedback for changes to pkgsrc
7373: infrastructure, proposed new features, questions related to porting
7374: pkgsrc to a new platform, advice for maintaining a package, patches
7375: that affect many packages, help requests moved from pkgsrc-users when
7376: an infrastructure bug is found, etc.
7377:
7378: pkgsrc-bugs
7379:
7380: All bug reports in category "pkg" sent with send-pr(1) appear here.
7381: Please do not report your bugs here directly; use one of the other
7382: mailing lists.
7383:
1.6 rillig 7384: 22.8. Where is the pkgsrc documentation?
1.1 dsieger 7385:
7386: There are many places where you can find documentation about pkgsrc:
7387:
7388: * The pkgsrc guide (this document) is a collection of chapters that
7389: explain large parts of pkgsrc, but some chapters tend to be outdated.
7390: Which ones they are is hard to say.
7391:
7392: * On the mailing list archives (see http://mail-index.NetBSD.org/), you
7393: can find discussions about certain features, announcements of new
7394: parts of the pkgsrc infrastructure and sometimes even announcements
7395: that a certain feature has been marked as obsolete. The benefit here
7396: is that each message has a date appended to it.
7397:
7398: * Many of the files in the mk/ directory start with a comment that
7399: describes the purpose of the file and how it can be used by the
7400: pkgsrc user and package authors. An easy way to find this
7401: documentation is to run bmake help.
7402:
7403: * The CVS log messages are a rich source of information, but they tend
7404: to be highly abbreviated, especially for actions that occur often.
7405: Some contain a detailed description of what has changed, but they are
7406: geared towards the other pkgsrc developers, not towards an average
7407: pkgsrc user. They also only document changes, so if you don't know
7408: what has been before, these messages may not be worth too much to
7409: you.
7410:
7411: * Some parts of pkgsrc are only "implicitly documented", that is the
7412: documentation exists only in the mind of the developer who wrote the
7413: code. To get this information, use the cvs annotate command to see
7414: who has written it and ask on the tech-pkg mailing list, so that
7415: others can find your questions later (see above). To be sure that the
7416: developer in charge reads the mail, you may CC him or her.
7417:
1.6 rillig 7418: 22.9. I have a little time to kill. What shall I do?
1.1 dsieger 7419:
7420: This is not really an FAQ yet, but here's the answer anyway.
7421:
7422: * Run pkg_chk -N (from the pkgtools/pkg_chk package). It will tell you
7423: about newer versions of installed packages that are available, but
7424: not yet updated in pkgsrc.
7425:
7426: * Browse pkgsrc/doc/TODO ? it contains a list of suggested new packages
7427: and a list of cleanups and enhancements for pkgsrc that would be nice
7428: to have.
7429:
1.71 wiz 7430: * Review packages for which review was requested on the tech-pkg
7431: mailing list.
1.1 dsieger 7432:
1.6 rillig 7433: Chapter 23. GNOME packaging and porting
1.1 dsieger 7434:
7435: Table of Contents
7436:
1.6 rillig 7437: 23.1. Meta packages
7438: 23.2. Packaging a GNOME application
7439: 23.3. Updating GNOME to a newer version
7440: 23.4. Patching guidelines
1.1 dsieger 7441:
7442: Quoting GNOME's web site:
7443:
7444: The GNOME project provides two things: The GNOME desktop environment, an
7445: intuitive and attractive desktop for users, and the GNOME development
7446: platform, an extensive framework for building applications that integrate
7447: into the rest of the desktop.
7448:
7449: pkgsrc provides a seamless way to automatically build and install a complete
7450: GNOME environment under many different platforms. We can say with confidence
7451: that pkgsrc is one of the most advanced build and packaging systems for GNOME
7452: due to its included technologies buildlink3, the wrappers and tools framework
7453: and automatic configuration file management. Lots of efforts are put into
7454: achieving a completely clean deinstallation of installed software components.
7455:
7456: Given that pkgsrc is NetBSD's official packaging system, the above also means
7457: that great efforts are put into making GNOME work under this operating system.
7458: Recently, DragonFly BSD also adopted pkgsrc as its preferred packaging system,
7459: contributing lots of portability fixes to make GNOME build and install under
7460: it.
7461:
7462: This chapter is aimed at pkgsrc developers and other people interested in
7463: helping our GNOME porting and packaging efforts. It provides instructions on
7464: how to manage the existing packages and some important information regarding
7465: their internals.
7466:
7467: We need your help!
7468:
7469: Should you have some spare cycles to devote to NetBSD, pkgsrc and GNOME and are
7470: willing to learn new exciting stuff, please jump straight to the pending work
7471: list! There is still a long way to go to get a fully-functional GNOME desktop
7472: under NetBSD and we need your help to achieve it!
7473:
1.6 rillig 7474: 23.1. Meta packages
1.1 dsieger 7475:
7476: pkgsrc includes three GNOME-related meta packages:
7477:
7478: * meta-pkgs/gnome-base: Provides the core GNOME desktop environment. It only
7479: includes the necessary bits to get it to boot correctly, although it may
7480: lack important functionality for daily operation. The idea behind this
7481: package is to let end users build their own configurations on top of this
7482: one, first installing this meta package to achieve a functional setup and
7483: then adding individual applications.
7484:
7485: * meta-pkgs/gnome: Provides a complete installation of the GNOME platform and
7486: desktop as defined by the GNOME project; this is based on the components
7487: distributed in the platform/x.y/x.y.z/sources and desktop/x.y/x.y.z/sources
7488: directories of the official FTP server. Developer-only tools found in those
7489: directories are not installed unless required by some other component to
7490: work properly. Similarly, packages from the bindings set (bindings/x.y/
7491: x.y.z/sources) are not pulled in unless required as a dependency for an
7492: end-user component. This package "extends" meta-pkgs/gnome-base.
7493:
7494: * meta-pkgs/gnome-devel: Installs all the tools required to build a GNOME
7495: component when fetched from the CVS repository. These are required to let
7496: the autogen.sh scripts work appropriately.
7497:
7498: In all these packages, the DEPENDS lines are sorted in a way that eases
7499: updates: a package may depend on other packages listed before it but not on any
1.25 wiz 7500: listed after it. It is very important to keep this order to ease updates so...
1.1 dsieger 7501: do not change it to alphabetical sorting!
7502:
1.6 rillig 7503: 23.2. Packaging a GNOME application
1.1 dsieger 7504:
7505: Almost all GNOME applications are written in C and use a common set of tools as
7506: their build system. Things get different with the new bindings to other
7507: languages (such as Python), but the following will give you a general idea on
7508: the minimum required tools:
7509:
7510: * Almost all GNOME applications use the GNU Autotools as their build system.
7511: As a general rule you will need to tell this to your package:
7512:
7513: GNU_CONFIGURE=yes
7514: USE_LIBTOOL=yes
7515: USE_TOOLS+=gmake
7516:
7517: * If the package uses pkg-config to detect dependencies, add this tool to the
7518: list of required utilities:
7519:
7520: USE_TOOLS+=pkg-config
7521:
7522: Also use pkgtools/verifypc at the end of the build process to ensure that
7523: you did not miss to specify any dependency in your package and that the
7524: version requirements are all correct.
7525:
7526: * If the package uses intltool, be sure to add intltool to the USE_TOOLS to
7527: handle dependencies and to force the package to use the latest available
7528: version.
7529:
7530: * If the package uses gtk-doc (a documentation generation utility), do not
7531: add a dependency on it. The tool is rather big and the distfile should come
7532: with pregenerated documentation anyway; if it does not, it is a bug that
7533: you ought to report. For such packages you should disable gtk-doc (unless
7534: it is the default):
7535:
7536: CONFIGURE_ARGS+=--disable-gtk-doc
7537:
7538: The default location of installed HTML files (share/gtk-doc/<package-name>)
7539: is correct and should not be changed unless the package insists on
7540: installing them somewhere else. Otherwise programs as devhelp will not be
7541: able to open them. You can do that with an entry similar to:
7542:
7543: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
7544:
7545: GNOME uses multiple shared directories and files under the installation prefix
7546: to maintain databases. In this context, shared means that those exact same
7547: directories and files are used among several different packages, leading to
7548: conflicts in the PLIST. pkgsrc currently includes functionality to handle the
7549: most common cases, so you have to forget about using @unexec ${RMDIR} lines in
7550: your file lists and omitting shared files from them. If you find yourself doing
7551: those, your package is most likely incorrect.
7552:
7553: The following table lists the common situations that result in using shared
7554: directories or files. For each of them, the appropriate solution is given.
1.25 wiz 7555: After applying the solution be sure to regenerate the package's file list with
1.1 dsieger 7556: make print-PLIST and ensure it is correct.
7557:
1.6 rillig 7558: Table 23.1. PLIST handling for GNOME packages
1.1 dsieger 7559:
7560: +-----------------------------------------------------------------------------+
7561: | If the package... | Then... |
7562: |-------------------------------------------+---------------------------------|
1.6 rillig 7563: | |See Section 19.6.10, "Packages |
1.18 mishka 7564: |Installs OMF files under share/omf. |installing scrollkeeper/rarian |
7565: | |data files". |
1.1 dsieger 7566: |-------------------------------------------+---------------------------------|
1.6 rillig 7567: |Installs icons under the share/icons/ |See Section 19.6.19, "Packages |
1.1 dsieger 7568: |hicolor hierarchy or updates share/icons/ |installing hicolor theme icons". |
7569: |hicolor/icon-theme.cache. | |
7570: |-------------------------------------------+---------------------------------|
1.6 rillig 7571: | |See Section 19.6.14, "Packages |
1.1 dsieger 7572: |Installs files under share/mime/packages. |installing extensions to the MIME|
7573: | |database". |
7574: |-------------------------------------------+---------------------------------|
1.6 rillig 7575: |Installs .desktop files under share/ |See Section 19.6.20, "Packages |
1.1 dsieger 7576: |applications and these include MIME |installing desktop files". |
7577: |information. | |
7578: +-----------------------------------------------------------------------------+
7579:
7580:
1.6 rillig 7581: 23.3. Updating GNOME to a newer version
1.1 dsieger 7582:
7583: When seeing GNOME as a whole, there are two kinds of updates:
7584:
7585: Major update
7586:
7587: Given that there is still a very long way for GNOME 3 (if it ever appears),
7588: we consider a major update one that goes from a 2.X version to a 2.Y one,
7589: where Y is even and greater than X. These are hard to achieve because they
7590: introduce lots of changes in the components' code and almost all GNOME
7591: distfiles are updated to newer versions. Some of them can even break API
7592: and ABI compatibility with the previous major version series. As a result,
7593: the update needs to be done all at once to minimize breakage.
7594:
7595: A major update typically consists of around 80 package updates and the
7596: addition of some new ones.
7597:
7598: Minor update
7599:
7600: We consider a minor update one that goes from a 2.A.X version to a 2.A.Y
7601: one where Y is greater than X. These are easy to achieve because they do
7602: not update all GNOME components, can be done in an incremental way and do
7603: not break API nor ABI compatibility.
7604:
7605: A minor update typically consists of around 50 package updates, although
7606: the numbers here may vary a lot.
7607:
7608: In order to update the GNOME components in pkgsrc to a new stable release
7609: (either major or minor), the following steps should be followed:
7610:
7611: 1. Get a list of all the tarballs that form the new release by using the
1.19 snj 7612: following commands. These will leave the full list of the components'
1.1 dsieger 7613: distfiles into the list.txt file:
7614:
7615: % echo ls "*.tar.bz2" | \
7616: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
7617: awk '{ print $9 }' >list.txt
7618: % echo ls "*.tar.bz2" | \
7619: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
7620: awk '{ print $9 }' >>list.txt
7621:
7622: 2. Open each meta package's Makefile and bump their version to the release you
7623: are updating them to. The three meta packages should be always consistent
7624: with versioning. Obviously remove any PKGREVISIONs that might be in them.
7625:
7626: 3. For each meta package, update all its DEPENDS lines to match the latest
7627: versions as shown by the above commands. Do not list any newer version
7628: (even if found in the FTP) because the meta packages are supposed to list
7629: the exact versions that form a specific GNOME release. Exceptions are
7630: permitted here if a newer version solves a serious issue in the overall
7631: desktop experience; these typically come in the form of a revision bump in
7632: pkgsrc, not in newer versions from the developers.
7633:
7634: Packages not listed in the list.txt file should be updated to the latest
7635: version available (if found in pkgsrc). This is the case, for example, of
7636: the dependencies on the GNU Autotools in the meta-pkgs/gnome-devel meta
7637: package.
7638:
7639: 4. Generate a patch from the modified meta packages and extract the list of
7640: "new" lines. This will provide you an outline on what packages need to be
7641: updated in pkgsrc and in what order:
7642:
7643: % cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt
7644:
7645: 5. For major desktop updates it is recommended to zap all your installed
7646: packages and start over from scratch at this point.
7647:
7648: 6. Now comes the longest step by far: iterate over the contents of todo.txt
7649: and update the packages listed in it in order. For major desktop updates
7650: none of these should be committed until the entire set is completed because
7651: there are chances of breaking not-yet-updated packages.
7652:
7653: 7. Once the packages are up to date and working, commit them to the tree one
7654: by one with appropriate log messages. At the end, commit the three meta
7655: package updates and all the corresponding changes to the doc/CHANGES-<YEAR>
7656: and pkgsrc/doc/TODO files.
7657:
1.6 rillig 7658: 23.4. Patching guidelines
1.1 dsieger 7659:
7660: GNOME is a very big component in pkgsrc which approaches 100 packages. Please,
7661: it is very important that you always, always, always feed back any portability
7662: fixes you do to a GNOME package to the mainstream developers (see
1.6 rillig 7663: Section 11.3.5, "Feedback to the author"). This is the only way to get their
1.1 dsieger 7664: attention on portability issues and to ensure that future versions can be built
7665: out-of-the box on NetBSD. The less custom patches in pkgsrc, the easier further
7666: updates are. Those developers in charge of issuing major GNOME updates will be
7667: grateful if you do that.
7668:
7669: The most common places to report bugs are the GNOME's Bugzilla and the
7670: freedesktop.org's Bugzilla. Not all components use these to track bugs, but
7671: most of them do. Do not be short on your reports: always provide detailed
7672: explanations of the current failure, how it can be improved to achieve maximum
7673: portability and, if at all possible, provide a patch against CVS head. The more
7674: verbose you are, the higher chances of your patch being accepted.
7675:
7676: Also, please avoid using preprocessor magic to fix portability issues. While
7677: the FreeBSD GNOME people are doing a great job in porting GNOME to their
7678: operating system, the official GNOME sources are now plagued by conditionals
7679: that check for __FreeBSD__ and similar macros. This hurts portability. Please
1.6 rillig 7680: see our patching guidelines (Section 11.3.4, "Patching guidelines") for more
1.1 dsieger 7681: details.
7682:
7683: Part III. The pkgsrc infrastructure internals
7684:
7685: This part of the guide deals with everything from the infrastructure that is
7686: behind the interfaces described in the developer's guide. A casual package
7687: maintainer should not need anything from this part.
7688:
7689: Table of Contents
7690:
1.6 rillig 7691: 24. Design of the pkgsrc infrastructure
1.1 dsieger 7692:
1.6 rillig 7693: 24.1. The meaning of variable definitions
7694: 24.2. Avoiding problems before they arise
7695: 24.3. Variable evaluation
1.1 dsieger 7696:
1.6 rillig 7697: 24.3.1. At load time
7698: 24.3.2. At runtime
1.1 dsieger 7699:
1.6 rillig 7700: 24.4. How can variables be specified?
7701: 24.5. Designing interfaces for Makefile fragments
1.1 dsieger 7702:
1.6 rillig 7703: 24.5.1. Procedures with parameters
7704: 24.5.2. Actions taken on behalf of parameters
1.1 dsieger 7705:
1.6 rillig 7706: 24.6. The order in which files are loaded
1.1 dsieger 7707:
1.6 rillig 7708: 24.6.1. The order in bsd.prefs.mk
7709: 24.6.2. The order in bsd.pkg.mk
1.1 dsieger 7710:
1.6 rillig 7711: 25. Regression tests
1.1 dsieger 7712:
1.108 rillig 7713: 25.1. Running the regression tests
7714: 25.2. Adding a new regression test
1.1 dsieger 7715:
1.108 rillig 7716: 25.2.1. Overridable functions
7717: 25.2.2. Helper functions
1.1 dsieger 7718:
1.6 rillig 7719: 26. Porting pkgsrc
1.1 dsieger 7720:
1.6 rillig 7721: 26.1. Porting pkgsrc to a new operating system
1.1 dsieger 7722:
1.6 rillig 7723: Chapter 24. Design of the pkgsrc infrastructure
1.1 dsieger 7724:
7725: Table of Contents
7726:
1.6 rillig 7727: 24.1. The meaning of variable definitions
7728: 24.2. Avoiding problems before they arise
7729: 24.3. Variable evaluation
1.1 dsieger 7730:
1.6 rillig 7731: 24.3.1. At load time
7732: 24.3.2. At runtime
1.1 dsieger 7733:
1.6 rillig 7734: 24.4. How can variables be specified?
7735: 24.5. Designing interfaces for Makefile fragments
1.1 dsieger 7736:
1.6 rillig 7737: 24.5.1. Procedures with parameters
7738: 24.5.2. Actions taken on behalf of parameters
1.1 dsieger 7739:
1.6 rillig 7740: 24.6. The order in which files are loaded
1.1 dsieger 7741:
1.6 rillig 7742: 24.6.1. The order in bsd.prefs.mk
7743: 24.6.2. The order in bsd.pkg.mk
1.1 dsieger 7744:
7745: The pkgsrc infrastructure consists of many small Makefile fragments. Each such
7746: fragment needs a properly specified interface. This chapter explains how such
7747: an interface looks like.
7748:
1.6 rillig 7749: 24.1. The meaning of variable definitions
1.1 dsieger 7750:
7751: Whenever a variable is defined in the pkgsrc infrastructure, the location and
7752: the way of definition provide much information about the intended use of that
7753: variable. Additionally, more documentation may be found in a header comment or
7754: in this pkgsrc guide.
7755:
7756: A special file is mk/defaults/mk.conf, which lists all variables that are
7757: intended to be user-defined. They are either defined using the ?= operator or
7758: they are left undefined because defining them to anything would effectively
7759: mean "yes". All these variables may be overridden by the pkgsrc user in the
7760: MAKECONF file.
7761:
7762: Outside this file, the following conventions apply: Variables that are defined
7763: using the ?= operator may be overridden by a package.
7764:
7765: Variables that are defined using the = operator may be used read-only at
7766: run-time.
7767:
7768: Variables whose name starts with an underscore must not be accessed outside the
7769: pkgsrc infrastructure at all. They may change without further notice.
7770:
7771: Note
7772:
7773: These conventions are currently not applied consistently to the complete pkgsrc
7774: infrastructure.
7775:
1.6 rillig 7776: 24.2. Avoiding problems before they arise
1.1 dsieger 7777:
7778: All variables that contain lists of things should default to being empty. Two
7779: examples that do not follow this rule are USE_LANGUAGES and DISTFILES. These
7780: variables cannot simply be modified using the += operator in package Makefiles
7781: (or other files included by them), since there is no guarantee whether the
7782: variable is already set or not, and what its value is. In the case of
7783: DISTFILES, the packages "know" the default value and just define it as in the
7784: following example.
7785:
7786: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
7787:
7788: Because of the selection of this default value, the same value appears in many
7789: package Makefiles. Similarly for USE_LANGUAGES, but in this case the default
7790: value ("c") is so short that it doesn't stand out. Nevertheless it is mentioned
7791: in many files.
7792:
1.6 rillig 7793: 24.3. Variable evaluation
1.1 dsieger 7794:
1.6 rillig 7795: 24.3.1. At load time
1.1 dsieger 7796:
7797: Variable evaluation takes place either at load time or at runtime, depending on
7798: the context in which they occur. The contexts where variables are evaluated at
7799: load time are:
7800:
7801: * The right hand side of the := and != operators,
7802:
7803: * Make directives like .if or .for,
7804:
7805: * Dependency lines.
7806:
7807: A special exception are references to the iteration variables of .for loops,
7808: which are expanded inline, no matter in which context they appear.
7809:
7810: As the values of variables may change during load time, care must be taken not
7811: to evaluate them by accident. Typical examples for variables that should not be
7812: evaluated at load time are DEPENDS and CONFIGURE_ARGS. To make the effect more
7813: clear, here is an example:
7814:
7815: CONFIGURE_ARGS= # none
7816: CFLAGS= -O
7817: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
7818:
7819: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
7820:
7821: CFLAGS+= -Wall
7822:
7823: This code shows how the use of the := operator can quickly lead to unexpected
7824: results. The first paragraph is fairly common code. The second paragraph
7825: evaluates the CONFIGURE_ARGS variable, which results in CFLAGS=-O. In the third
7826: paragraph, the -Wall is appended to the CFLAGS, but this addition will not
7827: appear in CONFIGURE_ARGS. In actual code, the three paragraphs from above
7828: typically occur in completely unrelated files.
7829:
1.6 rillig 7830: 24.3.2. At runtime
1.1 dsieger 7831:
7832: After all the files have been loaded, the values of the variables cannot be
7833: changed anymore. Variables that are used in the shell commands are expanded at
7834: this point.
7835:
1.6 rillig 7836: 24.4. How can variables be specified?
1.1 dsieger 7837:
7838: There are many ways in which the definition and use of a variable can be
7839: restricted in order to detect bugs and violations of the (mostly unwritten)
1.108 rillig 7840: policies. A package can be checked with pkglint -Wall to see whether it meets
7841: these rules.
1.1 dsieger 7842:
1.6 rillig 7843: 24.5. Designing interfaces for Makefile fragments
1.1 dsieger 7844:
7845: Most of the .mk files fall into one of the following classes. Cases where a
7846: file falls into more than one class should be avoided as it often leads to
7847: subtle bugs.
7848:
1.6 rillig 7849: 24.5.1. Procedures with parameters
1.1 dsieger 7850:
7851: In a traditional imperative programming language some of the .mk files could be
1.23 jakllsch 7852: described as procedures. They take some input parameters and?after
7853: inclusion?provide a result in output parameters. Since all variables in
7854: Makefiles have global scope care must be taken not to use parameter names that
7855: have already another meaning. For example, PKGNAME is a bad choice for a
7856: parameter name.
1.1 dsieger 7857:
7858: Procedures are completely evaluated at preprocessing time. That is, when
7859: calling a procedure all input parameters must be completely resolvable. For
7860: example, CONFIGURE_ARGS should never be an input parameter since it is very
7861: likely that further text will be added after calling the procedure, which would
7862: effectively apply the procedure to only a part of the variable. Also,
1.108 rillig 7863: references to other variables will be modified after calling the procedure.
1.1 dsieger 7864:
7865: A procedure can declare its output parameters either as suitable for use in
7866: preprocessing directives or as only available at runtime. The latter
7867: alternative is for variables that contain references to other runtime
7868: variables.
7869:
7870: Procedures shall be written such that it is possible to call the procedure more
7871: than once. That is, the file must not contain multiple-inclusion guards.
7872:
7873: Examples for procedures are mk/bsd.options.mk and mk/buildlink3/bsd.builtin.mk.
7874: To express that the parameters are evaluated at load time, they should be
7875: assigned using the := operator, which should be used only for this purpose.
7876:
1.6 rillig 7877: 24.5.2. Actions taken on behalf of parameters
1.1 dsieger 7878:
7879: Action files take some input parameters and may define runtime variables. They
7880: shall not define loadtime variables. There are action files that are included
7881: implicitly by the pkgsrc infrastructure, while other must be included
7882: explicitly.
7883:
7884: An example for action files is mk/subst.mk.
7885:
1.6 rillig 7886: 24.6. The order in which files are loaded
1.1 dsieger 7887:
7888: Package Makefiles usually consist of a set of variable definitions, and include
7889: the file ../../mk/bsd.pkg.mk in the very last line. Before that, they may also
7890: include various other *.mk files if they need to query the availability of
7891: certain features like the type of compiler or the X11 implementation. Due to
7892: the heavy use of preprocessor directives like .if and .for, the order in which
7893: the files are loaded matters.
7894:
7895: This section describes at which point the various files are loaded and gives
7896: reasons for that order.
7897:
1.6 rillig 7898: 24.6.1. The order in bsd.prefs.mk
1.1 dsieger 7899:
7900: The very first action in bsd.prefs.mk is to define some essential variables
7901: like OPSYS, OS_VERSION and MACHINE_ARCH.
7902:
1.4 rillig 7903: Then, the user settings are loaded from the file specified in MAKECONF, which
7904: is usually mk.conf. After that, those variables that have not been overridden
7905: by the user are loaded from mk/defaults/mk.conf.
1.1 dsieger 7906:
7907: After the user settings, the system settings and platform settings are loaded,
7908: which may override the user settings.
7909:
7910: Then, the tool definitions are loaded. The tool wrappers are not yet in effect.
7911: This only happens when building a package, so the proper variables must be used
7912: instead of the direct tool names.
7913:
7914: As the last steps, some essential variables from the wrapper and the package
7915: system flavor are loaded, as well as the variables that have been cached in
7916: earlier phases of a package build.
7917:
1.6 rillig 7918: 24.6.2. The order in bsd.pkg.mk
1.1 dsieger 7919:
7920: First, bsd.prefs.mk is loaded.
7921:
7922: Then, the various *-vars.mk files are loaded, which fill default values for
7923: those variables that have not been defined by the package. These variables may
7924: later be used even in unrelated files.
7925:
7926: Then, the file bsd.pkg.error.mk provides the target error-check that is added
7927: as a special dependency to all other targets that use DELAYED_ERROR_MSG or
7928: DELAYED_WARNING_MSG.
7929:
7930: Then, the package-specific hacks from hacks.mk are included.
7931:
7932: Then, various other files follow. Most of them don't have any dependencies on
7933: what they need to have included before or after them, though some do.
7934:
7935: The code to check PKG_FAIL_REASON and PKG_SKIP_REASON is then executed, which
7936: restricts the use of these variables to all the files that have been included
7937: before. Appearances in later files will be silently ignored.
7938:
7939: Then, the files for the main targets are included, in the order of later
7940: execution, though the actual order should not matter.
7941:
7942: At last, some more files are included that don't set any interesting variables
7943: but rather just define make targets to be executed.
7944:
1.6 rillig 7945: Chapter 25. Regression tests
1.1 dsieger 7946:
7947: Table of Contents
7948:
1.108 rillig 7949: 25.1. Running the regression tests
7950: 25.2. Adding a new regression test
1.1 dsieger 7951:
1.108 rillig 7952: 25.2.1. Overridable functions
7953: 25.2.2. Helper functions
1.1 dsieger 7954:
7955: The pkgsrc infrastructure consists of a large codebase, and there are many
7956: corners where every little bit of a file is well thought out, making pkgsrc
7957: likely to fail as soon as anything is changed near those parts. To prevent most
7958: changes from breaking anything, a suite of regression tests should go along
7959: with every important part of the pkgsrc infrastructure. This chapter describes
7960: how regression tests work in pkgsrc and how you can add new tests.
7961:
1.108 rillig 7962: 25.1. Running the regression tests
1.1 dsieger 7963:
1.25 wiz 7964: You first need to install the pkgtools/pkg_regress package, which provides the
1.1 dsieger 7965: pkg_regress command. Then you can simply run that command, which will run all
7966: tests in the regress category.
7967:
1.108 rillig 7968: 25.2. Adding a new regression test
1.1 dsieger 7969:
7970: Every directory in the regress category that contains a file called spec is
7971: considered a regression test. This file is a shell program that is included by
7972: the pkg_regress command. The following functions can be overridden to suit your
7973: needs.
7974:
1.108 rillig 7975: 25.2.1. Overridable functions
1.1 dsieger 7976:
1.108 rillig 7977: These functions do not take any parameters. Although they are called in "set -e
7978: " mode, they don't stop at the first failing command. See this StackOverflow
7979: question for details.
1.1 dsieger 7980:
1.108 rillig 7981: do_setup
1.1 dsieger 7982:
7983: This function prepares the environment for the test. By default it does
7984: nothing.
7985:
1.108 rillig 7986: do_test
1.1 dsieger 7987:
7988: This function runs the actual test. By default, it calls TEST_MAKE with the
7989: arguments MAKEARGS_TEST and writes its output including error messages into
7990: the file TEST_OUTFILE.
7991:
1.108 rillig 7992: When defining this function, make sure that all output that needs to be
7993: checked is written to the correct output file. Example:
7994:
7995: do_test() {
7996: echo "Example output"
7997: } 1>$TEST_OUTFILE 2>&1
7998:
7999: check_result
1.1 dsieger 8000:
8001: This function is run after the test and is typically used to compare the
8002: actual output from the one that is expected. It can make use of the various
1.108 rillig 8003: helper functions from the next section. Example:
8004:
8005: check_result() {
8006: exit_status 0
8007: output_require "Example"
8008: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
8009: output_prohibit "no such file or directory"
8010: }
1.1 dsieger 8011:
1.108 rillig 8012: do_cleanup
1.1 dsieger 8013:
8014: This function cleans everything up after the test has been run. By default
8015: it does nothing.
8016:
1.108 rillig 8017: 25.2.2. Helper functions
1.1 dsieger 8018:
1.108 rillig 8019: exit_status expected
1.1 dsieger 8020:
1.108 rillig 8021: This function compares the exitcode of the do_test function with its first
8022: parameter. If they differ, the test will fail.
1.1 dsieger 8023:
1.108 rillig 8024: output_require regex...
1.1 dsieger 8025:
8026: This function checks for each of its parameters if the output from do_test
1.108 rillig 8027: matches the extended regular expression. If it does not, the test will
8028: fail. Example:
8029:
8030: output_require "looks fine"
8031: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.1 dsieger 8032:
8033: output_prohibit(regex...)
8034:
8035: This function checks for each of its parameters if the output from do_test
8036: () does not match the extended regular expression. If any of the regular
8037: expressions matches, the test will fail.
8038:
1.6 rillig 8039: Chapter 26. Porting pkgsrc
1.1 dsieger 8040:
8041: Table of Contents
8042:
1.6 rillig 8043: 26.1. Porting pkgsrc to a new operating system
1.1 dsieger 8044:
8045: The pkgsrc system has already been ported to many operating systems, hardware
8046: architectures and compilers. This chapter explains the necessary steps to make
8047: pkgsrc even more portable.
8048:
1.6 rillig 8049: 26.1. Porting pkgsrc to a new operating system
1.1 dsieger 8050:
8051: To port pkgsrc to a new operating system (called MyOS in this example), you
8052: need to touch the following files:
8053:
8054: pkgtools/bootstrap-mk-files/files/mods/MyOS.sys.mk
8055:
8056: This file contains some basic definitions, for example the name of the C
8057: compiler.
8058:
8059: mk/bsd.prefs.mk
8060:
8061: Insert code that defines the variables OPSYS, OS_VERSION, LOWER_OS_VERSION,
8062: LOWER_VENDOR, MACHINE_ARCH, OBJECT_FMT, APPEND_ELF, and the other variables
8063: that appear in this file.
8064:
8065: mk/platform/MyOS.mk
8066:
8067: This file contains the platform-specific definitions that are used by
8068: pkgsrc. Start by copying one of the other files and edit it to your needs.
8069:
8070: mk/tools/tools.MyOS.mk
8071:
8072: This file defines the paths to all the tools that are needed by one or the
8073: other package in pkgsrc, as well as by pkgsrc itself. Find out where these
8074: tools are on your platform and add them.
8075:
8076: Now, you should be able to build some basic packages, like lang/perl5, shells/
8077: bash.
8078:
8079: Appendix A. A simple example package: bison
8080:
8081: Table of Contents
8082:
8083: A.1. files
8084:
8085: A.1.1. Makefile
8086: A.1.2. DESCR
8087: A.1.3. PLIST
8088: A.1.4. Checking a package with pkglint
8089:
8090: A.2. Steps for building, installing, packaging
8091:
8092: We checked to find a piece of software that wasn't in the packages collection,
1.25 wiz 8093: and picked GNU bison. Quite why someone would want to have bison when Berkeley
1.1 dsieger 8094: yacc is already present in the tree is beyond us, but it's useful for the
8095: purposes of this exercise.
8096:
8097: A.1. files
8098:
8099: A.1.1. Makefile
8100:
1.2 rillig 8101: # $NetBSD$
1.1 dsieger 8102: #
8103:
8104: DISTNAME= bison-1.25
8105: CATEGORIES= devel
8106: MASTER_SITES= ${MASTER_SITE_GNU}
8107:
1.30 dholland 8108: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 8109: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
8110: COMMENT= GNU yacc clone
8111:
8112: GNU_CONFIGURE= yes
1.47 wiz 8113: INFO_FILES= yes
1.1 dsieger 8114:
8115: .include "../../mk/bsd.pkg.mk"
8116:
8117: A.1.2. DESCR
8118:
8119: GNU version of yacc. Can make re-entrant parsers, and numerous other
8120: improvements. Why you would want this when Berkeley yacc(1) is part
8121: of the NetBSD source tree is beyond me.
8122:
8123: A.1.3. PLIST
8124:
1.2 rillig 8125: @comment $NetBSD$
1.1 dsieger 8126: bin/bison
8127: man/man1/bison.1.gz
8128: share/bison.simple
8129: share/bison.hairy
8130:
8131: A.1.4. Checking a package with pkglint
8132:
8133: The NetBSD package system comes with pkgtools/pkglint which helps to check the
8134: contents of these files. After installation it is quite easy to use, just
8135: change to the directory of the package you wish to examine and execute pkglint:
8136:
8137: $ pkglint
8138: looks fine.
8139:
8140: Depending on the supplied command line arguments (see pkglint(1)), more checks
8141: will be performed. Use e.g. pkglint -Call -Wall for a very thorough check.
8142:
8143: A.2. Steps for building, installing, packaging
8144:
8145: Create the directory where the package lives, plus any auxiliary directories:
8146:
8147: # cd /usr/pkgsrc/lang
8148: # mkdir bison
8149: # cd bison
8150: # mkdir patches
8151:
1.6 rillig 8152: Create Makefile, DESCR and PLIST (see Chapter 11, Package components - files,
1.1 dsieger 8153: directories and contents) then continue with fetching the distfile:
8154:
8155: # make fetch
8156: >> bison-1.25.tar.gz doesn't seem to exist on this system.
8157: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
8158: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8159: ftp: Error retrieving file: 500 Internal error
8160:
8161: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
8162: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8163: ftp: Error retrieving file: 500 Internal error
8164:
8165: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
8166: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8167: Successfully retrieved file.
8168:
8169: Generate the checksum of the distfile into distinfo:
8170:
8171: # make makedistinfo
8172:
8173: Now compile:
8174:
8175: # make
8176: >> Checksum OK for bison-1.25.tar.gz.
8177: ===> Extracting for bison-1.25
8178: ===> Patching for bison-1.25
8179: ===> Ignoring empty patch directory
8180: ===> Configuring for bison-1.25
8181: creating cache ./config.cache
8182: checking for gcc... cc
8183: checking whether we are using GNU C... yes
8184: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
8185: checking how to run the C preprocessor... cc -E
8186: checking for minix/config.h... no
8187: checking for POSIXized ISC... no
8188: checking whether cross-compiling... no
8189: checking for ANSI C header files... yes
8190: checking for string.h... yes
8191: checking for stdlib.h... yes
8192: checking for memory.h... yes
8193: checking for working const... yes
8194: checking for working alloca.h... no
8195: checking for alloca... yes
8196: checking for strerror... yes
8197: updating cache ./config.cache
8198: creating ./config.status
8199: creating Makefile
8200: ===> Building for bison-1.25
8201: 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
8202: 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
8203: 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
8204: 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
8205: 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
8206: 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
8207: 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
8208: 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
8209: 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
8210: 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
8211: 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
8212: 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
8213: 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
8214: 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
8215: 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
8216: 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
8217: 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
8218: 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
8219: 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
8220: 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
8221: 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
8222: 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
8223: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
8224: rm -f bison.s1
8225: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1
8226:
8227: Everything seems OK, so install the files:
8228:
8229: # make install
8230: >> Checksum OK for bison-1.25.tar.gz.
8231: ===> Installing for bison-1.25
8232: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
8233: rm -f /usr/pkg/bin/bison
8234: cd /usr/pkg/share; rm -f bison.simple bison.hairy
8235: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
8236: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
8237: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
8238: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
8239: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
8240: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
8241: ===> Registering installation for bison-1.25
8242:
8243: You can now use bison, and also - if you decide so - remove it with pkg_delete
8244: bison. Should you decide that you want a binary package, do this now:
8245:
8246: # make package
8247: >> Checksum OK for bison-1.25.tar.gz.
8248: ===> Building package for bison-1.25
8249: Creating package bison-1.25.tgz
8250: Registering depends:.
8251: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
8252:
8253: Now that you don't need the source and object files any more, clean up:
8254:
8255: # make clean
8256: ===> Cleaning for bison-1.25
8257:
8258: Appendix B. Build logs
8259:
8260: Table of Contents
8261:
8262: B.1. Building figlet
8263: B.2. Packaging figlet
8264:
8265: B.1. Building figlet
8266:
8267: # make
8268: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8269: => figlet221.tar.gz doesn't seem to exist on this system.
8270: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
8271: => [172219 bytes]
8272: Connected to ftp.plig.net.
8273: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
8274: 331 Guest login ok, send your complete e-mail address as password.
8275: 230-You are user #5 of 500 simultaneous users allowed.
8276: 230-
8277: 230- ___ _ _ _
8278: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
8279: 230- | _| _| . |_| . | | | . |_| . | _| . |
8280: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
8281: 230- |_| |_| |___| |___|
8282: 230-
8283: 230-** Welcome to ftp.plig.org **
8284: 230-
8285: 230-Please note that all transfers from this FTP site are logged. If you
8286: 230-do not like this, please disconnect now.
8287: 230-
1.19 snj 8288: 230-This archive is available via
1.1 dsieger 8289: 230-
8290: 230-HTTP: http://ftp.plig.org/
8291: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
8292: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
8293: 230-
8294: 230-Please email comments, bug reports and requests for packages to be
8295: 230-mirrored to ftp-admin@plig.org.
8296: 230-
8297: 230-
8298: 230 Logged in anonymously.
8299: Remote system type is UNIX.
8300: Using binary mode to transfer files.
8301: 200 Type okay.
8302: 250 "/pub" is new cwd.
8303: 250-"/pub/figlet" is new cwd.
8304: 250-
8305: 250-Welcome to the figlet archive at ftp.figlet.org
8306: 250-
8307: 250- ftp://ftp.figlet.org/pub/figlet/
8308: 250-
8309: 250-The official FIGlet web page is:
8310: 250- http://www.figlet.org/
8311: 250-
8312: 250-If you have questions, please mailto:info@figlet.org. If you want to
8313: 250-contribute a font or something else, you can email us.
8314: 250
8315: 250 "/pub/figlet/program" is new cwd.
8316: 250 "/pub/figlet/program/unix" is new cwd.
8317: local: figlet221.tar.gz remote: figlet221.tar.gz
8318: 502 Unimplemented command.
8319: 227 Entering Passive Mode (195,40,6,41,246,104)
8320: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
8321: 38% |************** | 65800 64.16 KB/s 00:01 ETA
8322: 226 Transfer completed.
8323: 172219 bytes received in 00:02 (75.99 KB/s)
8324: 221 Goodbye.
8325: => Checksum OK for figlet221.tar.gz.
8326: ===> Extracting for figlet-2.2.1nb2
8327: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
8328: ===> Patching for figlet-2.2.1nb2
8329: ===> Applying pkgsrc patches for figlet-2.2.1nb2
8330: ===> Overriding tools for figlet-2.2.1nb2
8331: ===> Creating toolchain wrappers for figlet-2.2.1nb2
8332: ===> Configuring for figlet-2.2.1nb2
8333: ===> Building for figlet-2.2.1nb2
8334: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
8335: chmod a+x figlet
8336: gcc -O2 -o chkfont chkfont.c
8337: => Unwrapping files-to-be-installed.
8338: #
8339: # make install
8340: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8341: ===> Installing for figlet-2.2.1nb2
8342: install -d -o root -g wheel -m 755 /usr/pkg/bin
8343: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
8344: mkdir -p /usr/pkg/share/figlet
8345: cp figlet /usr/pkg/bin
8346: cp chkfont /usr/pkg/bin
8347: chmod 555 figlist showfigfonts
8348: cp figlist /usr/pkg/bin
8349: cp showfigfonts /usr/pkg/bin
8350: cp fonts/*.flf /usr/pkg/share/figlet
8351: cp fonts/*.flc /usr/pkg/share/figlet
8352: cp figlet.6 /usr/pkg/man/man6
8353: ===> Registering installation for figlet-2.2.1nb2
8354: #
8355:
8356: B.2. Packaging figlet
8357:
8358: # make package
8359: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8360: ===> Packaging figlet-2.2.1nb2
8361: ===> Building binary package for figlet-2.2.1nb2
8362: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
8363: Using SrcDir value of /usr/pkg
8364: Registering depends:.
8365: #
8366:
8367: Appendix C. Directory layout of the pkgsrc FTP server
8368:
8369: Table of Contents
8370:
1.23 jakllsch 8371: C.1. distfiles: The distributed source files
8372: C.2. misc: Miscellaneous things
8373: C.3. packages: Binary packages
8374: C.4. reports: Bulk build reports
1.148 leot 8375: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 8376:
8377: As in other big projects, the directory layout of pkgsrc is quite complex for
8378: newbies. This chapter explains where you find things on the FTP server. The
8379: base directory on ftp.NetBSD.org is /pub/pkgsrc/. On other servers it may be
8380: different, but inside this directory, everything should look the same, no
8381: matter on which server you are. This directory contains some subdirectories,
8382: which are explained below.
8383:
1.23 jakllsch 8384: C.1. distfiles: The distributed source files
1.1 dsieger 8385:
8386: The directory distfiles contains lots of archive files from all pkgsrc
8387: packages, which are mirrored here. The subdirectories are called after their
8388: package names and are used when the distributed files have names that don't
8389: explicitly contain a version number or are otherwise too generic (for example
8390: release.tar.gz).
8391:
1.23 jakllsch 8392: C.2. misc: Miscellaneous things
1.1 dsieger 8393:
8394: This directory contains things that individual pkgsrc developers find worth
8395: publishing.
8396:
1.23 jakllsch 8397: C.3. packages: Binary packages
1.1 dsieger 8398:
1.3 rillig 8399: This directory contains binary packages for the various platforms that are
8400: supported by pkgsrc. Each subdirectory is of the form OPSYS/ARCH/OSVERSION_TAG.
8401: The meaning of these variables is:
8402:
8403: * OPSYS is the name of the operating system for which the packages have been
1.9 rillig 8404: built. The name is taken from the output of the uname command, so it may
8405: differ from the one you are used to hear.
1.3 rillig 8406:
1.8 rillig 8407: * ARCH is the hardware architecture of the platform for which the packages
1.10 hubertf 8408: have been built. It also includes the ABI (Application Binary Interface)
8409: for platforms that have several of them.
1.3 rillig 8410:
1.8 rillig 8411: * OSVERSION is the version of the operating system. For version numbers that
8412: change often (for example NetBSD-current), the often-changing part should
8413: be replaced with an x, for example 4.99.x.
1.3 rillig 8414:
1.23 jakllsch 8415: * TAG is either 20xxQy for a stable branch, or head for packages built from
1.8 rillig 8416: the HEAD branch. The latter should only be used when the packages are
8417: updated on a regular basis. Otherwise the date from checking out pkgsrc
8418: should be appended, for example head_20071015.
1.3 rillig 8419:
8420: The rationale for exactly this scheme is that the pkgsrc users looking for
8421: binary packages can quickly click through the directories on the server and
8422: find the best binary packages for their machines. Since they usually know the
8423: operating system and the hardware architecture, OPSYS and ARCH are placed
8424: first. After these choices, they can select the best combination of OSVERSION
8425: and TAG together, since it is usually the case that packages stay compatible
8426: between different version of the operating system.
8427:
8428: In each of these directories, there is a whole binary packages collection for a
8429: specific platform. It has a directory called All which contains all binary
8430: packages. Besides that, there are various category directories that contain
8431: symbolic links to the real binary packages.
1.1 dsieger 8432:
1.23 jakllsch 8433: C.4. reports: Bulk build reports
1.8 rillig 8434:
8435: Here are the reports from bulk builds, for those who want to fix packages that
8436: didn't build on some of the platforms. The structure of subdirectories should
1.23 jakllsch 8437: look like the one in Section C.3, "packages: Binary packages".
1.8 rillig 8438:
1.148 leot 8439: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 8440:
8441: These directories contain the "real" pkgsrc, that is the files that define how
8442: to create binary packages from source archives.
8443:
1.149 leot 8444: Each of the current, stable and pkgsrc-20xxQy directories share the same
8445: structure. They each contain a pkgsrc directory and pkgsrc.tar.{bz,gz,xz} file.
8446:
1.1 dsieger 8447: The directory pkgsrc contains a snapshot of the CVS repository, which is
1.149 leot 8448: updated regularly. The file pkgsrc.tar.{bz,gz,xz} contains the same as the
8449: directory, ready to be downloaded as a whole.
1.1 dsieger 8450:
1.149 leot 8451: The current directory contains files related to the HEAD branch of the CVS
8452: repository. In this directory there is an additional file called
8453: pkgsrc-readmes.tar.{bz,gz,xz} that contains all pkgsrc READMEs with information
8454: about categories and packages.
8455:
8456: The stable directory is a symlink to the latest pkgsrc-20xxQy.
8457:
8458: The pkgsrc-20xxQy. directories contain files related to the -20xxQy stable
8459: branch of the CVS repository. In these directories there is an additional file
8460: called pkgsrc-20xxQy.tar.{bz,gz,xz}, which contains the state of pkgsrc when it
8461: was branched.
1.148 leot 8462:
1.1 dsieger 8463: Appendix D. Editing guidelines for the pkgsrc guide
8464:
8465: Table of Contents
8466:
8467: D.1. Make targets
8468: D.2. Procedure
8469:
8470: This section contains information on editing the pkgsrc guide itself.
8471:
8472: D.1. Make targets
8473:
8474: The pkgsrc guide's source code is stored in pkgsrc/doc/guide/files, and several
8475: files are created from it:
8476:
8477: * pkgsrc/doc/pkgsrc.txt
8478:
8479: * pkgsrc/doc/pkgsrc.html
8480:
1.2 rillig 8481: * http://www.NetBSD.org/docs/pkgsrc/
1.1 dsieger 8482:
1.2 rillig 8483: * http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf: The PDF version of the pkgsrc
8484: guide.
1.1 dsieger 8485:
1.2 rillig 8486: * http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps: PostScript version of the
8487: pkgsrc guide.
1.1 dsieger 8488:
8489: D.2. Procedure
8490:
8491: The procedure to edit the pkgsrc guide is:
8492:
8493: 1. Make sure you have the packages needed to regenerate the pkgsrc guide (and
1.46 obache 8494: other XML-based NetBSD documentation) installed. These are automatically
8495: installed when you install the meta-pkgs/pkgsrc-guide-tools package.
1.1 dsieger 8496:
8497: 2. Run cd doc/guide to get to the right directory. All further steps will take
8498: place here.
8499:
8500: 3. Edit the XML file(s) in files/.
8501:
8502: 4. Run bmake to check the pkgsrc guide for valid XML and to build the final
8503: output files. If you get any errors at this stage, you can just edit the
8504: files, as there are only symbolic links in the working directory, pointing
8505: to the files in files/.
8506:
8507: 5. (cd files && cvs commit)
8508:
8509: 6. Run bmake clean && bmake to regenerate the output files with the proper RCS
8510: Ids.
8511:
8512: 7. Run bmake regen to install and commit the files in both pkgsrc/doc and
8513: htdocs.
8514:
8515: Note
8516:
8517: If you have added, removed or renamed some chapters, you need to
8518: synchronize them using cvs add or cvs delete in the htdocs directory.
8519:
CVSweb <webmaster@jp.NetBSD.org>