[PATCH 4/5] kconfig: improve error message for recursive dependency in choice

From: Masahiro Yamada
Date: Wed Jun 26 2024 - 14:23:17 EST


Kconfig detects recursive dependencies in a choice block, but the error
message is unclear.

[Test Code]

choice
prompt "choose"
depends on A

config A
bool "A"

config B
bool "B"

endchoice

[Result]

Kconfig:1:error: recursive dependency detected!
Kconfig:1: choice <choice> contains symbol A
Kconfig:5: symbol A is part of choice <choice>
For a resolution refer to Documentation/kbuild/kconfig-language.rst
subsection "Kconfig recursive dependency limitations"

The phrase "contains symbol A" does not accurately describe the problem.
The issue is that the choice depends on A, which is a member of itself.

The first if-block does not print a sensible message. Remove it.

This commit improves the error message to:

Kconfig:1:error: recursive dependency detected!
Kconfig:1: symbol <choice> symbol is visible depending on A
Kconfig:5: symbol A is part of choice <choice>
For a resolution refer to Documentation/kbuild/kconfig-language.rst
subsection "Kconfig recursive dependency limitations"

Signed-off-by: Masahiro Yamada <masahiroy@xxxxxxxxxx>
---

scripts/kconfig/symbol.c | 7 +------
1 file changed, 1 insertion(+), 6 deletions(-)

diff --git a/scripts/kconfig/symbol.c b/scripts/kconfig/symbol.c
index 0c4b2894ac4e..787f0667836b 100644
--- a/scripts/kconfig/symbol.c
+++ b/scripts/kconfig/symbol.c
@@ -1106,12 +1106,7 @@ static void sym_check_print_recursive(struct symbol *last_sym)
fprintf(stderr, "%s:%d:error: recursive dependency detected!\n",
prop->filename, prop->lineno);

- if (sym_is_choice(sym)) {
- fprintf(stderr, "%s:%d:\tchoice %s contains symbol %s\n",
- menu->filename, menu->lineno,
- sym->name ? sym->name : "<choice>",
- next_sym->name ? next_sym->name : "<choice>");
- } else if (sym_is_choice(next_sym)) {
+ if (sym_is_choice(next_sym)) {
fprintf(stderr, "%s:%d:\tsymbol %s is part of choice %s\n",
menu->filename, menu->lineno,
sym->name ? sym->name : "<choice>",
--
2.43.0