commit:     770ee5ae02ed5749695895ab3488fd750e44ff48
Author:     Mike Pagano <mpagano <AT> gentoo <DOT> org>
AuthorDate: Fri Jun 18 23:05:37 2021 +0000
Commit:     Mike Pagano <mpagano <AT> gentoo <DOT> org>
CommitDate: Fri Jun 18 23:05:37 2021 +0000
URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=770ee5ae

eclass/linux-info: Properly document CONFIG_CHECK and ERROR_<CFG>

Closes: https://bugs.gentoo.org/409207

Signed-off-by: Mike Pagano <mpagano <AT> gentoo.org>

 eclass/linux-info.eclass | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/eclass/linux-info.eclass b/eclass/linux-info.eclass
index e2f2ad1b888..6da13cc0b2f 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

Reply via email to