linux-kernel - Re: [PATCH] selftests: Fix dangling documentation references to kselftest

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <201912071043.748BB5A6@keescook>
Date:   Sat, 7 Dec 2019 10:43:46 -0800
From:   Kees Cook <keescook@...omium.org>
To:     Michael Ellerman <mpe@...erman.id.au>
Cc:     shuahkh@....samsung.com, linux-kselftest@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] selftests: Fix dangling documentation references to
 kselftest_module.sh

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@...erman.id.au>

Whoops! Thank you! :)

Acked-by: Kees Cook <keescook@...omium.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