linux-kernel - [PATCH v2 5/6] Documentation/dev-tools: Use reStructuredText markups for 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]
Date:   Wed,  3 May 2017 00:26:40 +0200
From:   Mickaël Salaün <mic@...ikod.net>
To:     linux-kernel@...r.kernel.org
Cc:     Mickaël Salaün <mic@...ikod.net>,
        Andy Lutomirski <luto@...capital.net>,
        Jonathan Corbet <corbet@....net>,
        Kees Cook <keescook@...omium.org>,
        Shuah Khan <shuah@...nel.org>, Will Drewry <wad@...omium.org>,
        linux-doc@...r.kernel.org, linux-kselftest@...r.kernel.org
Subject: [PATCH v2 5/6] Documentation/dev-tools: Use reStructuredText markups for kselftest

Include and convert kselftest to the Sphinx format.

Signed-off-by: Mickaël Salaün <mic@...ikod.net>
Cc: Jonathan Corbet <corbet@....net>
Cc: Shuah Khan <shuah@...nel.org>
---
 Documentation/dev-tools/index.rst     |  1 +
 Documentation/dev-tools/kselftest.rst | 77 ++++++++++++++++++++++++-----------
 2 files changed, 55 insertions(+), 23 deletions(-)

diff --git a/Documentation/dev-tools/index.rst b/Documentation/dev-tools/index.rst
index 07d881147ef3..e50054c6aeaa 100644
--- a/Documentation/dev-tools/index.rst
+++ b/Documentation/dev-tools/index.rst
@@ -23,6 +23,7 @@ whole; patches welcome!
    kmemleak
    kmemcheck
    gdb-kernel-debugging
+   kselftest
 
 
 .. only::  subproject and html
diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
index 5bd590335839..39af2cb3d248 100644
--- a/Documentation/dev-tools/kselftest.rst
+++ b/Documentation/dev-tools/kselftest.rst
@@ -1,4 +1,5 @@
 Linux Kernel Selftests
+======================
 
 The kernel contains a set of "self tests" under the tools/testing/selftests/
 directory. These are intended to be small tests to exercise individual code
@@ -13,65 +14,93 @@ run on a single cpu as opposed to all hotplug capable cpus, and memory
 hotplug test is run on 2% of hotplug capable memory instead of 10%.
 
 Running the selftests (hotplug tests are run in limited mode)
-=============================================================
+-------------------------------------------------------------
 
 To build the tests:
-  $ make -C tools/testing/selftests
+
+.. code-block:: sh
+
+    make -C tools/testing/selftests
 
 
 To run the tests:
-  $ make -C tools/testing/selftests run_tests
+
+.. code-block:: sh
+
+    make -C tools/testing/selftests run_tests
 
 To build and run the tests with a single command, use:
-  $ make kselftest
 
-- note that some tests will require root privileges.
+.. code-block:: sh
+
+    make kselftest
+
+Note that some tests will require root privileges.
 
 
 Running a subset of selftests
-========================================
+-----------------------------
+
 You can use the "TARGETS" variable on the make command line to specify
 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
+
+.. code-block:: sh
+
+    make -C tools/testing/selftests TARGETS=ptrace run_tests
 
 You can specify multiple tests to build and run:
-  $  make TARGETS="size timers" kselftest
+
+.. code-block:: sh
+
+    make TARGETS="size timers" kselftest
 
 See the top-level tools/testing/selftests/Makefile for the list of all
 possible targets.
 
 
 Running the full range hotplug selftests
-========================================
+----------------------------------------
 
 To build the hotplug tests:
-  $ make -C tools/testing/selftests hotplug
+
+.. code-block:: sh
+
+    make -C tools/testing/selftests hotplug
 
 To run the hotplug tests:
-  $ make -C tools/testing/selftests run_hotplug
 
-- note that some tests will require root privileges.
+.. code-block:: sh
+
+    make -C tools/testing/selftests run_hotplug
+
+Note that some tests will require root privileges.
 
 
 Install selftests
-=================
+-----------------
 
 You can use kselftest_install.sh tool installs selftests in default
 location which is tools/testing/selftests/kselftest or a user specified
 location.
 
 To install selftests in default location:
-   $ cd tools/testing/selftests
-   $ ./kselftest_install.sh
+
+.. code-block:: 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
+
+.. code-block:: sh
+
+    cd tools/testing/selftests
+    ./kselftest_install.sh install_dir
 
 Running installed selftests
-===========================
+---------------------------
 
 Kselftest install as well as the Kselftest tarball provide a script
 named "run_kselftest.sh" to run the tests.
@@ -79,11 +108,13 @@ 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.
 
-cd kselftest
-./run_kselftest.sh
+.. code-block:: sh
+
+    cd kselftest
+    ./run_kselftest.sh
 
 Contributing new tests
-======================
+----------------------
 
 In general, the rules for selftests are
 
@@ -96,8 +127,8 @@ In general, the rules for selftests are
  * Don't cause the top-level "make run_tests" to fail if your feature is
    unconfigured.
 
-Contributing new tests(details)
-===============================
+Contributing new tests (details)
+--------------------------------
 
  * Use TEST_GEN_XXX if such binaries or files are generated during
    compiling.
-- 
2.11.0