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