pkgcheck icon indicating copy to clipboard operation
pkgcheck copied to clipboard

pkgcheck reports EclassDocMissingVar for variables that are inherited from another eclass

Open mgorny opened this issue 3 years ago • 2 comments

For example, I'm adding verify-sig support to llvm.org.eclass, so in global scope I'm setting VERIFY_SIG_OPENPGP_KEY_PATH.

pkgcheck now reports:

eclass
  EclassDocMissingVar: llvm.org: undocumented variable: VERIFY_SIG_OPENPGP_KEY_PATH

However, this variable is documented in verify-sig already, so I don't think it should be documented again.

mgorny avatar Jun 11 '22 10:06 mgorny

Could you please show the eclass example for that? I'm asking as it might sound like you are defining a new undocumented variable instead of setting "sane default one" (at least for pkgcheck check). In this case should we try to "inherit" documentation? In this case from which eclasses (all inherited, only provided, etc?)

arthurzam avatar Jun 15 '22 16:06 arthurzam

E.g. the following patch to llvm.org.eclass:

diff --git a/eclass/llvm.org.eclass b/eclass/llvm.org.eclass
index 306b9c020e18..1bfbabb408ba 100644
--- a/eclass/llvm.org.eclass
+++ b/eclass/llvm.org.eclass
@@ -174,6 +174,7 @@ ALL_LLVM_TARGET_FLAGS=(
        "${ALL_LLVM_EXPERIMENTAL_TARGETS[@]/#/llvm_targets_}"
 )
 
+VERIFY_SIG_OPENPGP_KEY_PATH=${BROOT}/usr/share/openpgp-keys/llvm.asc
 
 # == global scope logic ==
 
@@ -209,7 +210,6 @@ llvm.org_set_globals() {
                                        sec-keys/openpgp-keys-llvm
                                )
                        "
-                       VERIFY_SIG_OPENPGP_KEY_PATH=${BROOT}/usr/share/openpgp-keys/llvm.asc
                else
                        SRC_URI+="
                                https://github.com/llvm/llvm-project/archive/llvmorg-${PV/_/-}.tar.gz

(I've moved the var into a function to silence this)

mgorny avatar Jun 15 '22 17:06 mgorny