From 84e5f34968bc484bebbe02300283685e801383da Mon Sep 17 00:00:00 2001 From: rillig Date: Sun, 10 Jul 2016 08:21:50 +0000 Subject: regen --- doc/pkgsrc.html | 99 +++++++++++++++++++++++++++------------------------------ doc/pkgsrc.txt | 44 +++++++++++-------------- 2 files changed, 66 insertions(+), 77 deletions(-) diff --git a/doc/pkgsrc.html b/doc/pkgsrc.html index 3e66943fcac..56e449e4199 100644 --- a/doc/pkgsrc.html +++ b/doc/pkgsrc.html @@ -1595,20 +1595,15 @@ that file depends on the installation. On NetBSD, when you use /etc/. In all other cases the default location is ${PREFIX}/etc/, depending on where you told the bootstrap program to install the binary packages.

-

During the bootstrap, an example configuration file is created. To -use that, you have to create the directory -${PREFIX}/etc and copy the example file -there.

The format of the configuration file is that of the usual BSD-style Makefiles. The whole pkgsrc configuration is done by setting variables in this file. Note that you can define all kinds of variables, and no special error checking (for example for -spelling mistakes) takes place, so you have to try it out to see if it -works.

+spelling mistakes) takes place.

5.1. General configuration

-

In this section, you can find some variables that apply to all +

The following variables apply to all pkgsrc packages. A complete list of the variables that can be configured by the user is available in mk/defaults/mk.conf, together with some @@ -1882,8 +1877,8 @@ LDFLAGS+= -your -linkerflags (normal, default, quiet operation); the value 1 will display all shell commands before their invocation, and the value 2 will display both the shell commands before their invocation, - and their actual execution progress with set - -x will be displayed.

+ as well as their actual execution progress with set + -x.

@@ -1982,9 +1977,9 @@ PKG_OPTIONS.apache= suexec directory in pkgsrc, and run make package:

-# cd misc/figlet
-# make package
-
+$ cd misc/figlet +$ make package +

This will build and install your package (if not already done), and then build a binary package from what was installed. You can then use the pkg_* tools to manipulate @@ -2023,9 +2018,8 @@ it is wasted time if they all build their packages themselves from source. Or you may want to build a list of packages you want and check them before deploying onto production system. There is a way of getting a set of binary packages: -The bulk build system, or pbulk ("p" stands for "parallel). -This chapter describes how to set it up so that the packages -are most likely to be usable later.

+The bulk build system, or pbulk ("p" stands for "parallel"). +This chapter describes how to set it up.

7.1. Preparations

@@ -2036,12 +2030,12 @@ There exists a number of particularly heavy packages that are not actually interesting to a wide audience. For a limited bulk builds you need to make a list of packages you want to build. -Note, that all their dependencies will be built, so you don't need to track them manually. +Note that all their dependencies will be built, so you don't need to track them manually.

During bulk builds various packages are installed and deinstalled in /usr/pkg (or whatever LOCALBASE is), so make sure that you don't need any package during the builds. -Essentially, you should provide fresh system, either a chroot environment +Essentially, you should provide a fresh system, either a chroot environment or something even more restrictive, depending on what the operating system provides, or dedicate the whole physical machine. As a useful side effect this makes sure that bulk builds cannot @@ -2062,10 +2056,10 @@ certain packages tried to install files outside the

7.2.1. Configuration

-

To simplify configuration we provide helper script mk/pbulk/pbulk.sh.

+

To simplify configuration, we provide the helper script mk/pbulk/pbulk.sh.

In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine). Configure network access to fetch distribution files. -Create user with name "pbulk".

+Create a user with name "pbulk".

Fetch and extract pkgsrc. Use a command like one of these:

 # (cd /usr && ftp -o - http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
@@ -2085,13 +2079,14 @@ Create user with name "pbulk".

 mk.conf that contains settings you want to
 apply to packages you build. For instance,

 
-PKG_DEVELOPER=		yes		# perform more checks
-X11_TYPE=		modular		# use pkgsrc X11
-SKIP_LICENSE_CHECK=	yes		# accept all licences (useful when building all packages)
+PKG_DEVELOPER=          yes     # perform more checks
+X11_TYPE=               modular # use pkgsrc X11
+SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
+                                # when building all packages)

If configured for limited list, replace the list in /usr/pbulk/etc/pbulk.list -with your list of packages one per line without empty lines or comments. E.g.:

