doc: update SRCEXT/PKGEXT to reduce needlessly scary warnings
Currently this tells people that the settings should not be touched, but we should just rely on the description of what it should be set to, and leave it up to the user. With the previous patch, makepkg aborts if an invalid value is set, greatly reducing the danger of it being badly configured. Also make this clearer by indicating when it would be useful to change the settings -- i.e. disable compression -- and ensure their described defaults are based on the ones established during ./configure or meson setup. Reported-by: Jouke Witteveen <j.witteveen@gmail.com> Signed-off-by: Eli Schwartz <eschwartz@archlinux.org> Signed-off-by: Allan McRae <allan@archlinux.org>
This commit is contained in:
parent
4c38f4b991
commit
5caf45cdbb
4 changed files with 9 additions and 7 deletions
|
@ -108,6 +108,8 @@ ASCIIDOC_OPTS = \
|
||||||
-f $(srcdir)/asciidoc.conf \
|
-f $(srcdir)/asciidoc.conf \
|
||||||
-a pacman_version="$(REAL_PACKAGE_VERSION)" \
|
-a pacman_version="$(REAL_PACKAGE_VERSION)" \
|
||||||
-a pacman_date="`date +%Y-%m-%d`" \
|
-a pacman_date="`date +%Y-%m-%d`" \
|
||||||
|
-a srcext="$(SRCEXT)" \
|
||||||
|
-a pkgext="$(PKGEXT)" \
|
||||||
-a pkgdatadir=$(pkgdatadir) \
|
-a pkgdatadir=$(pkgdatadir) \
|
||||||
-a localstatedir=$(localstatedir) \
|
-a localstatedir=$(localstatedir) \
|
||||||
-a sysconfdir=$(sysconfdir) \
|
-a sysconfdir=$(sysconfdir) \
|
||||||
|
|
|
@ -258,11 +258,12 @@ Options
|
||||||
Sets the command and options used when compressing compiled or source
|
Sets the command and options used when compressing compiled or source
|
||||||
packages in the named format.
|
packages in the named format.
|
||||||
|
|
||||||
**PKGEXT=**".pkg.tar.gz", **SRCEXT=**".src.tar.gz"::
|
**PKGEXT=**"{pkgext}", **SRCEXT=**"{srcext}"::
|
||||||
Sets the compression used when making compiled or source packages.
|
Sets the compression used when making compiled or source packages.
|
||||||
Valid suffixes are `.tar`, `.tar.gz`, `.tar.bz2`, `.tar.xz`, `.tar.zst`,
|
Valid suffixes are `.tar.gz`, `.tar.bz2`, `.tar.xz`, `.tar.zst`,
|
||||||
`.tar.lzo`, `.tar.lrz`, `.tar.lz4`, `.tar.lz` and `.tar.Z`.
|
`.tar.lzo`, `.tar.lrz`, `.tar.lz4`, `.tar.lz` and `.tar.Z`, or
|
||||||
Do not touch these unless you know what you are doing.
|
simply `.tar` to disable compression entirely.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
|
|
@ -27,6 +27,8 @@ asciidoc_opts = [
|
||||||
'-f', asciidoc_conf,
|
'-f', asciidoc_conf,
|
||||||
'-a', 'pacman_version="@0@"'.format(PACKAGE_VERSION),
|
'-a', 'pacman_version="@0@"'.format(PACKAGE_VERSION),
|
||||||
'-a', 'pacman_date=@0@'.format(run_command('date', '+%Y-%m-%d').stdout().strip()),
|
'-a', 'pacman_date=@0@'.format(run_command('date', '+%Y-%m-%d').stdout().strip()),
|
||||||
|
'-a', 'srcext=@0@'.format(get_option('src-ext')),
|
||||||
|
'-a', 'pkgext=@0@'.format(get_option('pkg-ext')),
|
||||||
'-a', 'pkgdatadir=@0@'.format(PKGDATADIR),
|
'-a', 'pkgdatadir=@0@'.format(PKGDATADIR),
|
||||||
'-a', 'localstatedir=@0@'.format(LOCALSTATEDIR),
|
'-a', 'localstatedir=@0@'.format(LOCALSTATEDIR),
|
||||||
'-a', 'sysconfdir=@0@'.format(SYSCONFDIR),
|
'-a', 'sysconfdir=@0@'.format(SYSCONFDIR),
|
||||||
|
|
|
@ -141,8 +141,5 @@ COMPRESSLZ=(lzip -c -f)
|
||||||
# EXTENSION DEFAULTS
|
# EXTENSION DEFAULTS
|
||||||
#########################################################################
|
#########################################################################
|
||||||
#
|
#
|
||||||
# WARNING: Do NOT modify these variables unless you know what you are
|
|
||||||
# doing.
|
|
||||||
#
|
|
||||||
PKGEXT='@PKGEXT@'
|
PKGEXT='@PKGEXT@'
|
||||||
SRCEXT='@SRCEXT@'
|
SRCEXT='@SRCEXT@'
|
||||||
|
|
Loading…
Add table
Reference in a new issue