1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-23 19:23:23 +01:00
llvm-mirror/docs/CommandGuide/llvm-addr2line.rst
Jordan Rupprecht 1a675694f0 [docs] Convert remaining command guide entries from md to rst.
Summary:
Linking between markdown and rst files is currently not supported very well, e.g. the current llvm-addr2line docs [1] link to "llvm-symbolizer" instead of "llvm-symbolizer.html". This is weirdly broken in different ways depending on which versions of sphinx and recommonmark are being used, so workaround the bug by using rst everywhere.

[1] http://llvm.org/docs/CommandGuide/llvm-addr2line.html

Reviewers: jhenderson

Reviewed By: jhenderson

Subscribers: lebedev.ri, llvm-commits

Tags: #llvm

Differential Revision: https://reviews.llvm.org/D66305

llvm-svn: 369553
2019-08-21 18:00:17 +00:00

39 lines
1.0 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:
- Defaults not to print function names. Use `-f`_ to enable that.
- Defaults not to demangle function names. Use `-C`_ to switch the
demangling on.
- Defaults not to print inlined frames. Use `-i`_ to show inlined
frames for a source code location in an inlined function.
- Uses `--output-style=GNU`_ by default.
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