+with your list of packages, one per line without empty lines or comments. E.g.:

 www/firefox
 mail/thunderbird
@@ -2491,7 +2486,7 @@ provide FETCH_CMD, FETCH_BEFO
 wget to download, you'll have to use something
 like:

 
-FETCH_USING=	wget
+FETCH_USING=    wget
@@ -3782,7 +3777,7 @@ monitor_file(...) int fd = kqueue(); ... #else - ... + ... #endif } @@ -4362,9 +4357,9 @@ PLIST_SUBST+= SOMEVAR="somevalue" “"@comment "”. For example, in Makefile:

-PLIST_VARS+=	foo
+PLIST_VARS+=    foo
 .if condition
-PLIST.foo=	yes
+PLIST.foo=      yes
 .else

And then in PLIST:

@@ -4622,20 +4617,20 @@ BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0 
 # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
 
-BUILDLINK_TREE+=	tiff
+BUILDLINK_TREE+=        tiff
 
 .if !defined(TIFF_BUILDLINK3_MK)
 TIFF_BUILDLINK3_MK:=
 
-BUILDLINK_API_DEPENDS.tiff+=	tiff>=3.6.1
-BUILDLINK_ABI_DEPENDS.tiff+=	tiff>=3.7.2nb1
-BUILDLINK_PKGSRCDIR.tiff?=	../../graphics/tiff
+BUILDLINK_API_DEPENDS.tiff+=    tiff>=3.6.1
+BUILDLINK_ABI_DEPENDS.tiff+=    tiff>=3.7.2nb1
+BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
 
 .include "../../devel/zlib/buildlink3.mk"
 .include "../../graphics/jpeg/buildlink3.mk"
 .endif # TIFF_BUILDLINK3_MK
 
-BUILDLINK_TREE+=	-tiff
+BUILDLINK_TREE+=        -tiff

The header and footer manipulate BUILDLINK_TREE, which is common across all @@ -8020,13 +8015,13 @@ ${INSTALL_DATA_DIR} ${PREFIX}/dir2 and SPECIAL_PERMS is used to install setgid the game binary:

-USE_GAMESGROUP=		yes
+USE_GAMESGROUP=         yes
 
-BUILD_DEFS+=		VARBASE
+BUILD_DEFS+=            VARBASE
 
