diff options
author | DeForest Richards <d4m1887@gmail.com> | 2019-09-16 20:19:32 +0000 |
---|---|---|
committer | DeForest Richards <d4m1887@gmail.com> | 2019-09-16 20:19:32 +0000 |
commit | e151cb7c632496f2ae263652d9d2977519128a27 (patch) | |
tree | 761437e896ce5a00d2251c61826cc55d170ad2f9 | |
parent | bfb197d7a3b322d55a11cbc076cd9f787934d34f (diff) | |
download | bcm5719-llvm-e151cb7c632496f2ae263652d9d2977519128a27.tar.gz bcm5719-llvm-e151cb7c632496f2ae263652d9d2977519128a27.zip |
[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.
llvm-svn: 372031
-rw-r--r-- | llvm/docs/ReferenceDocumentation.rst | 30 | ||||
-rw-r--r-- | llvm/docs/UserGuides.rst | 19 | ||||
-rw-r--r-- | llvm/docs/index.rst | 61 |
3 files changed, 58 insertions, 52 deletions
diff --git a/llvm/docs/ReferenceDocumentation.rst b/llvm/docs/ReferenceDocumentation.rst deleted file mode 100644 index d72c4978da8..00000000000 --- a/llvm/docs/ReferenceDocumentation.rst +++ /dev/null @@ -1,30 +0,0 @@ -Reference Documentation
-========================
-
-LLVM and API reference documentation.
-
-.. toctree::
- :hidden:
-
- CommandGuide/index
- TestingGuide
-
-:doc:`LLVM Language Reference Manual <LangRef>`
- Defines the LLVM intermediate representation and the assembly form of the
- different nodes.
-
-:doc:`LLVM Command Guide <CommandGuide/index>`
- A reference manual for the LLVM command line utilities ("man" pages for LLVM
- tools).
-
-:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
- A reference manual for using the LLVM testing infrastructure.
-
-`Doxygen generated documentation <http://llvm.org/doxygen/>`_
- (`classes <http://llvm.org/doxygen/inherits.html>`_)
-
-`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
-
-`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_
- ..
-
diff --git a/llvm/docs/UserGuides.rst b/llvm/docs/UserGuides.rst index 26ce6f927e2..65c7d5e83c3 100644 --- a/llvm/docs/UserGuides.rst +++ b/llvm/docs/UserGuides.rst @@ -18,16 +18,12 @@ intermediate LLVM representation. HowToBuildWithPGO
HowToCrossCompileBuiltinsOnArm
HowToCrossCompileLLVM
- GettingStarted
GettingStartedVS
FAQ
- Lexicon
HowToAddABuilder
yaml2obj
MarkdownQuickstartTemplate
Phabricator
- tutorial/index
- ReleaseNotes
Passes
YamlIO
GetElementPtr
@@ -42,11 +38,6 @@ intermediate LLVM representation. BuildingADistribution
Remarks
-:doc:`GettingStarted`
- Discusses how to get up and running quickly with the LLVM infrastructure.
- Everything from unpacking and compilation of the distribution to execution
- of some tools.
-
:doc:`CMake`
An addendum to the main Getting Started guide for those using the `CMake
build system <http://www.cmake.org>`_.
@@ -67,19 +58,12 @@ intermediate LLVM representation. An addendum to the main Getting Started guide for those using Visual Studio
on Windows.
-:doc:`tutorial/index`
- Tutorials about using LLVM. Includes a tutorial about making a custom
- language with LLVM.
-
:doc:`Passes`
A list of optimizations and analyses implemented in LLVM.
:doc:`FAQ`
A list of common questions and problems and their solutions.
-:doc:`Release notes for the current release <ReleaseNotes>`
- This describes new features, known bugs, and other limitations.
-
:doc:`TestSuiteGuide`
Describes how to compile and run the test-suite benchmarks.
@@ -88,9 +72,6 @@ intermediate LLVM representation. .. __: http://clang.llvm.org/get_started.html
-:doc:`Lexicon`
- Definition of acronyms, terms and concepts used in LLVM.
-
:doc:`HowToAddABuilder`
Instructions for adding new builder to LLVM buildbot master.
diff --git a/llvm/docs/index.rst b/llvm/docs/index.rst index 6b0d803a86a..7388174b023 100644 --- a/llvm/docs/index.rst +++ b/llvm/docs/index.rst @@ -22,6 +22,7 @@ Several introductory papers and presentations. :hidden: LangRef + Lexicon :doc:`LangRef` Defines the LLVM intermediate representation. @@ -50,6 +51,9 @@ Several introductory papers and presentations. `Publications mentioning LLVM <http://llvm.org/pubs>`_ .. +:doc:`Lexicon` + Definition of acronyms, terms and concepts used in LLVM. + Documentation ============= @@ -63,7 +67,6 @@ Getting Started, How-tos, Developer Guides, and Tutorials. SubsystemDocumentation ReferenceDocumentation - :doc:`UserGuides` For those new to the LLVM system. @@ -73,8 +76,56 @@ Getting Started, How-tos, Developer Guides, and Tutorials. :doc:`SubsystemDocumentation` For API clients and LLVM developers. -:doc:`ReferenceDocumentation` - LLVM and API reference documentation. +Getting Started/Tutorials +------------------------- + +.. toctree:: + :hidden: + + GettingStarted + tutorial/index + +:doc:`GettingStarted` + Discusses how to get up and running quickly with the LLVM infrastructure. + Everything from unpacking and compilation of the distribution to execution + of some tools. + +:doc:`tutorial/index` + Tutorials about using LLVM. Includes a tutorial about making a custom + language with LLVM. + +Reference +--------- + +.. toctree:: + :hidden: + +LLVM and API reference documentation. + +.. toctree:: + :hidden: + + CommandGuide/index + TestingGuide + +:doc:`LLVM Language Reference Manual <LangRef>` + Defines the LLVM intermediate representation and the assembly form of the + different nodes. + +:doc:`LLVM Command Guide <CommandGuide/index>` + A reference manual for the LLVM command line utilities ("man" pages for LLVM + tools). + +:doc:`LLVM Testing Infrastructure Guide <TestingGuide>` + A reference manual for using the LLVM testing infrastructure. + +`Doxygen generated documentation <http://llvm.org/doxygen/>`_ + (`classes <http://llvm.org/doxygen/inherits.html>`_) + +`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_ + +`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_ + .. Community ========= @@ -132,6 +183,7 @@ Information about LLVM's development process. HowToReleaseLLVM Packaging ReleaseProcess + ReleaseNotes :doc:`Projects` How-to guide and templates for new projects that *use* the LLVM @@ -152,6 +204,9 @@ Information about LLVM's development process. :doc:`Packaging` Advice on packaging LLVM into a distribution. +:doc:`Release notes for the current release <ReleaseNotes>` + This describes new features, known bugs, and other limitations. + Mailing Lists ------------- |