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