forked from OSchip/llvm-project
				
			[Docs] Move topics to new categories
This commit moves several topics to new categories. llvm-svn: 372428
This commit is contained in:
		
							parent
							
								
									0ae02fd71a
								
							
						
					
					
						commit
						01a3080960
					
				| 
						 | 
					@ -7,9 +7,7 @@ For developers of applications which use LLVM as a library.
 | 
				
			||||||
   :hidden:
 | 
					   :hidden:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
   Atomics
 | 
					   Atomics
 | 
				
			||||||
   CodingStandards
 | 
					 | 
				
			||||||
   CommandLine
 | 
					   CommandLine
 | 
				
			||||||
   CompilerWriterInfo
 | 
					 | 
				
			||||||
   ExtendingLLVM
 | 
					   ExtendingLLVM
 | 
				
			||||||
   HowToSetUpLLVMStyleRTTI
 | 
					   HowToSetUpLLVMStyleRTTI
 | 
				
			||||||
   ProgrammersManual
 | 
					   ProgrammersManual
 | 
				
			||||||
| 
						 | 
					@ -33,10 +31,6 @@ For developers of applications which use LLVM as a library.
 | 
				
			||||||
:doc:`CommandLine`
 | 
					:doc:`CommandLine`
 | 
				
			||||||
  Provides information on using the command line parsing library.
 | 
					  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`
 | 
					:doc:`HowToSetUpLLVMStyleRTTI`
 | 
				
			||||||
  How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
 | 
					  How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
 | 
				
			||||||
  class hierarchy.
 | 
					  class hierarchy.
 | 
				
			||||||
| 
						 | 
					@ -44,9 +38,6 @@ For developers of applications which use LLVM as a library.
 | 
				
			||||||
:doc:`ExtendingLLVM`
 | 
					:doc:`ExtendingLLVM`
 | 
				
			||||||
  Look here to see how to add instructions and intrinsics to LLVM.
 | 
					  Look here to see how to add instructions and intrinsics to LLVM.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
:doc:`CompilerWriterInfo`
 | 
					 | 
				
			||||||
  A list of helpful links for compiler writers.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
:doc:`LibFuzzer`
 | 
					:doc:`LibFuzzer`
 | 
				
			||||||
  A library for writing in-process guided fuzzers.
 | 
					  A library for writing in-process guided fuzzers.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -43,7 +43,6 @@ For API clients and LLVM developers.
 | 
				
			||||||
   TypeMetadata
 | 
					   TypeMetadata
 | 
				
			||||||
   TransformMetadata
 | 
					   TransformMetadata
 | 
				
			||||||
   FaultMaps
 | 
					   FaultMaps
 | 
				
			||||||
   MIRLangRef
 | 
					 | 
				
			||||||
   Coroutines
 | 
					   Coroutines
 | 
				
			||||||
   GlobalISel
 | 
					   GlobalISel
 | 
				
			||||||
   XRay
 | 
					   XRay
 | 
				
			||||||
| 
						 | 
					@ -67,10 +66,6 @@ For API clients and LLVM developers.
 | 
				
			||||||
   working on retargetting LLVM to a new architecture, designing a new codegen
 | 
					   working on retargetting LLVM to a new architecture, designing a new codegen
 | 
				
			||||||
   pass, or enhancing existing components.
 | 
					   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>`
 | 
					:doc:`TableGen <TableGen/index>`
 | 
				
			||||||
   Describes the TableGen tool, which is used heavily by the LLVM code
 | 
					   Describes the TableGen tool, which is used heavily by the LLVM code
 | 
				
			||||||
   generator.
 | 
					   generator.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -18,8 +18,6 @@ intermediate LLVM representation.
 | 
				
			||||||
   HowToBuildWithPGO
 | 
					   HowToBuildWithPGO
 | 
				
			||||||
   HowToCrossCompileBuiltinsOnArm
 | 
					   HowToCrossCompileBuiltinsOnArm
 | 
				
			||||||
   HowToCrossCompileLLVM
 | 
					   HowToCrossCompileLLVM
 | 
				
			||||||
   GettingStartedVS
 | 
					 | 
				
			||||||
   FAQ
 | 
					 | 
				
			||||||
   yaml2obj
 | 
					   yaml2obj
 | 
				
			||||||
   MarkdownQuickstartTemplate
 | 
					   MarkdownQuickstartTemplate
 | 
				
			||||||
   Phabricator
 | 
					   Phabricator
 | 
				
			||||||
| 
						 | 
					@ -53,16 +51,9 @@ intermediate LLVM representation.
 | 
				
			||||||
