Skip to contentSkip to conversation

kconfig: doc: fix a typo in the note about 'imply'

PATCH In review Masahiro Yamada 2 participants 7 messages Jun 3, 2024 – Jun 4, 2024

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/3 kconfig: doc: fix a typo in the note about 'imply'

This sentence does not make sense due to a typo. Fix it.

Fixes def2fbffe62c ("kconfig: allow symbols implied by y to become m")

---

 Documentation/kbuild/kconfig-language.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/kbuild/kconfig-language.rst +1 -1
index 555c2f839969..86be5b857cc4 100644
@@ -184,7 +184,7 @@ applicable everywhere (see syntax).
   ability to hook into a secondary subsystem while allowing the user to
   configure that subsystem out without also having to unset these drivers.
 
-  Note: If the combination of FOO=y and BAR=m causes a link error,
+  Note: If the combination of FOO=y and BAZ=m causes a link error,
   you can guard the function call with IS_REACHABLE()::
 
 	foo_init()
Signature · 1 line
2.40.1
#1 lore raw

PATCH 2/3 kconfig: doc: document behavior of 'select' and 'imply' followed by 'if'

Documentation/kbuild/kconfig-language.rst explains the behavior of 'select' as follows:

reverse dependencies can be used to force a lower limit of another symbol. The value of the current menu symbol is used as the minimal value <symbol> can be set to.

This is not true when the 'select' property is followed by 'if'.

[Test Code]

config MODULES
def_bool y
modules

config A
def_tristate y
select C if B

config B
def_tristate m

config C
tristate

[Result]

CONFIG_MODULES=y
CONFIG_A=y
CONFIG_B=m
CONFIG_C=m

If "the value of A is used as the minimal value C can be set to", C must be 'y'.

The actual behavior is "C is selected by (A && B)". The lower limit of C is downgraded due to B being 'm'.

I have always thought this behavior was odd, and this ha arisen several times in the mailing list.

I do not know whether it is a bug or intended behavior. Anyway, it is not feasible to change it now because many Kconfig files rely on this behavior. The same applies to 'imply'.

Document this (but reserve the possibility for a future change).

---

 Documentation/kbuild/kconfig-language.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)
Documentation/kbuild/kconfig-language.rst +10 -0
index 86be5b857cc4..1fb3f5e6193c 100644
@@ -150,6 +150,12 @@ applicable everywhere (see syntax).
 	That will limit the usefulness but on the other hand avoid
 	the illegal configurations all over.
 
+	If "select" <symbol> is followed by "if" <expr>, <symbol> will be
+	selected by the logical AND of the value of the current menu symbol
+	and <expr>. This means, the lower limit can be downgraded due to the
+	presence of "if" <expr>. This behavior may seem weird, but we rely on
+	it. (The future of this behavior is undecided.)
+
 - weak reverse dependencies: "imply" <symbol> ["if" <expr>]
 
   This is similar to "select" as it enforces a lower limit on another
@@ -202,6 +208,10 @@ applicable everywhere (see syntax).
 	imply BAR
 	imply BAZ
 
+  Note: If "imply" <symbol> is followed by "if" <expr>, the default of <symbol>
+  will be the logical AND of the value of the current menu symbol and <expr>.
+  (The future of this behavior is undecided.)
+
 - limiting menu display: "visible if" <expr>
 
   This attribute is only applicable to menu blocks, if the condition is
Signature · 1 line
2.40.1
reviewer Reviewed-by on v1 2/3
#2 lore raw

Re: [PATCH 2/3] kconfig: doc: document behavior of 'select' and 'imply' followed by 'if'

Quoted 32 lines · Masahiro Yamada

Documentation/kbuild/kconfig-language.rst explains the behavior of 'select' as follows:

reverse dependencies can be used to force a lower limit of another symbol. The value of the current menu symbol is used as the minimal value <symbol> can be set to.

This is not true when the 'select' property is followed by 'if'.

[Test Code]

config MODULES
def_bool y
modules