-OWN_DIRS_PERMS+=	${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
-REQD_FILES_PERMS+=	/dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
-SPECIAL_PERMS+=		${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
+OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
+REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
+SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}

Various INSTALL_* variables are also available: INSTALL_GAME to install setgid game binaries, @@ -8814,7 +8809,7 @@ place.

and if you still don't have the answer, ask on the pkgsrc-users mailing list.

-
+
22.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS? @@ -8859,7 +8854,7 @@ do? -

22.1.

+

22.1.

What is the difference between MAKEFLAGS, .MAKEFLAGS and @@ -8875,7 +8870,7 @@ do? -

22.2.

+

22.2.

What is the difference between MAKE, GMAKE and @@ -8893,7 +8888,7 @@ do? -

22.3.

+

22.3.

What is the difference between CC, PKG_CC and @@ -8911,7 +8906,7 @@ do? -

22.4.

+

22.4.

What is the difference between BUILDLINK_LDFLAGS, @@ -8924,7 +8919,7 @@ do? -

22.5.

+

22.5.

Why does make show-var VARNAME=BUILDLINK_PREFIX.foo @@ -8940,7 +8935,7 @@ do? -

22.6.

+

22.6.

What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I @@ -8964,7 +8959,7 @@ do? -

22.7.

+

22.7.

Which mailing lists are there for package developers?

@@ -8989,7 +8984,7 @@ do? -

22.8.

+

22.8.

Where is the pkgsrc documentation?

@@ -9037,7 +9032,7 @@ do? -

22.9.

+

22.9.

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

@@ -9749,7 +9744,7 @@ CFLAGS+= -Wall Example:

 do_test() {
-	echo "Example output"
+        echo "Example output"
 } 1>$TEST_OUTFILE 2>&1
@@ -9761,10 +9756,10 @@ do_test() { the next section. Example:

 check_result() {
-	exit_status 0
-	output_require "Example"
-	output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
-	output_prohibit "no such file or directory"
+        exit_status 0
+        output_require "Example"
+        output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
+        output_prohibit "no such file or directory"
 }
diff --git a/doc/pkgsrc.txt b/doc/pkgsrc.txt index 4e8d3b76fa2..29240068d9f 100644 --- a/doc/pkgsrc.txt +++ b/doc/pkgsrc.txt @@ -1364,21 +1364,16 @@ NetBSD, when you use make(1) from the base system, it is in the directory /etc /. In all other cases the default location is ${PREFIX}/etc/, depending on where you told the bootstrap program to install the binary packages. -During the bootstrap, an example configuration file is created. To use that, -you have to create the directory ${PREFIX}/etc and copy the example file there. - The format of the configuration file is that of the usual BSD-style Makefiles. The whole pkgsrc configuration is done by setting variables in this file. Note that you can define all kinds of variables, and no special error checking (for -example for spelling mistakes) takes place, so you have to try it out to see if -it works. +example for spelling mistakes) takes place. 5.1. General configuration -In this section, you can find some variables that apply to all pkgsrc packages. -A complete list of the variables that can be configured by the user is -available in mk/defaults/mk.conf, together with some comments that describe -each variable's intent. +The following variables apply to all pkgsrc packages. A complete list of the +variables that can be configured by the user is available in mk/defaults/ +mk.conf, together with some comments that describe each variable's intent. * LOCALBASE: Where packages will be installed. The default is /usr/pkg. Do not mix binary packages with different LOCALBASEs! @@ -1562,8 +1557,7 @@ LDFLAGS+= -your -linkerflags will not display the commands as they are executed (normal, default, quiet operation); the value 1 will display all shell commands before their invocation, and the value 2 will display both the shell commands before - their invocation, and their actual execution progress with set -x will be - displayed. + their invocation, as well as their actual execution progress with set -x. 5.6. Selecting Build Options @@ -1646,9 +1640,8 @@ distribute it. To create a binary package, change into the appropriate directory in pkgsrc, and run make package: -# cd misc/figlet -# make package - +$ cd misc/figlet +$ make package This will build and install your package (if not already done), and then build a binary package from what was installed. You can then use the pkg_* tools to @@ -1683,8 +1676,8 @@ instance, when you have multiple machines that should run the same software, it is wasted time if they all build their packages themselves from source. Or you may want to build a list of packages you want and check them before deploying onto production system. There is a way of getting a set of binary packages: The -bulk build system, or pbulk ("p" stands for "parallel). This chapter describes -how to set it up so that the packages are most likely to be usable later. +bulk build system, or pbulk ("p" stands for "parallel"). This chapter describes +how to set it up. 7.1. Preparations @@ -1693,12 +1686,12 @@ set of them. Full bulk builds usually consume a lot more resources, both space and time, than builds for some practical sets of packages. There exists a number of particularly heavy packages that are not actually interesting to a wide audience. For a limited bulk builds you need to make a list of packages -you want to build. Note, that all their dependencies will be built, so you -don't need to track them manually. +you want to build. Note that all their dependencies will be built, so you don't +need to track them manually. During bulk builds various packages are installed and deinstalled in /usr/pkg (or whatever LOCALBASE is), so make sure that you don't need any package during -the builds. Essentially, you should provide fresh system, either a chroot +the builds. Essentially, you should provide a fresh system, either a chroot environment or something even more restrictive, depending on what the operating system provides, or dedicate the whole physical machine. As a useful side effect this makes sure that bulk builds cannot break anything in your system. @@ -1716,11 +1709,11 @@ Running a pbulk-style bulk build works roughly as follows: 7.2.1. Configuration -To simplify configuration we provide helper script mk/pbulk/pbulk.sh. +To simplify configuration, we provide the helper script mk/pbulk/pbulk.sh. In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine). Configure network access to fetch distribution files. -Create user with name "pbulk". +Create a user with name "pbulk". Fetch and extract pkgsrc. Use a command like one of these: @@ -1741,12 +1734,13 @@ Note mk.conf.frag is a fragment of mk.conf that contains settings you want to apply to packages you build. For instance, -PKG_DEVELOPER= yes # perform more checks -X11_TYPE= modular # use pkgsrc X11 -SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages) +PKG_DEVELOPER= yes # perform more checks +X11_TYPE= modular # use pkgsrc X11 +SKIP_LICENSE_CHECK= yes # accept all licences (useful + # when building all packages) If configured for limited list, replace the list in /usr/pbulk/etc/pbulk.list -with your list of packages one per line without empty lines or comments. E.g.: +with your list of packages, one per line without empty lines or comments. E.g.: www/firefox mail/thunderbird -- cgit v1.2.3