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