llvm.org GIT mirror llvm / 09c2c6f
[Docs] Adds Getting Started/Tutorials, Reference to LLVM docs homepage Adds a section for Getting Started/Tutorials and Reference topics to the LLVM docs homepage. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@372031 91177308-0d34-0410-b5e6-96231b3b80d8 DeForest Richards a month ago
3 changed file(s) with 58 addition(s) and 52 deletion(s). Raw diff Collapse all Expand all
+0
-30
docs/ReferenceDocumentation.rst less more
None 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 GettingStarted
2120 GettingStartedVS
2221 FAQ
23 Lexicon
2422 HowToAddABuilder
2523 yaml2obj
2624 MarkdownQuickstartTemplate
2725 Phabricator
28 tutorial/index
29 ReleaseNotes
3026 Passes
3127 YamlIO
3228 GetElementPtr
4036 Docker
4137 BuildingADistribution
4238 Remarks
43
44 :doc:`GettingStarted`
45 Discusses how to get up and running quickly with the LLVM infrastructure.
46 Everything from unpacking and compilation of the distribution to execution
47 of some tools.
4839
4940 :doc:`CMake`
5041 An addendum to the main Getting Started guide for those using the `CMake
6657 An addendum to the main Getting Started guide for those using Visual Studio
6758 on Windows.
6859
69 :doc:`tutorial/index`
70 Tutorials about using LLVM. Includes a tutorial about making a custom
71 language with LLVM.
72
7360 :doc:`Passes`
7461 A list of optimizations and analyses implemented in LLVM.
7562
7663 :doc:`FAQ`
7764 A list of common questions and problems and their solutions.
78
79 :doc:`Release notes for the current release `
80 This describes new features, known bugs, and other limitations.
8165
8266 :doc:`TestSuiteGuide`
8367 Describes how to compile and run the test-suite benchmarks.
8670 Instructions for building the clang front-end from source.
8771
8872 .. __: http://clang.llvm.org/get_started.html
89
90 :doc:`Lexicon`
91 Definition of acronyms, terms and concepts used in LLVM.
9273
9374 :doc:`HowToAddABuilder`
9475 Instructions for adding new builder to LLVM buildbot master.
2121 :hidden:
2222
2323 LangRef
24 Lexicon
2425
2526 :doc:`LangRef`
2627 Defines the LLVM intermediate representation.
4849
4950 `Publications mentioning LLVM `_
5051 ..
52
53 :doc:`Lexicon`
54 Definition of acronyms, terms and concepts used in LLVM.
5155
5256 Documentation
5357 =============
6266 SubsystemDocumentation
6367 ReferenceDocumentation
6468
65
6669 :doc:`UserGuides`
6770 For those new to the LLVM system.
6871
7275 :doc:`SubsystemDocumentation`
7376 For API clients and LLVM developers.
7477
75 :doc:`ReferenceDocumentation`
76 LLVM and API reference documentation.
78 Getting Started/Tutorials
79 -------------------------
80
81 .. toctree::
82 :hidden:
83
84 GettingStarted
85 tutorial/index
86
87 :doc:`GettingStarted`
88 Discusses how to get up and running quickly with the LLVM infrastructure.
89 Everything from unpacking and compilation of the distribution to execution
90 of some tools.
91
92 :doc:`tutorial/index`
93 Tutorials about using LLVM. Includes a tutorial about making a custom
94 language with LLVM.
95
96 Reference
97 ---------
98
99 .. toctree::
100 :hidden:
101
102 LLVM and API reference documentation.
103
104 .. toctree::
105 :hidden:
106
107 CommandGuide/index
108 TestingGuide
109
110 :doc:`LLVM Language Reference Manual `
111 Defines the LLVM intermediate representation and the assembly form of the
112 different nodes.
113
114 :doc:`LLVM Command Guide `
115 A reference manual for the LLVM command line utilities ("man" pages for LLVM
116 tools).
117
118 :doc:`LLVM Testing Infrastructure Guide `
119 A reference manual for using the LLVM testing infrastructure.
120
121 `Doxygen generated documentation `_
122 (`classes `_)
123
124 `Documentation for Go bindings `_
125
126 `Github Source Repository Browser `_
127 ..
77128
78129 Community
79130 =========
131182 HowToReleaseLLVM
132183 Packaging
133184 ReleaseProcess
185 ReleaseNotes
134186
135187 :doc:`Projects`
136188 How-to guide and templates for new projects that *use* the LLVM
150202
151203 :doc:`Packaging`
152204 Advice on packaging LLVM into a distribution.
205
206 :doc:`Release notes for the current release `
207 This describes new features, known bugs, and other limitations.
153208
154209 Mailing Lists
155210 -------------