[dsymutil] Add a manpage for dsymutil

llvm-svn: 317221

llvm/docs/CMakeLists.txt

@@ -3,7 +3,7 @@ if (DOXYGEN_FOUND)
 if (LLVM_ENABLE_DOXYGEN)
   set(abs_top_srcdir ${CMAKE_CURRENT_SOURCE_DIR})
   set(abs_top_builddir ${CMAKE_CURRENT_BINARY_DIR})
-  
+
   if (HAVE_DOT)
     set(DOT ${LLVM_PATH_DOT})
   endif()
@@ -21,20 +21,20 @@ if (LLVM_ENABLE_DOXYGEN)
     set(enable_external_search "NO")
     set(extra_search_mappings "")
   endif()
-  
+
   # If asked, configure doxygen for the creation of a Qt Compressed Help file.
   option(LLVM_ENABLE_DOXYGEN_QT_HELP
     "Generate a Qt Compressed Help file." OFF)
   if (LLVM_ENABLE_DOXYGEN_QT_HELP)
     set(LLVM_DOXYGEN_QCH_FILENAME "org.llvm.qch" CACHE STRING
       "Filename of the Qt Compressed help file")
-    set(LLVM_DOXYGEN_QHP_NAMESPACE "org.llvm" CACHE STRING 
+    set(LLVM_DOXYGEN_QHP_NAMESPACE "org.llvm" CACHE STRING
       "Namespace under which the intermediate Qt Help Project file lives")
     set(LLVM_DOXYGEN_QHP_CUST_FILTER_NAME "${PACKAGE_STRING}" CACHE STRING
       "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters")
     set(LLVM_DOXYGEN_QHP_CUST_FILTER_ATTRS "${PACKAGE_NAME},${PACKAGE_VERSION}" CACHE STRING
       "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes")
-    find_program(LLVM_DOXYGEN_QHELPGENERATOR_PATH qhelpgenerator 
+    find_program(LLVM_DOXYGEN_QHELPGENERATOR_PATH qhelpgenerator
       DOC "Path to the qhelpgenerator binary")
     if (NOT LLVM_DOXYGEN_QHELPGENERATOR_PATH)
       message(FATAL_ERROR "Failed to find qhelpgenerator binary")
@@ -55,7 +55,7 @@ if (LLVM_ENABLE_DOXYGEN)
     set(llvm_doxygen_qhp_cust_filter_name "")
     set(llvm_doxygen_qhp_cust_filter_attrs "")
   endif()
-  
+
   option(LLVM_DOXYGEN_SVG
     "Use svg instead of png files for doxygen graphs." OFF)
   if (LLVM_DOXYGEN_SVG)
@@ -113,6 +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)
     endif()
 
   endif()

llvm/docs/CommandGuide/index.rst

@@ -30,6 +30,7 @@ Basic Commands
    llvm-stress
    llvm-symbolizer
    llvm-dwarfdump
+   llvm-dsymutil
 
 Debugging Tools
 ~~~~~~~~~~~~~~~

llvm/docs/CommandGuide/llvm-dsymutil.rst

@@ -0,0 +1,86 @@
+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)`

llvm/docs/CommandGuide/llvm-dwarfdump.rst

@@ -139,4 +139,4 @@ successfully. Otherwise, it returns 1.
 SEE ALSO
 --------
 
-:manpage:`dsymutil(1)`
+:manpage:`llvm-dsymutil(1)`