Skip to content

Commit fb7bf1d

Browse files
JDevlieghereJDevlieghere
committed
[dsymutil][doc] Improve wording in manpage and rename file.
 - Improve wording - Rename llvm-dsymutil to dsymutil - Name -arch=<arch> argument Differential revision: https://reviews.llvm.org/D39561 llvm-svn: 317226
1 parent 729dafc commit fb7bf1d

File tree

7 files changed

+95
-92
lines changed

7 files changed

+95
-92
lines changed

‎llvm/docs/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ if (LLVM_ENABLE_SPHINX)
113113
if (${SPHINX_OUTPUT_MAN})
114114
add_sphinx_target(man llvm)
115115
add_sphinx_target(man llvm-dwarfdump)
116-
add_sphinx_target(man llvm-dsymutil)
116+
add_sphinx_target(man dsymutil)
117117
endif()
118118

119119
endif()

‎llvm/docs/CommandGuide/dsymutil.rst

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
dsymutil - manipulate archived DWARF debug symbol files
2+
=======================================================
3+
4+
SYNOPSIS
5+
--------
6+
7+
| :program:`dsymutil` [*options*] *executable*
8+
9+
DESCRIPTION
10+
-----------
11+
12+
:program:`dsymutil` links the DWARF debug information found in the object files
13+
for an executable *executable* by using debug symbols information contained in
14+
its symbol table. By default, the linked debug information is placed in a
15+
``.dSYM`` bundle with the same name as the executable.
16+
17+
OPTIONS
18+
-------
19+
.. option:: -arch=<arch>
20+
21+
Link DWARF debug information only for specified CPU architecture types.
22+
Architectures may be specified by name. When using this option, an error will
23+
be returned if any architectures can not be properly linked. This option can
24+
be specified multiple times, once for each desired architecture. All CPU
25+
architectures will be linked by default and any architectures that can't be
26+
properly linked will cause :program:`dsymutil` to return an error.
27+
28+
.. option:: -dump-debug-map
29+
30+
Dump the executable debug-map (the list of the object files containing the
31+
debug information) in YAML format and exit. Not DWARF link will take place.
32+
33+
.. option:: -f, -flat
34+
35+
Produce a flat dSYM file. A ``.dwarf`` extension will be appended to the
36+
executable name unless the output file is specified using the -o option.
37+
38+
.. option:: -no-odr
39+
40+
Do not use ODR (One Definition Rule) for uniquing C++ types.
41+
42+
.. option:: -no-output
43+
44+
Do the link in memory, but do not emit the result file.
45+
46+
.. option:: -no-swiftmodule-timestamp
47+
48+
Don't check the timestamp for swiftmodule files.
49+
50+
.. option:: -j <n>, -num-threads=<n>
51+
52+
Specifies the maximum number (``n``) of simultaneous threads to use when
53+
linking multiple architectures.
54+
55+
.. option:: -o <filename>
56+
57+
Specifies an alternate ``path`` to place the dSYM bundle. The default dSYM
58+
bundle path is created by appending ``.dSYM`` to the executable name.
59+
60+
.. option:: -oso-prepend-path=<path>
61+
62+
Specifies a ``path`` to prepend to all debug symbol object file paths.
63+
64+
.. option:: -s, -symtab
65+
66+
Dumps the symbol table found in executable or object file(s) and exits.
67+
68+
.. option:: -v, -verbose
69+
70+
Display verbose information when linking.
71+
72+
.. option:: --version
73+
74+
Display the version of the tool.
75+
76+
.. option:: -y
77+
78+
Treat *executable* as a YAML debug-map rather than an executable.
79+
80+
EXIT STATUS
81+
-----------
82+
83+
:program:`dsymutil` returns 0 if the DWARF debug information was linked
84+
successfully. Otherwise, it returns 1.
85+
86+
SEE ALSO
87+
--------
88+
89+
:manpage:`llvm-dwarfdump(1)`

‎llvm/docs/CommandGuide/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Basic Commands
3030
llvm-stress
3131
llvm-symbolizer
3232
llvm-dwarfdump
33-
llvm-dsymutil
33+
dsymutil
3434

3535
Debugging Tools
3636
~~~~~~~~~~~~~~~

‎llvm/docs/CommandGuide/llvm-dsymutil.rst

Lines changed: 0 additions & 86 deletions
This file was deleted.

‎llvm/docs/CommandGuide/llvm-dwarfdump.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,4 +139,4 @@ successfully. Otherwise, it returns 1.
139139
SEE ALSO
140140
--------
141141

142-
:manpage:`llvm-dsymutil(1)`
142+
:manpage:`dsymutil(1)`

‎llvm/test/tools/dsymutil/cmdline.test

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ HELP: OVERVIEW: manipulate archived DWARF debug symbol files.
33
HELP: USAGE: llvm-dsymutil{{[^ ]*}} [options] <input files>
44
HELP-NOT: -reverse-iterate
55
HELP: Specific Options:
6-
HELP: -arch=<string>
6+
HELP: -arch=<arch>
77
HELP: -dump-debug-map
88
HELP: -flat
99
HELP: -no-odr

‎llvm/tools/dsymutil/dsymutil.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ static list<std::string> ArchFlags(
9393
"arch",
9494
desc("Link DWARF debug information only for specified CPU architecture\n"
9595
"types. This option can be specified multiple times, once for each\n"
96-
"desired architecture. All cpu architectures will be linked by\n"
97-
"default."),
96+
"desired architecture. All CPU architectures will be linked by\n"
97+
"default."), value_desc("arch"),
9898
ZeroOrMore, cat(DsymCategory));
9999

100100
static opt<bool>

0 commit comments

Comments
 (0)