diff mbox series

doc: dev-tools: kselftest.rst: update contributing new tests

Message ID 20180629100248.11560-1-anders.roxell@linaro.org
State Accepted
Commit 8ab1416a6d51a6cbc4875b496f01f70dc43612f8
Headers show
Series doc: dev-tools: kselftest.rst: update contributing new tests | expand

Commit Message

Anders Roxell June 29, 2018, 10:02 a.m. UTC
Add a description that kernel config options should be added into a
config file that is placed next to the newly added test.

Signed-off-by: Anders Roxell <anders.roxell@linaro.org>

---
 Documentation/dev-tools/kselftest.rst | 3 +++
 1 file changed, 3 insertions(+)

-- 
2.18.0

Comments

Shuah June 29, 2018, 12:09 p.m. UTC | #1
On 06/29/2018 04:02 AM, Anders Roxell wrote:
> Add a description that kernel config options should be added into a

> config file that is placed next to the newly added test.

> 

> Signed-off-by: Anders Roxell <anders.roxell@linaro.org>

> ---

>  Documentation/dev-tools/kselftest.rst | 3 +++

>  1 file changed, 3 insertions(+)

> 

> diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst

> index 3bf371a938d0..4c546a35bd58 100644

> --- a/Documentation/dev-tools/kselftest.rst

> +++ b/Documentation/dev-tools/kselftest.rst

> @@ -156,6 +156,9 @@ Contributing new tests (details)

>     installed by the distro on the system should be the primary focus to be able

>     to find regressions.

>  

> + * If a new test needs specific kernel options, they should be enabled in


get rid of new

> +   then config file in the same directory where the test is added.


"the config" instead of "then config"

Rephrasing this might be better:

"If a test needs specific kernel config options enabled, add a config file in the
test directory to enable them.

e.g: tools/testing/selftests/android/ion/config

> +

>  Test Harness

>  ============

>  

>
Anders Roxell June 29, 2018, 12:47 p.m. UTC | #2
On Fri, 29 Jun 2018 at 14:10, Shuah Khan <shuah@kernel.org> wrote:
>

> On 06/29/2018 04:02 AM, Anders Roxell wrote:

> > Add a description that kernel config options should be added into a

> > config file that is placed next to the newly added test.

> >

> > Signed-off-by: Anders Roxell <anders.roxell@linaro.org>

> > ---

> >  Documentation/dev-tools/kselftest.rst | 3 +++

> >  1 file changed, 3 insertions(+)

> >

> > diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst

> > index 3bf371a938d0..4c546a35bd58 100644

> > --- a/Documentation/dev-tools/kselftest.rst

> > +++ b/Documentation/dev-tools/kselftest.rst

> > @@ -156,6 +156,9 @@ Contributing new tests (details)

> >     installed by the distro on the system should be the primary focus to be able

> >     to find regressions.

> >

> > + * If a new test needs specific kernel options, they should be enabled in

>

> get rid of new

>

> > +   then config file in the same directory where the test is added.

>

> "the config" instead of "then config"

>

> Rephrasing this might be better:

>

> "If a test needs specific kernel config options enabled, add a config file in the

> test directory to enable them.

>

> e.g: tools/testing/selftests/android/ion/config


I like it. sending v2 shortly.

Thank you.

Cheers,
Anders

>

> > +

> >  Test Harness

> >  ============

> >

> >

>
diff mbox series

Patch

diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
index 3bf371a938d0..4c546a35bd58 100644
--- a/Documentation/dev-tools/kselftest.rst
+++ b/Documentation/dev-tools/kselftest.rst
@@ -156,6 +156,9 @@  Contributing new tests (details)
    installed by the distro on the system should be the primary focus to be able
    to find regressions.
 
+ * If a new test needs specific kernel options, they should be enabled in
+   then config file in the same directory where the test is added.
+
 Test Harness
 ============