Skip to content

Commit c18fba2

Browse files
committed
add docs about flag conflicts
1 parent 59403ab commit c18fba2

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

commands.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,8 @@ $ solana-test-suite run-tests [OPTIONS]
230230
* `-r, --randomize-output-buffer`: Randomizes bytes in output buffer before shared library execution
231231
* `-c, --chunk-size INTEGER`: Number of test results per file [default: 10000]
232232
* `-v, --verbose`: Verbose output: log failed test cases
233-
* `-c, --consensus-mode`: Only fail on consensus failures. One such effect is to normalize error codes when comparing results
234-
* `-cb, --core-bpf-mode`: Deliberately skip known mismatches between BPF programs and builtins, only failing on genuine mimatches. For example, builtin programs may throw errors on readonly account state violations sooner than BPF programs, compute unit usage will be different, etc. This feature is primarily used to test a BPF program against a builtin.
233+
* `-c, --consensus-mode`: Only fail on consensus failures. One such effect is to normalize error codes when comparing results. Note: Cannot be used with --core-bpf-mode.
234+
* `-cb, --core-bpf-mode`: Deliberately skip known mismatches between BPF programs and builtins, only failing on genuine mimatches. For example, builtin programs may throw errors on readonly account state violations sooner than BPF programs, compute unit usage will be different, etc. This feature is primarily used to test a BPF program against a builtin. Note: Cannot be used with --consensus-mode.
235235
* `-f, --failures-only`: Only log failed test cases
236236
* `-sf, --save-failures`: Saves failed test cases to results directory
237237
* `-ss, --save-successes`: Saves successful test cases to results directory

src/test_suite/test_suite.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -354,15 +354,17 @@ def run_tests(
354354
False,
355355
"--consensus-mode",
356356
"-c",
357-
help="Only fail on consensus failures. One such effect is to normalize error codes when comparing results",
357+
help="Only fail on consensus failures. One such effect is to normalize error codes when comparing results. \
358+
Note: Cannot be used with --core-bpf-mode.",
358359
),
359360
core_bpf_mode: bool = typer.Option(
360361
False,
361362
"--core-bpf-mode",
362363
"-cb",
363364
help="Deliberately skip known mismatches between BPF programs and builtins, only failing on genuine mimatches. \
364365
For example, builtin programs may throw errors on readonly account state violations sooner than BPF programs, \
365-
compute unit usage will be different, etc. This feature is primarily used to test a BPF program against a builtin.",
366+
compute unit usage will be different, etc. This feature is primarily used to test a BPF program against a builtin. \
367+
Note: Cannot be used with --consensus-mode.",
366368
),
367369
failures_only: bool = typer.Option(
368370
False,

0 commit comments

Comments
 (0)