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

Message ID 20180417084631.11242-1-anders.roxell@linaro.org
State Superseded
Headers show
Series
  • doc: dev-tools: kselftest.rst: update contributing new tests
Related show

Commit Message

Anders Roxell April 17, 2018, 8:46 a.m.
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(+)

-- 
2.11.0

Comments

Shuah Khan April 18, 2018, 2:48 p.m. | #1
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

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