From fc1af3e0f8385c2ea155888303d57a8e86e210c7 Mon Sep 17 00:00:00 2001 From: Jonas Devlieghere Date: Thu, 2 Nov 2017 18:44:54 +0000 Subject: [PATCH] [dsymutil][doc] Improve wording in manpage and rename file. - Improve wording - Rename llvm-dsymutil to dsymutil - Name -arch= argument Differential revision: https://reviews.llvm.org/D39561 llvm-svn: 317226 --- docs/CMakeLists.txt | 2 +- docs/CommandGuide/dsymutil.rst | 89 ++++++++++++++++++++++++++++ docs/CommandGuide/index.rst | 2 +- docs/CommandGuide/llvm-dsymutil.rst | 86 --------------------------- docs/CommandGuide/llvm-dwarfdump.rst | 2 +- test/tools/dsymutil/cmdline.test | 2 +- tools/dsymutil/dsymutil.cpp | 4 +- 7 files changed, 95 insertions(+), 92 deletions(-) create mode 100644 docs/CommandGuide/dsymutil.rst delete mode 100644 docs/CommandGuide/llvm-dsymutil.rst diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 6e430459e5d..0f2681e0cd8 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -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() diff --git a/docs/CommandGuide/dsymutil.rst b/docs/CommandGuide/dsymutil.rst new file mode 100644 index 00000000000..3cbbcb07894 --- /dev/null +++ b/docs/CommandGuide/dsymutil.rst @@ -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= + + 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 , -num-threads= + + Specifies the maximum number (``n``) of simultaneous threads to use when + linking multiple architectures. + +.. option:: -o + + 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= + + 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)` diff --git a/docs/CommandGuide/index.rst b/docs/CommandGuide/index.rst index a706ba1d675..805df00c173 100644 --- a/docs/CommandGuide/index.rst +++ b/docs/CommandGuide/index.rst @@ -30,7 +30,7 @@ Basic Commands llvm-stress llvm-symbolizer llvm-dwarfdump - llvm-dsymutil + dsymutil Debugging Tools ~~~~~~~~~~~~~~~ diff --git a/docs/CommandGuide/llvm-dsymutil.rst b/docs/CommandGuide/llvm-dsymutil.rst deleted file mode 100644 index 19340e194b8..00000000000 --- a/docs/CommandGuide/llvm-dsymutil.rst +++ /dev/null @@ -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= - - 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 , -num-threads= - - Specifies the maximum number (n) of simultaneous threads to use - when linking multiple architectures. - -.. option:: -o= - - Specify the output file. default: .dwarf - -.. option:: -oso-prepend-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)` diff --git a/docs/CommandGuide/llvm-dwarfdump.rst b/docs/CommandGuide/llvm-dwarfdump.rst index 4e7791573e6..a3b62664cbe 100644 --- a/docs/CommandGuide/llvm-dwarfdump.rst +++ b/docs/CommandGuide/llvm-dwarfdump.rst @@ -139,4 +139,4 @@ successfully. Otherwise, it returns 1. SEE ALSO -------- -:manpage:`llvm-dsymutil(1)` +:manpage:`dsymutil(1)` diff --git a/test/tools/dsymutil/cmdline.test b/test/tools/dsymutil/cmdline.test index dea28cf3d90..f66858e9ae5 100644 --- a/test/tools/dsymutil/cmdline.test +++ b/test/tools/dsymutil/cmdline.test @@ -3,7 +3,7 @@ HELP: OVERVIEW: manipulate archived DWARF debug symbol files. HELP: USAGE: llvm-dsymutil{{[^ ]*}} [options] HELP-NOT: -reverse-iterate HELP: Specific Options: -HELP: -arch= +HELP: -arch= HELP: -dump-debug-map HELP: -flat HELP: -no-odr diff --git a/tools/dsymutil/dsymutil.cpp b/tools/dsymutil/dsymutil.cpp index b6d6c909abc..769668c8a9f 100644 --- a/tools/dsymutil/dsymutil.cpp +++ b/tools/dsymutil/dsymutil.cpp @@ -93,8 +93,8 @@ static list 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