Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20211213100043.45645-1-arielmarcovitch@gmail.com> <20211213100043.45645-3-arielmarcovitch@gmail.com>
In-Reply-To: <20211213100043.45645-3-arielmarcovitch@gmail.com>
From:   Masahiro Yamada <masahiroy@kernel.org>
Date:   Wed, 19 Jan 2022 03:25:50 +0900
Message-ID: <CAK7LNAQb8ivsQX-0YDNx6B_ZTBUq9v7SSG+m8=e1GsGL-DuBsg@mail.gmail.com>
Subject: Re: [PATCH 2/2] kconfig: Make comments look different than menus in .config
To:     Ariel Marcovitch <arielmarcovitch@gmail.com>
Cc:     Linux Kbuild mailing list <linux-kbuild@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Mon, Dec 13, 2021 at 7:01 PM Ariel Marcovitch
<arielmarcovitch@gmail.com> wrote:
>
> Currently, the same code that handles menus in the write to .config
> handles comments as well. That's why comments look exactly like menus in
> the .config except for the 'end of menu' comments that appear only for
> menus. This makes sense because sometimes comments are used as sort of
> submenus. However for the other cases, it looks kinda weird because one
> might attempt to look for the 'end of menu' for comments as well and be
> very confused.
>
> Make comments look different than menus. For the following:
> ```kconfig
> menu "Stuff"
>
> config FOO
>         def_bool y
>
> comment "Some comment"
>
> config BAR
>         def_bool n
>
> endmenu
> ```
>
> The .config will look like this:
> ```
>  #
>  # Stuff
>  #
>  CONFIG_FOO=y
>
>  ### Some comment
>  # CONFIG_BAR is not defined
>  # end of Stuff
>
> ```
>
> Signed-off-by: Ariel Marcovitch <arielmarcovitch@gmail.com>
> ---
>  scripts/kconfig/confdata.c | 14 ++++++++++----
>  1 file changed, 10 insertions(+), 4 deletions(-)
>
> diff --git a/scripts/kconfig/confdata.c b/scripts/kconfig/confdata.c
> index 9f2c22f46ee0..d3ec1ad67d92 100644
> --- a/scripts/kconfig/confdata.c
> +++ b/scripts/kconfig/confdata.c
> @@ -880,10 +880,16 @@ int conf_write(const char *name)
>
>                         if (type == P_MENU || type == P_COMMENT) {
>                                 str = menu_get_prompt(menu);
> -                               fprintf(out, "\n"
> -                                       "#\n"
> -                                       "# %s\n"
> -                                       "#\n", str);
> +
> +                               if (type == P_MENU)
> +                                       fprintf(out, "\n"
> +                                               "#\n"
> +                                               "# %s\n"
> +                                               "#\n", str);
> +                               else
> +                                       fprintf(out, "\n"
> +                                               "### %s\n", str);
> +
>                                 need_newline = false;
>                         }
>                 }
> --
> 2.25.1
>


Since "# CONFIG... is not set" looks like a comment,
I am not sure if this improves the visibility.

I will not pick up this until I find out what a really good format is.

-- 
Best Regards
Masahiro Yamada