lkml.org 
[lkml]   [2020]   [Oct]   [28]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH] KUnit: Docs: style: fix some Kconfig example issues
From
Date
On 10/27/20 8:00 PM, David Gow wrote:
> On Wed, Oct 28, 2020 at 2:49 AM Randy Dunlap <rdunlap@infradead.org> 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@infradead.org>
>> Cc: David Gow <davidgow@google.com>
>> Cc: linux-kselftest@vger.kernel.org
>> Cc: kunit-dev@googlegroups.com
>> Cc: Shuah Khan <shuah@kernel.org>
>> Cc: Shuah Khan <skhan@linuxfoundation.org>
>> Cc: Brendan Higgins <brendanhiggins@google.com>
>> ---
>
> 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@google.com>

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

\
 
 \ /
  Last update: 2020-10-28 23:32    [W:0.447 / U:0.020 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site