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

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

[Anders Roxell]

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

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

[Shuah Khan]

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

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

[Anders Roxell]

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

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

[Anders Roxell]

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 | 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

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

[Shuah Khan]

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 <anders.roxell@linaro.org>
> ---
>  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) <shuah@kernel.org>


thanks,
-- Shuah

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

[Jonathan Corbet]

On Fri, 29 Jun 2018 14:52:01 +0200
Anders Roxell <anders.roxell@linaro.org> 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>

Applied, thanks.

jon

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

[Shuah Khan]

On 04/17/2018 02:46 AM, Anders Roxell wrote:
> Add a description that the kernel headers should be used as far as it is
> possible and then the system headers.
> 
> 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 e80850eefe13..27f08d6ba91c 100644
> --- a/Documentation/dev-tools/kselftest.rst
> +++ b/Documentation/dev-tools/kselftest.rst
> @@ -151,6 +151,9 @@ Contributing new tests (details)
>     TEST_FILES, TEST_GEN_FILES mean it is the file which is used by
>     test.
>  
> + * First use the headers inside the kernel, and then the system headers. The
> +   internal headers should be the primary focus to be able to find regressions.

Clarifying the location of the headers might be helpful. This description uses
different terminology to describe kernel headers.

"First use the headers inside the kernel sources and/or git reo" would make this
clear. Instead of "internal headers" headers for the kernel release as opposed
to headers installed by the distro on the system would make a clear distinction.

thanks,
-- Shuah

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

[Anders Roxell]

Add a description that the kernel headers should be used as far as it is
possible and then the system headers.

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 e80850eefe13..27f08d6ba91c 100644
--- a/Documentation/dev-tools/kselftest.rst
+++ b/Documentation/dev-tools/kselftest.rst
@@ -151,6 +151,9 @@ Contributing new tests (details)
    TEST_FILES, TEST_GEN_FILES mean it is the file which is used by
    test.
 
+ * First use the headers inside the kernel, and then the system headers. The
+   internal headers should be the primary focus to be able to find regressions.
+
 Test Harness
 ============
 
-- 
2.11.0