Re: [PATCH] KUnit: Docs: style: fix some Kconfig example issues

From: Randy Dunlap
Date: Wed Oct 28 2020 - 18:31:54 EST


On 10/27/20 8:00 PM, David Gow wrote:
> On Wed, Oct 28, 2020 at 2:49 AM Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
>>
>> Fix the Kconfig example to be closer to Kconfig coding style.
>> (Except that it still uses spaces instead of tabs for indentation;
>> I guess that Sphinx wants it that way.)
>>
>> Also add punctuation and a trailing slash ('/') to a sub-directory
>> name -- this is how the text mostly appears in other Kconfig files.
>>
>> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>> Cc: David Gow <davidgow@xxxxxxxxxx>
>> Cc: linux-kselftest@xxxxxxxxxxxxxxx
>> Cc: kunit-dev@xxxxxxxxxxxxxxxx
>> Cc: Shuah Khan <shuah@xxxxxxxxxx>
>> Cc: Shuah Khan <skhan@xxxxxxxxxxxxxxxxxxx>
>> Cc: Brendan Higgins <brendanhiggins@xxxxxxxxxx>
>> ---
>
> Thanks for fixing this!
>
> For what it's worth, I _think_ we could get away with tabs for
> indentation in the file without Sphinx actually complaining, but it
> does annoy some of the editors, and as far as I can tell, Sphinx
> converts them back to spaces in its output. I'm far from an expert,
> though...
>
> Regardless, this is:
>
> Reviewed-by: David Gow <davidgow@xxxxxxxxxx>

I tested with tabs for indentation and it's no problem with Sphinx.
Some editors care? I am surprised. and don't much care.

I would be happy to submit a v2 using tabs for indentation.

thanks.
--
~Randy