This commit moves several topics to new categories.
llvm-svn: 372428
:hidden:\r
\r
Atomics\r
- CodingStandards\r
CommandLine\r
- CompilerWriterInfo\r
ExtendingLLVM\r
HowToSetUpLLVMStyleRTTI\r
ProgrammersManual\r
:doc:`CommandLine`\r
Provides information on using the command line parsing library.\r
\r
-:doc:`CodingStandards`\r
- Details the LLVM coding standards and provides useful information on writing\r
- efficient C++ code.\r
-\r
:doc:`HowToSetUpLLVMStyleRTTI`\r
How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your\r
class hierarchy.\r
:doc:`ExtendingLLVM`\r
Look here to see how to add instructions and intrinsics to LLVM.\r
\r
-:doc:`CompilerWriterInfo`\r
- A list of helpful links for compiler writers.\r
-\r
:doc:`LibFuzzer`\r
A library for writing in-process guided fuzzers.\r
\r
TypeMetadata\r
TransformMetadata\r
FaultMaps\r
- MIRLangRef\r
Coroutines\r
GlobalISel\r
XRay\r
working on retargetting LLVM to a new architecture, designing a new codegen\r
pass, or enhancing existing components.\r
\r
-:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`\r
- A reference manual for the MIR serialization format, which is used to test\r
- LLVM's code generation passes.\r
-\r
:doc:`TableGen <TableGen/index>`\r
Describes the TableGen tool, which is used heavily by the LLVM code\r
generator.\r
HowToBuildWithPGO\r
HowToCrossCompileBuiltinsOnArm\r
HowToCrossCompileLLVM\r
- GettingStartedVS\r
- FAQ\r
yaml2obj\r
MarkdownQuickstartTemplate\r
Phabricator\r
:doc:`HowToCrossCompileLLVM`\r
Notes on cross-building and testing LLVM/Clang.\r
\r
-:doc:`GettingStartedVS`\r
- An addendum to the main Getting Started guide for those using Visual Studio\r
- on Windows.\r
-\r
:doc:`Passes`\r
A list of optimizations and analyses implemented in LLVM.\r
\r
-:doc:`FAQ`\r
- A list of common questions and problems and their solutions.\r
-\r
:doc:`TestSuiteGuide`\r
Describes how to compile and run the test-suite benchmarks.\r
\r
.. toctree::
:hidden:
- LangRef
Lexicon
-
-:doc:`LangRef`
- Defines the LLVM intermediate representation.
+ FAQ
`Introduction to the LLVM Compiler`__
Presentation providing a users introduction to LLVM.
:doc:`Lexicon`
Definition of acronyms, terms and concepts used in LLVM.
+:doc:`FAQ`
+ A list of common questions and problems and their solutions.
+
Documentation
=============
GettingStarted
tutorial/index
+ GettingStartedVS
:doc:`GettingStarted`
Discusses how to get up and running quickly with the LLVM infrastructure.
Tutorials about using LLVM. Includes a tutorial about making a custom
language with LLVM.
+:doc:`GettingStartedVS`
+ An addendum to the main Getting Started guide for those using Visual Studio
+ on Windows.
+
Reference
---------
.. toctree::
:hidden:
+ LangRef
CommandGuide/index
TestingGuide
+ CompilerWriterInfo
+ MIRLangRef
:doc:`LLVM Language Reference Manual <LangRef>`
Defines the LLVM intermediate representation and the assembly form of the
:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
A reference manual for using the LLVM testing infrastructure.
+:doc:`CompilerWriterInfo`
+ A list of helpful links for compiler writers.
+
+:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
+ A reference manual for the MIR serialization format, which is used to test
+ LLVM's code generation passes.
+
`Doxygen generated documentation <http://llvm.org/doxygen/>`_
(`classes <http://llvm.org/doxygen/inherits.html>`_)
Phabricator
HowToSubmitABug
BugLifeCycle
+ CodingStandards
:doc:`Contributing`
An overview on how to contribute to LLVM.
:doc:`BugLifeCycle`
Describes how bugs are reported, triaged and closed.
+:doc:`CodingStandards`
+ Details the LLVM coding standards and provides useful information on writing
+ efficient C++ code.
+
Development Process
-------------------