Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1651557

[PATCH v5 5/7] Documentation/dev-tools: Use reStructuredText markups for kselftest

From Mickaël Salaün <mic@digikod.net>
Newsgroups linux.kernel
Subject [PATCH v5 5/7] Documentation/dev-tools: Use reStructuredText markups for kselftest
Date 2017-05-26 20:50 +0200
Message-ID <tLstc-115-19@gated-at.bofh.it> (permalink)
References <tLstb-115-1@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw

Include and convert kselftest to the Sphinx format.

Changes since v2:
* lighten the modifications (suggested by Kees Cook)

Signed-off-by: Mickaël Salaün <mic@digikod.net>
Acked-by: Kees Cook <keescook@chromium.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <shuah@kernel.org>
---
 Documentation/dev-tools/index.rst     |  1 +
 Documentation/dev-tools/kselftest.rst | 67 +++++++++++++++++++++--------------
 2 files changed, 41 insertions(+), 27 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..9232ce94612c 100644
--- a/Documentation/dev-tools/kselftest.rst
+++ b/Documentation/dev-tools/kselftest.rst
@@ -1,4 +1,6 @@
+======================
 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
@@ -15,29 +17,34 @@ 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
+To build the tests::
 
+    make -C tools/testing/selftests
 
-To run the tests:
-  $ make -C tools/testing/selftests run_tests
+To run the tests::
 
-To build and run the tests with a single command, use:
-  $ make kselftest
+    make -C tools/testing/selftests run_tests
 
-- note that some tests will require root privileges.
+To build and run the tests with a single command, use::
+
+    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
+To run only tests targeted for a single subsystem::
 
-You can specify multiple tests to build and run:
-  $  make TARGETS="size timers" kselftest
+    make -C tools/testing/selftests TARGETS=ptrace run_tests
+
+You can specify multiple tests to build and run::
+
+    make TARGETS="size timers" kselftest
 
 See the top-level tools/testing/selftests/Makefile for the list of all
 possible targets.
@@ -46,13 +53,15 @@ possible targets.
 Running the full range hotplug selftests
 ========================================
 
-To build the hotplug tests:
-  $ make -C tools/testing/selftests hotplug
+To build the hotplug tests::
 
-To run the hotplug tests:
-  $ make -C tools/testing/selftests run_hotplug
+    make -C tools/testing/selftests hotplug
 
-- note that some tests will require root privileges.
+To run the hotplug tests::
+
+    make -C tools/testing/selftests run_hotplug
+
+Note that some tests will require root privileges.
 
 
 Install selftests
@@ -62,13 +71,15 @@ 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
+To install selftests in default location::
 
-To install selftests in a user specified location:
-   $ cd tools/testing/selftests
-   $ ./kselftest_install.sh install_dir
+    cd tools/testing/selftests
+    ./kselftest_install.sh
+
+To install selftests in a user specified location::
+
+    cd tools/testing/selftests
+    ./kselftest_install.sh install_dir
 
 Running installed selftests
 ===========================
@@ -79,8 +90,10 @@ 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
+::
+
+    cd kselftest
+    ./run_kselftest.sh
 
 Contributing new tests
 ======================
@@ -96,8 +109,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

Back to linux.kernel | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

[PATCH v5 0/7] Add kselftest_harness.h Mickaël Salaün <mic@digikod.net> - 2017-05-26 20:50 +0200
  [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness documentation Mickaël Salaün <mic@digikod.net> - 2017-05-26 20:50 +0200
    Re: [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness documentation Kees Cook <keescook@chromium.org> - 2017-05-26 21:10 +0200
    Re: [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness  documentation Shuah Khan <shuah@kernel.org> - 2017-06-02 22:10 +0200
      Re: [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness  documentation Mickaël Salaün <mic@digikod.net> - 2017-06-03 13:20 +0200
        Re: [PATCH v5 7/7] Documentation/dev-tools: Add kselftest_harness  documentation Shuah Khan <shuah@kernel.org> - 2017-06-05 20:30 +0200
  [PATCH v5 4/7] Documentation/dev-tools: Add kselftest Mickaël Salaün <mic@digikod.net> - 2017-05-26 20:50 +0200
  [PATCH v5 1/7] selftests: Make test_harness.h more generally available Mickaël Salaün <mic@digikod.net> - 2017-05-26 20:50 +0200
  [PATCH v5 2/7] selftests: Cosmetic renames in kselftest_harness.h Mickaël Salaün <mic@digikod.net> - 2017-05-26 20:50 +0200
  [PATCH v5 5/7] Documentation/dev-tools: Use reStructuredText markups for kselftest Mickaël Salaün <mic@digikod.net> - 2017-05-26 20:50 +0200
  [PATCH v5 3/7] selftests/seccomp: Force rebuild according to dependencies Mickaël Salaün <mic@digikod.net> - 2017-05-26 20:50 +0200
    Re: [PATCH v5 3/7] selftests/seccomp: Force rebuild according to  dependencies Shuah Khan <shuah@kernel.org> - 2017-06-02 21:40 +0200
      Re: [PATCH v5 3/7] selftests/seccomp: Force rebuild according to  dependencies Mickaël Salaün <mic@digikod.net> - 2017-06-03 13:20 +0200
        Re: [PATCH v5 3/7] selftests/seccomp: Force rebuild according to  dependencies Shuah Khan <shuah@kernel.org> - 2017-06-05 20:20 +0200
  [PATCH v5 6/7] selftests: Remove the TEST_API() wrapper from kselftest_harness.h Mickaël Salaün <mic@digikod.net> - 2017-05-26 20:50 +0200
    Re: [PATCH v5 6/7] selftests: Remove the TEST_API() wrapper from kselftest_harness.h Kees Cook <keescook@chromium.org> - 2017-05-26 21:10 +0200
  Re: [PATCH v5 0/7] Add kselftest_harness.h Kees Cook <keescook@chromium.org> - 2017-05-26 21:20 +0200
    Re: [PATCH v5 0/7] Add kselftest_harness.h Shuah Khan <shuah@kernel.org> - 2017-05-30 23:40 +0200

csiph-web