This is an archive of the discontinued LLVM Phabricator instance.

Differential D63787

[llvm-objdump] Update the doc for --disassemble-functions.
ClosedPublic

Authored by ychen on Jun 25 2019, 1:31 PM.

Details

Reviewers
jhenderson
grimar
MaskRay
rupprecht
peter.smith
Commits
rG2dcd2c2493b1: [llvm-objdump] Update the doc for --disassemble-functions.
rL364573: [llvm-objdump] Update the doc for --disassemble-functions.
Summary

Update the doc after llvm-svn: 364121 is landed.
With two more trivial fixes that are not related to
--disassemble-functions but still about llvm-objdump.

Diff Detail

Event Timeline

ychen created this revision.Jun 25 2019, 1:31 PM
Herald added a project: Restricted Project. · View Herald TranscriptJun 25 2019, 1:31 PM
Herald added a subscriber: llvm-commits. · View Herald Transcript
Harbormaster completed remote builds in B33907: Diff 206521.Jun 25 2019, 1:36 PM
MaskRay accepted this revision.Jun 25 2019, 7:45 PM
This revision is now accepted and ready to land.Jun 25 2019, 7:45 PM
jhenderson accepted this revision.Jun 26 2019, 2:09 AM

LGTM, with one suggestion.

llvm/docs/CommandGuide/llvm-objdump.rst
38

Perhaps worth changing "demangled symbols" to "demangled symbol names" and "mangled symbols" to "mangled symbol names".

ychen updated this revision to Diff 206699.Jun 26 2019, 9:26 AM
  • update
ychen marked an inline comment as done.Jun 26 2019, 9:26 AM
Harbormaster completed remote builds in B33955: Diff 206699.Jun 26 2019, 9:28 AM
jhenderson accepted this revision.Jun 27 2019, 1:38 AM
Closed by commit rL364573: [llvm-objdump] Update the doc for --disassemble-functions. (authored by yuanfang). · Explain WhyJun 27 2019, 11:42 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
llvm/
docs/
CommandGuide/
10 lines

Diff 206521

llvm/docs/CommandGuide/llvm-objdump.rst

Show All 27 Lines.. option:: -d, --disassemble
Display assembler mnemonics for the machine instructions. Disassembles all Display assembler mnemonics for the machine instructions. Disassembles all
text sections found in the input file(s) by default. text sections found in the input file(s) by default.
.. option:: -D, --disassemble-all .. option:: -D, --disassemble-all
Display assembler mnemonics for the machine instructions. Disassembles all Display assembler mnemonics for the machine instructions. Disassembles all
sections found in the input file(s) by default. sections found in the input file(s) by default.
.. option:: --disassemble-functions=<func1[,func2,...]> .. option:: --disassemble-functions=<symbol1[,symbol2,...]>
Disassemble only the specified symbols. Implies :option:`--disassemble`. Disassemble only the specified symbols. Takes demangled symbols when
jhendersonUnsubmitted
Done
ReplyInline Actions

Perhaps worth changing "demangled symbols" to "demangled symbol names" and "mangled symbols" to "mangled symbol names".

jhenderson: Perhaps worth changing "demangled symbols" to "demangled symbol names" and "mangled symbols" to…
:option:`--demangle` is specified, otherwise takes mangled symbols.
Implies :option:`--disassemble`.
.. option:: --dwarf=<value> .. option:: --dwarf=<value>
Dump the specified DWARF debug sections. The supported values are: Dump the specified DWARF debug sections. The supported values are:
`frames` - .debug_frame `frames` - .debug_frame
.. option:: -f, --file-headers .. option:: -f, --file-headers
▲ Show 20 Lines • Show All 57 Lines • ▼ Show 20 Lines
.. option:: --adjust-vma=<offset> .. option:: --adjust-vma=<offset>
Increase the displayed address in disassembly or section header printing by Increase the displayed address in disassembly or section header printing by
the specified offset. the specified offset.
.. option:: --arch-name=<string> .. option:: --arch-name=<string>
Specify the target architecture when disassembling. Use :option:``--version`` Specify the target architecture when disassembling. Use :option:`--version`
for a list of available targets. for a list of available targets.
.. option:: -C, --demangle .. option:: -C, --demangle
Demangle symbol names in the output. Demangle symbol names in the output.
.. option:: -j, --section=<section1[,section2,...]> .. option:: -j, --section=<section1[,section2,...]>
▲ Show 20 Lines • Show All 65 Lines • ▼ Show 20 Lines.. option:: --triple=<string>
Target triple to disassemble for, see ``--version`` for available targets. Target triple to disassemble for, see ``--version`` for available targets.
.. option:: -w, --wide .. option:: -w, --wide
Ignored for compatibility with GNU objdump. Ignored for compatibility with GNU objdump.
.. option:: --x86-asm-syntax=<style> .. option:: --x86-asm-syntax=<style>
When used with the ``--disassemble`` option, choose style of code to emit from When used with :option:`--disassemble`, choose style of code to emit from
X86 backend. Supported values are: X86 backend. Supported values are:
.. option:: att .. option:: att
AT&T-style assembly AT&T-style assembly
.. option:: intel .. option:: intel
▲ Show 20 Lines • Show All 129 Lines • Show Last 20 Lines