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