config A
def_tristate y
select C if B

config B
def_tristate m

config C
tristate

[Result]

CONFIG_MODULES=y
CONFIG_A=y
CONFIG_B=m
CONFIG_C=m

Quoted 7 lines

If "the value of A is used as the minimal value C can be set to", C must be 'y'.

The actual behavior is "C is selected by (A && B)". The lower limit of C is downgraded due to B being 'm'.

I have always thought this behavior was odd, and this ha arisen several

has

Quoted 9 lines

times in the mailing list.

I do not know whether it is a bug or intended behavior. Anyway, it is not feasible to change it now because many Kconfig files rely on this behavior. The same applies to 'imply'.

Document this (but reserve the possibility for a future change).

Thanks.

Quoted 33 lines

---

 Documentation/kbuild/kconfig-language.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)
Documentation/kbuild/kconfig-language.rst +10 -0
index 86be5b857cc4..1fb3f5e6193c 100644
@@ -150,6 +150,12 @@ applicable everywhere (see syntax).
 	That will limit the usefulness but on the other hand avoid
 	the illegal configurations all over.
 
+	If "select" <symbol> is followed by "if" <expr>, <symbol> will be
+	selected by the logical AND of the value of the current menu symbol
+	and <expr>. This means, the lower limit can be downgraded due to the
+	presence of "if" <expr>. This behavior may seem weird, but we rely on
+	it. (The future of this behavior is undecided.)
+
 - weak reverse dependencies: "imply" <symbol> ["if" <expr>]
 
   This is similar to "select" as it enforces a lower limit on another
@@ -202,6 +208,10 @@ applicable everywhere (see syntax).
 	imply BAR
 	imply BAZ
 
+  Note: If "imply" <symbol> is followed by "if" <expr>, the default of <symbol>
+  will be the logical AND of the value of the current menu symbol and <expr>.
+  (The future of this behavior is undecided.)
+
 - limiting menu display: "visible if" <expr>
 
   This attribute is only applicable to menu blocks, if the condition is
Signature · 3 lines
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html
#3 lore raw

PATCH 3/3 kconfig: remove wrong expr_trans_bool()

In reply to Masahiro Yamada

expr_trans_bool() performs an incorrect transformation.

[Test Code]

    config MODULES
            def_bool y
            modules

    config A
            def_bool y
            select C if B != n

    config B
            def_tristate m

    config C
            tristate

[Result]

CONFIG_MODULES=y
CONFIG_A=y
CONFIG_B=m
CONFIG_C=m

This result is incorrect because CONFIG_C=y is expected.

Documentation/kbuild/kconfig-language.rst clearly explains the function of the '!=' operator:

(3) If the values of both symbols are equal, it returns 'n', otherwise 'y'.

Therefore, the statement:

    select C if A != n

should be equivalent to:

select C if y

Hence, the symbol C should be selected by 'y' instead of 'm'.

The comment block of expr_trans_bool() correctly explains its intention:

* bool FOO!=n => FOO

    ^^^^

If FOO is bool, FOO!=n can be simplified into FOO. This is correct.

However, the actual code performs this transformation when FOO is tristate.

    if (e->left.sym->type == S_TRISTATE) {
                             ^^^^^^^^^^

While, it can be fixed to S_BOOLEAN, there is no point in doing so because expr_tranform() already transforms FOO!=n to FOO when FOO is bool. (see the "case E_UNEQUAL" part)

expr_trans_bool() is wrong and unnecessary.

---

 scripts/kconfig/expr.c | 29 -----------------------------
 scripts/kconfig/expr.h |  1 -
 scripts/kconfig/menu.c |  2 --
 3 files changed, 32 deletions(-)
scripts/kconfig/expr.c +0 -29
index 4d95fce5f9a7..fcc190b67b6f 100644
@@ -396,35 +396,6 @@ static struct expr *expr_eliminate_yn(struct expr *e)
 	return e;
 }
 
