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

Groups > linux.kernel > #1668329

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

From Mauro Carvalho Chehab <mchehab@s-opensource.com>
Newsgroups linux.kernel
Subject [PATCH v2 12/29] kselftest.rst: do some adjustments after ReST conversion
Date 2017-06-17 17:40 +0200
Message-ID <tTnZq-Cs-93@gated-at.bofh.it> (permalink)
References <tTnPH-y3-13@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw

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@s-opensource.com>
---
 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
-- 
2.9.4

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

Thread

[PATCH v2 01/29] IPMI.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 15/29] lzo.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 20/29] men-chameleon-bus.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 05/29] IRQ.txt: add a markup for its title Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 09/29] kobject.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 25/29] padata.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 22/29] nommu-mmap.txt: don't use all upper case on titles Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 18/29] memory-barriers.txt: use literals for variables Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 29/29] pi-futex.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 11/29] kref.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 02/29] IRQ-affinity.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 19/29] memory-hotplug.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 21/29] nommu-mmap.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 27/29] percpu-rw-semaphore.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 28/29] phy.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 23/29] ntb.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 24/29] numastat.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 03/29] IRQ-domain.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 12/29] kselftest.rst: do some adjustments after ReST conversion Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:40 +0200
  [PATCH v2 14/29] lockup-watchdogs.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:50 +0200
  Re: [PATCH v2 01/29] IPMI.txt: standardize document format Corey Minyard <minyard@acm.org> - 2017-06-17 17:50 +0200

csiph-web