linux-kselftest.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] selftests: Fix dangling documentation references to kselftest_module.sh
@ 2019-12-06  3:17 Michael Ellerman
  2019-12-07 18:43 ` Kees Cook
  0 siblings, 1 reply; 3+ messages in thread
From: Michael Ellerman @ 2019-12-06  3:17 UTC (permalink / raw)
  To: shuahkh; +Cc: linux-kselftest, keescook, linux-kernel

Commit c78fd76f2b67 ("selftests: Move kselftest_module.sh into
kselftest/") moved kselftest_module.sh but missed updating a few
references to the path in documentation.

Fixes: c78fd76f2b67 ("selftests: Move kselftest_module.sh into kselftest/")
Signed-off-by: Michael Ellerman <mpe@ellerman.id.au>
---
 Documentation/dev-tools/kselftest.rst       | 8 ++++----
 tools/testing/selftests/kselftest/module.sh | 2 +-
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
index ecdfdc9d4b03..61ae13c44f91 100644
--- a/Documentation/dev-tools/kselftest.rst
+++ b/Documentation/dev-tools/kselftest.rst
@@ -203,12 +203,12 @@ Test Module
 Kselftest tests the kernel from userspace.  Sometimes things need
 testing from within the kernel, one method of doing this is to create a
 test module.  We can tie the module into the kselftest framework by
-using a shell script test runner.  ``kselftest_module.sh`` is designed
+using a shell script test runner.  ``kselftest/module.sh`` is designed
 to facilitate this process.  There is also a header file provided to
 assist writing kernel modules that are for use with kselftest:
 
 - ``tools/testing/kselftest/kselftest_module.h``
-- ``tools/testing/kselftest/kselftest_module.sh``
+- ``tools/testing/kselftest/kselftest/module.sh``
 
 How to use
 ----------
@@ -247,7 +247,7 @@ Example Module
 
    #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 
-   #include "../tools/testing/selftests/kselftest_module.h"
+   #include "../tools/testing/selftests/kselftest/module.h"
 
    KSTM_MODULE_GLOBALS();
 
@@ -276,7 +276,7 @@ Example test script
 
     #!/bin/bash
     # SPDX-License-Identifier: GPL-2.0+
-    $(dirname $0)/../kselftest_module.sh "foo" test_foo
+    $(dirname $0)/../kselftest/module.sh "foo" test_foo
 
 
 Test Harness
diff --git a/tools/testing/selftests/kselftest/module.sh b/tools/testing/selftests/kselftest/module.sh
index 18e1c7992d30..fb4733faff12 100755
--- a/tools/testing/selftests/kselftest/module.sh
+++ b/tools/testing/selftests/kselftest/module.sh
@@ -9,7 +9,7 @@
 #
 #   #!/bin/sh
 #   SPDX-License-Identifier: GPL-2.0+
-#   $(dirname $0)/../kselftest_module.sh "description" module_name
+#   $(dirname $0)/../kselftest/module.sh "description" module_name
 #
 # Example: tools/testing/selftests/lib/printf.sh
 
-- 
2.21.0


^ permalink raw reply related	[flat|nested] 3+ messages in thread
* Re: [PATCH] selftests: Fix dangling documentation references to kselftest_module.sh
  2019-12-06  3:17 [PATCH] selftests: Fix dangling documentation references to kselftest_module.sh Michael Ellerman
@ 2019-12-07 18:43 ` Kees Cook
  2019-12-11 17:17   ` shuah
  0 siblings, 1 reply; 3+ messages in thread
From: Kees Cook @ 2019-12-07 18:43 UTC (permalink / raw)
  To: Michael Ellerman; +Cc: shuahkh, linux-kselftest, linux-kernel

On Fri, Dec 06, 2019 at 02:17:38PM +1100, Michael Ellerman wrote:
> Commit c78fd76f2b67 ("selftests: Move kselftest_module.sh into
> kselftest/") moved kselftest_module.sh but missed updating a few
> references to the path in documentation.
> 
> Fixes: c78fd76f2b67 ("selftests: Move kselftest_module.sh into kselftest/")
> Signed-off-by: Michael Ellerman <mpe@ellerman.id.au>

Whoops! Thank you! :)

Acked-by: Kees Cook <keescook@chromium.org>

-Kees

> ---
>  Documentation/dev-tools/kselftest.rst       | 8 ++++----
>  tools/testing/selftests/kselftest/module.sh | 2 +-
>  2 files changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
> index ecdfdc9d4b03..61ae13c44f91 100644
> --- a/Documentation/dev-tools/kselftest.rst
> +++ b/Documentation/dev-tools/kselftest.rst
> @@ -203,12 +203,12 @@ Test Module
>  Kselftest tests the kernel from userspace.  Sometimes things need
>  testing from within the kernel, one method of doing this is to create a
>  test module.  We can tie the module into the kselftest framework by
> -using a shell script test runner.  ``kselftest_module.sh`` is designed
> +using a shell script test runner.  ``kselftest/module.sh`` is designed
>  to facilitate this process.  There is also a header file provided to
>  assist writing kernel modules that are for use with kselftest:
>  
>  - ``tools/testing/kselftest/kselftest_module.h``
> -- ``tools/testing/kselftest/kselftest_module.sh``
> +- ``tools/testing/kselftest/kselftest/module.sh``
>  
>  How to use
>  ----------
> @@ -247,7 +247,7 @@ Example Module
>  
>     #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
>  
> -   #include "../tools/testing/selftests/kselftest_module.h"
> +   #include "../tools/testing/selftests/kselftest/module.h"
>  
>     KSTM_MODULE_GLOBALS();
>  
> @@ -276,7 +276,7 @@ Example test script
>  
>      #!/bin/bash
>      # SPDX-License-Identifier: GPL-2.0+
> -    $(dirname $0)/../kselftest_module.sh "foo" test_foo
> +    $(dirname $0)/../kselftest/module.sh "foo" test_foo
>  
>  
>  Test Harness
> diff --git a/tools/testing/selftests/kselftest/module.sh b/tools/testing/selftests/kselftest/module.sh
> index 18e1c7992d30..fb4733faff12 100755
> --- a/tools/testing/selftests/kselftest/module.sh
> +++ b/tools/testing/selftests/kselftest/module.sh
> @@ -9,7 +9,7 @@
>  #
>  #   #!/bin/sh
>  #   SPDX-License-Identifier: GPL-2.0+
> -#   $(dirname $0)/../kselftest_module.sh "description" module_name
> +#   $(dirname $0)/../kselftest/module.sh "description" module_name
>  #
>  # Example: tools/testing/selftests/lib/printf.sh
>  
> -- 
> 2.21.0
> 

-- 
Kees Cook

^ permalink raw reply	[flat|nested] 3+ messages in thread
* Re: [PATCH] selftests: Fix dangling documentation references to kselftest_module.sh
  2019-12-07 18:43 ` Kees Cook
