maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/docs/CommandGuide/index.rst

77 lines
1.2 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-09 00:50:35 +08: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
llvm-as
llvm-dis
opt
llc
lli
llvm-link
Start adding documentation for llvm-lib. llvm-svn: 242557
2015-07-18 02:49:26 +08:00
llvm-lib
[llvm-lipo] Add docs for llvm-lipo Add docs (llvm-lipo.rst) for llvm-lipo. Test plan: make -j8 sphinx check that ./docs/html/CommandGuide/llvm-lipo.html is built correctly and looks okay. Differential revision: https://reviews.llvm.org/D62706 llvm-svn: 362848
2019-06-08 06:03:02 +08:00
llvm-lipo
[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-09 00:50:35 +08:00
llvm-config
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-14 04:22:02 +08: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-09 00:50:35 +08:00
llvm-diff
llvm-cov
PGO: llvm-profdata: tool for merging profiles Introducing llvm-profdata, a tool for merging profile data generated by PGO instrumentation in clang. - The name indicates a file extension of <name>.profdata. Eventually profile data output by clang should be changed to that extension. - llvm-profdata merges two profiles. However, the name is more general, since it will likely pick up more tasks (such as summarizing a single profile). - llvm-profdata parses the current text-based format, but will be updated once we settle on a binary format. <rdar://problem/15949645> llvm-svn: 201535
2014-02-18 07:22:49 +08:00
llvm-profdata
[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-09 00:50:35 +08:00
llvm-stress
Docs for llvm-symbolizer command-line tool llvm-svn: 176337
2013-03-01 15:58:27 +08:00
llvm-symbolizer
Add documentation for llvm-dwarfdump tool llvm-svn: 209173
2014-05-20 06:53:29 +08:00
llvm-dwarfdump
[dsymutil][doc] Improve wording in manpage and rename file. - Improve wording - Rename llvm-dsymutil to dsymutil - Name -arch=<arch> argument Differential revision: https://reviews.llvm.org/D39561 llvm-svn: 317226
2017-11-03 02:44:54 +08:00
dsymutil
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 21:43:11 +08:00
llvm-mca
[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-08 00:43:44 +08:00
llvm-readobj
[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-09 00:50:35 +08: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-12 05:13:01 +08:00
GNU binutils replacements
~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
llvm-addr2line
llvm-ar
llvm-cxxfilt
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-09 00:50:35 +08:00
Debugging Tools
~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
bugpoint
llvm-extract
llvm-bcanalyzer
Developer Tools
~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
FileCheck
tblgen
lit
llvm-build
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 19:37:06 +08:00
llvm-exegesis
Add documentation for llvm-pdbutil. llvm-svn: 310744
2017-08-12 03:00:22 +08:00
llvm-pdbutil