summaryrefslogtreecommitdiff
path: root/share/man/man5
diff options
context:
space:
mode:
authorMarc Espie <espie@cvs.openbsd.org>2011-11-25 11:01:26 +0000
committerMarc Espie <espie@cvs.openbsd.org>2011-11-25 11:01:26 +0000
commitd1dcb129b4c65e6c766c1e801b5438098b5c308f (patch)
tree87b21cccbaeb01d93a8a7f76f1d34121deb479e5 /share/man/man5
parentb6bfef11bed20f62a82ac14f2cdc7069fb2a8648 (diff)
document targets related to dependency solving, finally
Diffstat (limited to 'share/man/man5')
-rw-r--r--share/man/man5/bsd.port.mk.5154
1 files changed, 153 insertions, 1 deletions
diff --git a/share/man/man5/bsd.port.mk.5 b/share/man/man5/bsd.port.mk.5
index b1849a20764..3210b410a57 100644
--- a/share/man/man5/bsd.port.mk.5
+++ b/share/man/man5/bsd.port.mk.5
@@ -1,4 +1,4 @@
-.\" $OpenBSD: bsd.port.mk.5,v 1.305 2011/11/25 10:12:26 espie Exp $
+.\" $OpenBSD: bsd.port.mk.5,v 1.306 2011/11/25 11:01:25 espie Exp $
.\"
.\" Copyright (c) 2000-2008 Marc Espie
.\"
@@ -120,6 +120,13 @@ Complete the ${CHECKSUM_FILE} record of checksums with files that have been
added since
.Ar makesum .
Complain if anything does not match.
+.It Ar all-lib-depends
+Process the full
+.Ev LIB_DEPENDS
+list into a form suitable for
+.Xr pkg_create 1 ,
+see
+.Ar print-package-args .
.It Ar build , Ar all
Default target.
Build the port.
@@ -279,6 +286,12 @@ Do not touch
.Ev pre-fake
unless you really know what you are doing.
Described in a separate section below.
+.It Ar fake-wantlib-args
+Check
+.Ev WANTLIB
+against the list of installed packages and libraries in the ports tree.
+See
+.Ar print-package-args .
.It Ar fetch
Fetch the distribution files and patchfiles, using ${FETCH_CMD}.
Each file of the
@@ -327,6 +340,11 @@ See
.Ev PATCHFILES ,
.Ev SUPDISTFILES ,
.Ev REFETCH .
+.It Ar fetch-makefile
+generates a makefile fragment for fetching the files
+in the current port.
+See
+.Xr mirroring-ports 7 .
.It Ar index
Top-level target, see
.Xr ports 7 .
@@ -341,6 +359,15 @@ Install all packages in a multi-packages port.
.It Ar lib-depends
Verify that the library dependencies a port needs are actually there,
by checking the library specifications.
+.It Ar lib-depends-args
+Filters
+.Ev LIB_DEPENDS
+to keep only entries required by
+.Ev WANTLIB ,
+and outputs a list of dependencies suitable for
+.Xr pkg_create 1 ,
+see
+.Ar print-package-args .
.It Ar lib-depends-check
Verify that the
.Ev LIB_DEPENDS
@@ -385,6 +412,16 @@ can do a correct job with the port's manpages.
.It Ar mirror-maker
Top-level target, see
.Xr mirroring-ports 7 .
+.It Ar mirror-maker-fetch
+Debug target: generates the mirror-maker makefile fragment and use it
+to fetch files, see
+.Xr mirroring-ports 7 .
+.It Ar no-wantlib-args
+Degenerate form of
+.Ar wantlib-args
+that does not do anything.
+See
+.Ar print-package-args .
.It Ar package
Build a port package (or packages in
.Ev MULTI_PACKAGES
@@ -478,9 +515,69 @@ completion of the
stage, and thus is quicker than
.Ar lib-depends-check ,
unless you already have all binary packages.
+.It Ar port-wantlib-args
+Resolves
+.Ev WANTLIB
+against the ports tree itself and system libraries, without looking at built
+or installed packages, and writes a list of options suitable for
+.Xr pkg-create 1 .
+See
+.Ar print-package-args .
.It Ar prepare
Prepare a port for building, by checking and installing all required
dependencies.
+.It Ar print-package-args
+Print all dependency-related information that will be passed as parameters
+to
+.Xr pkg_create 1 ,
+\&.e.g.,
+.Fl W Ar wantlib
+and
+.Fl P Ar depends
+lines.
+.Pp
+Those parameters are generated by
+.Ar run-depends-args
+for
+.Ev RUN_DEPENDENCIES
+handling, a form of
+.Ar lib-depends-args
+for
+.Ev LIB_DEPENDS
+and
+.Ev WANTLIB
+interaction,
+and a form of
+.Ar wantlib-args
+for
+.Ev WANTLIB
+resolution.
+.Pp
+Variables
+.Ev lib_depends_args
+and
+.Ev wantlib_args
+control the exact behavior:
+.Ev lib_depends_args
+is normally set to
+.Ar lib-depends-args ,
+but will be set to
+.Ar all-lib-depends-args
+by
+.Ar port-lib-depends-check ,
+in order to have access to the full list of LIB_DEPENDS for figuring
+out missing WANTLIB.
+.Ev wantlib_args
+is normally set to
+.Ar wantlib-args
+but it may be set to
+.Ar port-wantlib-args
+for introspection purposes,
+to
+.Ar fake-wantlib-args
+to avoid some checks, or to
+.Ar no-wantlib-args
+to avoid expensive WANTLIB checks entirely.
.It Ar print-package-signature
Print the package signature, as computed using information from the ports tree,
in the same format used for
@@ -489,6 +586,14 @@ in the same format used for
.It Ar print-plist
Generate and print a package packing-list from the static information
present in the port.
+.It Ar print-plist-all
+Iterates over
+.Ar print-plist
+for all subpackages in a given port.
+.It Ar print-plist-all-with-depends
+Iterates over
+.Ar print-plist-with-depends
+for all subpackages in a given port.
.It Ar print-plist-contents
Generate and print a package contents from the static information
present in the port.
@@ -502,6 +607,16 @@ See
Generate and print the list of static and dynamic libraries present in the port.
See
.Xr pkg_create 1 .
+.It Ar print-plist-libs-with-depends
+Like
+.Ar print-plist-libs ,
+but slower.
+It also handles
+.Ev LIB_DEPENDS ,
+.Ev RUN_DEPENDS ,
+and
+.Ev WANTLIB ,
+so that the packing-list is complete.
.It Ar print-plist-with-depends
Like
.Ar print-plist ,
@@ -512,6 +627,9 @@ It also handles
and
.Ev WANTLIB ,
so that the packing-list is complete.
+.It Ar readme
+Create an html description of the current subpackage, including comments,
+description, and dependencies.
.It Ar readmes
Create an html description of packages, including comments, description,
and dependencies.
@@ -550,6 +668,13 @@ Verify the ports mentioned in
by checking the corresponding packages are actually installed,
and install the missing ports by recursing through the ports tree.
Invoked right before installing the package.
+.It Ar run-depends-args
+Processes
+.Ev RUN_DEPENDS
+and outputs a list of dependencies suitable for
+.Xr pkg_create 1 ,
+see
+.Ar print-package-args .
.It Ar show
Invoked as make show=name, show the contents of ${name}.
Invoked as make show="name1 name2 ...",
@@ -563,6 +688,13 @@ Prints the list of
for all ports that will be affected by the
current port changing.
Works by walking the list of dependencies, in reverse.
+.It Ar show-run-depends
+Prints all running dependencies for a port, one per-line, without duplicates.
+.It Ar subpackage
+Build a port package.
+Exactly like
+.Ar package ,
+but affects only one single subpackage in multi-packages ports.
.It Ar subupdate
Update an existing installation to a newer package, exactly
like
@@ -666,6 +798,14 @@ Similar to
.Ar show ,
except that it prefixes each value with the variable name, e.g.
.Li VAR=value
+.It Ar wantlib-args
+Calls
+.Ar port-wantlib-args
+and
+.Ar fake-wantlib-args
+and compare the results, errors out in case of discrepancies.
+See
+.Ar print-package-args .
.El
.Sh VARIABLES
Note that some variables are marked as
@@ -1370,6 +1510,12 @@ See
.Xr library-specs 7
for more details.
.Pp
+.It Ev lib_depends_args
+Controls the behavior of
+.Xr pkg_create 1
+related targets, see
+.Ar print-package-args
+for details.
.It Ev LIBTOOL
Location of the libtool binary for ports that set
.Ev USE_LIBTOOL
@@ -2349,6 +2495,12 @@ may include absolute paths, e.g.,
.Pa ${LOCALBASE}/lib/expat.=4
to distinguish between base libraries and port libraries.
Use with caution, this is very seldom needed.
+.It Ev wantlib_args
+Controls the behavior of
+.Xr pkg_create 1
+related targets, see
+.Ar print-package-args
+for details.
.It Ev WARNINGS
User settings.
If set to