llvm-mirror/docs/CommandGuide/index.rst

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
   llvm-ar
   llvm-lib
   llvm-nm
   llvm-objdump
   llvm-config
   llvm-cxxmap
   llvm-diff
   llvm-cov
   llvm-profdata
   llvm-stress
   llvm-symbolizer
   llvm-dwarfdump
   dsymutil
   llvm-mca

Debugging Tools
~~~~~~~~~~~~~~~

.. toctree::
   :maxdepth: 1

   bugpoint
   llvm-extract
   llvm-bcanalyzer

Developer Tools
~~~~~~~~~~~~~~~

.. toctree::
   :maxdepth: 1

   FileCheck
   tblgen
   lit
   llvm-build
   llvm-exegesis
   llvm-pdbutil
   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-08 18:50:35 +02: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`
			`llvm-ar`
Start adding documentation for llvm-lib. llvm-svn: 242557 2015-07-17 20:49:26 +02:00			`llvm-lib`
[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 18:50:35 +02:00			`llvm-nm`
Add a CommandGuide for llvm-objdump Summary: Add a CommandGuide for llvm-objdump summarizing its usage along with some general context. Reviewers: beanz Reviewed By: beanz Subscribers: Eugene.Zelenko, llvm-commits Differential Revision: https://reviews.llvm.org/D50034 llvm-svn: 339250 2018-08-08 16:39:22 +02:00			`llvm-objdump`
[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 18:50:35 +02: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-13 22:22:02 +02: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 18:50:35 +02: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 00:22:49 +01: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-08 18:50:35 +02:00			`llvm-stress`
Docs for llvm-symbolizer command-line tool llvm-svn: 176337 2013-03-01 08:58:27 +01:00			`llvm-symbolizer`
Add documentation for llvm-dwarfdump tool llvm-svn: 209173 2014-05-20 00:53:29 +02: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-02 19:44:54 +01: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 14:43:11 +01:00			`llvm-mca`
[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 18:50:35 +02: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 13:37:06 +02:00			`llvm-exegesis`
Add documentation for llvm-pdbutil. llvm-svn: 310744 2017-08-11 21:00:22 +02:00			`llvm-pdbutil`
Add man page for llvm-readobj llvm-svn: 179244 2013-04-11 02:05:57 +02:00			`llvm-readobj`