summaryrefslogtreecommitdiff
path: root/eclass
diff options
context:
space:
mode:
authorMichael Orlitzky <mjo@gentoo.org>2024-01-14 17:34:44 -0500
committerMichael Orlitzky <mjo@gentoo.org>2024-01-22 06:29:22 -0500
commit6ebe06967e45f52ced72e61528956fac14fbd104 (patch)
tree2d5f7c726ab599b996b70c198fd34ec659cb9d46 /eclass
parentgap-pkg.eclass: use nullglob instead of working around it (diff)
downloadgentoo-6ebe06967e45f52ced72e61528956fac14fbd104.tar.gz
gentoo-6ebe06967e45f52ced72e61528956fac14fbd104.tar.bz2
gentoo-6ebe06967e45f52ced72e61528956fac14fbd104.zip
gap-pkg.eclass: default GAP_PKG_HTML_DOCDIR=doc at the top-level
The default value for this variable was essentially being set inside gap-pkg_src_install, rather than at the top-level. We move it to the top level so that the eclass man page correctly documents it. Suggested-by: Michał Górny <mgorny@gentoo.org> Signed-off-by: Michael Orlitzky <mjo@gentoo.org>
Diffstat (limited to 'eclass')
-rw-r--r--eclass/gap-pkg.eclass22
1 files changed, 10 insertions, 12 deletions
diff --git a/eclass/gap-pkg.eclass b/eclass/gap-pkg.eclass
index 6f50444bfa12..bcb8e2be23a8 100644
--- a/eclass/gap-pkg.eclass
+++ b/eclass/gap-pkg.eclass
@@ -249,18 +249,18 @@ gap-pkg_src_test() {
# src_install phase.
# @ECLASS_VARIABLE GAP_PKG_HTML_DOCDIR
-# @DEFAULT_UNSET
# @DESCRIPTION
# The directory inside the tarball where the HTML documentation is
# located. This is _usually_ "doc", which conforms to the suggested
-# GAPDoc layout and is where we look if this variable is left
-# unset. Many packages however use a top-level "htm" directory
-# instead. The named directory will be installed to gap-pkg_dir and
-# symlinked to the usual location under /usr/share/doc. As a result, you
-# should only use this for directories referenced by PackageInfo.g or by
-# some other part of the package. HTML documentation whose location
-# doesn't need to be known to the package at runtime should instead be
-# installed with HTML_DOCS or a similar mechanism.
+# GAPDoc layout and is the default value of this variable. Many
+# packages however use a top-level "htm" directory instead. The named
+# directory will be installed to gap-pkg_dir and symlinked to the usual
+# location under /usr/share/doc. As a result, you should only use this
+# for directories referenced by PackageInfo.g or by some other part of
+# the package. HTML documentation whose location doesn't need to be
+# known to the package at runtime should instead be installed with
+# HTML_DOCS or a similar mechanism.
+: "${GAP_PKG_HTML_DOCDIR:=doc}"
# @FUNCTION: gap-pkg_src_install
# @DESCRIPTION:
@@ -332,9 +332,7 @@ gap-pkg_src_install() {
fi
# Install the HTML documentation. The procedure is basically the
- # same as for the PDF docs. Default to "doc" as the location if
- # nothing else was specified.
- : "${GAP_PKG_HTML_DOCDIR:=doc}"
+ # same as for the PDF docs.
if [[ -d "${GAP_PKG_HTML_DOCDIR}" ]]; then
pushd "${GAP_PKG_HTML_DOCDIR}" > /dev/null || die