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