linux-kernel - Re: [PATCH v2 12/29] kselftest.rst: do some adjustments after ReST conversion

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: Windows password security audit tool. GUI, reports in PDF.

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

Date:   Fri, 23 Jun 2017 08:04:02 -0600
From:   Shuah Khan <shuah@...nel.org>
To:     Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>
Cc:     Mauro Carvalho Chehab <mchehab@...radead.org>,
        linux-kernel@...r.kernel.org, linux-kselftest@...r.kernel.org,
        Shuah Khan <shuahkh@....samsung.com>,
        Shuah Khan <shuah@...nel.org>
Subject: Re: [PATCH v2 12/29] kselftest.rst: do some adjustments after ReST
 conversion

Hi Mauro,

On 06/17/2017 09:26 AM, Mauro Carvalho Chehab wrote:
> Do some minor adjustments after ReST conversion:
> 
> - On most documents, we use prepend a "$ " before
>   command line arguments;
> 
> - Prefer to use :: on the preceding line;
> 
> - Split a multi-paragraph description as such.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@...pensource.com>

Looks good to me. I can take this through linux-kselftest or here is
my Ack for it to go through the doc tree with the rest in this series.

Acked-by: Shuah Khan <shuahkh@....samsung.com>

thanks,
-- Shuah

> ---
>  Documentation/dev-tools/kselftest.rst | 32 ++++++++++++++++----------------
>  1 file changed, 16 insertions(+), 16 deletions(-)
> 
> diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
> index b3861500c42d..ebd03d11d2c2 100644
> --- a/Documentation/dev-tools/kselftest.rst
> +++ b/Documentation/dev-tools/kselftest.rst
> @@ -19,15 +19,15 @@ Running the selftests (hotplug tests are run in limited mode)
>  
>  To build the tests::
>  
> -    make -C tools/testing/selftests
> +  $ make -C tools/testing/selftests
>  
>  To run the tests::
>  
> -    make -C tools/testing/selftests run_tests
> +  $ make -C tools/testing/selftests run_tests
>  
>  To build and run the tests with a single command, use::
>  
> -    make kselftest
> +  $ make kselftest
>  
>  Note that some tests will require root privileges.
>  
> @@ -40,11 +40,11 @@ single test to run, or a list of tests to run.
>  
>  To run only tests targeted for a single subsystem::
>  
> -    make -C tools/testing/selftests TARGETS=ptrace run_tests
> +  $ make -C tools/testing/selftests TARGETS=ptrace run_tests
>  
>  You can specify multiple tests to build and run::
>  
> -    make TARGETS="size timers" kselftest
> +  $  make TARGETS="size timers" kselftest
>  
>  See the top-level tools/testing/selftests/Makefile for the list of all
>  possible targets.
> @@ -55,11 +55,11 @@ Running the full range hotplug selftests
>  
>  To build the hotplug tests::
>  
> -    make -C tools/testing/selftests hotplug
> +  $ make -C tools/testing/selftests hotplug
>  
>  To run the hotplug tests::
>  
> -    make -C tools/testing/selftests run_hotplug
> +  $ make -C tools/testing/selftests run_hotplug
>  
>  Note that some tests will require root privileges.
>  
> @@ -73,13 +73,13 @@ location.
>  
>  To install selftests in default location::
>  
> -    cd tools/testing/selftests
> -    ./kselftest_install.sh
> +   $ cd tools/testing/selftests
> +   $ ./kselftest_install.sh
>  
>  To install selftests in a user specified location::
>  
> -    cd tools/testing/selftests
> -    ./kselftest_install.sh install_dir
> +   $ cd tools/testing/selftests
> +   $ ./kselftest_install.sh install_dir
>  
>  Running installed selftests
>  ===========================
> @@ -88,12 +88,10 @@ Kselftest install as well as the Kselftest tarball provide a script
>  named "run_kselftest.sh" to run the tests.
>  
>  You can simply do the following to run the installed Kselftests. Please
> -note some tests will require root privileges.
> +note some tests will require root privileges::
>  
> -::
> -
> -    cd kselftest
> -    ./run_kselftest.sh
> +   $ cd kselftest
> +   $ ./run_kselftest.sh
>  
>  Contributing new tests
>  ======================
> @@ -114,8 +112,10 @@ Contributing new tests (details)
>  
>   * Use TEST_GEN_XXX if such binaries or files are generated during
>     compiling.
> +
>     TEST_PROGS, TEST_GEN_PROGS mean it is the excutable tested by
>     default.
> +
>     TEST_PROGS_EXTENDED, TEST_GEN_PROGS_EXTENDED mean it is the
>     executable which is not tested by default.
>     TEST_FILES, TEST_GEN_FILES mean it is the file which is used by
>