-/*
- * bool FOO!=n => FOO
- */
-struct expr *expr_trans_bool(struct expr *e)
-{
-	if (!e)
-		return NULL;
-	switch (e->type) {
-	case E_AND:
-	case E_OR:
-	case E_NOT:
-		e->left.expr = expr_trans_bool(e->left.expr);
-		e->right.expr = expr_trans_bool(e->right.expr);
-		break;
-	case E_UNEQUAL:
-		// FOO!=n -> FOO
-		if (e->left.sym->type == S_TRISTATE) {
-			if (e->right.sym == &symbol_no) {
-				e->type = E_SYMBOL;
-				e->right.sym = NULL;
-			}
-		}
-		break;
-	default:
-		;
-	}
-	return e;
-}
-
 /*
  * e1 || e2 -> ?
  */
scripts/kconfig/expr.h +0 -1
index fa50fc45622e..7c0c242318bc 100644
@@ -284,7 +284,6 @@ void expr_free(struct expr *e);
 void expr_eliminate_eq(struct expr **ep1, struct expr **ep2);
 int expr_eq(struct expr *e1, struct expr *e2);
 tristate expr_calc_value(struct expr *e);
-struct expr *expr_trans_bool(struct expr *e);
 struct expr *expr_eliminate_dups(struct expr *e);
 struct expr *expr_transform(struct expr *e);
 int expr_contains_symbol(struct expr *dep, struct symbol *sym);
scripts/kconfig/menu.c +0 -2
index 53151c5a6028..eef9b63cdf11 100644
@@ -398,8 +398,6 @@ static void _menu_finalize(struct menu *parent, bool inside_choice)
 				dep = expr_transform(dep);
 				dep = expr_alloc_and(expr_copy(basedep), dep);
 				dep = expr_eliminate_dups(dep);
-				if (menu->sym && menu->sym->type != S_TRISTATE)
-					dep = expr_trans_bool(dep);
 				prop->visible.expr = dep;
 
 				/*
Signature · 1 line
2.40.1
reviewer Acked-by on v1 3/3
#4 lore raw

Re: [PATCH 3/3] kconfig: remove wrong expr_trans_bool()

Quoted 50 lines · Masahiro Yamada

expr_trans_bool() performs an incorrect transformation.

[Test Code]

    config MODULES
            def_bool y
            modules

    config A
            def_bool y
            select C if B != n

    config B
            def_tristate m

    config C
            tristate

[Result]

CONFIG_MODULES=y
CONFIG_A=y
CONFIG_B=m
CONFIG_C=m

This result is incorrect because CONFIG_C=y is expected.

Documentation/kbuild/kconfig-language.rst clearly explains the function of the '!=' operator:

(3) If the values of both symbols are equal, it returns 'n', otherwise 'y'.

Therefore, the statement:

    select C if A != n

should be equivalent to:

select C if y

Hence, the symbol C should be selected by 'y' instead of 'm'.

The comment block of expr_trans_bool() correctly explains its intention:

* bool FOO!=n => FOO

    ^^^^

If FOO is bool, FOO!=n can be simplified into FOO. This is correct.

Quoted 7 lines

However, the actual code performs this transformation when FOO is tristate.

    if (e->left.sym->type == S_TRISTATE) {
                             ^^^^^^^^^^

While, it can be fixed to S_BOOLEAN, there is no point in doing so

While it can

Quoted 6 lines

because expr_tranform() already transforms FOO!=n to FOO when FOO is bool. (see the "case E_UNEQUAL" part)

expr_trans_bool() is wrong and unnecessary.

Thanks.

Quoted 72 lines

---

 scripts/kconfig/expr.c | 29 -----------------------------
 scripts/kconfig/expr.h |  1 -
 scripts/kconfig/menu.c |  2 --
 3 files changed, 32 deletions(-)
scripts/kconfig/expr.c +0 -29
index 4d95fce5f9a7..fcc190b67b6f 100644
@@ -396,35 +396,6 @@ static struct expr *expr_eliminate_yn(struct expr *e)
 	return e;
 }
 
-/*
- * bool FOO!=n => FOO
- */
-struct expr *expr_trans_bool(struct expr *e)
-{
-	if (!e)
-		return NULL;
-	switch (e->type) {
-	case E_AND:
-	case E_OR:
-	case E_NOT:
-		e->left.expr = expr_trans_bool(e->left.expr);
-		e->right.expr = expr_trans_bool(e->right.expr);
-		break;
-	case E_UNEQUAL:
-		// FOO!=n -> FOO
-		if (e->left.sym->type == S_TRISTATE) {
-			if (e->right.sym == &symbol_no) {
-				e->type = E_SYMBOL;
-				e->right.sym = NULL;
-			}
-		}
-		break;
-	default:
-		;
-	}
-	return e;
-}
-
 /*
  * e1 || e2 -> ?
  */
