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