From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 90BB415838C for ; Mon, 22 Jan 2024 11:29:42 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 65DAA2BC014; Mon, 22 Jan 2024 11:29:39 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [140.211.166.183]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 4349C2BC014 for ; Mon, 22 Jan 2024 11:29:39 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 2414B34329D for ; Mon, 22 Jan 2024 11:29:38 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 9F73A14CE for ; Mon, 22 Jan 2024 11:29:35 +0000 (UTC) From: "Michael Orlitzky" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Michael Orlitzky" Message-ID: <1705922962.6ebe06967e45f52ced72e61528956fac14fbd104.mjo@gentoo> Subject: [gentoo-commits] repo/gentoo:master commit in: eclass/ X-VCS-Repository: repo/gentoo X-VCS-Files: eclass/gap-pkg.eclass X-VCS-Directories: eclass/ X-VCS-Committer: mjo X-VCS-Committer-Name: Michael Orlitzky X-VCS-Revision: 6ebe06967e45f52ced72e61528956fac14fbd104 X-VCS-Branch: master Date: Mon, 22 Jan 2024 11:29:35 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: 6bc66c43-3223-4323-8fe1-c69ad6b0d056 X-Archives-Hash: 759fac3422dfb97bd4a7acefecba6f9a commit: 6ebe06967e45f52ced72e61528956fac14fbd104 Author: Michael Orlitzky gentoo org> AuthorDate: Sun Jan 14 22:34:44 2024 +0000 Commit: Michael Orlitzky gentoo org> CommitDate: Mon Jan 22 11:29:22 2024 +0000 URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=6ebe0696 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 gentoo.org> Signed-off-by: Michael Orlitzky gentoo.org> eclass/gap-pkg.eclass | 22 ++++++++++------------ 1 file 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