scripts/kconfig/expr.h +0 -1
index fa50fc45622e..7c0c242318bc 100644
@@ -284,7 +284,6 @@ void expr_free(struct expr *e);
 void expr_eliminate_eq(struct expr **ep1, struct expr **ep2);
 int expr_eq(struct expr *e1, struct expr *e2);
 tristate expr_calc_value(struct expr *e);
-struct expr *expr_trans_bool(struct expr *e);
 struct expr *expr_eliminate_dups(struct expr *e);
 struct expr *expr_transform(struct expr *e);
 int expr_contains_symbol(struct expr *dep, struct symbol *sym);
scripts/kconfig/menu.c +0 -2
index 53151c5a6028..eef9b63cdf11 100644
@@ -398,8 +398,6 @@ static void _menu_finalize(struct menu *parent, bool inside_choice)
 				dep = expr_transform(dep);
 				dep = expr_alloc_and(expr_copy(basedep), dep);
 				dep = expr_eliminate_dups(dep);
-				if (menu->sym && menu->sym->type != S_TRISTATE)
-					dep = expr_trans_bool(dep);
 				prop->visible.expr = dep;
 
 				/*
Signature · 3 lines
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html
#5 lore raw

Re: [PATCH 3/3] kconfig: remove wrong expr_trans_bool()

In reply to Masahiro Yamada
Quoted 31 lines · Masahiro Yamada

expr_trans_bool() performs an incorrect transformation.

[Test Code]

    config MODULES
            def_bool y
            modules

    config A
            def_bool y
            select C if B != n

    config B
            def_tristate m

    config C
            tristate

[Result]

CONFIG_MODULES=y
CONFIG_A=y
CONFIG_B=m
CONFIG_C=m

This result is incorrect because CONFIG_C=y is expected.

Documentation/kbuild/kconfig-language.rst clearly explains the function of the '!=' operator:

Quoted 6 lines

(3) If the values of both symbols are equal, it returns 'n', otherwise 'y'.

Therefore, the statement:

    select C if A != n

This is wrong.

I meant this:

      select C if B != n
Signature · 2 lines
Best Regards
Masahiro Yamada
reviewer Reviewed-by on v1 1/3
#6 lore raw
In reply to Masahiro Yamada
Quoted 4 lines · Masahiro Yamada

This sentence does not make sense due to a typo. Fix it.

Fixes def2fbffe62c ("kconfig: allow symbols implied by y to become m")

Thanks.

Quoted 18 lines

---

 Documentation/kbuild/kconfig-language.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/kbuild/kconfig-language.rst +1 -1
index 555c2f839969..86be5b857cc4 100644
@@ -184,7 +184,7 @@ applicable everywhere (see syntax).
   ability to hook into a secondary subsystem while allowing the user to
   configure that subsystem out without also having to unset these drivers.
 
-  Note: If the combination of FOO=y and BAR=m causes a link error,
+  Note: If the combination of FOO=y and BAZ=m causes a link error,
   you can guard the function call with IS_REACHABLE()::
 
 	foo_init()
Signature · 3 lines
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html