* [PATCH] KUnit: Docs: style: fix some Kconfig example issues
@ 2020-10-27 18:49 Randy Dunlap
2020-10-28 3:00 ` David Gow
0 siblings, 1 reply; 4+ messages in thread
From: Randy Dunlap @ 2020-10-27 18:49 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, David Gow, linux-kselftest, kunit-dev, Shuah Khan,
Shuah Khan, Brendan Higgins
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>
---
Documentation/dev-tools/kunit/style.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
--- linux-next-20201027.orig/Documentation/dev-tools/kunit/style.rst
+++ linux-next-20201027/Documentation/dev-tools/kunit/style.rst
@@ -180,12 +180,12 @@ An example Kconfig entry:
depends on KUNIT
default KUNIT_ALL_TESTS
help
- This builds unit tests for foo.
+ This builds unit tests for foo.
- For more information on KUnit and unit tests in general, please refer
- to the KUnit documentation in Documentation/dev-tools/kunit
+ For more information on KUnit and unit tests in general, please refer
+ to the KUnit documentation in Documentation/dev-tools/kunit/.
- If unsure, say N
+ If unsure, say N.
Test File and Module Names
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] KUnit: Docs: style: fix some Kconfig example issues
2020-10-27 18:49 [PATCH] KUnit: Docs: style: fix some Kconfig example issues Randy Dunlap
@ 2020-10-28 3:00 ` David Gow
2020-10-28 5:32 ` Randy Dunlap
0 siblings, 1 reply; 4+ messages in thread
From: David Gow @ 2020-10-28 3:00 UTC (permalink / raw)
To: Randy Dunlap
Cc: Linux Kernel Mailing List, open list:KERNEL SELFTEST FRAMEWORK,
KUnit Development, Shuah Khan, Shuah Khan, Brendan Higgins
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>
-- David
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] KUnit: Docs: style: fix some Kconfig example issues
2020-10-28 3:00 ` David Gow
@ 2020-10-28 5:32 ` Randy Dunlap
2020-10-28 5:56 ` David Gow
0 siblings, 1 reply; 4+ messages in thread
From: Randy Dunlap @ 2020-10-28 5:32 UTC (permalink / raw)
To: David Gow
Cc: Linux Kernel Mailing List, open list:KERNEL SELFTEST FRAMEWORK,
KUnit Development, Shuah Khan, Shuah Khan, Brendan Higgins
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] KUnit: Docs: style: fix some Kconfig example issues
2020-10-28 5:32 ` Randy Dunlap
@ 2020-10-28 5:56 ` David Gow
0 siblings, 0 replies; 4+ messages in thread
From: David Gow @ 2020-10-28 5:56 UTC (permalink / raw)
To: Randy Dunlap
Cc: Linux Kernel Mailing List, open list:KERNEL SELFTEST FRAMEWORK,
KUnit Development, Shuah Khan, Shuah Khan, Brendan Higgins
On Wed, Oct 28, 2020 at 1:32 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> 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.
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
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2020-10-29 1:22 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-10-27 18:49 [PATCH] KUnit: Docs: style: fix some Kconfig example issues Randy Dunlap
2020-10-28 3:00 ` David Gow
2020-10-28 5:32 ` Randy Dunlap
2020-10-28 5:56 ` David Gow
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.