Fix docs typo regarding lit.local.cfg files
[oota-llvm.git] / docs / CommandGuide / index.rst
1 LLVM Command Guide
2 ------------------
3
4 The following documents are command descriptions for all of the LLVM tools.
5 These pages describe how to use the LLVM commands and what their options are.
6 Note that these pages do not describe all of the options available for all
7 tools. To get a complete listing, pass the ``--help`` (general options) or
8 ``--help-hidden`` (general and debugging options) arguments to the tool you are
9 interested in.
10
11 Basic Commands
12 ~~~~~~~~~~~~~~
13
14 .. toctree::
15    :maxdepth: 1
16
17    llvm-as
18    llvm-dis
19    opt
20    llc
21    lli
22    llvm-link
23    llvm-ar
24    llvm-nm
25    llvm-config
26    llvm-diff
27    llvm-cov
28    llvm-profdata
29    llvm-stress
30    llvm-symbolizer
31    llvm-dwarfdump
32
33 Debugging Tools
34 ~~~~~~~~~~~~~~~
35
36 .. toctree::
37    :maxdepth: 1
38
39    bugpoint
40    llvm-extract
41    llvm-bcanalyzer
42
43 Developer Tools
44 ~~~~~~~~~~~~~~~
45
46 .. toctree::
47    :maxdepth: 1
48
49    FileCheck
50    tblgen
51    lit
52    llvm-build
53    llvm-readobj