summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Pagano <mpagano@gentoo.org>2021-06-18 19:05:37 -0400
committerMike Pagano <mpagano@gentoo.org>2021-06-18 19:05:37 -0400
commit770ee5ae02ed5749695895ab3488fd750e44ff48 (patch)
treefa4a84ed31cd4e6c7cff05b30685cb4a430f6bb0
parentprofiles: add note to libxcrypt mask(s) to treat with care for non-glibc (diff)
downloadgentoo-770ee5ae02ed5749695895ab3488fd750e44ff48.tar.gz
gentoo-770ee5ae02ed5749695895ab3488fd750e44ff48.tar.bz2
gentoo-770ee5ae02ed5749695895ab3488fd750e44ff48.zip
eclass/linux-info: Properly document CONFIG_CHECK and ERROR_<CFG>
Closes: https://bugs.gentoo.org/409207 Signed-off-by: Mike Pagano <mpagano@gentoo.org>
-rw-r--r--eclass/linux-info.eclass7
1 files changed, 6 insertions, 1 deletions
diff --git a/eclass/linux-info.eclass b/eclass/linux-info.eclass
index e2f2ad1b8885..6da13cc0b2f5 100644
--- a/eclass/linux-info.eclass
+++ b/eclass/linux-info.eclass
@@ -64,7 +64,12 @@ KERNEL_DIR="${KERNEL_DIR:-${ROOT%/}/usr/src/linux}"
# A string containing the error message to display when the check against CONFIG_CHECK
# fails. <CFG> should reference the appropriate option used in CONFIG_CHECK.
#
-# e.g.: ERROR_MTRR="MTRR exists in the .config but shouldn't!!"
+# e.g.: ERROR_MTRR="MTRR exists in the .config but shouldn't!!"
+#
+# CONFIG_CHECK="CFG" with ERROR_<CFG>="Error Message" will die
+# CONFIG_CHECK="~CFG" with ERROR_<CFG>="Error Message" calls eerror without dieing
+# CONFIG_CHECK="~CFG" with WARNING_<CFG>="Warning Message" calls ewarn without dieing
+
# @ECLASS-VARIABLE: KBUILD_OUTPUT
# @DEFAULT_UNSET