Documentation: dev-tools: Clarify requirements for result description
authorMark Brown <broonie@kernel.org>
Wed, 7 Dec 2022 13:03:02 +0000 (13:03 +0000)
committerShuah Khan <skhan@linuxfoundation.org>
Mon, 12 Dec 2022 21:13:48 +0000 (14:13 -0700)
commit054be257f28ca8eeb8e3620766501b81ceb4b293
treec29292b08c3a209264e3a27ddac0683623c6d49d
parentb11e51dd70947107fa4076c6286dce301671afc1
Documentation: dev-tools: Clarify requirements for result description

Currently the KTAP specification says that a test result line is

  <result> <number> [<description>][ # [<directive>] [<diagnostic data>]]

and the description of a test can be "any sequence of words
(can't include #)" which specifies that there may be more than
one word but does not specify anything other than those words
which might be used to separate the words which probably isn't
what we want.  Given that practically we have tests using a range
of separators for words including combinations of spaces and
combinations of other symbols like underscores or punctuation
let's just clarify that the description can contain any character
other than # (marking the start of the directive/diagnostic) or
newline (marking the end of this test result).

Signed-off-by: Mark Brown <broonie@kernel.org>
Reviewed-by: Kees Cook <keescook@chromium.org>
Reviewed-by: David Gow <davidgow@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Documentation/dev-tools/ktap.rst