LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH] doc: dev-tools: kselftest.rst: update contributing new tests
@ 2018-04-17  8:46 Anders Roxell
  2018-04-18 14:48 ` Shuah Khan
  2018-04-19 10:28 ` [PATCH v2] " Anders Roxell
  0 siblings, 2 replies; 8+ messages in thread
From: Anders Roxell @ 2018-04-17  8:46 UTC (permalink / raw)
  To: shuah, corbet; +Cc: linux-kselftest, linux-doc, linux-kernel, 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


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH] doc: dev-tools: kselftest.rst: update contributing new tests
  2018-04-17  8:46 [PATCH] doc: dev-tools: kselftest.rst: update contributing new tests Anders Roxell
@ 2018-04-18 14:48 ` Shuah Khan
  2018-04-19 10:28 ` [PATCH v2] " Anders Roxell
  1 sibling, 0 replies; 8+ messages in thread
From: Shuah Khan @ 2018-04-18 14:48 UTC (permalink / raw)
  To: Anders Roxell, corbet
  Cc: linux-kselftest, linux-doc, linux-kernel, Shuah Khan, 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

^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH v2] doc: dev-tools: kselftest.rst: update contributing new tests
  2018-04-17  8:46 [PATCH] doc: dev-tools: kselftest.rst: update contributing new tests Anders Roxell
  2018-04-18 14:48 ` Shuah Khan
@ 2018-04-19 10:28 ` Anders Roxell
  2018-04-24 19:35   ` Shuah Khan
  2018-04-27 22:56   ` Jonathan Corbet
  1 sibling, 2 replies; 8+ messages in thread
From: Anders Roxell @ 2018-04-19 10:28 UTC (permalink / raw)
  To: shuah, corbet; +Cc: linux-kselftest, linux-doc, linux-kernel, 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 | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
index e80850eefe13..3bf371a938d0 100644
--- a/Documentation/dev-tools/kselftest.rst
+++ b/Documentation/dev-tools/kselftest.rst
@@ -151,6 +151,11 @@ 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 source and/or git repo, and then the
+   system headers.  Headers for the kernel release as opposed to headers
+   installed by the distro on the system should be the primary focus to be able
+   to find regressions.
+
 Test Harness
 ============
 
-- 
2.11.0


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH v2] doc: dev-tools: kselftest.rst: update contributing new tests
  2018-04-19 10:28 ` [PATCH v2] " Anders Roxell
@ 2018-04-24 19:35   ` Shuah Khan
  2018-04-27 22:56   ` Jonathan Corbet
  1 sibling, 0 replies; 8+ messages in thread
From: Shuah Khan @ 2018-04-24 19:35 UTC (permalink / raw)
  To: Anders Roxell, corbet
  Cc: linux-kselftest, linux-doc, linux-kernel, Shuah Khan

On 04/19/2018 04:28 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 | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
> index e80850eefe13..3bf371a938d0 100644
> --- a/Documentation/dev-tools/kselftest.rst
> +++ b/Documentation/dev-tools/kselftest.rst
> @@ -151,6 +151,11 @@ 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 source and/or git repo, and then the
> +   system headers.  Headers for the kernel release as opposed to headers
> +   installed by the distro on the system should be the primary focus to be able
> +   to find regressions.
> +
>  Test Harness
>  ============
>  
> 

Here is my reviewed by for this to go through documentation tree.

Reviewed-by: Shuah Khan (Samsung OSG) <shuah@kernel.org>

thanks,
-- Shuah


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH v2] doc: dev-tools: kselftest.rst: update contributing new tests
  2018-04-19 10:28 ` [PATCH v2] " Anders Roxell
  2018-04-24 19:35   ` Shuah Khan
@ 2018-04-27 22:56   ` Jonathan Corbet
  1 sibling, 0 replies; 8+ messages in thread
From: Jonathan Corbet @ 2018-04-27 22:56 UTC (permalink / raw)
  To: Anders Roxell; +Cc: shuah, linux-kselftest, linux-doc, linux-kernel

On Thu, 19 Apr 2018 12:28:25 +0200
Anders Roxell <anders.roxell@linaro.org> 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>

Applied, thanks.

jon

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH] doc: dev-tools: kselftest.rst: update contributing new tests
  2018-06-29 12:09 ` Shuah Khan
@ 2018-06-29 12:47   ` Anders Roxell
  0 siblings, 0 replies; 8+ messages in thread
From: Anders Roxell @ 2018-06-29 12:47 UTC (permalink / raw)
  To: Shuah Khan
  Cc: Jonathan Corbet, open list:KERNEL SELFTEST FRAMEWORK, linux-doc,
	Linux Kernel Mailing List

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

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH] doc: dev-tools: kselftest.rst: update contributing new tests
  2018-06-29 10:02 [PATCH] " Anders Roxell
@ 2018-06-29 12:09 ` Shuah Khan
  2018-06-29 12:47   ` Anders Roxell
  0 siblings, 1 reply; 8+ messages in thread
From: Shuah Khan @ 2018-06-29 12:09 UTC (permalink / raw)
  To: Anders Roxell, corbet
  Cc: linux-kselftest, linux-doc, linux-kernel, 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
>  ============
>  
> 


^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH] doc: dev-tools: kselftest.rst: update contributing new tests
@ 2018-06-29 10:02 Anders Roxell
  2018-06-29 12:09 ` Shuah Khan
  0 siblings, 1 reply; 8+ messages in thread
From: Anders Roxell @ 2018-06-29 10:02 UTC (permalink / raw)
  To: shuah, corbet; +Cc: linux-kselftest, linux-doc, linux-kernel, 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


^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2018-06-29 12:48 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-04-17  8:46 [PATCH] doc: dev-tools: kselftest.rst: update contributing new tests Anders Roxell
2018-04-18 14:48 ` Shuah Khan
2018-04-19 10:28 ` [PATCH v2] " Anders Roxell
2018-04-24 19:35   ` Shuah Khan
2018-04-27 22:56   ` Jonathan Corbet
2018-06-29 10:02 [PATCH] " Anders Roxell
2018-06-29 12:09 ` Shuah Khan
2018-06-29 12:47   ` Anders Roxell

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).