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