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