Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorMartin Hořeňovský2022-01-02 21:19:22 +0100
committerMartin Hořeňovský2022-01-02 21:23:29 +0100
commiteeee4a49af77a51e0e870fbb9c07614bddda73f1 (patch)
treec997bc16cdc62dcd33730e51267f0dcf058cb86f /docs
parent0d1bdea69fd51739b06a69ccbac203dfecdb9e4b (diff)
downloadcatch3-eeee4a49af77a51e0e870fbb9c07614bddda73f1.tar.gz
Remove short flags from --list-tests and --list-tags
Diffstat (limited to 'docs')
-rw-r--r--docs/command-line.md25
-rw-r--r--docs/release-notes.md4
2 files changed, 20 insertions, 9 deletions
diff --git a/docs/command-line.md b/docs/command-line.md
index 20a601cb..bb43adec 100644
--- a/docs/command-line.md
+++ b/docs/command-line.md
@@ -37,8 +37,6 @@ Click one of the following links to take you straight to that option - or scroll
<a href="#specifying-which-tests-to-run"> ` <test-spec> ...`</a><br />
<a href="#usage"> ` -h, -?, --help`</a><br />
-<a href="#listing-available-tests-tags-or-reporters"> ` -l, --list-tests`</a><br />
-<a href="#listing-available-tests-tags-or-reporters"> ` -t, --list-tags`</a><br />
<a href="#showing-results-for-successful-tests"> ` -s, --success`</a><br />
<a href="#breaking-into-the-debugger"> ` -b, --break`</a><br />
<a href="#eliding-assertions-expected-to-throw"> ` -e, --nothrow`</a><br />
@@ -57,6 +55,8 @@ Click one of the following links to take you straight to that option - or scroll
</br>
+<a href="#listing-available-tests-tags-or-reporters"> ` --list-tests`</a><br />
+<a href="#listing-available-tests-tags-or-reporters"> ` --list-tags`</a><br />
<a href="#listing-available-tests-tags-or-reporters"> ` --list-reporters`</a><br />
<a href="#order"> ` --order`</a><br />
<a href="#rng-seed"> ` --rng-seed`</a><br />
@@ -175,17 +175,24 @@ Sometimes this results in a flood of failure messages and you'd rather just see
<a id="listing-available-tests-tags-or-reporters"></a>
## Listing available tests, tags or reporters
-<pre>-l, --list-tests
--t, --list-tags
+```
+--list-tests
+--list-tags
--list-reporters
-</pre>
+```
+
+> The `--list*` options became customizable through reporters in Catch2 X.Y.Z
+
+`--list-tests` lists all registered tests matching specified test spec.
+Usually this listing also includes tags, and potentially also other
+information, like source location, based on verbosity and reporter's design.
-```-l``` or ```--list-tests``` will list all registered tests, along with any tags.
-If one or more test-specs have been supplied too then only the matching tests will be listed.
+`--list-tags` lists all tags from registered tests matching specified test
+spec. Usually this also includes number of tests cases they match and
+similar information.
-```-t``` or ```--list-tags``` lists all available tags, along with the number of test cases they match. Again, supplying test specs limits the tags that match.
+`--list-reporters` lists all available reporters and their descriptions.
-```--list-reporters``` lists the available reporters.
<a id="sending-output-to-a-file"></a>
## Sending output to a file
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 85377e97..7c19c27e 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -133,6 +133,10 @@ new design.
* New pair of events were added
* One obsolete event was removed
* Catch2 generates a random seed if one hasn't been specified by the user
+* The short flag for `--list-tests`, `-l`, has been removed.
+ * This is not a commonly used flag and does not need to use up valuable single-letter space.
+* The short flag for `--list-tags`, `-t`, has been removed.
+ * This is not a commonly used flag and does not need to use up valuable single-letter space.
### Improvements