Improve documentation of abidiff --type-id-style
Commit Message
* tools/abidw.cc (display_usage): In documentation of
"--type-id-style" option, add a missing closing ')', spell
"type id" without a '-', split overly long string over two
lines, use "<...>" to indicate mandatory argument and improve
description of formats.
* doc/manuals/abidw.rst: In documentation of "--type-id-style"
option, use "<...>" to indicate mandatory argument.
Signed-off-by: Giuliano Procida <gprocida@google.com>
---
doc/manuals/abidw.rst | 2 +-
tools/abidw.cc | 3 ++-
2 files changed, 3 insertions(+), 2 deletions(-)
Comments
Giuliano Procida <gprocida@google.com> a écrit:
> * tools/abidw.cc (display_usage): In documentation of
> "--type-id-style" option, add a missing closing ')', spell
> "type id" without a '-', split overly long string over two
> lines, use "<...>" to indicate mandatory argument and improve
> description of formats.
> * doc/manuals/abidw.rst: In documentation of "--type-id-style"
> option, use "<...>" to indicate mandatory argument.
>
> Signed-off-by: Giuliano Procida <gprocida@google.com>
Applied to master, thanks!
Cheers,
@@ -197,7 +197,7 @@ Options
1.8 will not set the default size and will interpret types without
a size-in-bits attribute as zero sized.
- * ``--type-id-style`` ( ``sequence`` | ``hash`` )
+ * ``--type-id-style`` <``sequence``|``hash``>
This option controls how types are idenfied in the generated XML
files. The default ``sequence`` style just numbers (with
@@ -180,7 +180,8 @@ display_usage(const string& prog_name, ostream& out)
<< " --no-write-default-sizes do not emit pointer size when it equals"
" the default address size of the translation unit\n"
<< " --no-parameter-names do not show names of function parameters\n"
- << " --type-id-style (sequence|hash) type-id style (sequence(default): type-id-number; hash: hexdigits\n"
+ << " --type-id-style <sequence|hash> type id style (sequence(default): "
+ "\"type-id-\" + number; hash: hex-digits)\n"
<< " --check-alternate-debug-info <elf-path> check alternate debug info "
"of <elf-path>\n"
<< " --check-alternate-debug-info-base-name <elf-path> check alternate "