Subject: Re: [PATCH 0/2] kconfig: Improve comment blocks in the .config file
To:     Boris Kolpackov <boris@codesynthesis.com>
Cc:     masahiroy@kernel.org, linux-kbuild@vger.kernel.org,
        linux-kernel@vger.kernel.org
References: <20211213100043.45645-1-arielmarcovitch@gmail.com>
 <boris.20211213134416@codesynthesis.com>
From:   Ariel Marcovitch <arielmarcovitch@gmail.com>
Message-ID: <599d09db-f565-fe93-0c70-809c59461ff2@gmail.com>
Date:   Tue, 14 Dec 2021 10:27:22 +0200
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101
 Thunderbird/78.13.0
MIME-Version: 1.0
In-Reply-To: <boris.20211213134416@codesynthesis.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: 7bit
Content-Language: en-US
Precedence: bulk

On 13/12/2021 13:47, Boris Kolpackov wrote:
> Ariel Marcovitch <arielmarcovitch@gmail.com> writes:
>
>> The format for comment blocks in the second patch is a suggestion. I
>> realize some people will think the '###' prefix is distasteful. I'm open
>> to other options as well, I just couldn't think of a better option that
>> starts with '#', looks different from a menu and can't be confused with
>> a disabled config.
> Maybe instead of decorating the comment, it makes sense to decorate
> (and improve, while at it) the menu? Something along these lines:
>
> #-
> # Foo
> #
>
> CONFIG_FOO=y
>
> # Comment.
>
> # CONFIG_BAR is not defined
>
> #
> # Foo
> #-
>
> I also don't think a command is likely to confused with disabled option.

I mean that a comment like this - "CONFIG_FOO is not defined" will be 
considered by kconfig as a config, rather than a comment. Apart from 
this theoretical case which is not really likely to happen, making a 
comment only one line and similar to other lines that start with '#' 
really decreases the visibility of these comments.

As for the other suggestions, I think a bigger change will be even 
harder for people to accept, but I will leave it to the people to decide.

Thanks for the feedback!

- Ariel Marcovitch