| Message ID | 20201028174218.11750-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | Accepted |
| Delegated to: | Shuah Khan |
| Headers | show |
| Series | [v2] KUnit: Docs: style: fix some Kconfig example issues | expand |
On Thu, Oct 29, 2020 at 1:42 AM Randy Dunlap <rdunlap@infradead.org> wrote: > > Fix the Kconfig example to be closer to Kconfig coding style. > > 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> > Reviewed-by: David Gow <davidgow@google.com> > --- > v2: covert spaces indentation to tabs in Kconfig example > Thanks! Sphinx is still converting the tabs to spaces for its HTML output, but this is nevertheless an improvement. Cheers, -- David
--- linux-next-20201027.orig/Documentation/dev-tools/kunit/style.rst +++ linux-next-20201027/Documentation/dev-tools/kunit/style.rst @@ -175,17 +175,17 @@ An example Kconfig entry: .. code-block:: none - config FOO_KUNIT_TEST - tristate "KUnit test for foo" if !KUNIT_ALL_TESTS - depends on KUNIT - default KUNIT_ALL_TESTS - help - This builds unit tests for foo. + config FOO_KUNIT_TEST + tristate "KUnit test for foo" if !KUNIT_ALL_TESTS + depends on KUNIT + default KUNIT_ALL_TESTS + help + 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
Fix the Kconfig example to be closer to Kconfig coding style. 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> Reviewed-by: David Gow <davidgow@google.com> --- v2: covert spaces indentation to tabs in Kconfig example Documentation/dev-tools/kunit/style.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)