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