UPDATE-PLIST(1) | General Commands Manual | UPDATE-PLIST(1) |
update-plist
—
create or update packing-list(s) for a given
port
PORTSDIR
=path
[FAKE_TREE_OWNER
=user
PORTS_TREE_OWNER
=user
doas
]
update-plist |
[-Fmnqrvx ] [-C
dir] [-c
var] [-E
ext] [-e
ext] [-I
var] [-i
var] [-j
jobs] [-S
var] [-s
var] [-X
path] [-w
suffix] --
pkg_create_args ... |
update-plist
is a helper script for the
target update-plist in
bsd.port.mk(5).
Along with options and environment variables,
update-plist
uses the exact same options and
arguments that would be passed to
pkg_create(1). Since
pkg_create(1) normally
takes one single actual pkgname, there is no ambiguity
in MULTI_PACKAGES
situations.
The first set of arguments correspond to the ‘default package’.
If PORTS_PRIVSEP
is in effect,
update-plist
is run as root, but will switch back to
FAKE_TREE_OWNER
for scanning the installation
directory and to PORTS_TREE_OWNER
for writing
packing-lists.
update-plist
may need to know the
PORTSDIR
location in order to scan dependencies to
trim common directories.
The options are as follows:
-C
dir-c
var@
comment when other variables vanish.-E
ext-e
ext-F
-I
var-c
var can
be used to prevent duplicate entries.-i
var-j
jobs-n
-q
-r
-S
var-s
var-v
-w
suffix-X
pathupdate-plist
assumes all multi-packages
live under the same installation directory
(pkg_create(1)'s
-B
option), and it will scan all paths under that
directory and dispatch them into corresponding subpackages, using the
following heuristics:
As far as possible, everything that looks like actual files will be sorted in alphabetical order, after variable substitutions.
update-plist
will warn for a lot of
conditions, such as pre-formatted manpages, or files ending in pre-patch
suffixes. Adding a @comment
intentional<reason> will silence the warning.
For instance:
@man man/ja_JP.EUC/cat1/kakasi.0 @comment intentional: mandoc does't handle this locale
update-plist
will also scan dependencies,
in order to strip common directories.
If the pkglocatedb package is installed,
update-plist
will make use of it and report
unregistered conflicts. This can be disabled with -F
as it is time-consuming.
Most SUBST_VARS
variables will be
back-substituted into the regenerated packing-lists, starting from the
longest variable values. update-plist
tries to keep
existing substitutions. It does not add new substitutions on
BASE_PKGPATH
and
BUILD_PKGPATH
, it does only substitute
FULLPKGNAME
in
share/doc/pkg-readmes and it currently does not add
new substitutions for ARCH
nor
MACHINE_ARCH
.
Some packages (notoriously Python packages) create some
directories optionally based on flavors. Options -c
and -I
can be used to avoid duplicate directory
definitions.
Specifically, a generated packing-list would contain
lib/python${MODPY_VERSION}/site-packages/bpdb/ lib/python${MODPY_VERSION}/site-packages/bpdb/${MODPY_PYCACHE}/
lib/python3.7/site-packages/bpdb/ lib/python3.7/site-packages/bpdb/__pycache__/
But for python2, variable ‘MODPY_PYCACHE’ will be empty, resulting in
lib/python2.7/site-packages/bpdb/ lib/python2.7/site-packages/bpdb/
Using UPDATE_PLIST_ARGS =
-c
MODPY_COMMENT
-I
MODPY_PYCACHE will result
in injecting ‘${MODPY_COMMENT}’ wherever
update-plist
finds a duplicate directory by
replacing ‘${MODPY_PYCACHE}’ with nothing.
This yields
lib/python${MODPY_VERSION}/site-packages/bpdb/ ${MODPY_COMMENT}lib/python${MODPY_VERSION}/site-packages/bpdb/MODPY_PYCACHE}/
lib/python2.7/site-packages/bpdb/ @comment lib/python2.7/site-packages/bpdb/
Specific items such as shared libraries or binaries will gain
annotations and special handling, for instance
LIBlibname_VERSION
.
Existing packing-lists are scanned for non-file entries, such as
newuser
, mode
, or
exec
markers. Those will be inserted into the
updated packing-lists at the most likely position.
update-plist
will first write files as
<file>.new, then it will display which files
are new and which files have changed. If old packing-lists already exist, it
will move old packing lists into <file>.orig
unless these already exist, then move the new files into position.
update-plist
might be the most complicated
piece of the ports infrastructure. There will always be cases that require
manual intervention. Since fake is now run as
non-root, update-plist
can't figure out users and
groups for new files, so these should be considered carefully.
August 8, 2019 | OpenBSD-6.7 |