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