From 4b79c261d8fa1f1fa059ce50bb7f0cdc0eed5be2 Mon Sep 17 00:00:00 2001 From: rillig Date: Tue, 19 Sep 2006 18:03:35 +0000 Subject: regen --- doc/pkgsrc.html | 1826 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 978 insertions(+), 848 deletions(-) (limited to 'doc/pkgsrc.html') diff --git a/doc/pkgsrc.html b/doc/pkgsrc.html index 277c5e0f7d6..d2d6cf9066c 100644 --- a/doc/pkgsrc.html +++ b/doc/pkgsrc.html @@ -35,7 +35,7 @@
-

$NetBSD: pkgsrc.xml,v 1.22 2006/09/01 16:35:39 jmmv Exp $

+

$NetBSD: pkgsrc.xml,v 1.23 2006/09/19 17:50:38 rillig Exp $

Abstract

pkgsrc is a centralized package management system for @@ -144,271 +144,276 @@

6.4. Creating a multiple CD-ROM packages collection
6.4.1. Example of cdpack
-
7. Frequently Asked Questions
-
-
7.1. Are there any mailing lists for pkg-related discussion?
-
7.2. Where's the pkgviews documentation?
-
7.3. Utilities for package management (pkgtools)
-
7.4. How to use pkgsrc as non-root
-
7.5. How to resume transfers when fetching distfiles?
-
7.6. How can I install/use XFree86 from pkgsrc?
-
7.7. How can I install/use X.org from pkgsrc?
-
7.8. How to fetch files from behind a firewall
-
7.9. How do I tell make fetch to do passive FTP?
-
7.10. How to fetch all distfiles at once
-
7.11. What does “Don't know how to make +
7. Directory layout of the installed files
+
+
7.1. File system layout in ${PREFIX}
+
7.2. File system layout in ${VARBASE}
+
+
8. Frequently Asked Questions
+
+
8.1. Are there any mailing lists for pkg-related discussion?
+
8.2. Where's the pkgviews documentation?
+
8.3. Utilities for package management (pkgtools)
+
8.4. How to use pkgsrc as non-root
+
8.5. How to resume transfers when fetching distfiles?
+
8.6. How can I install/use XFree86 from pkgsrc?
+
8.7. How can I install/use X.org from pkgsrc?
+
8.8. How to fetch files from behind a firewall
+
8.9. How do I tell make fetch to do passive FTP?
+
8.10. How to fetch all distfiles at once
+
8.11. What does “Don't know how to make /usr/share/tmac/tmac.andoc” mean?
-
7.12. What does “Could not find bsd.own.mk” mean?
-
7.13. Using 'sudo' with pkgsrc
-
7.14. How do I change the location of configuration files?
-
7.15. Automated security checks
-
7.16. Why do some packages ignore my CFLAGS?
-
7.17. A package does not build. What shall I do?
-
7.18. What does “Makefile appears to contain unresolved cvs/rcs/??? merge conflicts” mean?
-
7.19. I have a little time to kill. What shall I do?
+
8.12. What does “Could not find bsd.own.mk” mean?
+
8.13. Using 'sudo' with pkgsrc
+
8.14. How do I change the location of configuration files?
+
8.15. Automated security checks
+
8.16. Why do some packages ignore my CFLAGS?
+
8.17. A package does not build. What shall I do?
+
8.18. What does “Makefile appears to contain unresolved cvs/rcs/??? merge conflicts” mean?
+
8.19. I have a little time to kill. What shall I do?
II. The pkgsrc developer's guide
-
8. Creating a new pkgsrc package from scratch
-
9. Package components - files, directories and contents
+
9. Creating a new pkgsrc package from scratch
+
10. Package components - files, directories and contents
-
9.1. Makefile
-
9.2. distinfo
-
9.3. patches/*
+
10.1. Makefile
+
10.2. distinfo
+
10.3. patches/*
-
9.3.1. Patching guidelines
-
9.3.2. Feedback to the author
+
10.3.1. Patching guidelines
+
10.3.2. Feedback to the author
-
9.4. Other mandatory files
-
9.5. Optional files
+
10.4. Other mandatory files
+
10.5. Optional files
-
9.5.1. Files affecting the binary package
-
9.5.2. Files affecting the build process
-
9.5.3. Files affecting nothing at all
+
10.5.1. Files affecting the binary package
+
10.5.2. Files affecting the build process
+
10.5.3. Files affecting nothing at all
-
9.6. work*
-
9.7. files/*
+
10.6. work*
+
10.7. files/*
-
10. Programming in Makefiles
+
11. Programming in Makefiles
-
10.1. Makefile variables
-
10.1.1. Naming conventions
-
10.2. Code snippets
+
11.1. Makefile variables
+
11.1.1. Naming conventions
+
11.2. Code snippets
-
10.2.1. Adding things to a list
-
10.2.2. Converting an internal list into an external list
-
10.2.3. Passing variables to a shell command
-
10.2.4. Quoting guideline
-
10.2.5. Workaround for a bug in BSD Make
+
11.2.1. Adding things to a list
+
11.2.2. Converting an internal list into an external list
+
11.2.3. Passing variables to a shell command
+
11.2.4. Quoting guideline
+
11.2.5. Workaround for a bug in BSD Make
-
11. PLIST issues
+
12. PLIST issues
-
11.1. RCS ID
-
11.2. Semi-automatic PLIST generation
-
11.3. Tweaking output of make print-PLIST
-
11.4. Variable substitution in PLIST
-
11.5. Man page compression
-
11.6. Changing PLIST source with PLIST_SRC
-
11.7. Platform-specific and differing PLISTs
-
11.8. Sharing directories between packages
+
12.1. RCS ID
+
12.2. Semi-automatic PLIST generation
+
12.3. Tweaking output of make print-PLIST
+
12.4. Variable substitution in PLIST
+
12.5. Man page compression
+
12.6. Changing PLIST source with PLIST_SRC
+
12.7. Platform-specific and differing PLISTs
+
12.8. Sharing directories between packages
-
12. Buildlink methodology
+
13. Buildlink methodology
-
12.1. Converting packages to use buildlink3
-
12.2. Writing buildlink3.mk files
+
13.1. Converting packages to use buildlink3
+
13.2. Writing buildlink3.mk files
-
12.2.1. Anatomy of a buildlink3.mk file
-
12.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files
+
13.2.1. Anatomy of a buildlink3.mk file
+
13.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files
-
12.3. Writing builtin.mk files
+
13.3. Writing builtin.mk files
-
12.3.1. Anatomy of a builtin.mk file
-
12.3.2. Global preferences for native or pkgsrc software
+
13.3.1. Anatomy of a builtin.mk file
+
13.3.2. Global preferences for native or pkgsrc software
-
13. The pkginstall framework
+
14. The pkginstall framework
-
13.1. Files and directories outside the installation prefix
+
14.1. Files and directories outside the installation prefix
-
13.1.1. Directory manipulation
-
13.1.2. File manipulation
+
14.1.1. Directory manipulation
+
14.1.2. File manipulation
-
13.2. Configuration files
+
14.2. Configuration files
-
13.2.1. How PKG_SYSCONFDIR is set
-
13.2.2. Telling the software where configuration files are
-
13.2.3. Patching installations
-
13.2.4. Disabling handling of configuration files
+
14.2.1. How PKG_SYSCONFDIR is set
+
14.2.2. Telling the software where configuration files are
+
14.2.3. Patching installations
+
14.2.4. Disabling handling of configuration files
-
13.3. System startup scripts
-
13.3.1. Disabling handling of system startup scripts
-
13.4. System users and groups
-
13.5. System shells
-
13.5.1. Disabling shell registration
-
13.6. Fonts
-
13.6.1. Disabling automatic update of the fonts databases
+
14.3. System startup scripts
+
14.3.1. Disabling handling of system startup scripts
+
14.4. System users and groups
+
14.5. System shells
+
14.5.1. Disabling shell registration
+
14.6. Fonts
+
14.6.1. Disabling automatic update of the fonts databases
-
14. Options handling
+
15. Options handling
-
14.1. Global default options
-
14.2. Converting packages to use bsd.options.mk
-
14.3. Option Names
+
15.1. Global default options
+
15.2. Converting packages to use bsd.options.mk
+
15.3. Option Names
-
15. The build process
+
16. The build process
+
+
16.1. Introduction
+
16.2. Program location
+
16.3. Directories used during the build process
+
16.4. Running a phase
+
16.5. The fetch phase
-
15.1. Introduction
-
15.2. Program location
-
15.3. Directories used during the build process
-
15.4. Running a phase
-
15.5. The fetch phase
+
16.5.1. What to fetch and where to get it from
+
16.5.2. How are the files fetched?
+
+
16.6. The checksum phase
+
16.7. The extract phase
+
16.8. The patch phase
+
16.9. The tools phase
+
16.10. The wrapper phase
+
16.11. The configure phase
+
16.12. The build phase
+
16.13. The test phase
+
16.14. The install phase
+
16.15. The package phase
+
16.16. Cleaning up
+
16.17. Other helpful targets
+
+
17. Tools needed for building or running
-
15.5.1. What to fetch and where to get it from
-
15.5.2. How are the files fetched?
+
17.1. Tools for pkgsrc builds
+
17.2. Tools needed by packages
+
17.3. Tools provided by platforms
-
15.6. The checksum phase
-
15.7. The extract phase
-
15.8. The patch phase
-
15.9. The tools phase
-
15.10. The wrapper phase
-
15.11. The configure phase
-
15.12. The build phase
-
15.13. The test phase
-
15.14. The install phase
-
15.15. The package phase
-
15.16. Cleaning up
-
15.17. Other helpful targets
+
18. Making your package work
+
+
18.1. General operation
+
+
18.1.1. Portability of packages
+
18.1.2. How to pull in user-settable variables from mk.conf
+
18.1.3. User interaction
+
18.1.4. Handling licenses
+
18.1.5. Restricted packages
+
18.1.6. Handling dependencies
+
18.1.7. Handling conflicts with other packages
+
18.1.8. Packages that cannot or should not be built
+
18.1.9. Packages which should not be deleted, once installed
+
18.1.10. Handling packages with security problems
+
18.1.11. How to handle incrementing versions when fixing an existing package
+
18.1.12. Substituting variable text in the package files (the SUBST framework)
-
16. Tools needed for building or running
+
18.2. Fixing problems in the fetch phase
-
16.1. Tools for pkgsrc builds
-
16.2. Tools needed by packages
-
16.3. Tools provided by platforms
+
18.2.1. Packages whose distfiles aren't available for plain downloading
+
18.2.2. How to handle modified distfiles with the 'old' name
-
17. Making your package work
-
-
17.1. General operation
+
18.3. Fixing problems in the configure phase
-
17.1.1. Portability of packages
-
17.1.2. How to pull in user-settable variables from mk.conf
-
17.1.3. User interaction
-
17.1.4. Handling licenses
-
17.1.5. Restricted packages
-
17.1.6. Handling dependencies
-
17.1.7. Handling conflicts with other packages
-
17.1.8. Packages that cannot or should not be built
-
17.1.9. Packages which should not be deleted, once installed
-
17.1.10. Handling packages with security problems
-
17.1.11. How to handle incrementing versions when fixing an existing package
-
17.1.12. Substituting variable text in the package files (the SUBST framework)
-
-
17.2. Fixing problems in the fetch phase
-
-
17.2.1. Packages whose distfiles aren't available for plain downloading
-
17.2.2. How to handle modified distfiles with the 'old' name
-
-
17.3. Fixing problems in the configure phase
-
-
17.3.1. Shared libraries - libtool
-
17.3.2. Using libtool on GNU packages that already support libtool
-
17.3.3. GNU Autoconf/Automake
+
18.3.1. Shared libraries - libtool
+
18.3.2. Using libtool on GNU packages that already support libtool
+
18.3.3. GNU Autoconf/Automake
-
17.4. Programming languages
-
-
17.4.1. C, C++, and Fortran
-
17.4.2. Java
-
17.4.3. Packages containing perl scripts
-
17.4.4. Other programming languages
-
-
17.5. Fixing problems in the build phase
-
-
17.5.1. Compiling C and C++ code conditionally
-
17.5.2. How to handle compiler bugs
-
17.5.3. Undefined reference to “...
-
17.5.4. Running out of memory
-
-
17.6. Fixing problems in the install phase
-
-
17.6.1. Creating needed directories
-
17.6.2. Where to install documentation
-
17.6.3. Installing score files
-
17.6.4. Packages with hardcoded paths to other interpreters
-
17.6.5. Packages installing perl modules
-
17.6.6. Packages installing info files
-
17.6.7. Packages installing man pages
-
17.6.8. Packages installing GConf2 data files
-
17.6.9. Packages installing scrollkeeper data files
-
17.6.10. Packages installing X11 fonts
-
17.6.11. Packages installing GTK2 modules
-
17.6.12. Packages installing SGML or XML data
-
17.6.13. Packages installing extensions to the MIME database
-
17.6.14. Packages using intltool
-
17.6.15. Packages installing startup scripts
-
17.6.16. Packages installing TeX modules
-
17.6.17. Packages supporting running binaries in +
18.4. Programming languages
+
+
18.4.1. C, C++, and Fortran
+
18.4.2. Java
+
18.4.3. Packages containing perl scripts
+
18.4.4. Other programming languages
+
+
18.5. Fixing problems in the build phase
+
+
18.5.1. Compiling C and C++ code conditionally
+
18.5.2. How to handle compiler bugs
+
18.5.3. Undefined reference to “...
+
18.5.4. Running out of memory
+
+
18.6. Fixing problems in the install phase
+
+
18.6.1. Creating needed directories
+
18.6.2. Where to install documentation
+
18.6.3. Installing score files
+
18.6.4. Packages with hardcoded paths to other interpreters
+
18.6.5. Packages installing perl modules
+
18.6.6. Packages installing info files
+
18.6.7. Packages installing man pages
+
18.6.8. Packages installing GConf2 data files
+
18.6.9. Packages installing scrollkeeper data files
+
18.6.10. Packages installing X11 fonts
+
18.6.11. Packages installing GTK2 modules
+
18.6.12. Packages installing SGML or XML data
+
18.6.13. Packages installing extensions to the MIME database
+
18.6.14. Packages using intltool
+
18.6.15. Packages installing startup scripts
+
18.6.16. Packages installing TeX modules
+
18.6.17. Packages supporting running binaries in emulation
-
17.6.18. Packages installing hicolor theme icons
-
17.6.19. Packages installing desktop files
+
18.6.18. Packages installing hicolor theme icons
+
18.6.19. Packages installing desktop files
-
17.7. Marking packages as having problems
+
18.7. Marking packages as having problems
-
18. Debugging
-
19. Submitting and Committing
+
19. Debugging
+
20. Submitting and Committing
-
19.1. Submitting binary packages
-
19.2. Submitting source packages (for non-NetBSD-developers)
-
19.3. General notes when adding, updating, or removing packages
-
19.4. Committing: Importing a package into CVS
-
19.5. Updating a package to a newer version
-
19.6. Moving a package in pkgsrc
+
20.1. Submitting binary packages
+
20.2. Submitting source packages (for non-NetBSD-developers)
+
20.3. General notes when adding, updating, or removing packages
+
20.4. Committing: Importing a package into CVS
+
20.5. Updating a package to a newer version
+
20.6. Moving a package in pkgsrc
-
20. Frequently Asked Questions
-
21. GNOME packaging and porting
+
21. Frequently Asked Questions
+
22. GNOME packaging and porting
-
21.1. Meta packages
-
21.2. Packaging a GNOME application
-
21.3. Updating GNOME to a newer version
-
21.4. Patching guidelines
+
22.1. Meta packages
+
22.2. Packaging a GNOME application
+
22.3. Updating GNOME to a newer version
+
22.4. Patching guidelines
III. The pkgsrc infrastructure internals
-
22. Design of the pkgsrc infrastructure
+
23. Design of the pkgsrc infrastructure
-
22.1. The meaning of variable definitions
-
22.2. Avoiding problems before they arise
-
22.3. Variable evaluation
+
23.1. The meaning of variable definitions
+
23.2. Avoiding problems before they arise
+
23.3. Variable evaluation
-
22.3.1. At load time
-
22.3.2. At runtime
+
23.3.1. At load time
+
23.3.2. At runtime
-
22.4. How can variables be specified?
-
22.5. Designing interfaces for Makefile fragments
+
23.4. How can variables be specified?
+
23.5. Designing interfaces for Makefile fragments
-
22.5.1. Procedures with parameters
-
22.5.2. Actions taken on behalf of parameters
+
23.5.1. Procedures with parameters
+
23.5.2. Actions taken on behalf of parameters
-
22.6. The order in which files are loaded
+
23.6. The order in which files are loaded
-
22.6.1. The order in bsd.prefs.mk
-
22.6.2. The order in bsd.pkg.mk
+
23.6.1. The order in bsd.prefs.mk
+
23.6.2. The order in bsd.pkg.mk
-
23. Regression tests
+
24. Regression tests
-
23.1. The regression tests framework
-
23.2. Running the regression tests
-
23.3. Adding a new regression test
+
24.1. The regression tests framework
+
24.2. Running the regression tests
+
24.3. Adding a new regression test
-
23.3.1. Overridable functions
-
23.3.2. Helper functions
+
24.3.1. Overridable functions
+
24.3.2. Helper functions
-
24. Porting pkgsrc
+
25. Porting pkgsrc
-
24.1. Porting pkgsrc to a new operating system
-
24.2. Adding support for a new compiler
+
25.1. Porting pkgsrc to a new operating system
+
25.2. Adding support for a new compiler
A. A simple example package: bison
@@ -452,9 +457,9 @@ source packages
3.1. Binary kits and available packages
-
9.1. Patching examples +
10.1. Patching examples
-
21.1. PLIST handling for GNOME packages +
22.1. PLIST handling for GNOME packages
@@ -809,28 +814,33 @@ minutes!

6.4. Creating a multiple CD-ROM packages collection
6.4.1. Example of cdpack
-
7. Frequently Asked Questions
-
-
7.1. Are there any mailing lists for pkg-related discussion?
-
7.2. Where's the pkgviews documentation?
-
7.3. Utilities for package management (pkgtools)
-
7.4. How to use pkgsrc as non-root
-
7.5. How to resume transfers when fetching distfiles?
-
7.6. How can I install/use XFree86 from pkgsrc?
-
7.7. How can I install/use X.org from pkgsrc?
-
7.8. How to fetch files from behind a firewall
-
7.9. How do I tell make fetch to do passive FTP?
-
7.10. How to fetch all distfiles at once
-
7.11. What does “Don't know how to make +
7. Directory layout of the installed files
+
+
7.1. File system layout in ${PREFIX}
+
7.2. File system layout in ${VARBASE}
+
+
8. Frequently Asked Questions
+
+
8.1. Are there any mailing lists for pkg-related discussion?
+
8.2. Where's the pkgviews documentation?
+
8.3. Utilities for package management (pkgtools)
+
8.4. How to use pkgsrc as non-root
+
8.5. How to resume transfers when fetching distfiles?
+
8.6. How can I install/use XFree86 from pkgsrc?
+
8.7. How can I install/use X.org from pkgsrc?
+
8.8. How to fetch files from behind a firewall
+
8.9. How do I tell make fetch to do passive FTP?
+
8.10. How to fetch all distfiles at once
+
8.11. What does “Don't know how to make /usr/share/tmac/tmac.andoc” mean?
-
7.12. What does “Could not find bsd.own.mk” mean?
-
7.13. Using 'sudo' with pkgsrc
-
7.14. How do I change the location of configuration files?
-
7.15. Automated security checks
-
7.16. Why do some packages ignore my CFLAGS?
-
7.17. A package does not build. What shall I do?
-
7.18. What does “Makefile appears to contain unresolved cvs/rcs/??? merge conflicts” mean?
-
7.19. I have a little time to kill. What shall I do?
+
8.12. What does “Could not find bsd.own.mk” mean?
+
8.13. Using 'sudo' with pkgsrc
+
8.14. How do I change the location of configuration files?
+
8.15. Automated security checks
+
8.16. Why do some packages ignore my CFLAGS?
+
8.17. A package does not build. What shall I do?
+
8.18. What does “Makefile appears to contain unresolved cvs/rcs/??? merge conflicts” mean?
+
8.19. I have a little time to kill. What shall I do?
@@ -2348,7 +2358,7 @@ works.

pkgsrc tree instances.)

  • LOCALPATCHES: Directory for local patches that aren't part of pkgsrc. - See Section 9.3, “patches/*” for more + See Section 10.3, “patches/*” for more information. rel and arch are replaced with OS release (“2.0”, etc.) and architecture @@ -2588,13 +2598,13 @@ PKG_OPTIONS.apache= suexec /usr/pkgsrc/packages, in the form of a gzipped tar file. See Section B.2, “Packaging figlet” for a continuation of the above misc/figlet example.

    -

    See Chapter 19, Submitting and Committing for information on how to submit +

    See Chapter 20, Submitting and Committing for information on how to submit such a binary package.

    6.2. Settings for creation of binary packages

    -

    See Section 15.17, “Other helpful targets”.

    +

    See Section 16.17, “Other helpful targets”.

    @@ -3036,30 +3046,150 @@ nbftp% chmod 755 .

    -Chapter 7. Frequently Asked Questions

    +Chapter 7. Directory layout of the installed files
    +

    The files that are installed by pkgsrc are organized in a way that +is similar to what you find in the /usr directory +of the base system. But some details are different. This is because +pkgsrc initially came from FreeBSD and had adopted its file system +hierarchy. Later it was largely influenced by NetBSD. But no matter +which operating system you are using pkgsrc with, you can expect the +same layout for pkgsrc.

    +

    There are mainly three root directories for pkgsrc:

    +
      +
    • LOCALBASE corresponds to the +/usr directory in the base system. It is the +“main” directory where the files are installed and contains +the well-known subdirectories like bin, +include, lib, +share and +sbin.

    • +
    • VARBASE corresponds to +/var in the base system. Some programs (especially +games, network daemons) need write access to it during normal +operation.

    • +
    • PKG_SYSCONFDIR corresponds to +/etc in the base system. It contains configuration +files of the packages, as well as pkgsrc's mk.conf +itself.

    • +
    +
    +

    +7.1. File system layout in ${PREFIX}

    +

    The following directories exist in a typical pkgsrc installation +in ${PREFIX}.

    +
    +
    bin
    +

    Contains executable programs that are intended to be +directly used by the end user.

    +
    emul
    +

    Contains files for the emulation layers of various other +operating systems, especially for +NetBSD.

    +
    etc (the usual location of +${PKG_SYSCONFDIR})
    +

    Contains +the configuration files.

    +
    include
    +

    Contains headers for the C and C++ programming +languages.

    +
    info
    +

    Contains GNU info files of various +packages.

    +
    lib
    +

    Contains shared and static +libraries.

    +
    libdata
    +

    Contains data files that don't change after +installation. Other data files belong into +${VARBASE}.

    +
    libexec
    +

    Contains programs that are not intended to be used by +end users, such as helper programs or network +daemons.

    +
    libexec/cgi-bin
    +

    Contains programs that are intended to be executed as +CGI scripts by a web server.

    +
    man (the usual value of +${PKGMANDIR})
    +

    Contains brief +documentation in form of manual pages.

    +
    sbin
    +

    Contains programs that are intended to be used only by +the super-user.

    +
    share
    +

    Contains platform-independent data files that don't +change after installation.

    +
    share/doc
    +

    Contains documentation files provided by the +packages.

    +
    share/examples
    +

    Contains example files provided by the packages. Among +others, the original configuration files are saved here and copied to +${PKG_SYSCONFDIR} during +installation.

    +
    share/examples/rc.d
    +

    Contains the original files for rc.d +scripts.

    +
    var (the usual location of +${VARBASE})
    +

    Contains files +that may be modified after +installation.

    +
    +
    +
    +

    +7.2. File system layout in ${VARBASE}

    +
    +
    db/pkg (the usual location of +${PKG_DBDIR})
    +

    Contains +information about the currently installed +packages.

    +
    games
    +

    Contains highscore +files.

    +
    log
    +

    Contains log files.

    +
    run
    +

    Contains informational files about daemons that are +currently running.

    +
    +
    +
    +
    +

    +Chapter 8. Frequently Asked Questions

    +

    This section contains hints, tips & tricks on special things in @@ -3067,7 +3197,7 @@ pkgsrc that we didn't find a better place for in the previous chapters, and it contains items for both pkgsrc users and developers.

    -7.1. Are there any mailing lists for pkg-related discussion?

    +8.1. Are there any mailing lists for pkg-related discussion?

    The following mailing lists may be of interest to pkgsrc users:

    • pkgsrc-users: @@ -3098,14 +3228,14 @@ it contains items for both pkgsrc users and developers.

    -7.2. Where's the pkgviews documentation?

    +8.2. Where's the pkgviews documentation?

    Pkgviews is tightly integrated with buildlink. You can find a pkgviews User's guide in pkgsrc/mk/buildlink3/PKGVIEWS_UG.

    -7.3. Utilities for package management (pkgtools)

    +8.3. Utilities for package management (pkgtools)

    The directory pkgsrc/pkgtools contains a number of useful utilities for both users and developers of pkgsrc. This section attempts only to make the reader aware of the utilities and when @@ -3182,7 +3312,7 @@ utilities)

    -7.4. How to use pkgsrc as non-root

    +8.4. How to use pkgsrc as non-root

    If you want to use pkgsrc as non-root user, you can set some variables to make pkgsrc work under these conditions. At the very least, you need to set UNPRIVILEGED to “yes”; this @@ -3203,7 +3333,7 @@ that allow finer tuning of the tree layout.

    -7.5. How to resume transfers when fetching distfiles?

    +8.5. How to resume transfers when fetching distfiles?

    By default, resuming transfers in pkgsrc is disabled, but you can enable this feature by adding the option PKG_RESUME_TRANSFERS=YES into @@ -3227,7 +3357,7 @@ like:

    -7.6. How can I install/use XFree86 from pkgsrc?

    +8.6. How can I install/use XFree86 from pkgsrc?

    If you want to use XFree86 from pkgsrc instead of your system's own X11 (/usr/X11R6, /usr/openwin, ...), you will have to add the following line into @@ -3238,7 +3368,7 @@ X11 (/usr/X11R6, /usr/openw

    -7.7. How can I install/use X.org from pkgsrc?

    +8.7. How can I install/use X.org from pkgsrc?

    If you want to use X.org from pkgsrc instead of your system's own X11 (/usr/X11R6, /usr/openwin, ...) you will have to add the following line into @@ -3254,7 +3384,7 @@ this X.org X11 implementation from pkgsrc.

    -7.8. How to fetch files from behind a firewall

    +8.8. How to fetch files from behind a firewall

    If you are sitting behind a firewall which does not allow direct connections to Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This is done using an environment variable in the @@ -3269,7 +3399,7 @@ are:

    -7.9. How do I tell make fetch to do passive FTP?

    +8.9. How do I tell make fetch to do passive FTP?

    This depends on which utility is used to retrieve distfiles. From bsd.pkg.mk, FETCH_CMD is assigned the first available command from the following list:

    @@ -3289,7 +3419,7 @@ transfers.

    -7.10. How to fetch all distfiles at once

    +8.10. How to fetch all distfiles at once

    You would like to download all the distfiles in a single batch from work or university, where you can't run a make fetch. There is an archive of distfiles on ftp.NetBSD.org, @@ -3321,7 +3451,7 @@ by running:

    -7.11. What does “Don't know how to make +8.11. What does “Don't know how to make /usr/share/tmac/tmac.andoc” mean?

    When compiling the pkgtools/pkg_install package, you get the error from make that it doesn't know how to make @@ -3335,7 +3465,7 @@ environment or in /etc/mk.conf.

    -7.12. What does “Could not find bsd.own.mk” mean?

    +8.12. What does “Could not find bsd.own.mk” mean?

    You didn't install the compiler set, comp.tgz, when you installed your NetBSD machine. Please get and install it, by extracting it in /:

    @@ -3347,7 +3477,7 @@ the one that corresponds to your release (determine via

    -7.13. Using 'sudo' with pkgsrc

    +8.13. Using 'sudo' with pkgsrc

    When installing packages as non-root user and using the just-in-time su(1) feature of pkgsrc, it can become annoying to type in the root password for each required package installed. To avoid this, the sudo @@ -3363,7 +3493,7 @@ into your /etc/mk.conf:

    -7.14. How do I change the location of configuration files?

    +8.14. How do I change the location of configuration files?

    As the system administrator, you can choose where configuration files are installed. The default settings make all these files go into ${PREFIX}/etc or some of its subdirectories; this may @@ -3385,7 +3515,7 @@ reinstall any affected packages.

    -7.15. Automated security checks

    +8.15. Automated security checks

    Please be aware that there can often be bugs in third-party software, and some of these bugs can leave a machine vulnerable to exploitation by attackers. In an effort to lessen the exposure, the NetBSD packages team @@ -3419,7 +3549,7 @@ check.

    -7.16. Why do some packages ignore my CFLAGS?

    +8.16. Why do some packages ignore my CFLAGS?

    When you add your own preferences to the CFLAGS variable in your mk.conf, these flags are passed in @@ -3441,7 +3571,7 @@ check.

    -7.17. A package does not build. What shall I do?

    +8.17. A package does not build. What shall I do?
    1. Make sure that your copy of pkgsrc is consistent. A case that occurs often is that people only update pkgsrc in @@ -3462,7 +3592,7 @@ check.

    -7.18. What does “Makefile appears to contain unresolved cvs/rcs/??? merge conflicts” mean?

    +8.18. What does “Makefile appears to contain unresolved cvs/rcs/??? merge conflicts” mean?

    You have modified a file from pkgsrc, and someone else has modified that same file afterwards in the CVS repository. Both changes are in the same region of the file, so when you updated pkgsrc, the @@ -3475,7 +3605,7 @@ anymore, you can remove that file and run cvs -q u

    -7.19. I have a little time to kill. What shall I do?

    +8.19. I have a little time to kill. What shall I do?

    This is not really an FAQ yet, but here's the answer anyway.

    -Chapter 8. Creating a new pkgsrc package from scratch

    +Chapter 9. Creating a new pkgsrc package from scratch

    When you find a package that is not yet in pkgsrc, you most likely have a URL from where you can download the source code. Starting with this URL, creating a package involves only a @@ -3771,7 +3901,7 @@ anymore, you can remove that file and run cvs -q u explanations.

  • Now, run bmake to build the package. For the various things that can go wrong in this phase, - consult Chapter 17, Making your package work.

  • + consult Chapter 18, Making your package work.

  • When the package builds fine, the next step is to install the package. Run bmake install and hope that everything works.

  • @@ -3796,26 +3926,26 @@ anymore, you can remove that file and run cvs -q u

    -Chapter 9. Package components - files, directories and contents

    +Chapter 10. Package components - files, directories and contents

    Whenever you're preparing a package, there are a number of @@ -3823,7 +3953,7 @@ files involved which are described in the following sections.

    -9.1. Makefile

    +10.1. Makefile

    Building, installation and creation of a binary package are all controlled by the package's Makefile. The Makefile describes various things about @@ -3879,7 +4009,7 @@ sections.

    DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES are discussed in detail in - Section 15.5, “The fetch phase”.

    + Section 16.5, “The fetch phase”.

    The second section contains information about separately downloaded patches, if any. @@ -3956,12 +4086,12 @@ sections.

  • Replace /usr/local with “${PREFIX}” in all files (see patches, below).

  • -
  • If the package installs any info files, see Section 17.6.6, “Packages installing info files”.

  • +
  • If the package installs any info files, see Section 18.6.6, “Packages installing info files”.

  • -9.2. distinfo

    +10.2. distinfo

    The distinfo file contains the message digest, or checksum, of each distfile needed for the package. This ensures that the distfiles retrieved from the Internet have not been @@ -3971,7 +4101,7 @@ sections.

    message digests, as well as the file size.

    The distinfo file also contains the checksums for all the patches found in the - patches directory (see Section 9.3, “patches/*”).

    + patches directory (see Section 10.3, “patches/*”).

    To regenerate the distinfo file, use the make makedistinfo or make mdi command.

    @@ -3983,7 +4113,7 @@ sections.

    -9.3. patches/*

    +10.3. patches/*

    This directory contains files that are used by the patch(1) command to modify the sources as distributed in the distribution file into a form @@ -4020,7 +4150,7 @@ sections.

    directory to patches/.

    When you have finished a package, remember to generate the checksums for the patch files by using the make - makepatchsum command, see Section 9.2, “distinfo.

    + makepatchsum
    command, see Section 10.2, “distinfo.

    When adding a patch that corrects a problem in the distfile (rather than e.g. enforcing pkgsrc's view of where man pages should go), send the patch as a bug report to the @@ -4052,7 +4182,7 @@ sections.

    applied.

    -9.3.1. Patching guidelines

    +10.3.1. Patching guidelines

    When fixing a portability issue in the code do not use preprocessor magic to check for the current operating system nor platform. Doing so hurts portability to other platforms because @@ -4076,7 +4206,7 @@ sections.

    It doesn't work unless it is right!

    Some typical examples:

    -

    Table 9.1. Patching examples

    +

    Table 10.1. Patching examples

    @@ -4154,7 +4284,7 @@ sections.

    -9.3.2. Feedback to the author

    +10.3.2. Feedback to the author

    Always, always, always feed back any portability fixes or improvements you do to a package to the mainstream developers. @@ -4175,7 +4305,7 @@ sections.

    -9.4. Other mandatory files

    +10.4. Other mandatory files
    DESCR

    A multi-line description of the piece of software. This should include @@ -4187,16 +4317,16 @@ sections.

    system: all the binaries, manual pages, etc. There are other directives which may be entered in this file, to control the creation and deletion of directories, and the location of - inserted files. See Chapter 11, PLIST issues for more + inserted files. See Chapter 12, PLIST issues for more information.

    -9.5. Optional files

    +10.5. Optional files

    -9.5.1. Files affecting the binary package

    +10.5.1. Files affecting the binary package
    INSTALL

    This shell script is invoked twice by pkg_add(1). @@ -4205,7 +4335,7 @@ sections.

    are moved in place. This can be used to do any custom procedures not possible with @exec commands in PLIST. See pkg_add(1) and - pkg_create(1) for more information. See also Section 13.1, “Files and directories outside the installation prefix”.

    + pkg_create(1) for more information. See also Section 14.1, “Files and directories outside the installation prefix”.

    DEINSTALL

    This script is executed before and after any files are removed. It is this script's responsibility to clean up any additional messy details @@ -4246,7 +4376,7 @@ sections.

    -9.5.2. Files affecting the build process

    +10.5.2. Files affecting the build process
    Makefile.common

    This file contains arbitrary things that could @@ -4258,7 +4388,7 @@ sections.

    describes what it does.

    buildlink3.mk

    This file contains the dependency information - for the buildlink3 framework (see Chapter 12, Buildlink methodology).

    + for the buildlink3 framework (see Chapter 13, Buildlink methodology).

    hacks.mk

    This file contains workarounds for compiler bugs and similar things. It is included automatically by the pkgsrc @@ -4267,7 +4397,7 @@ sections.

    it.

    options.mk

    This file contains the code for the - package-specific options (see Chapter 14, Options handling) that can be + package-specific options (see Chapter 15, Options handling) that can be selected by the user. If a package has only one or two options, it is equally acceptable to put the code directly into the Makefile.

    @@ -4275,7 +4405,7 @@ sections.

    -9.5.3. Files affecting nothing at all

    +10.5.3. Files affecting nothing at all
    README*

    These files do not take place in the creation of @@ -4290,7 +4420,7 @@ sections.

    -9.6. work*

    +10.6. work*

    When you type make, the distribution files are unpacked into the directory denoted by WRKDIR. It can be removed by running @@ -4303,7 +4433,7 @@ sections.

    -9.7. files/*

    +10.7. files/*

    If you have any files that you wish to be placed in the package prior to configuration or building, you could place these files here and use a ${CP} command in the @@ -4322,19 +4452,19 @@ sections.

    -Chapter 10. Programming in Makefiles

    +Chapter 11. Programming in Makefiles
    @@ -4354,7 +4484,7 @@ sections.

    with them.

    -10.1. Makefile variables

    +11.1. Makefile variables

    Makefile variables contain strings that can be processed using the five operators ``='', ``+='', ``?='', ``:='', and ``!='', which are described in the make(1) man @@ -4412,7 +4542,7 @@ sections.

    -10.1.1. Naming conventions

    +11.1.1. Naming conventions
    • All variable names starting with an underscore are reserved for use by the pkgsrc infrastructure. They shall @@ -4429,13 +4559,13 @@ sections.

    -10.2. Code snippets

    +11.2. Code snippets

    This section presents you with some code snippets you should use in your own code. If you don't find anything appropriate here, you should test your code and add it here.

    -10.2.1. Adding things to a list

    +11.2.1. Adding things to a list
         STRING=                 foo * bar `date`
         INT_LIST=               # empty
    @@ -4456,7 +4586,7 @@ sections.

    -10.2.2. Converting an internal list into an external list

    +11.2.2. Converting an internal list into an external list
         EXT_LIST=       # empty
         .for i in ${INT_LIST}
    @@ -4471,7 +4601,7 @@ sections.

    -10.2.3. Passing variables to a shell command

    +11.2.3. Passing variables to a shell command

    Sometimes you may want to print an arbitrary string. There are many ways to get it wrong and only few that can handle every nastiness.

    @@ -4515,7 +4645,7 @@ sections.

    -10.2.4. Quoting guideline

    +11.2.4. Quoting guideline

    There are many possible sources of wrongly quoted variables. This section lists some of the commonly known ones.

      @@ -4598,7 +4728,7 @@ sections.

    -10.2.5. Workaround for a bug in BSD Make

    +11.2.5. Workaround for a bug in BSD Make

    The pkgsrc bmake program does not handle the following assignment correctly. In case _othervar_ contains a ``-'' character, one of the closing braces is included @@ -4614,18 +4744,18 @@ sections.

    -Chapter 11. PLIST issues

    +Chapter 12. PLIST issues

    The PLIST file contains a package's @@ -4638,7 +4768,7 @@ sections.

    below!).

    -11.1. RCS ID

    +12.1. RCS ID

    Be sure to add a RCS ID line as the first thing in any PLIST file you write:

    @@ -4647,17 +4777,17 @@ sections.

    -11.2. Semi-automatic PLIST generation

    +12.2. Semi-automatic PLIST generation

    You can use the make print-PLIST command to output a PLIST that matches any new files since the package - was extracted. See Section 15.17, “Other helpful targets” for + was extracted. See Section 16.17, “Other helpful targets” for more information on this target.

    -11.3. Tweaking output of make print-PLIST

    +12.3. Tweaking output of make print-PLIST

    If you have used any of the *-dirs packages, as explained in - Section 11.8, “Sharing directories between packages”, you may have noticed that + Section 12.8, “Sharing directories between packages”, you may have noticed that make print-PLIST outputs a set of @comments instead of real @dirrm lines. You can also do this for @@ -4683,7 +4813,7 @@ sections.

    -11.4. Variable substitution in PLIST

    +12.4. Variable substitution in PLIST

    A number of variables are substituted automatically in PLISTs when a package is installed on a system. This includes the following variables:

    @@ -4728,7 +4858,7 @@ sections.

    search for PLIST_SUBST).

    If you want to change other variables not listed above, you can add variables and their expansions to this variable in the - following way, similar to MESSAGE_SUBST (see Section 9.5, “Optional files”):

    + following way, similar to MESSAGE_SUBST (see Section 10.5, “Optional files”):

           PLIST_SUBST+=   SOMEVAR="somevalue"
         
    @@ -4738,7 +4868,7 @@ sections.

    -11.5. Man page compression

    +12.5. Man page compression

    Man pages should be installed in compressed form if MANZ is set (in bsd.own.mk), and uncompressed otherwise. To handle this in the @@ -4751,7 +4881,7 @@ sections.

    -11.6. Changing PLIST source with PLIST_SRC

    +12.6. Changing PLIST source with PLIST_SRC

    To use one or more files as source for the PLIST used in generating the binary package, set the variable PLIST_SRC to the names of that file(s). @@ -4761,7 +4891,7 @@ sections.

    -11.7. Platform-specific and differing PLISTs

    +12.7. Platform-specific and differing PLISTs

    Some packages decide to install a different set of files based on the operating system being used. These differences can be automatically handled by using the following files:

    @@ -4775,7 +4905,7 @@ sections.

    -11.8. Sharing directories between packages

    +12.8. Sharing directories between packages

    A “shared directory” is a directory where multiple (and unrelated) packages install files. These directories are problematic because you have to add special tricks @@ -4830,20 +4960,20 @@ sections.

    -Chapter 12. Buildlink methodology

    +Chapter 13. Buildlink methodology
    @@ -4871,7 +5001,7 @@ sections.

    software.

    -12.1. Converting packages to use buildlink3

    +13.1. Converting packages to use buildlink3

    The process of converting packages to use the buildlink3 framework (“bl3ifying”) is fairly straightforward. The things to keep in mind are:

    @@ -4948,7 +5078,7 @@ sections.

    -12.2. Writing buildlink3.mk files

    +13.2. Writing buildlink3.mk files

    A package's buildlink3.mk file is included by Makefiles to indicate the need to compile and link against header files and libraries provided by the package. A @@ -4968,7 +5098,7 @@ sections.

    -12.2.1. Anatomy of a buildlink3.mk file

    +13.2.1. Anatomy of a buildlink3.mk file

    The following real-life example buildlink3.mk is taken from pkgsrc/graphics/tiff:

    @@ -5105,7 +5235,7 @@ sections.

    -12.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files

    +13.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files

    The situation that requires increasing the dependency listed in BUILDLINK_API_DEPENDS.pkg after a package update is when the API or interface to the @@ -5128,7 +5258,7 @@ sections.

    packages made using it will require the correct package dependency and not settle for an older one which will not contain the necessary shared libraries.

    -

    See Section 17.1.6, “Handling dependencies” for +

    See Section 18.1.6, “Handling dependencies” for more information about dependencies on other packages, including the BUILDLINK_ABI_DEPENDS and ABI_DEPENDS definitions.

    @@ -5147,7 +5277,7 @@ sections.

    -12.3. Writing builtin.mk files

    +13.3. Writing builtin.mk files

    Some packages in pkgsrc install headers and libraries that coincide with headers and libraries present in the base system. Aside from a buildlink3.mk file, these @@ -5172,7 +5302,7 @@ sections.

    -12.3.1. Anatomy of a builtin.mk file

    +13.3.1. Anatomy of a builtin.mk file

    The following is the recommended template for builtin.mk files:

    @@ -5262,7 +5392,7 @@ sections.

    -12.3.2. Global preferences for native or pkgsrc software

    +13.3.2. Global preferences for native or pkgsrc software

    When building packages, it's possible to choose whether to set a global preference for using either the built-in (native) version or the pkgsrc version of software to satisfy a @@ -5295,29 +5425,29 @@ sections.

    -Chapter 13. The pkginstall framework

    +Chapter 14. The pkginstall framework

    This chapter describes the framework known as @@ -5343,7 +5473,7 @@ described above is by means of the installation scripts, which are automatically generated by pkginstall.

    -13.1. Files and directories outside the installation prefix

    +14.1. Files and directories outside the installation prefix

    As you already know, the PLIST file holds a list of files and directories that belong to a package. The names used in it are relative to the installation prefix (${PREFIX}), @@ -5376,7 +5506,7 @@ and directories based on variables set in the package's these variables.

    -13.1.1. Directory manipulation

    +14.1.1. Directory manipulation

    The following variables can be set to request the creation of directories anywhere in the file system:

      @@ -5403,7 +5533,7 @@ directories anywhere in the file system:

    -13.1.2. File manipulation

    +14.1.2. File manipulation

    Creating non-empty files outside the installation prefix is tricky because the PLIST forces all files to be inside it. To overcome this problem, the only solution is to extract the file in the @@ -5443,7 +5573,7 @@ installation prefix:

    -13.2. Configuration files

    +14.2. Configuration files

    Configuration files are special in the sense that they are installed in their own specific directory, PKG_SYSCONFDIR, and need special treatment during installation (most of which is automated by @@ -5455,7 +5585,7 @@ be removed if they have local modifications. This ensures that administrators never lose any custom changes they may have made.

    -13.2.1. How PKG_SYSCONFDIR is set

    +14.2.1. How PKG_SYSCONFDIR is set

    As said before, the PKG_SYSCONFDIR variable specifies where configuration files shall be installed. Its contents are set based upon the following variables:

    @@ -5503,11 +5633,11 @@ following:

    ${PKG_SYSCONFBASE}.

    It is worth mentioning that ${PKG_SYSCONFDIR} is -automatically added to OWN_DIRS. See Section 13.1.1, “Directory manipulation” what this means.

    +automatically added to OWN_DIRS. See Section 14.1.1, “Directory manipulation” what this means.

    -13.2.2. Telling the software where configuration files are

    +14.2.2. Telling the software where configuration files are

    Given that pkgsrc (and users!) expect configuration files to be in a known place, you need to teach each package where it shall install its files. In some cases you will have to patch the package Makefiles to @@ -5524,7 +5654,7 @@ unfortunately).

    -13.2.3. Patching installations

    +14.2.3. Patching installations

    As said before, pkginstall automatically handles configuration files. This means that the packages themselves must not touch the contents of ${PKG_SYSCONFDIR} @@ -5541,7 +5671,7 @@ examples hierarchy), the pkginstall framework can use them as master copies during the package installation to update what is in ${PKG_SYSCONFDIR}. To achieve this, the variables CONF_FILES and CONF_FILES_PERMS are -used. Check out Section 13.1.2, “File manipulation” for information +used. Check out Section 14.1.2, “File manipulation” for information about their syntax and their purpose. Here is an example, taken from the mail/mutt package:

    @@ -5553,7 +5683,7 @@ package and has no meaning outside it.

    -13.2.4. Disabling handling of configuration files

    +14.2.4. Disabling handling of configuration files

    The automatic copying of config files can be toggled by setting the environment variable PKG_CONFIG prior to package installation.

    @@ -5561,10 +5691,10 @@ installation.

    -13.3. System startup scripts

    +14.3. System startup scripts

    System startup scripts are special files because they must be installed in a place known by the underlying OS, usually outside the -installation prefix. Therefore, the same rules described in Section 13.1, “Files and directories outside the installation prefix” apply, and the same solutions +installation prefix. Therefore, the same rules described in Section 14.1, “Files and directories outside the installation prefix” apply, and the same solutions can be used. However, pkginstall provides a special mechanism to handle these files.

    In order to provide system startup scripts, the package has @@ -5599,7 +5729,7 @@ script in an automated fashion:

    -13.3.1. Disabling handling of system startup scripts

    +14.3.1. Disabling handling of system startup scripts

    The automatic copying of config files can be toggled by setting the environment variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts will be always copied inside the @@ -5609,7 +5739,7 @@ matter what the value of this variable is.

    -13.4. System users and groups

    +14.4. System users and groups

    If a package needs to create special users and/or groups during installation, it can do so by using the pkginstall framework.

    Users can be created by adding entries to the @@ -5646,7 +5776,7 @@ are automatically hardcoded into the final installation scripts.

    -13.5. System shells

    +14.5. System shells

    Packages that install system shells should register them in the shell database, /etc/shells, to make things easier to the administrator. This must be done from the installation scripts to keep @@ -5661,7 +5791,7 @@ following example, taken from

    -13.5.1. Disabling shell registration

    +14.5.1. Disabling shell registration

    The automatic registration of shell interpreters can be disabled by the administrator by setting the PKG_REGISTER_SHELLS environment variable to NO.

    @@ -5669,7 +5799,7 @@ environment variable to NO.

    -13.6. Fonts

    +14.6. Fonts

    Packages that install X11 fonts should update the database files that index the fonts within each fonts directory. This can easily be accomplished within the pkginstall framework.

    @@ -5687,7 +5817,7 @@ installation prefix. Consider the following example, taken from

    -13.6.1. Disabling automatic update of the fonts databases

    +14.6.1. Disabling automatic update of the fonts databases

    The automatic update of fonts databases can be disabled by the administrator by setting the PKG_UPDATE_FONTS_DB environment variable to NO.

    @@ -5696,13 +5826,13 @@ environment variable to NO.

    -Chapter 14. Options handling

    +Chapter 15. Options handling

    Many packages have the ability to be built to support different @@ -5714,7 +5844,7 @@ built into a package or to allow a set of global default options apply.

    -14.1. Global default options

    +15.1. Global default options

    Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of the options that should be built into every package if that option is supported. @@ -5722,7 +5852,7 @@ This variable should be set in /etc/mk.conf.

    -14.2. Converting packages to use bsd.options.mk

    +15.2. Converting packages to use bsd.options.mk

    The following example shows how bsd.options.mk should be used by the hypothetical ``wibble'' package, either in the package @@ -5860,7 +5990,7 @@ whether it is listed in PKG_OPTIONS:

    -14.3. Option Names

    +15.3. Option Names

    Options that enable similar features in different packages (like optional support for a library) should use a common name in all packages that support it (like the name of the library). If another @@ -5885,36 +6015,36 @@ support.” The file is sorted by option names.

    -Chapter 15. The build process

    +Chapter 16. The build process

    -15.1. Introduction

    +16.1. Introduction

    This chapter gives a detailed description on how a package is built. Building a package is separated into different phases (for example fetch, @@ -5934,7 +6064,7 @@ support.” The file is sorted by option names.

    -15.2. Program location

    +16.2. Program location

    Before outlining the process performed by the NetBSD package system in the next section, here's a brief discussion on where programs are installed, and which variables influence this.

    @@ -5945,7 +6075,7 @@ support.” The file is sorted by option names.

    for pkgs in the cross category. The value of PREFIX needs to be put into the various places in the program's source where paths to - these files are encoded. See Section 9.3, “patches/*” and Section 17.3.1, “Shared libraries - libtool” for more details.

    + these files are encoded. See Section 10.3, “patches/*” and Section 18.3.1, “Shared libraries - libtool” for more details.

    When choosing which of these variables to use, follow the following rules:

      @@ -6035,7 +6165,7 @@ support.” The file is sorted by option names.

    -15.3. Directories used during the build process

    +16.3. Directories used during the build process

    When building a package, a number of directories is used to store source files, temporary files, pkgsrc-internal files, and so on. These directories are explained here.

    @@ -6069,7 +6199,7 @@ support.” The file is sorted by option names.

    -15.4. Running a phase

    +16.4. Running a phase

    You can run a particular phase by typing make phase, where phase is the name of the phase. This will automatically run all phases that are required for this @@ -6079,14 +6209,14 @@ support.” The file is sorted by option names.

    -15.5. The fetch phase

    +16.5. The fetch phase

    The first step in building a package is to fetch the distribution files (distfiles) from the sites that are providing them. This is the task of the fetch phase.

    -15.5.1. What to fetch and where to get it from

    +16.5.1. What to fetch and where to get it from

    In simple cases, MASTER_SITES defines all URLs from where the distfile, whose name is derived from the DISTNAME variable, is @@ -6181,7 +6311,7 @@ support.” The file is sorted by option names.

    -15.5.2. How are the files fetched?

    +16.5.2. How are the files fetched?

    The fetch phase makes sure that all the distfiles exist in a local directory (DISTDIR), which can be set by the pkgsrc @@ -6204,7 +6334,7 @@ support.” The file is sorted by option names.

    -15.6. The checksum phase

    +16.6. The checksum phase

    After the distfile(s) are fetched, their checksum is generated and compared with the checksums stored in the distinfo file. If the checksums don't match, the build is @@ -6215,7 +6345,7 @@ support.” The file is sorted by option names.

    -15.7. The extract phase

    +16.7. The extract phase

    When the distfiles are present on the local system, they need to be extracted, as they usually come in the form of some compressed archive format.

    @@ -6254,7 +6384,7 @@ support.” The file is sorted by option names.

    -15.8. The patch phase

    +16.8. The patch phase

    After extraction, all the patches named by the PATCHFILES, those present in the patches subdirectory of the package as well as in @@ -6265,7 +6395,7 @@ support.” The file is sorted by option names.

    applied, files ending in .orig or .rej are ignored. Any special options to patch(1) can be handed in - PATCH_DIST_ARGS. See Section 9.3, “patches/*” for more details.

    + PATCH_DIST_ARGS. See Section 10.3, “patches/*” for more details.

    By default patch(1) is given special args to make it fail if the patches apply with some lines of fuzz. Please fix (regen) the patches so that they apply cleanly. The @@ -6275,13 +6405,13 @@ support.” The file is sorted by option names.

    -15.9. The tools phase

    -

    This is covered in Chapter 16, Tools needed for building or running. +16.9. The tools phase

    +

    This is covered in Chapter 17, Tools needed for building or running.

    -15.10. The wrapper phase

    +16.10. The wrapper phase

    This phase creates wrapper programs for the compilers and linkers. The following variables can be used to tweak the wrappers.

    @@ -6319,7 +6449,7 @@ support.” The file is sorted by option names.

    -15.11. The configure phase

    +16.11. The configure phase

    Most pieces of software need information on the header files, system calls, and library routines which are available on the platform they run on. The process of determining this @@ -6359,7 +6489,7 @@ support.” The file is sorted by option names.

    -15.12. The build phase

    +16.12. The build phase

    For building a package, a rough equivalent of the following code is executed.

    @@ -6389,12 +6519,12 @@ support.” The file is sorted by option names.

    -15.13. The test phase

    +16.13. The test phase

    [TODO]

    -15.14. The install phase

    +16.14. The install phase

    Once the build stage has completed, the final step is to install the software in public directories, so users can access the programs and files.

    @@ -6478,7 +6608,7 @@ support.” The file is sorted by option names.

    -15.15. The package phase

    +16.15. The package phase

    Once the install stage has completed, a binary package of the installed files can be built. These binary packages can be used for quick installation without previous compilation, e.g. by @@ -6493,7 +6623,7 @@ support.” The file is sorted by option names.

    -15.16. Cleaning up

    +16.16. Cleaning up

    Once you're finished with a package, you can clean the work directory by running make clean. If you want to clean the work directories of all dependencies too, use @@ -6501,7 +6631,7 @@ support.” The file is sorted by option names.

    -15.17. Other helpful targets

    +16.17. Other helpful targets
    pre/post-*

    For any of the main targets described in the @@ -6813,7 +6943,7 @@ support.” The file is sorted by option names.

    PLIST, as the “find -newer” command used by this target won't catch them!

    -

    See Section 11.3, “Tweaking output of make print-PLIST for more +

    See Section 12.3, “Tweaking output of make print-PLIST for more information on this target.

    bulk-package
    @@ -6854,13 +6984,13 @@ support.” The file is sorted by option names.

    -Chapter 16. Tools needed for building or running

    +Chapter 17. Tools needed for building or running

    The USE_TOOLS definition is used both internally @@ -6884,7 +7014,7 @@ yacc) or a better sed.

    make show-tools.

    -16.1. Tools for pkgsrc builds

    +17.1. Tools for pkgsrc builds

    The default set of tools used by pkgsrc is defined in bsd.pkg.mk. This includes standard Unix tools, such as: cat, awk, @@ -6897,7 +7027,7 @@ to define the tools needed.

    -16.2. Tools needed by packages

    +17.2. Tools needed by packages

    In the following examples, the :pkgsrc means to use the pkgsrc version and not the native version for a build dependency. And the :run means that it is used for a @@ -6920,7 +7050,7 @@ tool at run-time, then just use DEPENDS instead.

    -16.3. Tools provided by platforms

    +17.3. Tools provided by platforms

    When improving or porting pkgsrc to a new platform, have a look at (or create) the corresponding platform specific make file fragment under pkgsrc/mk/tools/tools.${OPSYS}.mk which defines @@ -6938,82 +7068,82 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -Chapter 17. Making your package work

    +Chapter 18. Making your package work

    Table of Contents

    -
    17.1. General operation
    -
    -
    17.1.1. Portability of packages
    -
    17.1.2. How to pull in user-settable variables from mk.conf
    -
    17.1.3. User interaction
    -
    17.1.4. Handling licenses
    -
    17.1.5. Restricted packages
    -
    17.1.6. Handling dependencies
    -
    17.1.7. Handling conflicts with other packages
    -
    17.1.8. Packages that cannot or should not be built
    -
    17.1.9. Packages which should not be deleted, once installed
    -
    17.1.10. Handling packages with security problems
    -
    17.1.11. How to handle incrementing versions when fixing an existing package
    -
    17.1.12. Substituting variable text in the package files (the SUBST framework)
    -
    -
    17.2. Fixing problems in the fetch phase
    -
    -
    17.2.1. Packages whose distfiles aren't available for plain downloading
    -
    17.2.2. How to handle modified distfiles with the 'old' name
    -
    -
    17.3. Fixing problems in the configure phase
    -
    -
    17.3.1. Shared libraries - libtool
    -
    17.3.2. Using libtool on GNU packages that already support libtool
    -
    17.3.3. GNU Autoconf/Automake
    -
    -
    17.4. Programming languages
    -
    -
    17.4.1. C, C++, and Fortran
    -
    17.4.2. Java
    -
    17.4.3. Packages containing perl scripts
    -
    17.4.4. Other programming languages
    -
    -
    17.5. Fixing problems in the build phase
    -
    -
    17.5.1. Compiling C and C++ code conditionally
    -
    17.5.2. How to handle compiler bugs
    -
    17.5.3. Undefined reference to “...
    -
    17.5.4. Running out of memory
    -
    -
    17.6. Fixing problems in the install phase
    -
    -
    17.6.1. Creating needed directories
    -
    17.6.2. Where to install documentation
    -
    17.6.3. Installing score files
    -
    17.6.4. Packages with hardcoded paths to other interpreters
    -
    17.6.5. Packages installing perl modules
    -
    17.6.6. Packages installing info files
    -
    17.6.7. Packages installing man pages
    -
    17.6.8. Packages installing GConf2 data files
    -
    17.6.9. Packages installing scrollkeeper data files
    -
    17.6.10. Packages installing X11 fonts
    -
    17.6.11. Packages installing GTK2 modules
    -
    17.6.12. Packages installing SGML or XML data
    -
    17.6.13. Packages installing extensions to the MIME database
    -
    17.6.14. Packages using intltool
    -
    17.6.15. Packages installing startup scripts
    -
    17.6.16. Packages installing TeX modules
    -
    17.6.17. Packages supporting running binaries in +
    18.1. General operation
    +
    +
    18.1.1. Portability of packages
    +
    18.1.2. How to pull in user-settable variables from mk.conf
    +
    18.1.3. User interaction
    +
    18.1.4. Handling licenses
    +
    18.1.5. Restricted packages
    +
    18.1.6. Handling dependencies
    +
    18.1.7. Handling conflicts with other packages
    +
    18.1.8. Packages that cannot or should not be built
    +
    18.1.9. Packages which should not be deleted, once installed
    +
    18.1.10. Handling packages with security problems
    +
    18.1.11. How to handle incrementing versions when fixing an existing package
    +
    18.1.12. Substituting variable text in the package files (the SUBST framework)
    +
    +
    18.2. Fixing problems in the fetch phase
    +
    +
    18.2.1. Packages whose distfiles aren't available for plain downloading
    +
    18.2.2. How to handle modified distfiles with the 'old' name
    +
    +
    18.3. Fixing problems in the configure phase
    +
    +
    18.3.1. Shared libraries - libtool
    +
    18.3.2. Using libtool on GNU packages that already support libtool
    +
    18.3.3. GNU Autoconf/Automake
    +
    +
    18.4. Programming languages
    +
    +
    18.4.1. C, C++, and Fortran
    +
    18.4.2. Java
    +
    18.4.3. Packages containing perl scripts
    +
    18.4.4. Other programming languages
    +
    +
    18.5. Fixing problems in the build phase
    +
    +
    18.5.1. Compiling C and C++ code conditionally
    +
    18.5.2. How to handle compiler bugs
    +
    18.5.3. Undefined reference to “...
    +
    18.5.4. Running out of memory
    +
    +
    18.6. Fixing problems in the install phase
    +
    +
    18.6.1. Creating needed directories
    +
    18.6.2. Where to install documentation
    +
    18.6.3. Installing score files
    +
    18.6.4. Packages with hardcoded paths to other interpreters
    +
    18.6.5. Packages installing perl modules
    +
    18.6.6. Packages installing info files
    +
    18.6.7. Packages installing man pages
    +
    18.6.8. Packages installing GConf2 data files
    +
    18.6.9. Packages installing scrollkeeper data files
    +
    18.6.10. Packages installing X11 fonts
    +
    18.6.11. Packages installing GTK2 modules
    +
    18.6.12. Packages installing SGML or XML data
    +
    18.6.13. Packages installing extensions to the MIME database
    +
    18.6.14. Packages using intltool
    +
    18.6.15. Packages installing startup scripts
    +
    18.6.16. Packages installing TeX modules
    +
    18.6.17. Packages supporting running binaries in emulation
    -
    17.6.18. Packages installing hicolor theme icons
    -
    17.6.19. Packages installing desktop files
    +
    18.6.18. Packages installing hicolor theme icons
    +
    18.6.19. Packages installing desktop files
    -
    17.7. Marking packages as having problems
    +
    18.7. Marking packages as having problems

    -17.1. General operation

    +18.1. General operation

    -17.1.1. Portability of packages

    +18.1.1. Portability of packages

    One appealing feature of pkgsrc is that it runs on many different platforms. As a result, it is important to ensure, where possible, that packages in pkgsrc are portable. This @@ -7022,7 +7152,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.1.2. How to pull in user-settable variables from mk.conf

    +18.1.2. How to pull in user-settable variables from mk.conf

    The pkgsrc user can configure pkgsrc by overriding several variables in the file pointed to by MAKECONF, which is /etc/mk.conf by default. When you @@ -7049,7 +7179,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.1.3. User interaction

    +18.1.3. User interaction

    Occasionally, packages require interaction from the user, and this can be in a number of ways:

      @@ -7078,7 +7208,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.1.4. Handling licenses

    +18.1.4. Handling licenses

    A package may be covered by a license which the user has or has not agreed to accept. For these cases, pkgsrc contains a mechanism to note that a package is covered by a particular @@ -7147,7 +7277,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.1.5. Restricted packages

    +18.1.5. Restricted packages

    Some licenses restrict how software may be re-distributed. In order to satisfy these restrictions, the package system defines five make variables that can be set to note these @@ -7196,7 +7326,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.1.6. Handling dependencies

    +18.1.6. Handling dependencies

    Your package may depend on some other package being present - and there are various ways of expressing this dependency. pkgsrc supports the BUILD_DEPENDS and @@ -7204,7 +7334,7 @@ TOOLS_PLATFORM.true?= true # shell builtin USE_TOOLS definition, as well as dependencies via buildlink3.mk, which is the preferred way to handle dependencies, and which uses the variables named above. - See Chapter 12, Buildlink methodology for more information.

    + See Chapter 13, Buildlink methodology for more information.

    The basic difference between the two variables is as follows: The DEPENDS definition registers that pre-requisite in the binary package so it will be pulled in @@ -7301,7 +7431,7 @@ TOOLS_PLATFORM.true?= true # shell builtin should not be used across different systems that may have different versions of binary packages installed.

    For security fixes, please update the package - vulnerabilities file. See Section 17.1.10, “Handling packages with security problems” for more + vulnerabilities file. See Section 18.1.10, “Handling packages with security problems” for more information.

  • @@ -7333,7 +7463,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.1.7. Handling conflicts with other packages

    +18.1.7. Handling conflicts with other packages

    Your package may conflict with other packages a user might already have installed on his system, e.g. if your package installs the same set of files as another package in the pkgsrc @@ -7359,7 +7489,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.1.8. Packages that cannot or should not be built

    +18.1.8. Packages that cannot or should not be built

    There are several reasons why a package might be instructed to not build under certain circumstances. If the package builds and runs on most platforms, the exceptions @@ -7387,7 +7517,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.1.9. Packages which should not be deleted, once installed

    +18.1.9. Packages which should not be deleted, once installed

    To ensure that a package may not be deleted, once it has been installed, the PKG_PRESERVE definition should be set in the package Makefile. This will be carried into any @@ -7398,7 +7528,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.1.10. Handling packages with security problems

    +18.1.10. Handling packages with security problems

    When a vulnerability is found, this should be noted in localsrc/security/advisories/pkg-vulnerabilities, and after committing that file, use make upload @@ -7414,7 +7544,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.1.11. How to handle incrementing versions when fixing an existing package

    +18.1.11. How to handle incrementing versions when fixing an existing package

    When making fixes to an existing package it can be useful to change the version number in PKGNAME. To avoid conflicting with future versions by the original author, a @@ -7467,7 +7597,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.1.12. Substituting variable text in the package files (the SUBST framework)

    +18.1.12. Substituting variable text in the package files (the SUBST framework)

    When you want to replace the same text in multiple files or when the replacement text varies, patches alone cannot help. This is where the SUBST framework comes in. It provides an @@ -7527,10 +7657,10 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.2. Fixing problems in the fetch phase

    +18.2. Fixing problems in the fetch phase

    -17.2.1. Packages whose distfiles aren't available for plain downloading

    +18.2.1. Packages whose distfiles aren't available for plain downloading

    If you need to download from a dynamic URL you can set DYNAMIC_MASTER_SITES and a make fetch will call files/getsite.sh @@ -7551,7 +7681,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.2.2. How to handle modified distfiles with the 'old' name

    +18.2.2. How to handle modified distfiles with the 'old' name

    Sometimes authors of a software package make some modifications after the software was released, and they put up a new distfile without changing the package's version number. If a @@ -7579,10 +7709,10 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.3. Fixing problems in the configure phase

    +18.3. Fixing problems in the configure phase

    -17.3.1. Shared libraries - libtool

    +18.3.1. Shared libraries - libtool

    pkgsrc supports many different machines, with different object formats like a.out and ELF, and varying abilities to do shared library and dynamic loading at all. To accompany this, @@ -7704,7 +7834,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.3.2. Using libtool on GNU packages that already support libtool

    +18.3.2. Using libtool on GNU packages that already support libtool

    Add USE_LIBTOOL=yes to the package Makefile. This will override the package's own libtool in most cases. For older libtool using packages, libtool is @@ -7745,7 +7875,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.3.3. GNU Autoconf/Automake

    +18.3.3. GNU Autoconf/Automake

    If a package needs GNU autoconf or automake to be executed to regenerate the configure script and Makefile.in makefile templates, then they should be executed in a pre-configure @@ -7787,14 +7917,14 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.4. Programming languages

    +18.4. Programming languages

    -17.4.1. C, C++, and Fortran

    +18.4.1. C, C++, and Fortran

    Compilers for the C, C++, and Fortran languages comes with the NetBSD base system. By default, pkgsrc assumes that a package is written in C and will hide all other compilers (via the wrapper - framework, see Chapter 12, Buildlink methodology).

    + framework, see Chapter 13, Buildlink methodology).

    To declare which language's compiler a package needs, set the USE_LANGUAGES variable. Allowed values currently are “c”, “c++”, and @@ -7805,7 +7935,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.4.2. Java

    +18.4.2. Java

    If a program is written in Java, use the Java framework in pkgsrc. The package must include ../../mk/java-vm.mk. This Makefile fragment @@ -7828,7 +7958,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.4.3. Packages containing perl scripts

    +18.4.3. Packages containing perl scripts

    If your package contains interpreted perl scripts, add “perl” to the USE_TOOLS variable and set REPLACE_PERL to ensure that the proper @@ -7840,12 +7970,12 @@ TOOLS_PLATFORM.true?= true # shell builtin

    If a particular version of perl is needed, set the PERL5_REQD variable to the version number. The default is “5.0”.

    -

    See Section 17.6.5, “Packages installing perl modules” for information +

    See Section 18.6.5, “Packages installing perl modules” for information about handling perl modules.

    -17.4.4. Other programming languages

    +18.4.4. Other programming languages

    Currently, there is no special handling for other languages in pkgsrc. If a compiler package provides a buildlink3.mk file, include that, otherwise @@ -7855,7 +7985,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.5. Fixing problems in the build phase

    +18.5. Fixing problems in the build phase

    The most common failures when building a package are that some platforms do not provide certain header files, functions or libraries, or they provide the functions in a library that the @@ -7864,7 +7994,7 @@ TOOLS_PLATFORM.true?= true # shell builtin use the missing functions or provides a replacement function.

    -17.5.1. Compiling C and C++ code conditionally

    +18.5.1. Compiling C and C++ code conditionally

    If a package already comes with a GNU configure script, the preferred way to fix the build failure is to change the configure script, not the code. In the other cases, you can @@ -7884,7 +8014,7 @@ TOOLS_PLATFORM.true?= true # shell builtin does not define it. Use __sun instead.

    -17.5.1.1. C preprocessor macros to identify the operating system

    +18.5.1.1. C preprocessor macros to identify the operating system

    To distinguish between 4.4 BSD-derived systems and the rest of the world, you should use the following code.

    @@ -7909,7 +8039,7 @@ TOOLS_PLATFORM.true?=           true                    # shell builtin
     
     

    -17.5.1.2. C preprocessor macros to identify the hardware architecture

    +18.5.1.2. C preprocessor macros to identify the hardware architecture
         i386        i386, __i386, __i386__
         MIPS        __mips
    @@ -7918,7 +8048,7 @@ TOOLS_PLATFORM.true?=           true                    # shell builtin
     
     

    -17.5.1.3. C preprocessor macros to identify the compiler

    +18.5.1.3. C preprocessor macros to identify the compiler
         GCC         __GNUC__ (major version), __GNUC_MINOR__
         SunPro      __SUNPRO_C (0x570 for version 5.7)
    @@ -7928,7 +8058,7 @@ TOOLS_PLATFORM.true?=           true                    # shell builtin
     
     

    -17.5.2. How to handle compiler bugs

    +18.5.2. How to handle compiler bugs

    Some source files trigger bugs in the compiler, based on combinations of compiler version and architecture and almost always relation to optimisation being enabled. Common symptoms @@ -7943,7 +8073,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.5.3. Undefined reference to “...

    +18.5.3. Undefined reference to “...

    This compiler error often means that a package did not link to a shared library it needs. The following functions are known to cause this error message over and over.

    @@ -8006,7 +8136,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.5.4. Running out of memory

    +18.5.4. Running out of memory

    Sometimes packages fail to build because the compiler runs into an operating system specific soft limit. With the UNLIMIT_RESOURCES variable pkgsrc can be told @@ -8020,10 +8150,10 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6. Fixing problems in the install phase

    +18.6. Fixing problems in the install phase

    -17.6.1. Creating needed directories

    +18.6.1. Creating needed directories

    The BSD-compatible install supplied with some operating systems cannot create more than one directory at a time. As such, you should call @@ -8039,7 +8169,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.2. Where to install documentation

    +18.6.2. Where to install documentation

    In general, documentation should be installed into ${PREFIX}/share/doc/${PKGBASE} or ${PREFIX}/share/doc/${PKGNAME} (the latter @@ -8068,7 +8198,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.3. Installing score files

    +18.6.3. Installing score files

    Certain packages, most of them in the games category, install a score file that allows all users on the system to record their highscores. In order for this to work, the binaries need to be @@ -8089,7 +8219,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.4. Packages with hardcoded paths to other interpreters

    +18.6.4. Packages with hardcoded paths to other interpreters

    Your package may also contain scripts with hardcoded paths to other interpreters besides (or as well as) perl. To correct the full pathname to the script interpreter, you need to set the @@ -8111,7 +8241,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.5. Packages installing perl modules

    +18.6.5. Packages installing perl modules

    Makefiles of packages providing perl5 modules should include the Makefile fragment ../../lang/perl5/module.mk. It provides a @@ -8140,7 +8270,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.6. Packages installing info files

    +18.6.6. Packages installing info files

    Some packages install info files or use the “makeinfo” or “install-info” commands. INFO_FILES should be defined in @@ -8187,7 +8317,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.7. Packages installing man pages

    +18.6.7. Packages installing man pages

    All packages that install manual pages should install them into the same directory, so that there is one common place to look for them. In pkgsrc, this place is @@ -8219,12 +8349,12 @@ TOOLS_PLATFORM.true?= true # shell builtin Or if the ./configure script uses a non-standard use of --mandir, you can set GNU_CONFIGURE_MANDIR as needed.

    -

    See Section 11.5, “Man page compression” for +

    See Section 12.5, “Man page compression” for information on installation of compressed manual pages.

    -17.6.8. Packages installing GConf2 data files

    +18.6.8. Packages installing GConf2 data files

    If a package installs .schemas or .entries files, used by GConf2, you need to take some extra steps to make sure they get registered @@ -8244,7 +8374,7 @@ TOOLS_PLATFORM.true?= true # shell builtin need to manually patch the package.

  • Check the PLIST and remove any entries under the etc/gconf directory, as they will be handled automatically. See - Section 7.14, “How do I change the location of configuration files?” for more information.

  • + Section 8.14, “How do I change the location of configuration files?” for more information.

  • Define the GCONF2_SCHEMAS variable in your Makefile with a list of all .schemas files installed by the package, if @@ -8258,7 +8388,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.9. Packages installing scrollkeeper data files

    +18.6.9. Packages installing scrollkeeper data files

    If a package installs .omf files, used by scrollkeeper, you need to take some extra steps to make sure they get registered in the database:

    @@ -8278,7 +8408,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.10. Packages installing X11 fonts

    +18.6.10. Packages installing X11 fonts

    If a package installs font files, you will need to rebuild the fonts database in the directory where they get installed at installation and deinstallation time. This can be automatically @@ -8295,7 +8425,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.11. Packages installing GTK2 modules

    +18.6.11. Packages installing GTK2 modules

    If a package installs GTK2 immodules or loaders, you need to take some extra steps to get them registered in the GTK2 database properly:

    @@ -8323,7 +8453,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.12. Packages installing SGML or XML data

    +18.6.12. Packages installing SGML or XML data

    If a package installs SGML or XML data files that need to be registered in system-wide catalogs (like DTDs, sub-catalogs, etc.), you need to take some extra steps:

    @@ -8351,7 +8481,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.13. Packages installing extensions to the MIME database

    +18.6.13. Packages installing extensions to the MIME database

    If a package provides extensions to the MIME database by installing .xml files inside ${PREFIX}/share/mime/packages, you @@ -8381,7 +8511,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.14. Packages using intltool

    +18.6.14. Packages using intltool

    If a package uses intltool during its build, include the ../../textproc/intltool/buildlink3.mk file, which forces it to use the intltool package provided by pkgsrc, @@ -8392,7 +8522,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.15. Packages installing startup scripts

    +18.6.15. Packages installing startup scripts

    If a package contains a rc.d script, it won't be copied into the startup directory by default, but you can enable it, by adding the option PKG_RCD_SCRIPTS=YES in @@ -8403,7 +8533,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.16. Packages installing TeX modules

    +18.6.16. Packages installing TeX modules

    If a package installs TeX packages into the texmf tree, the ls-R database of the tree needs to be updated.

    @@ -8441,7 +8571,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.17. Packages supporting running binaries in +18.6.17. Packages supporting running binaries in emulation

    There are some packages that provide libraries and executables for running binaries from a one operating system @@ -8458,7 +8588,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.18. Packages installing hicolor theme icons

    +18.6.18. Packages installing hicolor theme icons

    If a package installs images under the share/icons/hicolor and/or updates the share/icons/hicolor/icon-theme.cache @@ -8480,7 +8610,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.6.19. Packages installing desktop files

    +18.6.19. Packages installing desktop files

    If a package installs .desktop files under share/applications and these include MIME information, you need to take extra steps to ensure that they @@ -8499,7 +8629,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -17.7. Marking packages as having problems

    +18.7. Marking packages as having problems

    In some cases one does not have the time to solve a problem immediately. There are currently two ways to declare that one knows that a package has problems.

    @@ -8526,7 +8656,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -Chapter 18. Debugging

    +Chapter 19. Debugging

    To check out all the gotchas when building a package, here are the steps that I do in order to get a package working. Please note this is basically the same as what was explained in the previous @@ -8565,7 +8695,7 @@ TOOLS_PLATFORM.true?= true # shell builtin package.

  • Look at the Makefile, fix if - necessary; see Section 9.1, “Makefile.

  • + necessary; see Section 10.1, “Makefile.

  • Generate a PLIST:

    # make install
    @@ -8604,26 +8734,26 @@ TOOLS_PLATFORM.true?=           true                    # shell builtin
           reports:

    # pkglint
  • -
  • Submit (or commit, if you have cvs access); see Chapter 19, Submitting and Committing.

  • +
  • Submit (or commit, if you have cvs access); see Chapter 20, Submitting and Committing.

  • -Chapter 19. Submitting and Committing

    +Chapter 20. Submitting and Committing

    -19.1. Submitting binary packages

    +20.1. Submitting binary packages

    Our policy is that we accept binaries only from pkgsrc developers to guarantee that the packages don't contain any trojan horses etc. This is not to annoy anyone but rather to @@ -8634,9 +8764,9 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -19.2. Submitting source packages (for non-NetBSD-developers)

    +20.2. Submitting source packages (for non-NetBSD-developers)

    First, check that your package is complete, compiles and - runs well; see Chapter 18, Debugging and the rest of this + runs well; see Chapter 19, Debugging and the rest of this document. Next, generate an uuencoded gzipped tar(1) archive that contains all files that make up the package. Finally, send this package to the pkgsrc bug tracking system, @@ -8661,7 +8791,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -19.3. General notes when adding, updating, or removing packages

    +20.3. General notes when adding, updating, or removing packages

    Please note all package additions, updates, moves, and removals in pkgsrc/doc/CHANGES. It's very important to keep this file up to date and conforming to the @@ -8694,7 +8824,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -19.4. Committing: Importing a package into CVS

    +20.4. Committing: Importing a package into CVS

    This section is only of interest for pkgsrc developers with write access to the pkgsrc repository. Please remember that cvs imports files relative to the current working directory, and that @@ -8720,7 +8850,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -19.5. Updating a package to a newer version

    +20.5. Updating a package to a newer version

    Please always put a concise, appropriate and relevant summary of the changes between old and new versions into the commit log when updating a package. There are various reasons for this:

    @@ -8744,7 +8874,7 @@ TOOLS_PLATFORM.true?= true # shell builtin

    -19.6. Moving a package in pkgsrc

    +20.6. Moving a package in pkgsrc
    1. Make a copy of the directory somewhere else.

    2. @@ -8778,7 +8908,7 @@ place.

    -Chapter 20. Frequently Asked Questions

    +Chapter 21. Frequently Asked Questions

    This section contains the answers to questions that may arise when you are writing a package. If you don't find your question answered here, first have a look in the other chapters, @@ -8786,36 +8916,36 @@ place.

    pkgsrc-users mailing list.

    @@ -8954,7 +9084,7 @@ place.

    @@ -9004,14 +9134,14 @@ place.

    -Chapter 21. GNOME packaging and porting

    +Chapter 22. GNOME packaging and porting

    Quoting GNOME's web @@ -9048,7 +9178,7 @@ important information regarding their internals.

    -21.1. Meta packages

    +22.1. Meta packages

    pkgsrc includes three GNOME-related meta packages:

    -21.2. Packaging a GNOME application

    +22.2. Packaging a GNOME application

    Almost all GNOME applications are written in C and use a common set of tools as their build system. Things get different with the new bindings to other languages (such as Python), but the following will @@ -9140,7 +9270,7 @@ solution is given. After applying the solution be sure to regenerate the package's file list with make print-PLIST and ensure it is correct.

    -

    Table 21.1. PLIST handling for GNOME packages

    +

    Table 22.1. PLIST handling for GNOME packages

    -20.1. +21.1.

    What is the difference between MAKEFLAGS, .MAKEFLAGS and @@ -8840,7 +8970,7 @@ place.

    -20.2. +21.2.

    What is the difference between MAKE, GMAKE and @@ -8858,7 +8988,7 @@ place.

    -20.3. +21.3.

    What is the difference between CC, PKG_CC and @@ -8876,7 +9006,7 @@ place.

    -20.4. +21.4.

    What is the difference between BUILDLINK_LDFLAGS, @@ -8889,7 +9019,7 @@ place.

    -20.5. +21.5.

    Why does make show-var VARNAME=BUILDLINK_PREFIX.foo @@ -8905,7 +9035,7 @@ place.

    -20.6. +21.6.

    What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I @@ -8929,7 +9059,7 @@ place.

    -20.7. +21.7.

    Which mailing lists are there for package developers?

    -20.8. +21.8.

    Where is the pkgsrc documentation?

    @@ -9153,24 +9283,24 @@ solution is given. After applying the solution be sure to - + - + - + - +
    Installs OMF files under share/omf.See Section 17.6.9, “Packages installing scrollkeeper data files”.See Section 18.6.9, “Packages installing scrollkeeper data files”.
    Installs icons under the share/icons/hicolor hierarchy or updates share/icons/hicolor/icon-theme.cache.See Section 17.6.18, “Packages installing hicolor theme icons”.See Section 18.6.18, “Packages installing hicolor theme icons”.
    Installs files under share/mime/packages.See Section 17.6.13, “Packages installing extensions to the MIME database”.See Section 18.6.13, “Packages installing extensions to the MIME database”.
    Installs .desktop files under share/applications and these include MIME information.See Section 17.6.19, “Packages installing desktop files”.See Section 18.6.19, “Packages installing desktop files”.
    @@ -9178,7 +9308,7 @@ solution is given. After applying the solution be sure to

    -21.3. Updating GNOME to a newer version

    +22.3. Updating GNOME to a newer version

    When seeing GNOME as a whole, there are two kinds of updates:

    @@ -9267,11 +9397,11 @@ followed:

    -21.4. Patching guidelines

    +22.4. Patching guidelines

    GNOME is a very big component in pkgsrc which approaches 100 packages. Please, it is very important that you always, always, always feed back any portability -fixes you do to a GNOME package to the mainstream developers (see Section 9.3.2, “Feedback to the author”). This is the only way to get +fixes you do to a GNOME package to the mainstream developers (see Section 10.3.2, “Feedback to the author”). This is the only way to get their attention on portability issues and to ensure that future versions can be built out-of-the box on NetBSD. The less custom patches in pkgsrc, the easier further updates are. Those developers in charge of @@ -9288,7 +9418,7 @@ issues. While the FreeBSD GNOME people are doing a great job in porting GNOME to their operating system, the official GNOME sources are now plagued by conditionals that check for __FreeBSD__ and similar macros. This hurts portability. Please see our patching -guidelines (Section 9.3.1, “Patching guidelines”) for more +guidelines (Section 10.3.1, “Patching guidelines”) for more details.

    @@ -9305,68 +9435,68 @@ details.

    Table of Contents

    -
    22. Design of the pkgsrc infrastructure
    +
    23. Design of the pkgsrc infrastructure
    -
    22.1. The meaning of variable definitions
    -
    22.2. Avoiding problems before they arise
    -
    22.3. Variable evaluation
    +
    23.1. The meaning of variable definitions
    +
    23.2. Avoiding problems before they arise
    +
    23.3. Variable evaluation
    -
    22.3.1. At load time
    -
    22.3.2. At runtime
    +
    23.3.1. At load time
    +
    23.3.2. At runtime
    -
    22.4. How can variables be specified?
    -
    22.5. Designing interfaces for Makefile fragments
    +
    23.4. How can variables be specified?
    +
    23.5. Designing interfaces for Makefile fragments
    -
    22.5.1. Procedures with parameters
    -
    22.5.2. Actions taken on behalf of parameters
    +
    23.5.1. Procedures with parameters
    +
    23.5.2. Actions taken on behalf of parameters
    -
    22.6. The order in which files are loaded
    +
    23.6. The order in which files are loaded
    -
    22.6.1. The order in bsd.prefs.mk
    -
    22.6.2. The order in bsd.pkg.mk
    +
    23.6.1. The order in bsd.prefs.mk
    +
    23.6.2. The order in bsd.pkg.mk
    -
    23. Regression tests
    +
    24. Regression tests
    -
    23.1. The regression tests framework
    -
    23.2. Running the regression tests
    -
    23.3. Adding a new regression test
    +
    24.1. The regression tests framework
    +
    24.2. Running the regression tests
    +
    24.3. Adding a new regression test
    -
    23.3.1. Overridable functions
    -
    23.3.2. Helper functions
    +
    24.3.1. Overridable functions
    +
    24.3.2. Helper functions
    -
    24. Porting pkgsrc
    +
    25. Porting pkgsrc
    -
    24.1. Porting pkgsrc to a new operating system
    -
    24.2. Adding support for a new compiler
    +
    25.1. Porting pkgsrc to a new operating system
    +
    25.2. Adding support for a new compiler

    -Chapter 22. Design of the pkgsrc infrastructure

    +Chapter 23. Design of the pkgsrc infrastructure
    @@ -9376,7 +9506,7 @@ details.

    like.

    -22.1. The meaning of variable definitions

    +23.1. The meaning of variable definitions

    Whenever a variable is defined in the pkgsrc infrastructure, the location and the way of definition provide much information about the intended use of that variable. @@ -9407,7 +9537,7 @@ details.

    -22.2. Avoiding problems before they arise

    +23.2. Avoiding problems before they arise

    All variables that contain lists of things should default to being empty. Two examples that do not follow this rule are USE_LANGUAGES and @@ -9431,10 +9561,10 @@ details.

    -22.3. Variable evaluation

    +23.3. Variable evaluation

    -22.3.1. At load time

    +23.3.1. At load time

    Variable evaluation takes place either at load time or at runtime, depending on the context in which they occur. The contexts where variables are evaluated at load time are:

    @@ -9476,7 +9606,7 @@ details.

    -22.3.2. At runtime

    +23.3.2. At runtime

    After all the files have been loaded, the values of the variables cannot be changed anymore. Variables that are used in the shell commands are expanded at this point.

    @@ -9484,7 +9614,7 @@ details.

    -22.4. How can variables be specified?

    +23.4. How can variables be specified?

    There are many ways in which the definition and use of a variable can be restricted in order to detect bugs and violations of the (mostly unwritten) policies. See the @@ -9493,14 +9623,14 @@ details.

    -22.5. Designing interfaces for Makefile fragments

    +23.5. Designing interfaces for Makefile fragments

    Most of the .mk files fall into one of the following classes. Cases where a file falls into more than one class should be avoided as it often leads to subtle bugs.

    -22.5.1. Procedures with parameters

    +23.5.1. Procedures with parameters

    In a traditional imperative programming language some of the .mk files could be described as procedures. They take some input parameters and—after @@ -9534,7 +9664,7 @@ details.

    -22.5.2. Actions taken on behalf of parameters

    +23.5.2. Actions taken on behalf of parameters

    Action files take some input parameters and may define runtime variables. They shall not define loadtime variables. There are action files that are included implicitly by the @@ -9546,7 +9676,7 @@ details.

    -22.6. The order in which files are loaded

    +23.6. The order in which files are loaded

    Package Makefiles usually consist of a set of variable definitions, and include the file ../../mk/bsd.pkg.mk in the very last line. @@ -9561,7 +9691,7 @@ details.

    are loaded and gives reasons for that order.

    -22.6.1. The order in bsd.prefs.mk

    +23.6.1. The order in bsd.prefs.mk

    The very first action in bsd.pkg.mk is to define some essential variables like OPSYS, OS_VERSION and @@ -9588,7 +9718,7 @@ details.

    -22.6.2. The order in bsd.pkg.mk

    +23.6.2. The order in bsd.pkg.mk

    First, bsd.prefs.mk is loaded.

    Then, the various *-vars.mk files are loaded, which fill default values for those variables that have @@ -9620,16 +9750,16 @@ details.

    -Chapter 23. Regression tests

    +Chapter 24. Regression tests
    @@ -9643,12 +9773,12 @@ details.

    how you can add new tests.

    -23.1. The regression tests framework

    +24.1. The regression tests framework

    -23.2. Running the regression tests

    +24.2. Running the regression tests

    You first need to install the pkgtools/pkg_regress package, which provides the pkg_regress command. Then you can simply run that command, which will run all tests in the @@ -9656,7 +9786,7 @@ details.

    -23.3. Adding a new regression test

    +24.3. Adding a new regression test

    Every directory in the regress category that contains a file called spec is considered a regression test. This file is a shell program @@ -9665,7 +9795,7 @@ details.

    needs.

    -23.3.1. Overridable functions

    +24.3.1. Overridable functions

    These functions do not take any parameters. They are all called in “set -e” mode, so you should be careful to check the exitcodes of any commands you run in the @@ -9692,7 +9822,7 @@ details.

    -23.3.2. Helper functions

    +24.3.2. Helper functions
    exit_status(expected)

    This function compares the exitcode of the @@ -9715,12 +9845,12 @@ details.

    -Chapter 24. Porting pkgsrc

    +Chapter 25. Porting pkgsrc

    The pkgsrc system has already been ported to many @@ -9729,7 +9859,7 @@ details.

    portable.

    -24.1. Porting pkgsrc to a new operating system

    +25.1. Porting pkgsrc to a new operating system

    To port pkgsrc to a new operating system (called MyOS in this example), you need to touch the following files:

    @@ -9780,7 +9910,7 @@ details.

    -24.2. Adding support for a new compiler

    +25.2. Adding support for a new compiler

    TODO

    @@ -9876,7 +10006,7 @@ looks fine. # cd bison # mkdir patches

    Create Makefile, DESCR and - PLIST (see Chapter 9, Package components - files, directories and contents) + PLIST (see Chapter 10, Package components - files, directories and contents) then continue with fetching the distfile:

    # make fetch
     >> bison-1.25.tar.gz doesn't seem to exist on this system.
    -- 
    cgit v1.2.3