diff options
| author | Giuliano Procida <gprocida@google.com> | 2023-01-26 16:11:41 +0000 |
|---|---|---|
| committer | Giuliano Procida <gprocida@google.com> | 2023-01-27 08:31:30 +0000 |
| commit | 6bb25d70c0fa4dde0084a52a55bbdb379f6c3e8a (patch) | |
| tree | d97293fd7c1645f98fbc46fe10158b9964832dc3 /doc | |
| parent | 10a392565a0f631bbb2d179eba060c5c17e9623f (diff) | |
| download | stg-6bb25d70c0fa4dde0084a52a55bbdb379f6c3e8a.tar.gz | |
stgdiff: deprecate --compare-options in favour of --compare-option
It's better to support repeated arguments (which we do anyway) than to
split strings at commas.
With this change:
* `--compare-option` is added as a synonym for `--compare-options`
* usage string and documentation only mention `--compare-option`
```
stgdiff
...
[{-c|--compare-option} {ignore_symbol_type_presence_changes|ignore_type_declaration_status_changes}] ...
...
format, output and compare-option may be repeated
...
```
A later change will drop support for `--compare-options` and
comma-separated values.
Note that due to `getopt_long`'s prefix matching of long option names,
`--compare-option` used to work anyway!
PiperOrigin-RevId: 504845538
Change-Id: I7677fef7f714761d57295941bd1dfe1e60462455
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/stgdiff.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/stgdiff.md b/doc/stgdiff.md index b7e5538..a703381 100644 --- a/doc/stgdiff.md +++ b/doc/stgdiff.md @@ -12,13 +12,12 @@ stgdiff [-a|--abi|-b|--btf|-e|--elf|-s|--stg] file2 [{-x|--exact}] [--skip-dwarf] - [{-c|--compare-options} {ignore_symbol_type_presence_changes|ignore_type_declaration_status_changes}] + [{-c|--compare-option} {ignore_symbol_type_presence_changes|ignore_type_declaration_status_changes}] ... [{-f|--format} {plain|flat|small|short|viz}] [{-o|--output} {filename|-}] ... [{-F|--fidelity} {filename|-}] implicit defaults: --abi --format plain - format and output can appear multiple times - multiple comma-separated compare-options can be passed + format, output and compare-option may be repeated --exact (node equality) cannot be combined with --output ``` @@ -68,8 +67,10 @@ The default behaviour is to compare two ABIs for equivalence. ### Options -The options here suppress noisy diffs that are inevitable when consuming ABI XML -output from `abidw`. +* `-c|--compare-option` + +These two options suppress noisy diffs that are inevitable when consuming ABI +XML output from `abidw`. * `ignore_symbol_type_presence_changes` @@ -229,7 +230,7 @@ return 0. Otherwise: changes, and print short report to stdout: ``` - stgdiff -f short -c ignore_symbol_type_presence_changes,ignore_type_declaration_status_changes -a abi.0.xml abi.1.xml -o - + stgdiff -f short -c ignore_symbol_type_presence_changes -c ignore_type_declaration_status_changes -a abi.0.xml abi.1.xml -o - ``` * Compare ABI XML to ABI from ELF and print a short report to file: |