diff options
Diffstat (limited to 'llvm/docs')
-rw-r--r-- | llvm/docs/ProgrammingDocumentation.rst | 9 | ||||
-rw-r--r-- | llvm/docs/SubsystemDocumentation.rst | 5 | ||||
-rw-r--r-- | llvm/docs/UserGuides.rst | 9 | ||||
-rw-r--r-- | llvm/docs/index.rst | 28 |
4 files changed, 24 insertions, 27 deletions
diff --git a/llvm/docs/ProgrammingDocumentation.rst b/llvm/docs/ProgrammingDocumentation.rst index 85bf39241df..fa8f114b22a 100644 --- a/llvm/docs/ProgrammingDocumentation.rst +++ b/llvm/docs/ProgrammingDocumentation.rst @@ -7,9 +7,7 @@ For developers of applications which use LLVM as a library. :hidden:
Atomics
- CodingStandards
CommandLine
- CompilerWriterInfo
ExtendingLLVM
HowToSetUpLLVMStyleRTTI
ProgrammersManual
@@ -33,10 +31,6 @@ For developers of applications which use LLVM as a library. :doc:`CommandLine`
Provides information on using the command line parsing library.
-:doc:`CodingStandards`
- Details the LLVM coding standards and provides useful information on writing
- efficient C++ code.
-
:doc:`HowToSetUpLLVMStyleRTTI`
How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
class hierarchy.
@@ -44,9 +38,6 @@ For developers of applications which use LLVM as a library. :doc:`ExtendingLLVM`
Look here to see how to add instructions and intrinsics to LLVM.
-:doc:`CompilerWriterInfo`
- A list of helpful links for compiler writers.
-
:doc:`LibFuzzer`
A library for writing in-process guided fuzzers.
diff --git a/llvm/docs/SubsystemDocumentation.rst b/llvm/docs/SubsystemDocumentation.rst index 2d3882a6b6f..cac0ce85b1f 100644 --- a/llvm/docs/SubsystemDocumentation.rst +++ b/llvm/docs/SubsystemDocumentation.rst @@ -43,7 +43,6 @@ For API clients and LLVM developers. TypeMetadata
TransformMetadata
FaultMaps
- MIRLangRef
Coroutines
GlobalISel
XRay
@@ -67,10 +66,6 @@ For API clients and LLVM developers. working on retargetting LLVM to a new architecture, designing a new codegen
pass, or enhancing existing components.
-: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.
-
:doc:`TableGen <TableGen/index>`
Describes the TableGen tool, which is used heavily by the LLVM code
generator.
diff --git a/llvm/docs/UserGuides.rst b/llvm/docs/UserGuides.rst index 962fd149743..9dfab67f42e 100644 --- a/llvm/docs/UserGuides.rst +++ b/llvm/docs/UserGuides.rst @@ -18,8 +18,6 @@ intermediate LLVM representation. HowToBuildWithPGO
HowToCrossCompileBuiltinsOnArm
HowToCrossCompileLLVM
- GettingStartedVS
- FAQ
yaml2obj
MarkdownQuickstartTemplate
Phabricator
@@ -53,16 +51,9 @@ intermediate LLVM representation. :doc:`HowToCrossCompileLLVM`
Notes on cross-building and testing LLVM/Clang.
-:doc:`GettingStartedVS`
- An addendum to the main Getting Started guide for those using Visual Studio
- on Windows.
-
:doc:`Passes`
A list of optimizations and analyses implemented in LLVM.
-:doc:`FAQ`
- A list of common questions and problems and their solutions.
-
:doc:`TestSuiteGuide`
Describes how to compile and run the test-suite benchmarks.
diff --git a/llvm/docs/index.rst b/llvm/docs/index.rst index ef7ae86baab..a9abd97c373 100644 --- a/llvm/docs/index.rst +++ b/llvm/docs/index.rst @@ -21,11 +21,8 @@ Several introductory papers and presentations. .. toctree:: :hidden: - LangRef Lexicon - -:doc:`LangRef` - Defines the LLVM intermediate representation. + FAQ `Introduction to the LLVM Compiler`__ Presentation providing a users introduction to LLVM. @@ -54,6 +51,9 @@ Several introductory papers and presentations. :doc:`Lexicon` Definition of acronyms, terms and concepts used in LLVM. +:doc:`FAQ` + A list of common questions and problems and their solutions. + Documentation ============= @@ -83,6 +83,7 @@ Getting Started/Tutorials GettingStarted tutorial/index + GettingStartedVS :doc:`GettingStarted` Discusses how to get up and running quickly with the LLVM infrastructure. @@ -93,6 +94,10 @@ Getting Started/Tutorials 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 --------- @@ -104,8 +109,11 @@ LLVM and API reference documentation. .. 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 @@ -118,6 +126,13 @@ LLVM and API reference documentation. :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>`_) @@ -147,6 +162,7 @@ LLVM welcomes contributions of all kinds. To get started, please review the foll Phabricator HowToSubmitABug BugLifeCycle + CodingStandards :doc:`Contributing` An overview on how to contribute to LLVM. @@ -169,6 +185,10 @@ LLVM welcomes contributions of all kinds. To get started, please review the foll :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 ------------------- |