diff options
| author | Boris Kolpackov <boris@codesynthesis.com> | 2019-06-05 11:53:26 +0200 |
|---|---|---|
| committer | Boris Kolpackov <boris@codesynthesis.com> | 2019-06-05 11:53:26 +0200 |
| commit | 35b8ccc4379cda9188e5e2e415f6639d06a6fa47 (patch) | |
| tree | cc1678388267e02405b520c3465bce312eea879a /doc | |
| parent | 2a335eb05de3d26eb131a2112b7fcc2124def3b7 (diff) | |
Tighten allowed character set in testscript test ids
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/testscript.cli | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/testscript.cli b/doc/testscript.cli index e84dffd..41f8111 100644 --- a/doc/testscript.cli +++ b/doc/testscript.cli @@ -268,10 +268,13 @@ The description lines precede the test command. They start with a colon : ... \ + + The recommended format for \c{<id>} is \c{<keyword>-<keyword>...} with at least two keywords. The id is used in diagnostics, to name the test working -directory, as well as to run individual tests. The recommended style for -\c{<summary>} is that of the \c{git(1)} commit summary. The detailed +directory, as well as to run individual tests. It can only contain +alphanumeric characters as well as underscores and minuses. The recommended +style for \c{<summary>} is that of the \c{git(1)} commit summary. The detailed description is free-form. Here are some examples (\c{#} starts a comment): \ |