All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Shuah Khan <shuah@kernel.org>,
	linux-kselftest@vger.kernel.org
Subject: [PATCH v2 12/29] kselftest.rst: do some adjustments after ReST conversion
Date: Sat, 17 Jun 2017 12:26:40 -0300	[thread overview]
Message-ID: <eb20c298db29f7d57baac38d5376a61ae827bb90.1497713210.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <2932e5ece623ed990b6c3b80174df270278dc314.1497713210.git.mchehab@s-opensource.com>
In-Reply-To: <2932e5ece623ed990b6c3b80174df270278dc314.1497713210.git.mchehab@s-opensource.com>

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

  parent reply	other threads:[~2017-06-17 15:39 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-06-17 15:26 [PATCH v2 01/29] IPMI.txt: standardize document format Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 02/29] IRQ-affinity.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 03/29] IRQ-domain.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 04/29] irqflags-tracing.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 05/29] IRQ.txt: add a markup for its title Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 06/29] isapnp.txt: promote title level Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 07/29] isa.txt: standardize document format Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 08/29] kernel-per-CPU-kthreads.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 09/29] kobject.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 10/29] kprobes.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 11/29] kref.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` Mauro Carvalho Chehab [this message]
2017-06-23 14:04   ` [PATCH v2 12/29] kselftest.rst: do some adjustments after ReST conversion Shuah Khan
2017-06-23 21:32     ` Mauro Carvalho Chehab
2017-06-24  0:47       ` Shuah Khan
2017-06-25 19:35         ` Jonathan Corbet
2017-06-26 16:30           ` Shuah Khan
2017-06-17 15:26 ` [PATCH v2 13/29] ldm.txt: standardize document format Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 14/29] lockup-watchdogs.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 15/29] lzo.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 16/29] mailbox.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 17/29] memory-barriers.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 18/29] memory-barriers.txt: use literals for variables Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 19/29] memory-hotplug.txt: standardize document format Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 20/29] men-chameleon-bus.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 21/29] nommu-mmap.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 22/29] nommu-mmap.txt: don't use all upper case on titles Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 23/29] ntb.txt: standardize document format Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 24/29] numastat.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 25/29] padata.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 26/29] parport-lowlevel.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 27/29] percpu-rw-semaphore.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 28/29] phy.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 29/29] pi-futex.txt: " Mauro Carvalho Chehab
2017-06-17 15:46 ` [PATCH v2 01/29] IPMI.txt: " Corey Minyard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=eb20c298db29f7d57baac38d5376a61ae827bb90.1497713210.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=mchehab@infradead.org \
    --cc=shuah@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.