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