:doc:`HowToCrossCompileLLVM`
 | 
					:doc:`HowToCrossCompileLLVM`
 | 
				
			||||||
   Notes on cross-building and testing LLVM/Clang.
 | 
					   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`
 | 
					:doc:`Passes`
 | 
				
			||||||
   A list of optimizations and analyses implemented in LLVM.
 | 
					   A list of optimizations and analyses implemented in LLVM.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
:doc:`FAQ`
 | 
					 | 
				
			||||||
   A list of common questions and problems and their solutions.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
:doc:`TestSuiteGuide`
 | 
					:doc:`TestSuiteGuide`
 | 
				
			||||||
  Describes how to compile and run the test-suite benchmarks.
 | 
					  Describes how to compile and run the test-suite benchmarks.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -21,11 +21,8 @@ Several introductory papers and presentations.
 | 
				
			||||||
.. toctree::
 | 
					.. toctree::
 | 
				
			||||||
   :hidden:
 | 
					   :hidden:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
   LangRef
 | 
					 | 
				
			||||||
   Lexicon
 | 
					   Lexicon
 | 
				
			||||||
 | 
					   FAQ
 | 
				
			||||||
:doc:`LangRef`
 | 
					 | 
				
			||||||
  Defines the LLVM intermediate representation.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
`Introduction to the LLVM Compiler`__
 | 
					`Introduction to the LLVM Compiler`__
 | 
				
			||||||
  Presentation providing a users introduction to LLVM.
 | 
					  Presentation providing a users introduction to LLVM.
 | 
				
			||||||
| 
						 | 
					@ -54,6 +51,9 @@ Several introductory papers and presentations.
 | 
				
			||||||
:doc:`Lexicon`
 | 
					:doc:`Lexicon`
 | 
				
			||||||
   Definition of acronyms, terms and concepts used in LLVM.
 | 
					   Definition of acronyms, terms and concepts used in LLVM.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					:doc:`FAQ`
 | 
				
			||||||
 | 
					   A list of common questions and problems and their solutions.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Documentation
 | 
					Documentation
 | 
				
			||||||
=============
 | 
					=============
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -83,6 +83,7 @@ Getting Started/Tutorials
 | 
				
			||||||
 | 
					
 | 
				
			||||||
   GettingStarted
 | 
					   GettingStarted
 | 
				
			||||||
   tutorial/index
 | 
					   tutorial/index
 | 
				
			||||||
 | 
					   GettingStartedVS
 | 
				
			||||||
 | 
					
 | 
				
			||||||
:doc:`GettingStarted`
 | 
					:doc:`GettingStarted`
 | 
				
			||||||
   Discusses how to get up and running quickly with the LLVM infrastructure.
 | 
					   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
 | 
					   Tutorials about using LLVM. Includes a tutorial about making a custom
 | 
				
			||||||
   language with LLVM.
 | 
					   language with LLVM.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					:doc:`GettingStartedVS`
 | 
				
			||||||
 | 
					   An addendum to the main Getting Started guide for those using Visual Studio
 | 
				
			||||||
 | 
					   on Windows.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Reference
 | 
					Reference
 | 
				
			||||||
---------
 | 
					---------
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -104,8 +109,11 @@ LLVM and API reference documentation.
 | 
				
			||||||
.. toctree::
 | 
					.. toctree::
 | 
				
			||||||
   :hidden:
 | 
					   :hidden:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					   LangRef
 | 
				
			||||||
   CommandGuide/index
 | 
					   CommandGuide/index
 | 
				
			||||||
   TestingGuide
 | 
					   TestingGuide
 | 
				
			||||||
 | 
					   CompilerWriterInfo
 | 
				
			||||||
 | 
					   MIRLangRef
 | 
				
			||||||
 | 
					
 | 
				
			||||||
:doc:`LLVM Language Reference Manual <LangRef>`
 | 
					:doc:`LLVM Language Reference Manual <LangRef>`
 | 
				
			||||||
  Defines the LLVM intermediate representation and the assembly form of the
 | 
					  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>`
 | 
					:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
 | 
				
			||||||
   A reference manual for using the LLVM testing infrastructure.
 | 
					   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/>`_
 | 
					`Doxygen generated documentation <http://llvm.org/doxygen/>`_
 | 
				
			||||||
  (`classes <http://llvm.org/doxygen/inherits.html>`_)
 | 
					  (`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
 | 
					   Phabricator
 | 
				
			||||||
   HowToSubmitABug
 | 
					   HowToSubmitABug
 | 
				
			||||||
   BugLifeCycle
 | 
					   BugLifeCycle
 | 
				
			||||||
 | 
					   CodingStandards
 | 
				
			||||||
 | 
					
 | 
				
			||||||
:doc:`Contributing`
 | 
					:doc:`Contributing`
 | 
				
			||||||
   An overview on how to contribute to LLVM.
 | 
					   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`
 | 
					:doc:`BugLifeCycle`
 | 
				
			||||||
   Describes how bugs are reported, triaged and closed.
 | 
					   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
 | 
					Development Process
 | 
				
			||||||
-------------------
 | 
					-------------------
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue