1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2025-01-31 20:51:52 +01:00
llvm-mirror/docs/CommandGuide/llvm-addr2line.rst
Richard Smith c20ce5db86 [docs] Make llvm-addr2line documentation more explicit about which
behavior is llvm-addr2line's and which is llvm-symbolizer's.
2020-03-31 12:44:45 -07:00

43 lines
1.2 KiB
ReStructuredText

llvm-addr2line - a drop-in replacement for addr2line
====================================================
.. program:: llvm-addr2line
SYNOPSIS
--------
:program:`llvm-addr2line` [*options*]
DESCRIPTION
-----------
:program:`llvm-addr2line` is an alias for the :manpage:`llvm-symbolizer(1)`
tool with different defaults. The goal is to make it a drop-in replacement for
GNU's :program:`addr2line`.
Here are some of those differences:
- ``llvm-addr2line`` defaults not to print function names. Use `-f`_ to enable
that.
- ``llvm-addr2line`` defaults not to demangle function names. Use `-C`_ to
switch the demangling on.
- ``llvm-addr2line`` defaults not to print inlined frames. Use `-i`_ to show
inlined frames for a source code location in an inlined function.
- ``llvm-addr2line`` uses `--output-style=GNU`_ by default.
- ``llvm-addr2line`` parses options from the environment variable
``LLVM_ADDR2LINE_OPTS`` instead of from ``LLVM_SYMBOLIZER_OPTS``.
SEE ALSO
--------
:manpage:`llvm-symbolizer(1)`
.. _-f: llvm-symbolizer.html#llvm-symbolizer-opt-f
.. _-C: llvm-symbolizer.html#llvm-symbolizer-opt-c
.. _-i: llvm-symbolizer.html#llvm-symbolizer-opt-i
.. _--output-style=GNU: llvm-symbolizer.html#llvm-symbolizer-opt-output-style