[v2,0/3] kconfig: rework symbol help text

Message

Tom Hebb Dec. 17, 2019, 4:15 p.m. UTC

This series fixes several issues with help text generated by Kconfig,
mainly affecting symbols that are defined in multiple places. Although
results of these patches are somewhat visible for the symbols in Linux,
what prompted me to write the series was working on U-Boot, which also
uses Kconfig and makes very heavy use of multiple definitions (e.g. for
overriding defaults). I have provided Linux examples where I could find
them, but the example for the biggest patch (the first one) is taken
from U-Boot because it was more illustrative than anything I could find
in Linux.

Changes in v2:
- Added explicit U-Boot version in commit message + other rewordings
- Made the new "Depends on:" line print actual dependencies instead of
  visibility to avoid an intra-series regression, and noted that in the
  commit message.
- Get rid of redundant "with prompt" and "without prompt" notes in
  definition text, but continue to ensure that definitions with prompts
  are printed before ones without.
- Fixed checkpatch issues
- Omit already-merged patch "kconfig: don't crash on NULL expressions in
  expr_eq()"

Thomas Hebb (3):
  kconfig: list all definitions of a symbol in help text
  kconfig: distinguish between dependencies and visibility in help text
  kconfig: fix nesting of symbol help text

 scripts/kconfig/expr.c |  3 +-
 scripts/kconfig/expr.h |  1 +
 scripts/kconfig/menu.c | 82 +++++++++++++++++++++++++-----------------
 3 files changed, 52 insertions(+), 34 deletions(-)

Comments

Masahiro Yamada Dec. 18, 2019, 2:09 p.m. UTC | #1

On Wed, Dec 18, 2019 at 1:15 AM Thomas Hebb <[e-mail]> wrote:
>
> This series fixes several issues with help text generated by Kconfig,
> mainly affecting symbols that are defined in multiple places. Although
> results of these patches are somewhat visible for the symbols in Linux,
> what prompted me to write the series was working on U-Boot, which also
> uses Kconfig and makes very heavy use of multiple definitions (e.g. for
> overriding defaults). I have provided Linux examples where I could find
> them, but the example for the biggest patch (the first one) is taken
> from U-Boot because it was more illustrative than anything I could find
> in Linux.
>
> Changes in v2:
> - Added explicit U-Boot version in commit message + other rewordings
> - Made the new "Depends on:" line print actual dependencies instead of
>   visibility to avoid an intra-series regression, and noted that in the
>   commit message.
> - Get rid of redundant "with prompt" and "without prompt" notes in
>   definition text, but continue to ensure that definitions with prompts
>   are printed before ones without.
> - Fixed checkpatch issues
> - Omit already-merged patch "kconfig: don't crash on NULL expressions in
>   expr_eq()"
>
> Thomas Hebb (3):
>   kconfig: list all definitions of a symbol in help text
>   kconfig: distinguish between dependencies and visibility in help text
>   kconfig: fix nesting of symbol help text

All applied to linux-kbuild. Thanks.


>  scripts/kconfig/expr.c |  3 +-
>  scripts/kconfig/expr.h |  1 +
>  scripts/kconfig/menu.c | 82 +++++++++++++++++++++++++-----------------
>  3 files changed, 52 insertions(+), 34 deletions(-)
>
> --
> 2.24.1
>