@ 2019-12-11 17:17   ` shuah
  0 siblings, 0 replies; 3+ messages in thread
From: shuah @ 2019-12-11 17:17 UTC (permalink / raw)
  To: Kees Cook, Michael Ellerman; +Cc: linux-kselftest, linux-kernel, shuah

On 12/7/19 11:43 AM, Kees Cook wrote:
> On Fri, Dec 06, 2019 at 02:17:38PM +1100, Michael Ellerman wrote:
>> Commit c78fd76f2b67 ("selftests: Move kselftest_module.sh into
>> kselftest/") moved kselftest_module.sh but missed updating a few
>> references to the path in documentation.
>>
>> Fixes: c78fd76f2b67 ("selftests: Move kselftest_module.sh into kselftest/")
>> Signed-off-by: Michael Ellerman <mpe@ellerman.id.au>
> 
> Whoops! Thank you! :)
> 
> Acked-by: Kees Cook <keescook@chromium.org>
> 
> -Kees
> 
>> ---
>>   Documentation/dev-tools/kselftest.rst       | 8 ++++----
>>   tools/testing/selftests/kselftest/module.sh | 2 +-
>>   2 files changed, 5 insertions(+), 5 deletions(-)
>>
>> diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
>> index ecdfdc9d4b03..61ae13c44f91 100644
>> --- a/Documentation/dev-tools/kselftest.rst
>> +++ b/Documentation/dev-tools/kselftest.rst
>> @@ -203,12 +203,12 @@ Test Module
>>   Kselftest tests the kernel from userspace.  Sometimes things need
>>   testing from within the kernel, one method of doing this is to create a
>>   test module.  We can tie the module into the kselftest framework by
>> -using a shell script test runner.  ``kselftest_module.sh`` is designed
>> +using a shell script test runner.  ``kselftest/module.sh`` is designed
>>   to facilitate this process.  There is also a header file provided to
>>   assist writing kernel modules that are for use with kselftest:
>>   
>>   - ``tools/testing/kselftest/kselftest_module.h``
>> -- ``tools/testing/kselftest/kselftest_module.sh``
>> +- ``tools/testing/kselftest/kselftest/module.sh``
>>   
>>   How to use
>>   ----------
>> @@ -247,7 +247,7 @@ Example Module
>>   
>>      #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
>>   
>> -   #include "../tools/testing/selftests/kselftest_module.h"
>> +   #include "../tools/testing/selftests/kselftest/module.h"
>>   
>>      KSTM_MODULE_GLOBALS();
>>   
>> @@ -276,7 +276,7 @@ Example test script
>>   
>>       #!/bin/bash
>>       # SPDX-License-Identifier: GPL-2.0+
>> -    $(dirname $0)/../kselftest_module.sh "foo" test_foo
>> +    $(dirname $0)/../kselftest/module.sh "foo" test_foo
>>   
>>   
>>   Test Harness
>> diff --git a/tools/testing/selftests/kselftest/module.sh b/tools/testing/selftests/kselftest/module.sh
>> index 18e1c7992d30..fb4733faff12 100755
>> --- a/tools/testing/selftests/kselftest/module.sh
>> +++ b/tools/testing/selftests/kselftest/module.sh
>> @@ -9,7 +9,7 @@
>>   #
>>   #   #!/bin/sh
>>   #   SPDX-License-Identifier: GPL-2.0+
>> -#   $(dirname $0)/../kselftest_module.sh "description" module_name
>> +#   $(dirname $0)/../kselftest/module.sh "description" module_name
>>   #
>>   # Example: tools/testing/selftests/lib/printf.sh
>>   
>> -- 
>> 2.21.0
>>
> 

Thanks. Pulling it into fixes for next 5.5-rc

-- Shuah

^ permalink raw reply	[flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-12-11 17:17 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-12-06  3:17 [PATCH] selftests: Fix dangling documentation references to kselftest_module.sh Michael Ellerman
2019-12-07 18:43 ` Kees Cook
2019-12-11 17:17   ` shuah

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