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