From 5caf45cdbb267ee45c7b4a9c815e500efd350e6e Mon Sep 17 00:00:00 2001
From: Eli Schwartz <eschwartz@archlinux.org>
Date: Wed, 22 May 2019 10:39:44 -0400
Subject: 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>
---
 doc/makepkg.conf.5.asciidoc | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

(limited to 'doc/makepkg.conf.5.asciidoc')

diff --git a/doc/makepkg.conf.5.asciidoc b/doc/makepkg.conf.5.asciidoc
index 34810f51..9292b2a6 100644
--- a/doc/makepkg.conf.5.asciidoc
+++ b/doc/makepkg.conf.5.asciidoc
@@ -258,11 +258,12 @@ Options
 	Sets the command and options used when compressing compiled or source
 	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.
-	Valid suffixes are `.tar`, `.tar.gz`, `.tar.bz2`, `.tar.xz`, `.tar.zst`,
-	`.tar.lzo`, `.tar.lrz`, `.tar.lz4`, `.tar.lz` and `.tar.Z`.
-	Do not touch these unless you know what you are doing.
+	Valid suffixes are `.tar.gz`, `.tar.bz2`, `.tar.xz`, `.tar.zst`,
+	`.tar.lzo`, `.tar.lrz`, `.tar.lz4`, `.tar.lz` and `.tar.Z`, or
+	simply `.tar` to disable compression entirely.
+
 
 
 See Also
-- 
cgit v1.2.3-54-g00ecf

