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