|
1 | | -Hello rtcheck! |
2 | | -//============================================================================== |
3 | | -pluginval |
4 | | -JUCE v8.0.10 |
5 | | - |
6 | | -Description: |
7 | | - Validate plugins to test compatibility with hosts and verify plugin API conformance |
8 | | - |
9 | | -Usage: |
10 | | - --version |
11 | | - Print pluginval version. |
12 | | - --validate [pathToPlugin] |
13 | | - Validates the plugin at the given path. |
14 | | - N.B. the "--validate" flag is optional if the path is the last argument. |
15 | | - This enables you to validate a plugin with simply "pluginval path_to_plugin". |
16 | | - |
17 | | - --sample-rates [list of comma separated sample rates] |
18 | | - If specified, sets the list of sample rates at which tests will be executed |
19 | | - (default=44100,48000,96000) |
20 | | - --block-sizes [list of comma separated block sizes] |
21 | | - If specified, sets the list of block sizes at which tests will be executed |
22 | | - (default=64,128,256,512,1024) |
23 | | - --random-seed [hex or int] |
24 | | - Sets the random seed to use for the tests. Useful for replicating test |
25 | | - environments. |
26 | | - --data-file [pathToFile] |
27 | | - If specified, sets a path to a data file which can be used by tests to |
28 | | - configure themselves. This can be useful for things like known audio output. |
29 | | - |
30 | | - --strictness-level [1-10] |
31 | | - Sets the strictness level to use. A minimum level of 5 (also the default) |
32 | | - is recomended for compatibility. |
33 | | - Higher levels include longer, more thorough tests such as fuzzing. |
34 | | - --timeout-ms [numMilliseconds] |
35 | | - Sets a timout which will stop validation with an error if no output from any |
36 | | - test has happened for this number of ms. |
37 | | - By default this is 30s but can be set to "-1" (must be quoted) to never timeout. |
38 | | - --rtcheck [empty, disabled, enabled or relaxed] |
39 | | - Turns on real-time saftey checks using rtcheck (macOS and Linux only). |
40 | | - relaxed mode doesn't run the checks for the first processing block as a lot of plugins |
41 | | - use this to allocate or initialise thread-locals (which can allocate) |
42 | | - |
43 | | - --repeat [num repeats] |
44 | | - If specified repeats the tests a given number of times. Note that this does |
45 | | - not delete and re-instantiate the plugin for each repeat. |
46 | | - --randomise |
47 | | - If specified, the tests are run in a random order per repeat. |
48 | | - |
49 | | - --skip-gui-tests |
50 | | - If specified, avoids tests that create GUI windows, which can cause problems |
51 | | - on headless CI systems. |
52 | | - --disabled-tests [pathToFile] |
53 | | - If specified, sets a path to a file that should have the names of disabled |
54 | | - tests on each row. |
55 | | - --vst3validator [pathToValidator] |
56 | | - If specified, this will run the VST3 validator as part of the test process. |
57 | | - |
58 | | - --output-dir [pathToDir] |
59 | | - If specified, sets a directory to store the log files. This can be useful |
60 | | - for continuous integration. |
61 | | - --output-filename [filename] |
62 | | - If specified, sets a filename for the log files (within 'output-dir' or |
63 | | - (lacking that) the current directory. |
64 | | - By default, the name is constructed from the plugin metainformation |
65 | | - --verbose |
66 | | - If specified, outputs additional logging information. It can be useful to |
67 | | - turn this off when building with CI to avoid huge log files. |
68 | | - |
69 | | -Exit code: |
| 1 | +Usage: pluginval [OPTIONS...] |
| 2 | +Validate plugins to test compatibility with hosts and verify plugin API conformance |
| 3 | + |
| 4 | +Examples: |
| 5 | + |
| 6 | + pluginval --strictness-level 5 --validate path/to/plugin |
| 7 | + pluginval path/to/plugin |
| 8 | + pluginval --config settings.json --validate path/to/plugin |
| 9 | + |
| 10 | +Options: |
| 11 | + |
| 12 | + --validate=VALUE Validates the plugin at the given path (or AU id). Optional if the path is the last argument. |
| 13 | + --strictness-level=VALUE |
| 14 | + Strictness level 1-10 (default 5, minimum 5 recommended). |
| 15 | + --random-seed=VALUE Random seed (hex 0x.. or int) for replicable test runs. |
| 16 | + --timeout-ms=VALUE Test timeout in ms (default 30000, -1 to never timeout). |
| 17 | + --repeat=VALUE Number of times to repeat the tests. |
| 18 | + --randomise Run the tests in a random order per repeat. |
| 19 | + --verbose Output additional logging information. |
| 20 | + --skip-gui-tests Avoid tests that create GUI windows (for headless CI). |
| 21 | + --sample-rates=VALUE Comma-separated sample rates (default 44100,48000,96000). |
| 22 | + --block-sizes=VALUE Comma-separated block sizes (default 64,128,256,512,1024). |
| 23 | + --data-file=VALUE Path to a data file tests can use to configure themselves. |
| 24 | + --output-dir=VALUE Directory in which to write the log files. |
| 25 | + --output-filename=VALUE Filename to write logs into. |
| 26 | + --disabled-tests=VALUE Comma-separated test names, or a path to a file listing them. |
| 27 | + --rtcheck=VALUE Real-time safety checks: disabled, enabled or relaxed. |
| 28 | + --config=VALUE Path to a JSON file of settings (overridden by env vars and CLI options). |
| 29 | + |
| 30 | + -?, --help show this message |
| 31 | + --version print program version |
| 32 | + |
| 33 | +Other commands: |
| 34 | + --version Print the pluginval version. |
| 35 | + --run-tests Run the internal unit tests. |
| 36 | + --strictness-help [level] List all tests that run at the given strictness level. |
| 37 | + |
| 38 | +Exit code: |
70 | 39 | 0 if all tests complete successfully |
71 | 40 | 1 if there are any errors |
72 | 41 |
|
73 | 42 | Additionally, you can specify any of the command line options as environment |
74 | 43 | variables by removing prefix dashes, converting internal dashes to underscores |
75 | | -and capitalising all letters, a.g. |
| 44 | +and capitalising all letters, e.g. |
76 | 45 | "--skip-gui-tests" > "SKIP_GUI_TESTS=1" |
77 | 46 | "--timeout-ms 30000" > "TIMEOUT_MS=30000" |
78 | | -Specifying specific command-line options will override any environment variables |
79 | | -set for that option. |
80 | | - |
81 | | - pluginval --version Prints the current version number |
82 | | - pluginval --help|-h Prints the list of commands |
83 | | - pluginval --validate [pathToPlugin] Validates the file (or IDs for AUs). |
84 | | - pluginval --run-tests Runs the internal unit tests. |
| 47 | +Precedence is command-line options > environment variables > --config file. |
85 | 48 |
|
0 commit comments