From: frowand.list@gmail.com
To: Jonathan Corbet <corbet@lwn.net>, David Gow <davidgow@google.com>,
Shuah Khan <skhan@linuxfoundation.org>,
Kees Cook <keescook@chromium.org>,
Tim.Bird@sony.com, Brendan Higgins <brendanhiggins@google.com>
Cc: rmr167@gmail.com, guillaume.tucker@collabora.com,
dlatypov@google.com, kernelci@groups.io,
kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [RFC PATCH 2/2] Documentation: dev-tools: use literal block instead of code-block
Date: Wed, 16 Mar 2022 15:26:22 -0500 [thread overview]
Message-ID: <20220316202622.324866-3-frowand.list@gmail.com> (raw)
In-Reply-To: <20220316202622.324866-1-frowand.list@gmail.com>
From: Frank Rowand <frank.rowand@sony.com>
KTAP Specification: Change code-block directives to straightforward
literal blocks since the blocks do not contain code.
Suggested-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Frank Rowand <frank.rowand@sony.com>
---
Documentation/dev-tools/ktap.rst | 18 ++++++++----------
1 file changed, 8 insertions(+), 10 deletions(-)
diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst
index 37b5dc61bfb8..b9a57ceddd4f 100644
--- a/Documentation/dev-tools/ktap.rst
+++ b/Documentation/dev-tools/ktap.rst
@@ -115,34 +115,32 @@ The diagnostic data field is optional, and results which have neither a
directive nor any diagnostic data do not need to include the "#" field
separator.
-Example result lines include:
-
-.. code-block:: none
+Example result lines include::
ok 1 test_case_name
The test "test_case_name" passed.
-.. code-block:: none
+::
not ok 1 test_case_name
The test "test_case_name" failed.
-.. code-block:: none
+::
ok 1 test # SKIP necessary dependency unavailable
The test "test" was SKIPPED with the diagnostic message "necessary dependency
unavailable".
-.. code-block:: none
+::
not ok 1 test # TIMEOUT 30 seconds
The test "test" timed out, with diagnostic data "30 seconds".
-.. code-block:: none
+::
ok 5 check return code # rcode=0
@@ -202,7 +200,7 @@ allowed to be either indented or not indented.
An example of a test with two nested subtests:
-.. code-block:: none
+::
KTAP version 1
1..1
@@ -215,7 +213,7 @@ An example of a test with two nested subtests:
An example format with multiple levels of nested testing:
-.. code-block:: none
+::
KTAP version 1
1..2
@@ -250,7 +248,7 @@ nested version line, uses a line of the form
Example KTAP output
--------------------
-.. code-block:: none
+::
KTAP version 1
1..1
--
Frank Rowand <frank.rowand@sony.com>
next prev parent reply other threads:[~2022-03-16 20:26 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-16 20:26 [RFC PATCH 0/2] Documentation: dev-tools: begin KTAP spec v2 process frowand.list
2022-03-16 20:26 ` [RFC PATCH 1/2] Documentation: dev-tools: KTAP spec change version to 2-rc frowand.list
2022-03-17 8:43 ` David Gow
2022-04-22 23:25 ` Frank Rowand
2022-03-16 20:26 ` frowand.list [this message]
2022-03-17 8:43 ` [RFC PATCH 2/2] Documentation: dev-tools: use literal block instead of code-block David Gow
2022-04-22 23:10 ` Frank Rowand
2022-04-28 18:35 ` Jonathan Corbet
2022-03-17 8:42 ` [RFC PATCH 0/2] Documentation: dev-tools: begin KTAP spec v2 process David Gow
2022-04-22 23:16 ` Frank Rowand
2022-04-23 7:53 ` David Gow
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=20220316202622.324866-3-frowand.list@gmail.com \
--to=frowand.list@gmail.com \
--cc=Tim.Bird@sony.com \
--cc=brendanhiggins@google.com \
--cc=corbet@lwn.net \
--cc=davidgow@google.com \
--cc=dlatypov@google.com \
--cc=guillaume.tucker@collabora.com \
--cc=keescook@chromium.org \
--cc=kernelci@groups.io \
--cc=kunit-dev@googlegroups.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=rmr167@gmail.com \
--cc=skhan@linuxfoundation.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).