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