mirror of
https://github.com/RPCS3/llvm.git
synced 2024-11-23 19:59:48 +00:00
[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
This commit is contained in:
Jonas Devlieghere
parent
0c059eff81
commit
2f759d471a
@ -113,7 +113,7 @@ if (LLVM_ENABLE_SPHINX)
|
||||
if (${SPHINX_OUTPUT_MAN})
|
||||
add_sphinx_target(man llvm)
|
||||
add_sphinx_target(man llvm-dwarfdump)
|
||||
add_sphinx_target(man llvm-dsymutil)
|
||||
add_sphinx_target(man dsymutil)
|
||||
endif()
|
||||
|
||||
endif()
|
||||
|
||||
89
docs/CommandGuide/dsymutil.rst
Normal file
89
docs/CommandGuide/dsymutil.rst
Normal file
@ -0,0 +1,89 @@
|
||||
dsymutil - manipulate archived DWARF debug symbol files
|
||||
=======================================================
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
||||
| :program:`dsymutil` [*options*] *executable*
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
:program:`dsymutil` links the DWARF debug information found in the object files
|
||||
for an executable *executable* by using debug symbols information contained in
|
||||
its symbol table. By default, the linked debug information is placed in a
|
||||
``.dSYM`` bundle with the same name as the executable.
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
.. option:: -arch=<arch>
|
||||
|
||||
Link DWARF debug information only for specified CPU architecture types.
|
||||
Architectures may be specified by name. When using this option, an error will
|
||||
be returned if any architectures can not be properly linked. This option can
|
||||
be specified multiple times, once for each desired architecture. All CPU
|
||||
architectures will be linked by default and any architectures that can't be
|
||||
properly linked will cause :program:`dsymutil` to return an error.
|
||||
|
||||
.. option:: -dump-debug-map
|
||||
|
||||
Dump the executable debug-map (the list of the object files containing the
|
||||
debug information) in YAML format and exit. Not DWARF link will take place.
|
||||
|
||||
.. option:: -f, -flat
|
||||
|
||||
Produce a flat dSYM file. A ``.dwarf`` extension will be appended to the
|
||||
executable name unless the output file is specified using the -o option.
|
||||
|
||||
.. option:: -no-odr
|
||||
|
||||
Do not use ODR (One Definition Rule) for uniquing C++ types.
|
||||
|
||||
.. option:: -no-output
|
||||
|
||||
Do the link in memory, but do not emit the result file.
|
||||
|
||||
.. option:: -no-swiftmodule-timestamp
|
||||
|
||||
Don't check the timestamp for swiftmodule files.
|
||||
|
||||
.. option:: -j <n>, -num-threads=<n>
|
||||
|
||||
Specifies the maximum number (``n``) of simultaneous threads to use when
|
||||
linking multiple architectures.
|
||||
|
||||
.. option:: -o <filename>
|
||||
|
||||
Specifies an alternate ``path`` to place the dSYM bundle. The default dSYM
|
||||
bundle path is created by appending ``.dSYM`` to the executable name.
|
||||
|
||||
.. option:: -oso-prepend-path=<path>
|
||||
|
||||
Specifies a ``path`` to prepend to all debug symbol object file paths.
|
||||
|
||||
.. option:: -s, -symtab
|
||||
|
||||
Dumps the symbol table found in executable or object file(s) and exits.
|
||||
|
||||
.. option:: -v, -verbose
|
||||
|
||||
Display verbose information when linking.
|
||||
|
||||
.. option:: --version
|
||||
|
||||
Display the version of the tool.
|
||||
|
||||
.. option:: -y
|
||||
|
||||
Treat *executable* as a YAML debug-map rather than an executable.
|
||||
|
||||
EXIT STATUS
|
||||
-----------
|
||||
|
||||
:program:`dsymutil` returns 0 if the DWARF debug information was linked
|
||||
successfully. Otherwise, it returns 1.
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
|
||||
:manpage:`llvm-dwarfdump(1)`
|
||||
@ -30,7 +30,7 @@ Basic Commands
|
||||
llvm-stress
|
||||
llvm-symbolizer
|
||||
llvm-dwarfdump
|
||||
llvm-dsymutil
|
||||
dsymutil
|
||||
|
||||
Debugging Tools
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
@ -1,86 +0,0 @@
|
||||
llvm-dsymutil - manipulate archived DWARF debug symbol files
|
||||
============================================================
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
||||
:program:`llvm-dsymutil` [*options*] [*filename*]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
:program:`llvm-dsymutil` links the DWARF debug information found in the object
|
||||
files for the executable input file by using debug symbols information
|
||||
contained in its symbol table.
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
.. option:: -arch=<string>
|
||||
|
||||
Link DWARF debug information only for specified CPU architecture
|
||||
types. This option can be specified multiple times, once for each
|
||||
desired architecture. All cpu architectures will be linked by
|
||||
default.
|
||||
|
||||
.. option:: -dump-debug-map
|
||||
|
||||
Parse and dump the debug map to standard output. Not DWARF link
|
||||
will take place.
|
||||
|
||||
.. option:: -f, -flat
|
||||
|
||||
Produce a flat dSYM file (not a bundle).
|
||||
|
||||
.. option:: -no-odr
|
||||
|
||||
Do not use ODR (One Definition Rule) for type uniquing.
|
||||
|
||||
.. option:: -no-output
|
||||
|
||||
Do the link in memory, but do not emit the result file.
|
||||
|
||||
.. option:: -no-swiftmodule-timestamp
|
||||
|
||||
Don't check timestamp for swiftmodule files.
|
||||
|
||||
.. option:: -j <n>, -num-threads=<n>
|
||||
|
||||
Specifies the maximum number (n) of simultaneous threads to use
|
||||
when linking multiple architectures.
|
||||
|
||||
.. option:: -o=<filename>
|
||||
|
||||
Specify the output file. default: <input file>.dwarf
|
||||
|
||||
.. option:: -oso-prepend-path=<path>
|
||||
|
||||
Specify a directory to prepend to the paths of object files.
|
||||
|
||||
.. option:: -s, -symtab
|
||||
|
||||
Dumps the symbol table found in executable or object file(s) and
|
||||
exits.
|
||||
|
||||
.. option:: -v, -verbose
|
||||
|
||||
Verbosity level
|
||||
|
||||
.. option:: --version
|
||||
|
||||
Display the version of the tool.
|
||||
|
||||
.. option:: -y
|
||||
|
||||
Treat the input file is a YAML debug map rather than a binary.
|
||||
|
||||
|
||||
EXIT STATUS
|
||||
-----------
|
||||
|
||||
:program:`llvm-dsymutil` returns 0 if the DWARF debug information was linked
|
||||
successfully. Otherwise, it returns 1.
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
|
||||
:manpage:`llvm-dwarfdump(1)`
|
||||
@ -139,4 +139,4 @@ successfully. Otherwise, it returns 1.
|
||||
SEE ALSO
|
||||
--------
|
||||
|
||||
:manpage:`llvm-dsymutil(1)`
|
||||
:manpage:`dsymutil(1)`
|
||||
|
||||
@ -3,7 +3,7 @@ HELP: OVERVIEW: manipulate archived DWARF debug symbol files.
|
||||
HELP: USAGE: llvm-dsymutil{{[^ ]*}} [options] <input files>
|
||||
HELP-NOT: -reverse-iterate
|
||||
HELP: Specific Options:
|
||||
HELP: -arch=<string>
|
||||
HELP: -arch=<arch>
|
||||
HELP: -dump-debug-map
|
||||
HELP: -flat
|
||||
HELP: -no-odr
|
||||
|
||||
@ -93,8 +93,8 @@ static list<std::string> ArchFlags(
|
||||
"arch",
|
||||
desc("Link DWARF debug information only for specified CPU architecture\n"
|
||||
"types. This option can be specified multiple times, once for each\n"
|
||||
"desired architecture. All cpu architectures will be linked by\n"
|
||||
"default."),
|
||||
"desired architecture. All CPU architectures will be linked by\n"
|
||||
"default."), value_desc("arch"),
|
||||
ZeroOrMore, cat(DsymCategory));
|
||||
|
||||
static opt<bool>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user