Re: [PATCH] KUnit: Docs: style: fix some Kconfig example issues
On Wed, Oct 28, 2020 at 1:32 PM Randy Dunlap wrote:
>
> On 10/27/20 8:00 PM, David Gow wrote:
> > On Wed, Oct 28, 2020 at 2:49 AM Randy Dunlap 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
> >> Cc: David Gow
> >> Cc: linux-kselft...@vger.kernel.org
> >> Cc: kunit-...@googlegroups.com
> >> Cc: Shuah Khan
> >> Cc: Shuah Khan
> >> Cc: Brendan Higgins
> >> ---
> >
> > 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
>
> I tested with tabs for indentation and it's no problem with Sphinx.
> Some editors care? I am surprised. and don't much care.
Neat!
As for editors, I think it was just some aggressively set per-filetype
defaults, so I'm not particularly concerned either.
> I would be happy to submit a v2 using tabs for indentation.
That sounds good to me if it works, thanks!
Cheers,
-- David
Re: [PATCH] KUnit: Docs: style: fix some Kconfig example issues
On 10/27/20 8:00 PM, David Gow wrote:
> On Wed, Oct 28, 2020 at 2:49 AM Randy Dunlap 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
>> Cc: David Gow
>> Cc: linux-kselft...@vger.kernel.org
>> Cc: kunit-...@googlegroups.com
>> Cc: Shuah Khan
>> Cc: Shuah Khan
>> Cc: Brendan Higgins
>> ---
>
> 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
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
Re: [PATCH] KUnit: Docs: style: fix some Kconfig example issues
On Wed, Oct 28, 2020 at 2:49 AM Randy Dunlap 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
> Cc: David Gow
> Cc: linux-kselft...@vger.kernel.org
> Cc: kunit-...@googlegroups.com
> Cc: Shuah Khan
> Cc: Shuah Khan
> Cc: Brendan Higgins
> ---
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
-- David
