mirrors/llvm-project
0
0
Fork 0
mirror of https://github.com/llvm/llvm-project.git synced 2025-05-01 21:46:06 +00:00
Code Issues Projects Releases Wiki Activity
llvm-project/llvm/docs/CommandGuide/index.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

97 lines
1.5 KiB
ReStructuredText
Raw Normal View History

[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-08 16:50:35 +00:00
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
Introducing llvm-libtool-darwin This diff starts the implementation of llvm-libtool-darwin (an llvm based replacement of cctool's libtool). Libtool is used for creating static and dynamic libraries from a bunch of object files given as input. Reviewed by alexshap, smeenai, jhenderson, MaskRay Differential Revision: https://reviews.llvm.org/D82923
2020-07-01 14:41:07 -07:00
dsymutil
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-08 16:50:35 +00:00
llc
lli
Introducing llvm-libtool-darwin This diff starts the implementation of llvm-libtool-darwin (an llvm based replacement of cctool's libtool). Libtool is used for creating static and dynamic libraries from a bunch of object files given as input. Reviewed by alexshap, smeenai, jhenderson, MaskRay Differential Revision: https://reviews.llvm.org/D82923
2020-07-01 14:41:07 -07:00
llvm-as
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-08 16:50:35 +00:00
llvm-config
Introducing llvm-libtool-darwin This diff starts the implementation of llvm-libtool-darwin (an llvm based replacement of cctool's libtool). Libtool is used for creating static and dynamic libraries from a bunch of object files given as input. Reviewed by alexshap, smeenai, jhenderson, MaskRay Differential Revision: https://reviews.llvm.org/D82923
2020-07-01 14:41:07 -07:00
llvm-cov
Add flag to llvm-profdata to allow symbols in profile data to be remapped, and add a tool to generate symbol remapping files. Summary: The new tool llvm-cxxmap builds a symbol mapping table from a file containing a description of partial equivalences to apply to mangled names and files containing old and new symbol tables. Reviewers: davidxl Subscribers: mgorny, llvm-commits Differential Revision: https://reviews.llvm.org/D51470 llvm-svn: 342168
2018-09-13 20:22:02 +00:00
llvm-cxxmap
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-08 16:50:35 +00:00
llvm-diff
Introducing llvm-libtool-darwin This diff starts the implementation of llvm-libtool-darwin (an llvm based replacement of cctool's libtool). Libtool is used for creating static and dynamic libraries from a bunch of object files given as input. Reviewed by alexshap, smeenai, jhenderson, MaskRay Differential Revision: https://reviews.llvm.org/D82923
2020-07-01 14:41:07 -07:00
llvm-dis
Add documentation for llvm-dwarfdump tool llvm-svn: 209173
2014-05-19 22:53:29 +00:00
llvm-dwarfdump
[Reland][Debuginfo][llvm-dwarfutil] llvm-dwarfutil dsymutil-like tool for ELF. This patch implements proposal https://lists.llvm.org/pipermail/llvm-dev/2020-August/144579.html llvm-dwarfutil - is a tool that is used for processing debug info(DWARF) located in built binary files to improve debug info quality, reduce debug info size. The patch currently implements smaller set of command-line options(comparing to the proposal): ``` ./llvm-dwarfutil [options] <input file> <output file> --garbage-collection Do garbage collection for debug info(default) -j <value> Alias for --num-threads --no-garbage-collection Don`t do garbage collection for debug info --no-odr-deduplication Don`t do ODR deduplication for debug types --no-odr Alias for --no-odr-deduplication --no-separate-debug-file Create single output file, containing debug tables(default) --num-threads <threads> Number of available threads for multi-threaded execution. Defaults to the number of cores on the current machine --odr-deduplication Do ODR deduplication for debug types(default) --odr Alias for --odr-deduplication --separate-debug-file Create two output files: file w/o debug tables and file with debug tables --tombstone [bfd,maxpc,exec,universal] Tombstone value used as a marker of invalid address(default: universal) =bfd - Zero for all addresses and [1,1] for DWARF v4 (or less) address ranges and exec =maxpc - Minus 1 for all addresses and minus 2 for DWARF v4 (or less) address ranges =exec - Match with address ranges of executable sections =universal - Both: bfd and maxpc ``` Reviewed By: clayborg Differential Revision: https://reviews.llvm.org/D86539
2022-07-10 20:11:55 +03:00
llvm-dwarfutil
Introducing llvm-libtool-darwin This diff starts the implementation of llvm-libtool-darwin (an llvm based replacement of cctool's libtool). Libtool is used for creating static and dynamic libraries from a bunch of object files given as input. Reviewed by alexshap, smeenai, jhenderson, MaskRay Differential Revision: https://reviews.llvm.org/D82923
2020-07-01 14:41:07 -07:00
llvm-lib
llvm-libtool-darwin
llvm-link
llvm-lipo
Add llvm-mca.rst to the table of contents in docs/CommandGuide. This should fix the documentation error reported by builder llvm-sphinx-docs (build #16407) after r326998. llvm-svn: 326999
2018-03-08 13:43:11 +00:00
llvm-mca
[llvm-objdump] Add an llvm-otool tool This implements an LLVM tool that's flag- and output-compatible with macOS's `otool` -- except for bugs, but from testing with both `otool` and `xcrun otool-classic`, llvm-otool matches vanilla otool's behavior very well already. It's not 100% perfect, but it's a very solid start. This uses the same approach as llvm-objcopy: llvm-objdump uses a different OptTable when it's invoked as llvm-otool. This is possible thanks to D100433. Differential Revision: https://reviews.llvm.org/D100583
2021-04-15 10:55:22 -04:00
llvm-otool
Introducing llvm-libtool-darwin This diff starts the implementation of llvm-libtool-darwin (an llvm based replacement of cctool's libtool). Libtool is used for creating static and dynamic libraries from a bunch of object files given as input. Reviewed by alexshap, smeenai, jhenderson, MaskRay Differential Revision: https://reviews.llvm.org/D82923
2020-07-01 14:41:07 -07:00
llvm-profdata
[docs]Move llvm-readobj from "Developer Tools" to "Basic Commands" On the Command Guide page, there are multiple sections with links to the different documentation pages available for LLVM tools. The "Basic Tools" section includes tools like llvm-objdump, llvm-nm and so on. The "Developer Tools" section contains things like FileCheck and lit. This change moves llvm-readobj into the former block, from the latter. Reviewed by: MaskRay Differential Revision: https://reviews.llvm.org/D63011 llvm-svn: 362813
2019-06-07 16:43:44 +00:00
llvm-readobj
Introducing llvm-libtool-darwin This diff starts the implementation of llvm-libtool-darwin (an llvm based replacement of cctool's libtool). Libtool is used for creating static and dynamic libraries from a bunch of object files given as input. Reviewed by alexshap, smeenai, jhenderson, MaskRay Differential Revision: https://reviews.llvm.org/D82923
2020-07-01 14:41:07 -07:00
llvm-stress
llvm-symbolizer
opt
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-08 16:50:35 +00:00
[docs] Add "GNU binutils Replacements" section to command guide Summary: This splits out a section in the command guide for llvm tools that can be used as replacements for GNU tools. For pages that didn't exist, I added stub pages that can be individually filled in by followup patches. Tested by running `ninja docs-llvm-html` and inspecting locally. Reviewers: jhenderson, MaskRay, grimar, alexshap Reviewed By: jhenderson, MaskRay, grimar Subscribers: smeenai, arphaman, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D63014 llvm-svn: 363100
2019-06-11 21:13:01 +00:00
GNU binutils replacements
~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
llvm-addr2line
llvm-ar
llvm-cxxfilt
[llvm-install-name-tool] Adds docs for llvm-install-name-tool Adding documentation for llvm-install-name-tool. Reviewed by smeenai, Ktwu Differential Revision: https://reviews.llvm.org/D81944
2020-06-12 07:39:46 -07:00
llvm-install-name-tool
[docs] Add "GNU binutils Replacements" section to command guide Summary: This splits out a section in the command guide for llvm tools that can be used as replacements for GNU tools. For pages that didn't exist, I added stub pages that can be individually filled in by followup patches. Tested by running `ninja docs-llvm-html` and inspecting locally. Reviewers: jhenderson, MaskRay, grimar, alexshap Reviewed By: jhenderson, MaskRay, grimar Subscribers: smeenai, arphaman, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D63014 llvm-svn: 363100
2019-06-11 21:13:01 +00:00
llvm-nm
llvm-objcopy
llvm-objdump
llvm-ranlib
llvm-readelf
llvm-size
llvm-strings
llvm-strip
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-08 16:50:35 +00:00
Debugging Tools
~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
bugpoint
llvm-extract
llvm-bcanalyzer
Developer Tools
~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
FileCheck
tblgen
[TableGen] [Docs] Add lldb-tblgen to command guide; add 4 guide stubs Differential Revision: https://reviews.llvm.org/D99605
2021-03-30 12:37:13 -04:00
clang-tblgen
lldb-tblgen
llvm-tblgen
mlir-tblgen
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-08 16:50:35 +00:00
lit
Re-land r329156 "Add llvm-exegesis tool." Fixed to depend on and initialize the native target instead of X86. llvm-svn: 329169
2018-04-04 11:37:06 +00:00
llvm-exegesis
[doc] Add llvm-ifs commandline guide This patch adds llvm-ifs commandline guide Differential Review: https://reviews.llvm.org/D118514
2022-01-28 15:30:43 -08:00
llvm-ifs
Reland "[utils] Implement the llvm-locstats tool" The tool reports verbose output for the DWARF debug location coverage. The llvm-locstats for each variable or formal parameter DIE computes what percentage from the code section bytes, where it is in scope, it has location description. The line 0 shows the number (and the percentage) of DIEs with no location information, but the line 100 shows the number (and the percentage) of DIEs where there is location information in all code section bytes (where the variable or parameter is in the scope). The line 50..59 shows the number (and the percentage) of DIEs where the location information is in between 50 and 59 percentage of its scope covered. Differential Revision: https://reviews.llvm.org/D66526 The cause of the test failure was resolved. llvm-svn: 373427
2019-10-02 07:00:01 +00:00
llvm-locstats
[llvm-profgen] [docs] Fix invalid header. Add to ToC. NFC.
2020-11-26 10:40:52 +01:00
llvm-pdbutil
llvm-profgen
Add llvm-tli-checker A new tool that compares TargetLibraryInfo's opinion of the availability of library function calls against the functions actually exported by a specified set of libraries. Can be helpful in verifying the correctness of TLI for a given target, and avoid mishaps such as had to be addressed in D107509 and 94b4598d. The tool currently supports ELF object files only, although it's unlikely to be hard to add support for other formats. Re-commits 62dd488 with changes to use pre-generated objects, as not all bots have ld.lld available. Differential Revision: https://reviews.llvm.org/D111358
2021-11-08 16:29:28 -08:00
llvm-tli-checker
Add a utility for converting between different types of remarks 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
2022-09-09 19:58:02 -07:00
Remarks Tools
~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
llvm-remark-size-diff
llvm-remarkutil
Reference in New Issue Copy Permalink