Skip to content

Commit

Permalink
Make documentation up-2-date wrt. help information (#540)
Browse files Browse the repository at this point in the history
* Make documentation up-2-date wrt. help information

Fixes nunit/nunit#3433

* fix(linter): Remove trailing space

* Update NUnitLite-Options.md

@mikkelbu See how this seems to you.

* Update NUnitLite-Options.md

Fix lint errors

Co-authored-by: CharliePoole <charliepoole@gmail.com> b442069
  • Loading branch information
SeanKilleen committed Jan 10, 2021
1 parent 843349c commit effea66
Show file tree
Hide file tree
Showing 4 changed files with 375 additions and 350 deletions.
49 changes: 37 additions & 12 deletions articles/nunit/running-tests/NUnitLite-Options.html
Expand Up @@ -105,12 +105,16 @@ <h1 id="nunitlite-options">NUnitLite Options</h1>
<td>File PATH containing a list of tests to run, one per line. This option may be repeated.</td>
</tr>
<tr>
<td><code>--include=CATEGORIES</code></td>
<td>Test CATEGORIES to be included. May be a single category, a comma-separated list of categories or a category expression.</td>
<td><code>--prefilter=NAMES</code></td>
<td>Comma-separated list of NAMES of test classes or namespaces to be loaded. This option may be repeated.</td>
</tr>
<tr>
<td><code>--exclude=CATEGORIES</code></td>
<td>Test CATEGORIES to be excluded. May be a single category, a comma-separated list of categories or a category expression.</td>
<td><code>--where=EXPRESSION</code></td>
<td>Test selection EXPRESSION indicating what tests will be run.</td>
</tr>
<tr>
<td><code>--params, -p=VALUE</code></td>
<td>Define a test parameter.</td>
</tr>
<tr>
<td><code>--timeout=MILLISECONDS</code></td>
Expand All @@ -122,7 +126,7 @@ <h1 id="nunitlite-options">NUnitLite Options</h1>
</tr>
<tr>
<td><code>--workers=NUMBER</code></td>
<td>Specify the NUMBER of worker threads to be used in running tests.</td>
<td>Specify the NUMBER of worker threads to be used in running tests. If not specified, defaults to 2 or the number of processors, whichever is greater.</td>
</tr>
<tr>
<td><code>--stoponerror</code></td>
Expand All @@ -134,7 +138,7 @@ <h1 id="nunitlite-options">NUnitLite Options</h1>
</tr>
<tr>
<td><code>--work=PATH</code></td>
<td>PATH of the directory to use for output files.</td>
<td>PATH of the directory to use for output files. If not specified, defaults to the current directory.</td>
</tr>
<tr>
<td><code>--output</code>, <code>--out=PATH</code></td>
Expand All @@ -161,14 +165,18 @@ <h1 id="nunitlite-options">NUnitLite Options</h1>
<td>Specify whether to write test case names to the output. Values: <code>Off</code>, <code>On</code>, <code>All</code></td>
</tr>
<tr>
<td><code>--trace=LEVEL</code></td>
<td>Set internal trace LEVEL. Values: <code>Off</code>, <code>Error</code>, <code>Warning</code>, <code>Info</code>, <code>Verbose</code> (Debug)</td>
<td><code>--test-name-format=VALUE</code></td>
<td>Non-standard naming pattern to use in generating test names.</td>
</tr>
<tr>
<td><code>--teamcity</code></td>
<td>Turns on use of TeamCity service messages.</td>
</tr>
<tr>
<td><code>--trace=LEVEL</code></td>
<td>Set internal trace LEVEL. Values: <code>Off</code>, <code>Error</code>, <code>Warning</code>, <code>Info</code>, <code>Verbose</code> (Debug)</td>
</tr>
<tr>
<td><code>--noheader</code>, <code>--noh</code></td>
<td>Suppress display of program information at start of run.</td>
</tr>
Expand All @@ -177,20 +185,37 @@ <h1 id="nunitlite-options">NUnitLite Options</h1>
<td>Displays console output without color.</td>
</tr>
<tr>
<td><code>--verbose</code>, <code>-v</code></td>
<td>Display additional information as the test runs.</td>
</tr>
<tr>
<td><code>--help</code>, <code>-h</code></td>
<td>Display this message and exit.</td>
</tr>
<tr>
<td><code>--version</code>, <code>-V</code></td>
<td>Display the header and exit.</td>
</tr>
</tbody>
</table>
<h2 id="description">Description</h2>
<p>By default, this command runs the tests contained in the
assemblies and projects specified. If the <code>--explore</code> option
is used, no tests are executed but a description of the tests
is saved in the specified or default format.</p>
<h2 id="test-selection">Test Selection</h2>
<p>Several options allow selection of a subset of the tests in an
assembly for execution or display.</p>
<p>The <code>--prefilter</code> option operates first. If specified, it
limits the classes, which NUnit will examine to find tests.
Classes not included are simply ignored and the other two
selection options never even see them.</p>
<p>The <code>--where</code> option introduces a <em>where clause</em>, the most flexible
but also the most complex way to introduce tests. See the documentation of
<a href="https://docs.nunit.org/articles/nunit/running-tests/Test-Selection-Language.html">Test SelectionLanguage</a>
for details.</p>
<p>The <code>--test</code> and <code>testlist</code> options allow selecting individual
tests by name. The list of tests selected is joined to any <code>--where</code>
clause you provide by a logical <code>and</code> operation. That is, if both
<code>--test</code> and <code>--where</code> are specified, <strong>both</strong> must be satisfied by
a test in order for it to run.</p>
<h2 id="xml-output">XML Output</h2>
<p>Several options that specify processing of XML output take
an output specification as a value. A SPEC may take one of
the following forms:</p>
Expand Down
2 changes: 1 addition & 1 deletion index.json
Expand Up @@ -202,7 +202,7 @@
"articles/nunit/running-tests/NUnitLite-Options.html": {
"href": "articles/nunit/running-tests/NUnitLite-Options.html",
"title": "NUnitLite Options | NUnit Docs",
"keywords": "NUnitLite Options The NUnitLite runner is invoked by executing the test program. If desired, any of the following options may be specified: Option Description --test=NAMES Comma-separated list of NAMES of tests to run or explore. This option may be repeated. --testlist=PATH File PATH containing a list of tests to run, one per line. This option may be repeated. --include=CATEGORIES Test CATEGORIES to be included. May be a single category, a comma-separated list of categories or a category expression. --exclude=CATEGORIES Test CATEGORIES to be excluded. May be a single category, a comma-separated list of categories or a category expression. --timeout=MILLISECONDS Set timeout for each test case in MILLISECONDS. --seed=SEED Set the random SEED used to generate test cases. --workers=NUMBER Specify the NUMBER of worker threads to be used in running tests. --stoponerror Stop run immediately upon any test failure or error. --wait Wait for input before closing console window. --work=PATH PATH of the directory to use for output files. --output , --out=PATH File PATH to contain text output from the tests. --err=PATH File PATH to contain error output from the tests. --result=SPEC An output SPEC for saving the test results. This option may be repeated. --explore[=SPEC] Display or save test info rather than running tests. Optionally provide an output SPEC for saving the test info. This option may be repeated. --noresult Don't save any test results. --labels=VALUE Specify whether to write test case names to the output. Values: Off , On , All --trace=LEVEL Set internal trace LEVEL. Values: Off , Error , Warning , Info , Verbose (Debug) --teamcity Turns on use of TeamCity service messages. --noheader , --noh Suppress display of program information at start of run. --nocolor , --noc Displays console output without color. --verbose , -v Display additional information as the test runs. --help , -h Display this message and exit. Description By default, this command runs the tests contained in the assemblies and projects specified. If the --explore option is used, no tests are executed but a description of the tests is saved in the specified or default format. Several options that specify processing of XML output take an output specification as a value. A SPEC may take one of the following forms: --OPTION:filename --OPTION:filename;format=formatname --OPTION:filename;transform=xsltfile The --result option may use any of the following formats: nunit3 - the native XML format for NUnit 3.0 nunit2 - legacy XML format used by earlier releases of NUnit The --explore option may use any of the following formats: nunit3 - the native XML format for NUnit 3.0 cases - a text file listing the full names of all test cases. If --explore is used without any specification following, a list of test cases is output to the console. If none of the options ( --result , --explore , --noxml ) is used, NUnit saves the results to TestResult.xml in nunit3 format. Any transforms provided must handle input in the native nunit3 format."
"keywords": "NUnitLite Options The NUnitLite runner is invoked by executing the test program. If desired, any of the following options may be specified: Option Description --test=NAMES Comma-separated list of NAMES of tests to run or explore. This option may be repeated. --testlist=PATH File PATH containing a list of tests to run, one per line. This option may be repeated. --prefilter=NAMES Comma-separated list of NAMES of test classes or namespaces to be loaded. This option may be repeated. --where=EXPRESSION Test selection EXPRESSION indicating what tests will be run. --params, -p=VALUE Define a test parameter. --timeout=MILLISECONDS Set timeout for each test case in MILLISECONDS. --seed=SEED Set the random SEED used to generate test cases. --workers=NUMBER Specify the NUMBER of worker threads to be used in running tests. If not specified, defaults to 2 or the number of processors, whichever is greater. --stoponerror Stop run immediately upon any test failure or error. --wait Wait for input before closing console window. --work=PATH PATH of the directory to use for output files. If not specified, defaults to the current directory. --output , --out=PATH File PATH to contain text output from the tests. --err=PATH File PATH to contain error output from the tests. --result=SPEC An output SPEC for saving the test results. This option may be repeated. --explore[=SPEC] Display or save test info rather than running tests. Optionally provide an output SPEC for saving the test info. This option may be repeated. --noresult Don't save any test results. --labels=VALUE Specify whether to write test case names to the output. Values: Off , On , All --test-name-format=VALUE Non-standard naming pattern to use in generating test names. --teamcity Turns on use of TeamCity service messages. --trace=LEVEL Set internal trace LEVEL. Values: Off , Error , Warning , Info , Verbose (Debug) --noheader , --noh Suppress display of program information at start of run. --nocolor , --noc Displays console output without color. --help , -h Display this message and exit. --version , -V Display the header and exit. Description By default, this command runs the tests contained in the assemblies and projects specified. If the --explore option is used, no tests are executed but a description of the tests is saved in the specified or default format. Test Selection Several options allow selection of a subset of the tests in an assembly for execution or display. The --prefilter option operates first. If specified, it limits the classes, which NUnit will examine to find tests. Classes not included are simply ignored and the other two selection options never even see them. The --where option introduces a where clause , the most flexible but also the most complex way to introduce tests. See the documentation of Test SelectionLanguage for details. The --test and testlist options allow selecting individual tests by name. The list of tests selected is joined to any --where clause you provide by a logical and operation. That is, if both --test and --where are specified, both must be satisfied by a test in order for it to run. XML Output Several options that specify processing of XML output take an output specification as a value. A SPEC may take one of the following forms: --OPTION:filename --OPTION:filename;format=formatname --OPTION:filename;transform=xsltfile The --result option may use any of the following formats: nunit3 - the native XML format for NUnit 3.0 nunit2 - legacy XML format used by earlier releases of NUnit The --explore option may use any of the following formats: nunit3 - the native XML format for NUnit 3.0 cases - a text file listing the full names of all test cases. If --explore is used without any specification following, a list of test cases is output to the console. If none of the options ( --result , --explore , --noxml ) is used, NUnit saves the results to TestResult.xml in nunit3 format. Any transforms provided must handle input in the native nunit3 format."
},
"articles/nunit/running-tests/NUnitLite-Runner.html": {
"href": "articles/nunit/running-tests/NUnitLite-Runner.html",
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Expand Up @@ -1496,7 +1496,7 @@
"output": {
".html": {
"relative_path": "articles/nunit/running-tests/NUnitLite-Options.html",
"hash": "/aU8xHrV2G2kaBzcQ46J9w=="
"hash": "IEB9aGdOXYL9vr12m5O/5Q=="
}
},
"is_incremental": false,
Expand Down

0 comments on commit effea66

Please sign in to comment.