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