De-duplicate CS.getCalledFunction() expression.
[oota-llvm.git] / docs / CommandGuide / llvm-symbolizer.rst
index e03be9b19876dec31eba7c9a461b8220d08f297f..96720e633f2fafb9c53a03e1c5d983c4d40b9d25 100644 (file)
@@ -10,7 +10,9 @@ DESCRIPTION
 -----------
 
 :program:`llvm-symbolizer` reads object file names and addresses from standard
-input and prints corresponding source code locations to standard output. This
+input and prints corresponding source code locations to standard output.
+If object file is specified in command line, :program:`llvm-symbolizer` reads
+only addresses from standard input. This
 program uses debug info sections and symbol table in the object files.
 
 EXAMPLE
@@ -45,13 +47,28 @@ EXAMPLE
 
   _main
   /tmp/source_x86_64.cc:8
+  $ cat addr2.txt
+  0x4004f4
+  0x401000
+  $ llvm-symbolizer -obj=a.out < addr2.txt
+  main
+  /tmp/a.cc:4
+
+  foo(int)
+  /tmp/a.cc:12
 
 OPTIONS
 -------
 
-.. option:: -functions
+.. option:: -obj
+
+  Path to object file to be symbolized.
 
-  Print function names as well as source file/line locations. Defaults to true.
+.. option:: -functions=[none|short|linkage]
+
+  Specify the way function names are printed (omit function name,
+  print short function name, or print full linkage name, respectively).
+  Defaults to ``linkage``.
 
 .. option:: -use-symbol-table
 
@@ -75,6 +92,13 @@ OPTIONS
  input (see example above). If architecture is not specified in either way,
  address will not be symbolized. Defaults to empty string.
 
+.. option:: -dsym-hint=<path/to/file.dSYM>
+
+ (Darwin-only flag). If the debug info for a binary isn't present in the default
+ location, look for the debug info at the .dSYM path provided via the
+ ``-dsym-hint`` flag. This flag can be used multiple times.
+
+
 EXIT STATUS
 -----------