llvm.org GIT mirror llvm / 6528ff8
[docs][llvm-dwarfdump] Add missing options and behaviour to documentation This fixes https://bugs.llvm.org/show_bug.cgi?id=42185. llvm-dwarfdump's documentation was missing a number of options and other behaviours. This change tries to fix up the documentation by adding these missing items. Reviewed by: JDevlieghere Differential Revision: https://reviews.llvm.org/D63217 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@363264 91177308-0d34-0410-b5e6-96231b3b80d8 James Henderson a month ago
1 changed file(s) with 35 addition(s) and 4 deletion(s). Raw diff Collapse all Expand all
1212 archives, and `.dSYM` bundles and prints their contents in
1313 human-readable form. Only the .debug_info section is printed unless one of
1414 the section-specific options or :option:`--all` is specified.
15
16 If no input file is specified, `a.out` is used instead. If `-` is used as the
17 input file, :program:`llvm-dwarfdump` reads the input from its standard input
18 stream.
1519
1620 OPTIONS
1721 -------
3438 the :option:`--debug-info`, :option:`--find`,
3539 and :option:`--name` options.
3640
41 .. option:: --color
42
43 Use colors in output.
44
3745 .. option:: -f , --find=
3846
3947 Search for the exact text in the accelerator tables
4957 .. option:: -h, --help
5058
5159 Show help and usage for this command.
60
61 .. option:: --help-list
62
63 Show help and usage for this command without grouping the options
64 into categories.
5265
5366 .. option:: -i, --ignore-case
5467
6982
7083 .. option:: -o
7184
72 Redirect output to a file specified by .
85 Redirect output to a file specified by , where `-` is the
86 standard output stream.
7387
7488 .. option:: -p, --show-parents
7589
7791 :option:`--debug-info`, :option:`--find`, and
7892 :option:`--name` options.
7993
80 .. option:: -r , --recurse-depth=>
94 .. option:: --parent-recurse-depth=>
8195
82 Only recurse to a maximum depth of <n> when dumping debug info
96 Only recurse to a maximum depth of <N> when displaying parents of
97 debug info entries.
98
99 .. option:: --quiet
100
101 Use with :option:`--verify` to not emit to `STDOUT`.
102
103 .. option:: -r , --recurse-depth=
104
105 Only recurse to a maximum depth of when dumping debug info
83106 entries.
84107
85108 .. option:: --statistics
86109
87110 Collect debug info quality metrics and print the results
88111 as machine-readable single-line JSON output.
112
113 .. option:: --summarize-types
114
115 Abbreviate the description of type unit entries.
89116
90117 .. option:: -x, --regex
91118
116143
117144 Display the version of the tool.
118145
119 .. option:: --debug-abbrev, --debug-aranges, --debug-cu-index, --debug-frame [=], --debug-gnu-pubnames, --debug-gnu-pubtypes, --debug-info [=], --debug-line [=], --debug-loc [=], --debug-macro, --debug-pubnames, --debug-pubtypes, --debug-ranges, --debug-str, --debug-str-offsets, --debug-tu-index, --debug-types, --eh-frame, --gdb-index, --apple-names, --apple-types, --apple-namespaces, --apple-objc
146 .. option:: --debug-abbrev, --debug-addr, --debug-aranges, --debug-cu-index, --debug-frame [=], --debug-gnu-pubnames, --debug-gnu-pubtypes, --debug-info [=], --debug-line [=], --debug-line-str, --debug-loc [=], --debug-loclists [=], --debug-macro, --debug-names, --debug-pubnames, --debug-pubtypes, --debug-ranges, --debug-rnglists, --debug-str, --debug-str-offsets, --debug-tu-index, --debug-types, --eh-frame [=], --gdb-index, --apple-names, --apple-types, --apple-namespaces, --apple-objc
120147
121148 Dump the specified DWARF section by name. Only the
122149 `.debug_info` section is shown by default. Some entries
128155 offset can be dumped by also using the
129156 :option:`--show-children` option where applicable.
130157
158 .. option:: @
159
160 Read command-line options from ``.
161
131162 EXIT STATUS
132163 -----------
133164