[llvm] r317226 - [dsymutil][doc] Improve wording in manpage and rename file.
Jonas Devlieghere via llvm-commits
llvm-commits at lists.llvm.org
Thu Nov 2 11:44:55 PDT 2017
Author: jdevlieghere
Date: Thu Nov 2 11:44:54 2017
New Revision: 317226
URL: http://llvm.org/viewvc/llvm-project?rev=317226&view=rev
Log:
[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
Added:
llvm/trunk/docs/CommandGuide/dsymutil.rst
Removed:
llvm/trunk/docs/CommandGuide/llvm-dsymutil.rst
Modified:
llvm/trunk/docs/CMakeLists.txt
llvm/trunk/docs/CommandGuide/index.rst
llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst
llvm/trunk/test/tools/dsymutil/cmdline.test
llvm/trunk/tools/dsymutil/dsymutil.cpp
Modified: llvm/trunk/docs/CMakeLists.txt
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CMakeLists.txt?rev=317226&r1=317225&r2=317226&view=diff
==============================================================================
--- llvm/trunk/docs/CMakeLists.txt (original)
+++ llvm/trunk/docs/CMakeLists.txt Thu Nov 2 11:44:54 2017
@@ -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()
Added: llvm/trunk/docs/CommandGuide/dsymutil.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/dsymutil.rst?rev=317226&view=auto
==============================================================================
--- llvm/trunk/docs/CommandGuide/dsymutil.rst (added)
+++ llvm/trunk/docs/CommandGuide/dsymutil.rst Thu Nov 2 11:44:54 2017
@@ -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)`
Modified: llvm/trunk/docs/CommandGuide/index.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/index.rst?rev=317226&r1=317225&r2=317226&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/index.rst (original)
+++ llvm/trunk/docs/CommandGuide/index.rst Thu Nov 2 11:44:54 2017
@@ -30,7 +30,7 @@ Basic Commands
llvm-stress
llvm-symbolizer
llvm-dwarfdump
- llvm-dsymutil
+ dsymutil
Debugging Tools
~~~~~~~~~~~~~~~
Removed: llvm/trunk/docs/CommandGuide/llvm-dsymutil.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-dsymutil.rst?rev=317225&view=auto
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-dsymutil.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-dsymutil.rst (removed)
@@ -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)`
Modified: llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst?rev=317226&r1=317225&r2=317226&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst Thu Nov 2 11:44:54 2017
@@ -139,4 +139,4 @@ successfully. Otherwise, it returns 1.
SEE ALSO
--------
-:manpage:`llvm-dsymutil(1)`
+:manpage:`dsymutil(1)`
Modified: llvm/trunk/test/tools/dsymutil/cmdline.test
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/test/tools/dsymutil/cmdline.test?rev=317226&r1=317225&r2=317226&view=diff
==============================================================================
--- llvm/trunk/test/tools/dsymutil/cmdline.test (original)
+++ llvm/trunk/test/tools/dsymutil/cmdline.test Thu Nov 2 11:44:54 2017
@@ -3,7 +3,7 @@ HELP: OVERVIEW: manipulate archived DWAR
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
Modified: llvm/trunk/tools/dsymutil/dsymutil.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/tools/dsymutil/dsymutil.cpp?rev=317226&r1=317225&r2=317226&view=diff
==============================================================================
--- llvm/trunk/tools/dsymutil/dsymutil.cpp (original)
+++ llvm/trunk/tools/dsymutil/dsymutil.cpp Thu Nov 2 11:44:54 2017
@@ -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>
More information about the llvm-commits
mailing list