| Message ID | 20221207130302.129026-1-broonie@kernel.org (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 054be257f28ca8eeb8e3620766501b81ceb4b293 |
| Headers | show |
| Series | [RESEND] Documentation: dev-tools: Clarify requirements for result description | expand |
On Wed, Dec 7, 2022 at 9:03 PM Mark Brown <broonie@kernel.org> wrote: > > 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> > --- +CC Rae Moar I've added this to the list of patches we want to take for the kselftest/kunit branch. If someone else wants to take it (kselftest, Documentation), let me know and I'll remove it from the list. Cheers, -- David > Documentation/dev-tools/ktap.rst | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst > index d0a9565b0f44..414c105b10a9 100644 > --- a/Documentation/dev-tools/ktap.rst > +++ b/Documentation/dev-tools/ktap.rst > @@ -80,8 +80,8 @@ have the number 1 and the number then must increase by 1 for each additional > subtest within the same test at the same nesting level. > > The description is a description of the test, generally the name of > -the test, and can be any string of words (can't include #). The > -description is optional, but recommended. > +the test, and can be any string of characters other than # or a > +newline. The description is optional, but recommended. > > The directive and any diagnostic data is optional. If either are present, they > must follow a hash sign, "#". > -- > 2.30.2 >
diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst index d0a9565b0f44..414c105b10a9 100644 --- a/Documentation/dev-tools/ktap.rst +++ b/Documentation/dev-tools/ktap.rst @@ -80,8 +80,8 @@ have the number 1 and the number then must increase by 1 for each additional subtest within the same test at the same nesting level. The description is a description of the test, generally the name of -the test, and can be any string of words (can't include #). The -description is optional, but recommended. +the test, and can be any string of characters other than # or a +newline. The description is optional, but recommended. The directive and any diagnostic data is optional. If either are present, they must follow a hash sign, "#".