mirror of
https://github.com/llvm/llvm-project.git
synced 2025-05-01 20:26:05 +00:00
7d80b94ca3
This adds llvm-remarkutil. This is intended to be a general tool for doing stuff with/to remark files. This patch gives it the following powers: * `bitstream2yaml` - To convert bitstream remarks to YAML * `yaml2bitstream` - To convert YAML remarks to bitstream remarks These are both implemented as subcommands, like `llvm-remarkutil bitstream2yaml <input_file> -o -` I ran into an issue where I had some bitstream remarks coming from CI, and I wanted to be able to do stuff with them (e.g. visualize them). But then I noticed we didn't have any tooling for doing that, so I decided to write this thing. Being able to output YAML as a start seemed like a good idea, since it would allow people to reuse any tooling they may have written based around YAML remarks. Hopefully it can grow into a more featureful remark utility. :) Currently there are is an outstanding performance issue (see the TODO) with the bitstream2yaml case. I decided that I'd keep the tool small to start with and have the yaml2bitstream and bitstream2yaml cases be symmetric. Also I moved the remarks documentation to its own header because it seems a little out of place with "basic commands" and "developer tools"; it's really kind of its own thing. Differential Revision: https://reviews.llvm.org/D133646
97 lines
1.5 KiB
ReStructuredText
97 lines
1.5 KiB
ReStructuredText
LLVM Command Guide
|
|
------------------
|
|
|
|
The following documents are command descriptions for all of the LLVM tools.
|
|
These pages describe how to use the LLVM commands and what their options are.
|
|
Note that these pages do not describe all of the options available for all
|
|
tools. To get a complete listing, pass the ``--help`` (general options) or
|
|
``--help-hidden`` (general and debugging options) arguments to the tool you are
|
|
interested in.
|
|
|
|
Basic Commands
|
|
~~~~~~~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
dsymutil
|
|
llc
|
|
lli
|
|
llvm-as
|
|
llvm-config
|
|
llvm-cov
|
|
llvm-cxxmap
|
|
llvm-diff
|
|
llvm-dis
|
|
llvm-dwarfdump
|
|
llvm-dwarfutil
|
|
llvm-lib
|
|
llvm-libtool-darwin
|
|
llvm-link
|
|
llvm-lipo
|
|
llvm-mca
|
|
llvm-otool
|
|
llvm-profdata
|
|
llvm-readobj
|
|
llvm-stress
|
|
llvm-symbolizer
|
|
opt
|
|
|
|
GNU binutils replacements
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
llvm-addr2line
|
|
llvm-ar
|
|
llvm-cxxfilt
|
|
llvm-install-name-tool
|
|
llvm-nm
|
|
llvm-objcopy
|
|
llvm-objdump
|
|
llvm-ranlib
|
|
llvm-readelf
|
|
llvm-size
|
|
llvm-strings
|
|
llvm-strip
|
|
|
|
Debugging Tools
|
|
~~~~~~~~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
bugpoint
|
|
llvm-extract
|
|
llvm-bcanalyzer
|
|
|
|
Developer Tools
|
|
~~~~~~~~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
FileCheck
|
|
tblgen
|
|
clang-tblgen
|
|
lldb-tblgen
|
|
llvm-tblgen
|
|
mlir-tblgen
|
|
lit
|
|
llvm-exegesis
|
|
llvm-ifs
|
|
llvm-locstats
|
|
llvm-pdbutil
|
|
llvm-profgen
|
|
llvm-tli-checker
|
|
|
|
Remarks Tools
|
|
~~~~~~~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
llvm-remark-size-diff
|
|
llvm-remarkutil
|