llvm.org GIT mirror llvm / 9d1e305
[Docs] Adds page for reference docs Adds a Reference Documentation page for LLVM and API reference documentation. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@371782 91177308-0d34-0410-b5e6-96231b3b80d8 DeForest Richards a month ago
3 changed file(s) with 33 addition(s) and 9 deletion(s). Raw diff Collapse all Expand all
0 Reference Documentation
1 ========================
2
3 LLVM and API reference documentation.
4
5 .. toctree::
6 :hidden:
7
8 CommandGuide/index
9 TestingGuide
10
11 :doc:`LLVM Language Reference Manual `
12 Defines the LLVM intermediate representation and the assembly form of the
13 different nodes.
14
15 :doc:`LLVM Command Guide `
16 A reference manual for the LLVM command line utilities ("man" pages for LLVM
17 tools).
18
19 :doc:`LLVM Testing Infrastructure Guide `
20 A reference manual for using the LLVM testing infrastructure.
21
22 `Doxygen generated documentation `_
23 (`classes `_)
24
25 `Documentation for Go bindings `_
26
27 `Github Source Repository Browser `_
28 ..
29
1717 HowToBuildWithPGO
1818 HowToCrossCompileBuiltinsOnArm
1919 HowToCrossCompileLLVM
20 CommandGuide/index
2120 GettingStarted
2221 GettingStartedVS
2322 FAQ
2625 yaml2obj
2726 MarkdownQuickstartTemplate
2827 Phabricator
29 TestingGuide
3028 tutorial/index
3129 ReleaseNotes
3230 Passes
7270 Tutorials about using LLVM. Includes a tutorial about making a custom
7371 language with LLVM.
7472
75 :doc:`LLVM Command Guide `
76 A reference manual for the LLVM command line utilities ("man" pages for LLVM
77 tools).
78
7973 :doc:`Passes`
8074 A list of optimizations and analyses implemented in LLVM.
8175
8478
8579 :doc:`Release notes for the current release `
8680 This describes new features, known bugs, and other limitations.
87
88 :doc:`LLVM Testing Infrastructure Guide `
89 A reference manual for using the LLVM testing infrastructure.
9081
9182 :doc:`TestSuiteGuide`
9283 Describes how to compile and run the test-suite benchmarks.
6969
7070 :doc:`SubsystemDocumentation`
7171 For API clients and LLVM developers.
72
73 :doc:`ReferenceDocumentation`
74 LLVM and API reference documentation.
7275
7376 Community
7477 =========