X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2Findex.rst;h=a69ecfedc580789da8916982a7894bb74477c7c8;hb=7eac64ccedd13b9f0512e4e49a07a34ab946704b;hp=8f22ef2a774c44750e941ad7c10414cd03544c9d;hpb=0013a5d87b8b51bb6d563dbb7b96978bed9d3ac3;p=oota-llvm.git diff --git a/docs/index.rst b/docs/index.rst index 8f22ef2a774..a69ecfedc58 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -22,7 +22,6 @@ Several introductory papers and presentations. :hidden: LangRef - GetElementPtr :doc:`LangRef` Defines the LLVM intermediate representation. @@ -48,10 +47,6 @@ Several introductory papers and presentations. .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html -:doc:`GetElementPtr` - Answers to some very frequent questions about LLVM's most frequently - misunderstood instruction. - `Publications mentioning LLVM `_ .. @@ -71,10 +66,11 @@ representation. CMake HowToBuildOnARM + HowToCrossCompileLLVM CommandGuide/index - DeveloperPolicy GettingStarted GettingStartedVS + BuildingLLVMWithAutotools FAQ Lexicon HowToAddABuilder @@ -87,6 +83,10 @@ representation. ReleaseNotes Passes YamlIO + GetElementPtr + Frontend/PerformanceTips + MCJITDesignAndImplementation + CompileCudaWithLLVM :doc:`GettingStarted` Discusses how to get up and running quickly with the LLVM infrastructure. @@ -100,17 +100,21 @@ 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. +:doc:`BuildingLLVMWithAutotools` + An addendum to the Getting Started guide with instructions for building LLVM + with the Autotools build system. + :doc:`tutorial/index` Tutorials about using LLVM. Includes a tutorial about making a custom language with LLVM. -:doc:`DeveloperPolicy` - The LLVM project's policy towards developers and their contributions. - :doc:`LLVM Command Guide ` A reference manual for the LLVM command line utilities ("man" pages for LLVM tools). @@ -149,25 +153,14 @@ representation. :doc:`YamlIO` A reference guide for using LLVM's YAML I/O library. -IRC -=== - -Users and developers of the LLVM project (including subprojects such as Clang) -can be found in #llvm on `irc.oftc.net `_. - -This channel has several bots. - -* Buildbot reporters - - * llvmbb - Bot for the main LLVM buildbot master. - http://lab.llvm.org:8011/console - * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console - * smooshlab - Apple's internal buildbot master. +:doc:`GetElementPtr` + Answers to some very frequent questions about LLVM's most frequently + misunderstood instruction. -* robot - Bugzilla linker. %bug +:doc:`Frontend/PerformanceTips` + A collection of tips for frontend authors on how to generate IR + which LLVM is able to effectively optimize. -* clang-bot - A `geordi `_ instance running - near-trunk clang instead of gcc. Programming Documentation ========================= @@ -184,6 +177,8 @@ For developers of applications which use LLVM as a library. ExtendingLLVM HowToSetUpLLVMStyleRTTI ProgrammersManual + Extensions + LibFuzzer :doc:`LLVM Language Reference Manual ` Defines the LLVM intermediate representation and the assembly form of the @@ -196,6 +191,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. @@ -214,12 +212,17 @@ For developers of applications which use LLVM as a library. (`classes `_) (`tarball `_) +`Documentation for Go bindings `_ + `ViewVC Repository Browser `_ .. :doc:`CompilerWriterInfo` A list of helpful links for compiler writers. +:doc:`LibFuzzer` + A library for writing in-process guided fuzzers. + Subsystem Documentation ======================= @@ -230,6 +233,7 @@ For API clients and LLVM developers. AliasAnalysis BitCodeFormat + BlockFrequencyTerminology BranchWeightMetadata Bugpoint CodeGenerator @@ -237,6 +241,7 @@ For API clients and LLVM developers. LinkTimeOptimization SegmentedStacks TableGenFundamentals + TableGen/index DebuggingJITedCode GoldPlugin MarkedUpDisassembly @@ -246,8 +251,18 @@ For API clients and LLVM developers. WritingAnLLVMBackend GarbageCollection WritingAnLLVMPass - TableGen/LangRef HowToUseAttributes + NVPTXUsage + AMDGPUUsage + StackMaps + InAlloca + BigEndianNEON + CoverageMappingFormat + Statepoints + MergeFunctions + BitSets + FaultMaps + MIRLangRef :doc:`WritingAnLLVMPass` Information on how to write LLVM transformations and analyses. @@ -260,7 +275,11 @@ 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:`Machine IR (MIR) Format Reference Manual ` + A reference manual for the MIR serialization format, which is used to test + LLVM's code generation passes. + +:doc:`TableGen ` Describes the TableGen tool, which is used heavily by the LLVM code generator. @@ -304,9 +323,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. @@ -316,6 +342,39 @@ 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:`AMDGPUUsage` + This document describes how to use the AMDGPU back-end. + +: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. + +:doc:`CoverageMappingFormat` + This describes the format and encoding used for LLVM’s code coverage mapping. + +:doc:`Statepoints` + This describes a set of experimental extensions for garbage + collection support. + +:doc:`MergeFunctions` + Describes functions merging optimization. + +:doc:`InAlloca` + Description of the ``inalloca`` argument attribute. + +:doc:`FaultMaps` + LLVM support for folding control flow into faulting machine instructions. + +:doc:`CompileCudaWithLLVM` + LLVM support for CUDA. + Development Process Documentation ================================= @@ -324,11 +383,17 @@ Information about LLVM's development process. .. toctree:: :hidden: + DeveloperPolicy MakefileGuide Projects LLVMBuild HowToReleaseLLVM Packaging + ReleaseProcess + Phabricator + +:doc:`DeveloperPolicy` + The LLVM project's policy towards developers and their contributions. :doc:`Projects` How-to guide and templates for new projects that *use* the LLVM @@ -346,48 +411,84 @@ 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 guide to validate a new release, during the release process. Most developers can ignore it. + :doc:`Packaging` Advice on packaging LLVM into a distribution. +:doc:`Phabricator` + Describes how to use the Phabricator code review tool hosted on + http://reviews.llvm.org/ and its command line interface, Arcanist. + +Community +========= + +LLVM has a thriving community of friendly and helpful developers. +The two primary communication mechanisms in the LLVM community are mailing +lists and IRC. + Mailing Lists -============= +------------- If you can't find what you need in these docs, try consulting the mailing lists. -`LLVM Announcements List`__ - This is a low volume list that provides important announcements regarding - LLVM. It gets email about once a month. - - .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce - -`Developer's List`__ +`Developer's List (llvm-dev)`__ This list is for people who want to be included in technical discussions of LLVM. People post to this list when they have questions about writing code for or using the LLVM tools. It is relatively low volume. - .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev + .. __: http://lists.llvm.org/mailman/listinfo/llvm-dev -`Bugs & Patches Archive`__ - 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. +`Commits Archive (llvm-commits)`__ + This list contains all commit messages that are made when LLVM developers + 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/llvmbugs/ + .. __: http://lists.llvm.org/pipermail/llvm-commits/ -`Commits Archive`__ - 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. +`Bugs & Patches Archive (llvm-bugs)`__ + This list gets emailed every time a bug is opened and closed. It is + higher volume than the LLVM-dev list. - .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/ + .. __: http://lists.llvm.org/pipermail/llvm-bugs/ -`Test Results Archive`__ +`Test Results Archive (llvm-testresults)`__ A message is automatically sent to this list by every active nightly tester when it completes. As such, this list gets email several times each day, making it a high volume list. - .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/ + .. __: http://lists.llvm.org/pipermail/llvm-testresults/ + +`LLVM Announcements List (llvm-announce)`__ + This is a low volume list that provides important announcements regarding + LLVM. It gets email about once a month. + + .. __: http://lists.llvm.org/mailman/listinfo/llvm-announce + +IRC +--- + +Users and developers of the LLVM project (including subprojects such as Clang) +can be found in #llvm on `irc.oftc.net `_. + +This channel has several bots. + +* Buildbot reporters + + * llvmbb - Bot for the main LLVM buildbot master. + http://lab.llvm.org:8011/console + * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console + * smooshlab - Apple's internal buildbot master. + +* robot - Bugzilla linker. %bug + +* clang-bot - A `geordi `_ instance running + near-trunk clang instead of gcc. + Indices and tables ==================