This is an archive of the discontinued LLVM Phabricator instance.

Differential D102078

[llvm-symbolizer] Update Command Guide
ClosedPublic

Authored by gbreynoo on May 7 2021, 9:00 AM.

Details

Reviewers
MaskRay
akhuang
saugustine
Commits
rG2aa5f9b45a49: [llvm-symbolizer] Update Command Guide
Summary

The option --use-symbol-table is now a noop and does not appear in the help text, however it still appears in the command guide. This change removes it from the command guide and updates the description of --output-style .

Diff Detail

Event Timeline

gbreynoo requested review of this revision.May 7 2021, 9:00 AM
gbreynoo created this revision.
Herald added a project: Restricted Project. · View Herald TranscriptMay 7 2021, 9:00 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
MaskRay accepted this revision.May 7 2021, 9:27 AM

LGTM.

This revision is now accepted and ready to land.May 7 2021, 9:27 AM
Harbormaster completed remote builds in B103210: Diff 343694.May 7 2021, 9:45 AM
Closed by commit rG2aa5f9b45a49: [llvm-symbolizer] Update Command Guide (authored by gbreynoo). · Explain WhyMay 10 2021, 9:21 AM
This revision was automatically updated to reflect the committed changes.
gbreynoo added a commit: rG2aa5f9b45a49: [llvm-symbolizer] Update Command Guide.

Revision Contents

PathSize
llvm/
docs/
CommandGuide/
10 lines

Diff 344086

llvm/docs/CommandGuide/llvm-symbolizer.rst

Show First 20 Lines • Show All 241 Lines • ▼ Show 20 Lines.. option:: --output-style <LLVM|GNU>
style is set to ``GNU``, the tool follows the style of GNU's **addr2line**. style is set to ``GNU``, the tool follows the style of GNU's **addr2line**.
The differences from the ``LLVM`` style are: The differences from the ``LLVM`` style are:
* Does not print the column of a source code location. * Does not print the column of a source code location.
* Does not add an empty line after the report for an address. * Does not add an empty line after the report for an address.
* Does not replace the name of an inlined function with the name of the * Does not replace the name of an inlined function with the name of the
topmost caller when inlined frames are not shown and :option:`--use-symbol-table` topmost caller when inlined frames are not shown.
is on.
* Prints an address's debug-data discriminator when it is non-zero. One way to * Prints an address's debug-data discriminator when it is non-zero. One way to
produce discriminators is to compile with clang's -fdebug-info-for-profiling. produce discriminators is to compile with clang's -fdebug-info-for-profiling.
.. code-block:: console .. code-block:: console
$ llvm-symbolizer --obj=inlined.elf 0x4004be 0x400486 -p $ llvm-symbolizer --obj=inlined.elf 0x4004be 0x400486 -p
baz() at /tmp/test.cpp:11:18 baz() at /tmp/test.cpp:11:18
▲ Show 20 Lines • Show All 56 Lines • ▼ Show 20 Lines .. code-block:: console
12 : } 12 : }
.. option:: --relativenames .. option:: --relativenames
Print the file's path relative to the compilation directory, instead Print the file's path relative to the compilation directory, instead
of the absolute path. If the command-line to the compiler included of the absolute path. If the command-line to the compiler included
the full path, this will be the same as the default. the full path, this will be the same as the default.
.. _llvm-symbolizer-opt-use-symbol-table:
.. option:: --use-symbol-table
Prefer function names stored in symbol table to function names in debug info
sections. Defaults to true.
.. option:: --verbose .. option:: --verbose
Print verbose line and column information. Print verbose line and column information.
.. code-block:: console .. code-block:: console
$ llvm-symbolizer --obj=inlined.elf --verbose 0x4004be $ llvm-symbolizer --obj=inlined.elf --verbose 0x4004be
baz() baz()
▲ Show 20 Lines • Show All 66 Lines • Show Last 20 Lines