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