[PATCH] Docs for llvm-symbolizer tool

[Alexey Samsonov]

Hi echristo,

This patch adds a documentation for implemented llvm-symbolizer tool.
Couple of questions:
1) Should I describe input/output format more formally, or providing an example is fine?
2) Is there a way I can check the compiled .html file? I haven't found the instructions
in http://llvm.org/docs/SphinxQuickstartTemplate.html

http://llvm-reviews.chandlerc.com/D462

Files:
  docs/CommandGuide/llvm-symbolizer.rst
  docs/CommandGuide/index.rst

Index: docs/CommandGuide/llvm-symbolizer.rst
===================================================================
--- /dev/null
+++ docs/CommandGuide/llvm-symbolizer.rst
@@ -0,0 +1,60 @@
+llvm-symbolizer - convert addresses into source code locations
+====================================
+
+SYNOPSIS
+--------
+
+:program:`llvm-symbolizer` [options]
+
+DESCRIPTION
+-----------
+
+:program:`llvm-symbolizer` reads object file names and addresses from standard
+input and prints corresponding source code locations to standard output. This
+program uses debug info sections and symbol table in the object files.
+
+EXAMPLE
+--------
+
+.. code-block:: sh
+  $ cat addr.txt
+  a.out 0x4004f4
+  /tmp/b.out 0x400528
+  /tmp/c.so 0x710
+  $ llvm-symbolizer < addresses.txt
+  main
+  /tmp/a.cc:4
+  
+  f(int, int)
+  /tmp/b.cc:11
+
+  inlined_h
+  /tmp/header.h:2
+  inlined_g
+  /tmp/header.h:7
+  inlined_f
+  /tmp/source.cc:3
+  main
+  /tmp/source.cc:8
+
+OPTIONS
+-------
+
+.. option:: -functions
+ Print function names as well as source file/line locations. Defaults to true.
+
+.. option:: -use-symbol-table
+ Prefer function names stored in symbol table to function names
+ in debug info sections. Defaults to true.
+
+.. option:: -demangle
+ Print demangled function names. Defaults to true.
+
+.. option:: -inlining 
+ If a source code location is in an inlined function, prints all the
+ inlnied frames. Defaults to true.
+
+EXIT STATUS
+-----------
+
+:program:`llvm-symbolizer` returns 0.
Index: docs/CommandGuide/index.rst
===================================================================
--- docs/CommandGuide/index.rst
+++ docs/CommandGuide/index.rst
@@ -28,6 +28,7 @@
    llvm-diff
    llvm-cov
    llvm-stress
+   llvm-symbolizer
 
 Debugging Tools
 ~~~~~~~~~~~~~~~
-------------- next part --------------
A non-text attachment was scrubbed...
Name: D462.1.patch
Type: text/x-patch
Size: 1784 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20130226/8f8672f0/attachment.bin>