2018-06-29 13:12:23

by Anders Roxell

[permalink] [raw]
Subject: [PATCH] doc: dev-tools: kselftest.rst: update contributing new tests

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 <[email protected]>
---
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
+ then config file in the same directory where the test is added.
+
Test Harness
============

--
2.18.0



2018-06-29 14:17:13

by Shuah Khan

[permalink] [raw]
Subject: Re: [PATCH] doc: dev-tools: kselftest.rst: update contributing new tests

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 <[email protected]>
> ---
> 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
> ============
>
>


2018-06-29 14:19:52

by Anders Roxell

[permalink] [raw]
Subject: Re: [PATCH] doc: dev-tools: kselftest.rst: update contributing new tests

On Fri, 29 Jun 2018 at 14:10, Shuah Khan <[email protected]> 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 <[email protected]>
> > ---
> > 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
> > ============
> >
> >
>

2018-06-29 14:21:02

by Anders Roxell

[permalink] [raw]
Subject: [PATCH v2] doc: dev-tools: kselftest.rst: update contributing new tests

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 <[email protected]>
---
Documentation/dev-tools/kselftest.rst | 5 +++++
1 file changed, 5 insertions(+)

diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
index 3bf371a938d0..6f653acea248 100644
--- a/Documentation/dev-tools/kselftest.rst
+++ b/Documentation/dev-tools/kselftest.rst
@@ -156,6 +156,11 @@ Contributing new tests (details)
installed by the distro on the system should be the primary focus to be able
to find regressions.

+ * 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
============

--
2.18.0


2018-06-29 14:26:37

by Shuah Khan

[permalink] [raw]
Subject: Re: [PATCH v2] doc: dev-tools: kselftest.rst: update contributing new tests

On 06/29/2018 06:52 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 <[email protected]>
> ---
> Documentation/dev-tools/kselftest.rst | 5 +++++
> 1 file changed, 5 insertions(+)
>
> diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
> index 3bf371a938d0..6f653acea248 100644
> --- a/Documentation/dev-tools/kselftest.rst
> +++ b/Documentation/dev-tools/kselftest.rst
> @@ -156,6 +156,11 @@ Contributing new tests (details)
> installed by the distro on the system should be the primary focus to be able
> to find regressions.
>
> + * 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
> ============
>
>
Thanks. Looks good to me.

Reviewed-by: Shuah Khan (Samsung OSG) <[email protected]>


thanks,
-- Shuah



2018-06-29 18:15:14

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH v2] doc: dev-tools: kselftest.rst: update contributing new tests

On Fri, 29 Jun 2018 14:52:01 +0200
Anders Roxell <[email protected]> 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 <[email protected]>

Applied, thanks.

jon