1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-22 18:54:02 +01:00

[Docs] Removes Programming Documentation page

Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. 

llvm-svn: 373856
This commit is contained in:
DeForest Richards 2019-10-06 16:10:11 +00:00
parent d17ff27bab
commit 8f532fcce0
5 changed files with 48 additions and 60 deletions

View File

@ -6,9 +6,10 @@ For those new to the LLVM system.
.. toctree::
:hidden:
Frontend/PerformanceTips
GettingStarted
GettingStartedVS
Frontend/PerformanceTips
ProgrammersManual
tutorial/index
:doc:`GettingStarted`
@ -20,10 +21,14 @@ For those new to the LLVM system.
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.
:doc:`ProgrammersManual`
Introduction to the general layout of the LLVM sourcebase, important classes
and APIs, and some tips & tricks.
:doc:`Frontend/PerformanceTips`
A collection of tips for frontend authors on how to generate IR
which LLVM is able to effectively optimize.
which LLVM is able to effectively optimize.
:doc:`GettingStartedVS`
An addendum to the main Getting Started guide for those using Visual Studio
on Windows.

View File

@ -1,46 +0,0 @@
Programming Documentation
=========================
For developers of applications which use LLVM as a library.
.. toctree::
:hidden:
Atomics
CommandLine
ExtendingLLVM
HowToSetUpLLVMStyleRTTI
ProgrammersManual
Extensions
ScudoHardenedAllocator
OptBisect
GwpAsan
:doc:`Atomics`
Information about LLVM's concurrency model.
:doc:`ProgrammersManual`
Introduction to the general layout of the LLVM sourcebase, important classes
and APIs, and some tips & tricks.
:doc:`Extensions`
LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
:doc:`HowToSetUpLLVMStyleRTTI`
How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
class hierarchy.
:doc:`ExtendingLLVM`
Look here to see how to add instructions and intrinsics to LLVM.
:doc:`ScudoHardenedAllocator`
A library that implements a security-hardened `malloc()`.
:doc:`GwpAsan`
A sampled heap memory error detection toolkit designed for production use.
:doc:`CommandLine`
Provides information on using the command line parsing library.
:doc:`OptBisect`
A command line option for debugging optimization-induced failures.

View File

@ -9,16 +9,22 @@ LLVM and API reference documentation.
.. toctree::
:hidden:
Atomics
Bugpoint
CommandGuide/index
CompilerWriterInfo
Extensions
FuzzingLLVM
GarbageCollection
GetElementPtr
GwpAsan
HowToSetUpLLVMStyleRTTI
LangRef
LibFuzzer
MIRLangRef
OptBisect
PDB/index
ScudoHardenedAllocator
Statepoints
TestingGuide
YamlIO
@ -38,20 +44,36 @@ LLVM Reference
Defines the LLVM intermediate representation and the assembly form of the
different nodes.
: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.
:doc:`YamlIO`
A reference guide for using LLVM's YAML I/O library.
:doc:`Atomics`
Information about LLVM's concurrency model.
:doc:`CompilerWriterInfo`
A list of helpful links for compiler writers.
:doc:`Extensions`
LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
:doc:`HowToSetUpLLVMStyleRTTI`
How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
class hierarchy.
:doc:`GetElementPtr`
Answers to some very frequent questions about LLVM's most frequently
misunderstood instruction.
:doc:`ScudoHardenedAllocator`
A library that implements a security-hardened `malloc()`.
:doc:`GwpAsan`
A sampled heap memory error detection toolkit designed for production use.
:doc:`YamlIO`
A reference guide for using LLVM's YAML I/O library.
======================
Command Line Utilities
======================
@ -64,6 +86,9 @@ Command Line Utilities
Automatic bug finder and test-case reducer description and usage
information.
:doc:`OptBisect`
A command line option for debugging optimization-induced failures.
:doc:`The Microsoft PDB File Format <PDB/index>`
A detailed description of the Microsoft PDB (Program Database) file format.

View File

@ -37,6 +37,8 @@ intermediate LLVM representation.
TableGen/index
NVPTXUsage
AMDGPUUsage
ExtendingLLVM
CommandLine
Clang
-----
@ -102,6 +104,12 @@ Code Generation
Additional Topics
-----------------
:doc:`CommandLine`
Provides information on using the command line parsing library.
:doc:`ExtendingLLVM`
Look here to see how to add instructions and intrinsics to LLVM.
:doc:`HowToCrossCompileBuiltinsOnArm`
Notes on cross-building and testing the compiler-rt builtins for Arm.

View File

@ -54,7 +54,6 @@ Getting Started, How-tos, Developer Guides, and Tutorials.
:hidden:
GettingStartedTutorials
ProgrammingDocumentation
Reference
SubsystemDocumentation
UserGuides
@ -65,9 +64,6 @@ Getting Started, How-tos, Developer Guides, and Tutorials.
:doc:`UserGuides`
User guides and How-tos.
:doc:`ProgrammingDocumentation`
For developers of applications which use LLVM as a library.
:doc:`SubsystemDocumentation`
For API clients and LLVM developers.