Mercurial > hg > CbC > CbC_llvm
diff docs/index.rst @ 148:63bd29f05246
merged
author | Shinji KONO <kono@ie.u-ryukyu.ac.jp> |
---|---|
date | Wed, 14 Aug 2019 19:46:37 +0900 |
parents | c2174574ed3a |
children |
line wrap: on
line diff
--- a/docs/index.rst Sun Dec 23 19:23:36 2018 +0900 +++ b/docs/index.rst Wed Aug 14 19:46:37 2019 +0900 @@ -55,11 +55,10 @@ For those new to the LLVM system. -NOTE: If you are a user who is only interested in using LLVM-based -compilers, you should look into `Clang <http://clang.llvm.org>`_ or -`DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is -intended for users who have a need to work with the intermediate LLVM -representation. +NOTE: If you are a user who is only interested in using an LLVM-based compiler, +you should look into `Clang <http://clang.llvm.org>`_ instead. The +documentation here is intended for users who have a need to work with the +intermediate LLVM representation. .. toctree:: :hidden: @@ -68,6 +67,7 @@ CMakePrimer AdvancedBuilds HowToBuildOnARM + HowToBuildWithPGO HowToCrossCompileBuiltinsOnArm HowToCrossCompileLLVM CommandGuide/index @@ -79,6 +79,7 @@ yaml2obj HowToSubmitABug SphinxQuickstartTemplate + MarkdownQuickstartTemplate Phabricator TestingGuide tutorial/index @@ -88,11 +89,14 @@ GetElementPtr Frontend/PerformanceTips MCJITDesignAndImplementation + ORCv2 CodeOfConduct CompileCudaWithLLVM ReportingGuide Benchmarking Docker + BuildingADistribution + Remarks :doc:`GettingStarted` Discusses how to get up and running quickly with the LLVM infrastructure. @@ -106,6 +110,9 @@ :doc:`HowToBuildOnARM` Notes on building and testing LLVM/Clang on ARM. +:doc:`HowToBuildWithPGO` + Notes on building LLVM/Clang with PGO. + :doc:`HowToCrossCompileBuiltinsOnArm` Notes on cross-building and testing the compiler-rt builtins for Arm. @@ -144,6 +151,9 @@ :doc:`LLVM Testing Infrastructure Guide <TestingGuide>` A reference manual for using the LLVM testing infrastructure. +:doc:`TestSuiteGuide` + Describes how to compile and run the test-suite benchmarks. + `How to build the C, C++, ObjC, and ObjC++ front end`__ Instructions for building the clang front-end from source. @@ -169,6 +179,12 @@ :doc:`Docker` A reference for using Dockerfiles provided with LLVM. +:doc:`BuildingADistribution` + A best-practices guide for using LLVM's CMake build system to package and + distribute LLVM-based tools. + +:doc:`Remarks` + A reference on the implementation of remarks in LLVM. Programming Documentation ========================= @@ -224,7 +240,7 @@ `Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_ -`ViewVC Repository Browser <http://llvm.org/viewvc/>`_ +`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_ .. :doc:`CompilerWriterInfo` @@ -260,6 +276,7 @@ Bugpoint CodeGenerator ExceptionHandling + AddingConstrainedIntrinsics LinkTimeOptimization SegmentedStacks TableGenFundamentals @@ -268,6 +285,7 @@ GoldPlugin MarkedUpDisassembly SystemLibrary + SupportLibrary SourceLevelDebugging Vectorizers WritingAnLLVMBackend @@ -283,6 +301,7 @@ Statepoints MergeFunctions TypeMetadata + TransformMetadata FaultMaps MIRLangRef Coroutines @@ -292,6 +311,8 @@ XRayFDRFormat PDB/index CFIVerify + SpeculativeLoadHardening + StackSafetyAnalysis :doc:`WritingAnLLVMPass` Information on how to write LLVM transformations and analyses. @@ -334,6 +355,10 @@ This document describes the design and implementation of exception handling in LLVM. +:doc:`AddingConstrainedIntrinsics` + Gives the steps necessary when adding a new constrained math intrinsic + to LLVM. + :doc:`Bugpoint` Automatic bug finder and test-case reducer description and usage information. @@ -341,8 +366,8 @@ :doc:`BitCodeFormat` This describes the file format and encoding used for LLVM "bc" files. -:doc:`System Library <SystemLibrary>` - This document describes the LLVM System Library (``lib/System``) and +:doc:`Support Library <SupportLibrary>` + This document describes the LLVM Support Library (``lib/Support``) and how to keep LLVM source code portable :doc:`LinkTimeOptimization` @@ -358,6 +383,10 @@ :doc:`MCJITDesignAndImplementation` Describes the inner workings of MCJIT execution engine. +:doc:`ORCv2` + Describes the design and implementation of the ORC APIs, including some + usage examples, and a guide for users transitioning from ORCv1 to ORCv2. + :doc:`BranchWeightMetadata` Provides information about Branch Prediction Information. @@ -425,6 +454,13 @@ :doc:`CFIVerify` A description of the verification tool for Control Flow Integrity. +:doc:`SpeculativeLoadHardening` + A description of the Speculative Load Hardening mitigation for Spectre v1. + +:doc:`StackSafetyAnalysis` + This document describes the design of the stack safety analysis of local + variables. + Development Process Documentation ================================= @@ -441,6 +477,7 @@ Packaging ReleaseProcess Phabricator + BugLifeCycle :doc:`Contributing` An overview on how to contribute to LLVM. @@ -471,6 +508,9 @@ Describes how to use the Phabricator code review tool hosted on http://reviews.llvm.org/ and its command line interface, Arcanist. +:doc:`BugLifeCycle` + Describes how bugs are reported, triaged and closed. + Community ========= @@ -531,7 +571,6 @@ * 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 <number> @@ -539,6 +578,21 @@ * clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running near-trunk clang instead of gcc. +Meetups and social events +------------------------- + +.. toctree:: + :hidden: + + MeetupGuidelines + +Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_, +there are several user groups called +`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to +join one in your city. Or start a new one if there is none: + +:doc:`MeetupGuidelines` + Community wide proposals ------------------------ @@ -550,6 +604,8 @@ CodeOfConduct Proposals/GitHubMove + Proposals/TestSuite + Proposals/VariableNames Proposals/VectorizationPlan :doc:`CodeOfConduct` @@ -559,6 +615,12 @@ :doc:`Proposals/GitHubMove` Proposal to move from SVN/Git to GitHub. +:doc:`Proposals/TestSuite` + Proposals for additional benchmarks/programs for llvm's test-suite. + +:doc:`Proposals/VariableNames` + Proposal to change the variable names coding standard. + :doc:`Proposals/VectorizationPlan` Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.