diff mbox series

Improve documentation of abidiff --type-id-style

Message ID 20200724072948.3850055-1-gprocida@google.com
State New
Headers show
Series Improve documentation of abidiff --type-id-style | expand

Commit Message

Giuliano Procida July 24, 2020, 7:29 a.m. UTC 
* 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

Dodji Seketeli Aug. 4, 2020, 4:43 p.m. UTC | #1 
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,
diff mbox series

Patch

diff --git a/doc/manuals/abidw.rst b/doc/manuals/abidw.rst
index 5834923b..d0720a0b 100644
--- a/doc/manuals/abidw.rst
+++ b/doc/manuals/abidw.rst
@@ -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
diff --git a/tools/abidw.cc b/tools/abidw.cc
index 2cd848df..27a9e484 100644
--- a/tools/abidw.cc
+++ b/tools/abidw.cc
@@ -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 "