Bug 409207

Summary:	linux-info.eclass should document WARNING_<CFG> variables
Product:	Gentoo Linux	Reporter:	Martin von Gagern <Martin.vGagern>
Component:	Eclasses	Assignee:	Gentoo Kernel Bug Wranglers and Kernel Maintainers <kernel>
Status:	RESOLVED FIXED
Severity:	normal
Priority:	Normal
Version:	unspecified
Hardware:	All
OS:	Linux
Whiteboard:
Package list:		Runtime testing required:	---

Description Martin von Gagern 2012-03-21 17:32:09 UTC

The check_extra_config function from linux-info.eclass currently has three different severety levels:

CONFIG_CHECK="CFG" with ERROR_CFG="foo" is a hard error, will die.
CONFIG_CHECK="~CFG" with ERROR_CFG="foo" is a "soft error", calls eerror.
CONFIG_CHECK="~CFG" with WARNING_CFG="foo" is a warning, calls ewarn.

The distinction between the latter two isn't anywhere in the documentation. There is a piece of documentation about ERROR_<CFG> variables, but none at all about WARNING_<CFG> variables.

This can lead to confusion, bug #407547 comment #3 being an example. So please fix the documentation, so it properly documents all possible behaviour.

Comment 1 Larry the Git Cow gentoo-dev

2021-06-18 23:07:04 UTC

The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=770ee5ae02ed5749695895ab3488fd750e44ff48

commit 770ee5ae02ed5749695895ab3488fd750e44ff48
Author:     Mike Pagano <mpagano@gentoo.org>
AuthorDate: 2021-06-18 23:05:37 +0000
Commit:     Mike Pagano <mpagano@gentoo.org>
CommitDate: 2021-06-18 23:05:37 +0000

    eclass/linux-info: Properly document CONFIG_CHECK and ERROR_<CFG>
    
    Closes: https://bugs.gentoo.org/409207
    
    Signed-off-by: Mike Pagano <mpagano@gentoo.org>

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