X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2Findex.rst;h=1d4fbd9d34d0c03799bc09ae49dc57d1fc762f5e;hb=ed7d283ce5d205309dd0adf35496c5ecd29d70c5;hp=ed2be3f2c3483991000a51470216fd2228417e42;hpb=fb7aa394359288e1201e9118044ededaed74f621;p=oota-llvm.git diff --git a/docs/index.rst b/docs/index.rst index ed2be3f2c34..1d4fbd9d34d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -66,6 +66,7 @@ representation. CMake HowToBuildOnARM + HowToCrossCompileLLVM CommandGuide/index GettingStarted GettingStartedVS @@ -82,6 +83,7 @@ representation. Passes YamlIO GetElementPtr + MCJITDesignAndImplementation :doc:`GettingStarted` Discusses how to get up and running quickly with the LLVM infrastructure. @@ -95,6 +97,9 @@ representation. :doc:`HowToBuildOnARM` Notes on building and testing LLVM/Clang on ARM. +: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. @@ -160,6 +165,7 @@ For developers of applications which use LLVM as a library. ExtendingLLVM HowToSetUpLLVMStyleRTTI ProgrammersManual + Extensions :doc:`LLVM Language Reference Manual ` Defines the LLVM intermediate representation and the assembly form of the @@ -172,6 +178,9 @@ For developers of applications which use LLVM as a library. 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:`CommandLine` Provides information on using the command line parsing library. @@ -206,6 +215,7 @@ For API clients and LLVM developers. AliasAnalysis BitCodeFormat + BlockFrequencyTerminology BranchWeightMetadata Bugpoint CodeGenerator @@ -213,6 +223,7 @@ For API clients and LLVM developers. LinkTimeOptimization SegmentedStacks TableGenFundamentals + TableGen/index DebuggingJITedCode GoldPlugin MarkedUpDisassembly @@ -222,8 +233,11 @@ For API clients and LLVM developers. WritingAnLLVMBackend GarbageCollection WritingAnLLVMPass - TableGen/LangRef HowToUseAttributes + NVPTXUsage + StackMaps + InAlloca + BigEndianNEON :doc:`WritingAnLLVMPass` Information on how to write LLVM transformations and analyses. @@ -236,7 +250,7 @@ For API clients and LLVM developers. working on retargetting LLVM to a new architecture, designing a new codegen pass, or enhancing existing components. -:doc:`TableGenFundamentals` +:doc:`TableGen ` Describes the TableGen tool, which is used heavily by the LLVM code generator. @@ -280,9 +294,16 @@ For API clients and LLVM developers. :doc:`DebuggingJITedCode` How to debug JITed code with GDB. +:doc:`MCJITDesignAndImplementation` + Describes the inner workings of MCJIT execution engine. + :doc:`BranchWeightMetadata` Provides information about Branch Prediction Information. +:doc:`BlockFrequencyTerminology` + Provides information about terminology used in the ``BlockFrequencyInfo`` + analysis pass. + :doc:`SegmentedStacks` This document describes segmented stacks and how they are used in LLVM. @@ -292,6 +313,18 @@ For API clients and LLVM developers. :doc:`HowToUseAttributes` Answers some questions about the new Attributes infrastructure. +:doc:`NVPTXUsage` + This document describes using the NVPTX back-end to compile GPU kernels. + +:doc:`StackMaps` + LLVM support for mapping instruction addresses to the location of + values and allowing code to be patched. + +:doc:`BigEndianNEON` + LLVM's support for generating NEON instructions on big endian ARM targets is + somewhat nonintuitive. This document explains the implementation and rationale. + + Development Process Documentation ================================= @@ -306,6 +339,7 @@ Information about LLVM's development process. LLVMBuild HowToReleaseLLVM Packaging + ReleaseProcess :doc:`DeveloperPolicy` The LLVM project's policy towards developers and their contributions. @@ -326,6 +360,9 @@ Information about LLVM's development process. :doc:`HowToReleaseLLVM` This is a guide to preparing LLVM releases. Most developers can ignore it. +:doc:`ReleaseProcess` + This is a validate a new release, during the release process. Most developers can ignore it. + :doc:`Packaging` Advice on packaging LLVM into a distribution. @@ -351,15 +388,16 @@ lists. `Commits Archive (llvm-commits)`__ This list contains all commit messages that are made when LLVM developers - commit code changes to the repository. It is useful for those who want to - stay on the bleeding edge of LLVM development. This list is very high volume. + commit code changes to the repository. It also serves as a forum for + patch review (i.e. send patches here). It is useful for those who want to + stay on the bleeding edge of LLVM development. This list is very high + volume. .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/ `Bugs & Patches Archive (llvmbugs)`__ - This list gets emailed every time a bug is opened and closed, and when people - submit patches to be included in LLVM. It is higher volume than the LLVMdev - list. + This list gets emailed every time a bug is opened and closed. It is + higher volume than the LLVMdev list. .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/