llvm.org GIT mirror llvm / 2f759d4
[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 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@317226 91177308-0d34-0410-b5e6-96231b3b80d8 Jonas Devlieghere 1 year, 9 months ago
7 changed file(s) with 95 addition(s) and 92 deletion(s). Raw diff Collapse all Expand all
112112 if (${SPHINX_OUTPUT_MAN})
113113 add_sphinx_target(man llvm)
114114 add_sphinx_target(man llvm-dwarfdump)
115 add_sphinx_target(man llvm-dsymutil)
115 add_sphinx_target(man dsymutil)
116116 endif()
117117
118118 endif()
0 dsymutil - manipulate archived DWARF debug symbol files
1 =======================================================
2
3 SYNOPSIS
4 --------
5
6 | :program:`dsymutil` [*options*] *executable*
7
8 DESCRIPTION
9 -----------
10
11 :program:`dsymutil` links the DWARF debug information found in the object files
12 for an executable *executable* by using debug symbols information contained in
13 its symbol table. By default, the linked debug information is placed in a
14 ``.dSYM`` bundle with the same name as the executable.
15
16 OPTIONS
17 -------
18 .. option:: -arch=
19
20 Link DWARF debug information only for specified CPU architecture types.
21 Architectures may be specified by name. When using this option, an error will
22 be returned if any architectures can not be properly linked. This option can
23 be specified multiple times, once for each desired architecture. All CPU
24 architectures will be linked by default and any architectures that can't be
25 properly linked will cause :program:`dsymutil` to return an error.
26
27 .. option:: -dump-debug-map
28
29 Dump the executable debug-map (the list of the object files containing the
30 debug information) in YAML format and exit. Not DWARF link will take place.
31
32 .. option:: -f, -flat
33
34 Produce a flat dSYM file. A ``.dwarf`` extension will be appended to the
35 executable name unless the output file is specified using the -o option.
36
37 .. option:: -no-odr
38
39 Do not use ODR (One Definition Rule) for uniquing C++ types.
40
41 .. option:: -no-output
42
43 Do the link in memory, but do not emit the result file.
44
45 .. option:: -no-swiftmodule-timestamp
46
47 Don't check the timestamp for swiftmodule files.
48
49 .. option:: -j , -num-threads=
50
51 Specifies the maximum number (``n``) of simultaneous threads to use when
52 linking multiple architectures.
53
54 .. option:: -o
55
56 Specifies an alternate ``path`` to place the dSYM bundle. The default dSYM
57 bundle path is created by appending ``.dSYM`` to the executable name.
58
59 .. option:: -oso-prepend-path=
60
61 Specifies a ``path`` to prepend to all debug symbol object file paths.
62
63 .. option:: -s, -symtab
64
65 Dumps the symbol table found in executable or object file(s) and exits.
66
67 .. option:: -v, -verbose
68
69 Display verbose information when linking.
70
71 .. option:: --version
72
73 Display the version of the tool.
74
75 .. option:: -y
76
77 Treat *executable* as a YAML debug-map rather than an executable.
78
79 EXIT STATUS
80 -----------
81
82 :program:`dsymutil` returns 0 if the DWARF debug information was linked
83 successfully. Otherwise, it returns 1.
84
85 SEE ALSO
86 --------
87
88 :manpage:`llvm-dwarfdump(1)`
2929 llvm-stress
3030 llvm-symbolizer
3131 llvm-dwarfdump
32 llvm-dsymutil
32 dsymutil
3333
3434 Debugging Tools
3535 ~~~~~~~~~~~~~~~
+0
-86
docs/CommandGuide/llvm-dsymutil.rst less more
None llvm-dsymutil - manipulate archived DWARF debug symbol files
1 ============================================================
2
3 SYNOPSIS
4 --------
5
6 :program:`llvm-dsymutil` [*options*] [*filename*]
7
8 DESCRIPTION
9 -----------
10
11 :program:`llvm-dsymutil` links the DWARF debug information found in the object
12 files for the executable input file by using debug symbols information
13 contained in its symbol table.
14
15 OPTIONS
16 -------
17 .. option:: -arch=
18
19 Link DWARF debug information only for specified CPU architecture
20 types. This option can be specified multiple times, once for each
21 desired architecture. All cpu architectures will be linked by
22 default.
23
24 .. option:: -dump-debug-map
25
26 Parse and dump the debug map to standard output. Not DWARF link
27 will take place.
28
29 .. option:: -f, -flat
30
31 Produce a flat dSYM file (not a bundle).
32
33 .. option:: -no-odr
34
35 Do not use ODR (One Definition Rule) for type uniquing.
36
37 .. option:: -no-output
38
39 Do the link in memory, but do not emit the result file.
40
41 .. option:: -no-swiftmodule-timestamp
42
43 Don't check timestamp for swiftmodule files.
44
45 .. option:: -j , -num-threads=
46
47 Specifies the maximum number (n) of simultaneous threads to use
48 when linking multiple architectures.
49
50 .. option:: -o=
51
52 Specify the output file. default: .dwarf
53
54 .. option:: -oso-prepend-path=
55
56 Specify a directory to prepend to the paths of object files.
57
58 .. option:: -s, -symtab
59
60 Dumps the symbol table found in executable or object file(s) and
61 exits.
62
63 .. option:: -v, -verbose
64
65 Verbosity level
66
67 .. option:: --version
68
69 Display the version of the tool.
70
71 .. option:: -y
72
73 Treat the input file is a YAML debug map rather than a binary.
74
75
76 EXIT STATUS
77 -----------
78
79 :program:`llvm-dsymutil` returns 0 if the DWARF debug information was linked
80 successfully. Otherwise, it returns 1.
81
82 SEE ALSO
83 --------
84
85 :manpage:`llvm-dwarfdump(1)`
138138 SEE ALSO
139139 --------
140140
141 :manpage:`llvm-dsymutil(1)`
141 :manpage:`dsymutil(1)`
22 HELP: USAGE: llvm-dsymutil{{[^ ]*}} [options]
33 HELP-NOT: -reverse-iterate
44 HELP: Specific Options:
5 HELP: -arch=<string>
5 HELP: -arch=<arch>
66 HELP: -dump-debug-map
77 HELP: -flat
88 HELP: -no-odr
9292 "arch",
9393 desc("Link DWARF debug information only for specified CPU architecture\n"
9494 "types. This option can be specified multiple times, once for each\n"
95 "desired architecture. All cpu architectures will be linked by\n"
96 "default."),
95 "desired architecture. All CPU architectures will be linked by\n"
96 "default."), value_desc("arch"),
9797 ZeroOrMore, cat(DsymCategory));
9898
9999 static opt