From f94f1653368bf8c499fa9a6eeba81736bb2a7710 Mon Sep 17 00:00:00 2001 From: Edward Welbourne Date: Wed, 27 Jul 2022 19:02:59 +0200 Subject: Document shell-friendly data tags as best practice Also follow this best practice in testlib's own documentation and examples. Pick-to: 6.4 Change-Id: I8b57dfa8f88835adae8fceeb122a16635708e338 Reviewed-by: Paul Wicking --- src/testlib/doc/src/qttest-best-practices.qdoc | 6 +++++- src/testlib/doc/src/qttestlib-manual.qdoc | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) (limited to 'src/testlib/doc/src') diff --git a/src/testlib/doc/src/qttest-best-practices.qdoc b/src/testlib/doc/src/qttest-best-practices.qdoc index 3980b453f7..6633b07630 100644 --- a/src/testlib/doc/src/qttest-best-practices.qdoc +++ b/src/testlib/doc/src/qttest-best-practices.qdoc @@ -108,7 +108,11 @@ Do not simply number the test-case, or use bug-tracking identifiers. Someone reading the test output will have no idea what the numbers or identifiers mean. You can add a comment on the test-row that mentions the bug-tracking - identifier, when relevant. + identifier, when relevant. It's best to avoid spacing characters and + characters that may be significant to command-line shells on which you may + want to run tests. This makes it easier to specify the test and tag on \l{Qt + Test Command Line Arguments}{the command-line} to your test program - for + example, to limit a test run to just one test-case. \section2 Write Self-contained Test Functions diff --git a/src/testlib/doc/src/qttestlib-manual.qdoc b/src/testlib/doc/src/qttestlib-manual.qdoc index 3d9cfb3e3c..53ef055d2b 100644 --- a/src/testlib/doc/src/qttestlib-manual.qdoc +++ b/src/testlib/doc/src/qttestlib-manual.qdoc @@ -671,7 +671,7 @@ \li result \row \li 0 - \li all lower + \li all-lower \li "hello" \li HELLO \row @@ -681,7 +681,7 @@ \li HELLO \row \li 2 - \li all upper + \li all-upper \li "HELLO" \li HELLO \endtable -- cgit v1.2.3