summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* docs: remove in-progress warningsHans Wennborg2018-02-221-5/+0
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/branches/release_60@325786 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs][ARM] Add HowTo for cross compiling and testing compiler-rt builtinsPeter Smith2017-11-071-0/+4
| | | | | | | | | | | | This document contains information on how to cross-compile the compiler-rt builtins library for several flavours of Arm target and how to test the libraries using qemu. Differential Revision: https://reviews.llvm.org/D39600 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@317554 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: Add some information about Fuzzing LLVM itselfJustin Bogner2017-10-121-0/+4
| | | | | | | This splits some content out of the libFuzzer docs and adds a fair amount of detail about the fuzzers in LLVM. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@315544 91177308-0d34-0410-b5e6-96231b3b80d8
* Introduce the llvm-cfi-verify tool (resubmission of D37937).Vlad Tsyrklevich2017-09-201-1/+5
| | | | | | | | | | | | | | | | Summary: Resubmission of D37937. Fixed i386 target building (conversion from std::size_t& to uint64_t& failed). Fixed documentation warning failure about docs/CFIVerify.rst not being in the tree. Reviewers: vlad.tsyrklevich Reviewed By: vlad.tsyrklevich Patch by Mitch Phillips Subscribers: sbc100, mgorny, pcc, llvm-commits, kcc Differential Revision: https://reviews.llvm.org/D38089 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@313809 91177308-0d34-0410-b5e6-96231b3b80d8
* Revert "Introduce the llvm-cfi-verify tool (resubmission of D37937)."Vlad Tsyrklevich2017-09-201-5/+1
| | | | | | This reverts commit r313798, it's causing buildbot failures. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@313804 91177308-0d34-0410-b5e6-96231b3b80d8
* Introduce the llvm-cfi-verify tool (resubmission of D37937).Vlad Tsyrklevich2017-09-201-1/+5
| | | | | | | | | | | | | | | | Summary: Resubmission of D37937. Fixed i386 target building (conversion from std::size_t& to uint64_t& failed). Fixed documentation warning failure about docs/CFIVerify.rst not being in the tree. Reviewers: vlad.tsyrklevich Reviewed By: vlad.tsyrklevich Patch by Mitch Phillips Subscribers: mgorny, pcc, llvm-commits, kcc Differential Revision: https://reviews.llvm.org/D38089 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@313798 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: remove dead doxygen tarball linkHans Wennborg2017-08-301-1/+0
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@312142 91177308-0d34-0410-b5e6-96231b3b80d8
* Xray docs with description of Flight Data Recorder binary format.Keith Wyss2017-08-021-0/+1
| | | | | | | | | | | | | | | | | | | Summary: Adding a new restructuredText file to document the trace format produced with an FDR mode handler and read by llvm-xray toolset. Fixed two problems in the documentation from differential review. One bad table and a missing link in the toc. Original commit was e97c5836a77db803fe53319c53f3bf8e8b26d2b7. Reviewers: dberris, pelikan Subscribers: llvm-commits Differential Revision: https://reviews.llvm.org/D36041 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@309891 91177308-0d34-0410-b5e6-96231b3b80d8
* Added Dockerfiles to build clang from sources.Ilya Biryukov2017-06-301-0/+4
| | | | | | | | | | | | Reviewers: klimek, chandlerc, mehdi_amini Reviewed By: klimek, mehdi_amini Subscribers: mehdi_amini, jlebar, llvm-commits Differential Revision: https://reviews.llvm.org/D34197 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@306810 91177308-0d34-0410-b5e6-96231b3b80d8
* Add documentation for various aspects of the AMDGPU backend.Tony Tye2017-06-061-2/+2
| | | | | | | Differential Revision: https://reviews.llvm.org/D33736 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@304831 91177308-0d34-0410-b5e6-96231b3b80d8
* [Docs] Add VectorizationPlan to docs/Proposals.Ayal Zaks2017-05-291-0/+3
| | | | | | | | | Following the request made in https://reviews.llvm.org/D32871, the general documentation of the Vectorization Plan is hereby placed under docs/Proposals. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@304161 91177308-0d34-0410-b5e6-96231b3b80d8
* Add some tips on benchmarking.Rafael Espindola2017-05-241-0/+1
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@303769 91177308-0d34-0410-b5e6-96231b3b80d8
* [XRay][docs] Add XRayExample to docindex.Dean Michael Berris2017-03-311-0/+1
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@299172 91177308-0d34-0410-b5e6-96231b3b80d8
* [XRay][docs] Examples for how to use XRayDean Michael Berris2017-03-301-0/+3
| | | | | | | | | | | | | | | Summary: This document is an attempt at showing how XRay could be used to debug latency issues with LLVM tools, and how to use the llvm-xray tool to analyse XRay traces. Reviewers: echristo, mehdi_amini, davide Subscribers: llvm-commits Differential Revision: https://reviews.llvm.org/D31493 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@299133 91177308-0d34-0410-b5e6-96231b3b80d8
* [PDB] Begin adding documentation for the PDB file format.Zachary Turner2016-11-101-0/+4
| | | | | | Differential Revision: https://reviews.llvm.org/D26374 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@286491 91177308-0d34-0410-b5e6-96231b3b80d8
* [XRay][Docs] Add documentation for XRay in LLVMDean Michael Berris2016-11-091-0/+4
| | | | | | | | | | | | | | | | | | | Summary: This is the initial version of the documentation for how to use XRay as it stands in LLVM, Clang, and compiler-rt. We leave some room for later expansion mentioining what is work in progress and what could be expected moving forward. We also give a high level overview of future work that's both ongoing and planned. Reviewers: echristo, dblaikie, chandlerc Subscribers: mehdi_amini, llvm-commits Differential Revision: https://reviews.llvm.org/D26386 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@286319 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Add initial Global ISel documentation.Ahmed Bougacha2016-11-041-0/+4
| | | | | | | | This reflects the current state of Global ISel. As progress is made, we'll document our design decisions in it. Comments very welcome! git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@286002 91177308-0d34-0410-b5e6-96231b3b80d8
* Moving to GitHub - Unified ProposalMehdi Amini2016-10-121-2/+2
| | | | | | | | | | | | | | | This document describes the proposal to move to GitHub, and compare the two proposals through various workflow examples, presenting the current set of commands following by the ones involved in each of the two proposals. It is intended to supersede the previous "submodule proposal" document entirely, and drive the discussion at the BoF during the next Dev Meeting. Differential Revision: https://reviews.llvm.org/D24167 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@284077 91177308-0d34-0410-b5e6-96231b3b80d8
* Adding document describing the use of the -opt-bisect-limit option.Andrew Kaylor2016-08-261-0/+4
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@279881 91177308-0d34-0410-b5e6-96231b3b80d8
* [Docs] Add initial MemorySSA documentation.George Burgess IV2016-08-171-0/+4
| | | | | | | | | Patch partially by Danny. Differential Revision: https://reviews.llvm.org/D23535 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@278875 91177308-0d34-0410-b5e6-96231b3b80d8
* [coroutines] Part 1 of N: DocumentationDavid Majnemer2016-07-231-0/+4
| | | | | | | | | | | This is the first patch in the coroutine series. It contains the documentation for the coroutine intrinsics and their usage. Patch by Gor Nishanov! Differential Revision: https://reviews.llvm.org/D22603 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@276513 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Move GitHub to GitHubSubModRenato Golin2016-07-211-2/+2
| | | | | | | | Given that other proposals are making their way through, it's better if we specify what GitHub proposal this is, in case there are others that also involve GitHub, but not sub-modules. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@276325 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Add proposals to index fileRenato Golin2016-07-201-0/+19
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@276099 91177308-0d34-0410-b5e6-96231b3b80d8
* Introduce a *draft* of a code of conduct for the LLVM community and theChandler Carruth2016-06-301-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | associated reporting guide. I want to emphasize that at this point these are just drafts! This is the result of very extended discussion on the mailing lists on several different threads: http://lists.llvm.org/pipermail/llvm-dev/2015-October/091218.html http://lists.llvm.org/pipermail/llvm-dev/2016-May/099120.html http://lists.llvm.org/pipermail/llvm-commits/Week-of-Mon-20151019/307070.html The reporting guide in particular I anticipate will be shaped somewhat by the advisory committee when they are selected. But hopefully this serves as a good starting point and good guidance while the advisory committee is being sorted out. I'd like to thank all the folks who contributed to this. Many, *many* people worked to help with drafting, wording, suggestions, and edits. Also, this is based on widely used existing codes of coduct as mentioned in the text, and the original authors of those deserve many thanks as well. Differential Revision: http://reviews.llvm.org/D13741 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@274268 91177308-0d34-0410-b5e6-96231b3b80d8
* IR: New representation for CFI and virtual call optimization pass metadata.Peter Collingbourne2016-06-241-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The bitset metadata currently used in LLVM has a few problems: 1. It has the wrong name. The name "bitset" refers to an implementation detail of one use of the metadata (i.e. its original use case, CFI). This makes it harder to understand, as the name makes no sense in the context of virtual call optimization. 2. It is represented using a global named metadata node, rather than being directly associated with a global. This makes it harder to manipulate the metadata when rebuilding global variables, summarise it as part of ThinLTO and drop unused metadata when associated globals are dropped. For this reason, CFI does not currently work correctly when both CFI and vcall opt are enabled, as vcall opt needs to rebuild vtable globals, and fails to associate metadata with the rebuilt globals. As I understand it, the same problem could also affect ASan, which rebuilds globals with a red zone. This patch solves both of those problems in the following way: 1. Rename the metadata to "type metadata". This new name reflects how the metadata is currently being used (i.e. to represent type information for CFI and vtable opt). The new name is reflected in the name for the associated intrinsic (llvm.type.test) and pass (LowerTypeTests). 2. Attach metadata directly to the globals that it pertains to, rather than using the "llvm.bitsets" global metadata node as we are doing now. This is done using the newly introduced capability to attach metadata to global variables (r271348 and r271358). See also: http://lists.llvm.org/pipermail/llvm-dev/2016-June/100462.html Differential Revision: http://reviews.llvm.org/D21053 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@273729 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] fix the build by including ScudoHardenedAllocator into toc; mention ↵Kostya Serebryany2016-06-071-0/+4
| | | | | | SourceBasedCodeCoverage.html in libFuzzer docs git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@272070 91177308-0d34-0410-b5e6-96231b3b80d8
* [Docs] Add CMake Primer documentChris Bieneman2016-04-291-0/+1
| | | | | | | | This document is intended to provide a basic overview of the CMake scripting language for LLVM developers. It was unorthodoxly reviewed for accuracy and content on the CMake developer list: http://public.kitware.com/pipermail/cmake-developers/2016-April/028300.html git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@268096 91177308-0d34-0410-b5e6-96231b3b80d8
* Updates based on post-commit review of r263834Chris Bieneman2016-03-181-1/+1
| | | | | | | * Renamed to be camel case, consistent with other docs. * Fixed non-ascii characters (this is what I get for writing docs on an iPad). git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@263840 91177308-0d34-0410-b5e6-96231b3b80d8
* [Docs] New documentation for advanced build configurationsChris Bieneman2016-03-181-0/+1
| | | | | | | | This document covers how to use some of the new complex build configurations CMake supports. Feedback and improvements welcomed! git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@263834 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Remove references to autotools build.Alexey Samsonov2016-01-301-5/+0
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@259280 91177308-0d34-0410-b5e6-96231b3b80d8
* Fixing the documentation buildsChris Bieneman2016-01-261-4/+0
| | | | | | I broke the documentation builds when I deleted the MakefileGuide as part of the autoconf removal. At some point I'll need to do a more in-depth pass updating the documentation to remove references to the old build system. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@258873 91177308-0d34-0410-b5e6-96231b3b80d8
* [doc] Compile CUDA with LLVMJingyue Wu2015-11-101-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | Summary: This patch adds documentation on compiling CUDA with LLVM as requested by many engineers and researchers. It includes not only user guides but also some internals (mostly optimizations) so that early adopters can start hacking and contributing. Quite a few researchers who contacted us haven't used LLVM before, which is unsurprising as it hasn't been long since LLVM picked up CUDA. So I added a short summary to help these folks get started with LLVM. I expect this document to evolve substantially down the road. The user guides will be much simplified after the Clang integration is done. However, the internals should continue growing to include for example performance debugging and key areas to improve. Reviewers: chandlerc, meheff, broune, tra Subscribers: silvas, jingyue, llvm-commits, eliben Differential Revision: http://reviews.llvm.org/D14370 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@252660 91177308-0d34-0410-b5e6-96231b3b80d8
* Add initial documentation for the MIR serialization format.Alex Lorenz2015-08-061-0/+5
| | | | | | | Differential Revision: http://reviews.llvm.org/D11736 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@244292 91177308-0d34-0410-b5e6-96231b3b80d8
* Rename all references to old mailing lists to new lists.llvm.org address.Tanya Lattner2015-08-051-8/+8
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@243999 91177308-0d34-0410-b5e6-96231b3b80d8
* Unbreak docs build from r239740.Sanjoy Das2015-06-151-0/+4
| | | | | | Add FaultMaps.rst to toctree. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@239747 91177308-0d34-0410-b5e6-96231b3b80d8
* R600 -> AMDGPU renameTom Stellard2015-06-131-3/+3
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@239657 91177308-0d34-0410-b5e6-96231b3b80d8
* Move lib/Fuzzer docs from a README.txt to a proper .rst file.Kostya Serebryany2015-03-301-0/+4
| | | | | | | | | | | | | | | | | | Summary: Move lib/Fuzzer docs from a README.txt to a proper .rst file. This change does not add any content, just formatting. Test Plan: n/a Reviewers: samsonov Reviewed By: samsonov Subscribers: llvm-commits Differential Revision: http://reviews.llvm.org/D8710 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@233638 91177308-0d34-0410-b5e6-96231b3b80d8
* Updating GettingStarted documentation to reference CMake as the preferred ↵Chris Bieneman2015-03-131-0/+5
| | | | | | | | | | | | | | way to build LLVM. Reviewers: chandlerc, samsonov, echristo Reviewed By: samsonov Subscribers: emaste, joker.eph, llvm-commits Differential Revision: http://reviews.llvm.org/D8046 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@232135 91177308-0d34-0410-b5e6-96231b3b80d8
* [new docs] Performance Tips for Frontend AuthorsPhilip Reames2015-02-271-0/+6
| | | | | | | | | | | | As mentioned on llvm-dev, this is a new documentation page intended to collect tips for frontend authors on how to generate IR that LLVM is able to optimize well. These types of things come up repeated in review threads and it would be good to have a place to save them. I added a small handful to start us off, but I mostly want to get the framework in place. Once the docs are here, we can add to them incrementally. If you know of something appropriate for this page, please add it! Differential Revision: http://reviews.llvm.org/D7890 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@230807 91177308-0d34-0410-b5e6-96231b3b80d8
* Introduce bitset metadata format and bitset lowering pass.Peter Collingbourne2015-02-201-0/+1
| | | | | | | | | | | | | | | | | | | | This patch introduces a new mechanism that allows IR modules to co-operatively build pointer sets corresponding to addresses within a given set of globals. One particular use case for this is to allow a C++ program to efficiently verify (at each call site) that a vtable pointer is in the set of valid vtable pointers for the class or its derived classes. One way of doing this is for a toolchain component to build, for each class, a bit set that maps to the memory region allocated for the vtables, such that each 1 bit in the bit set maps to a valid vtable for that class, and lay out the vtables next to each other, to minimize the total size of the bit sets. The patch introduces a metadata format for representing pointer sets, an '@llvm.bitset.test' intrinsic and an LTO lowering pass that lays out the globals and builds the bitsets, and documents the new feature. Differential Revision: http://reviews.llvm.org/D7288 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@230054 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Put an explicit link to InAlloca.rstSean Silva2015-02-041-0/+3
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@228192 91177308-0d34-0410-b5e6-96231b3b80d8
* Add link to Go bindings documentation.Peter Collingbourne2015-01-131-0/+2
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@225815 91177308-0d34-0410-b5e6-96231b3b80d8
* Added documentation for MergeFunctions pass:Stepan Dyatkovskiy2014-12-101-0/+4
| | | | | | | | Pass looks for equivalent functions that are mergable and folds them. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@223931 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix sphinx error from Statepoints.rstMatt Arsenault2014-12-031-0/+5
| | | | | | It was complaining it wasn't included in any toctree git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@223254 91177308-0d34-0410-b5e6-96231b3b80d8
* R600/SI: Start implementing an assemblerTom Stellard2014-11-141-0/+4
| | | | | | | This was done using the Sparc and PowerPC AsmParsers as guides. So far it is very simple and only supports sopp instructions. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@221994 91177308-0d34-0410-b5e6-96231b3b80d8
* Add a reference to Phabricator.rst to docs/index.rst.Adrian Prantl2014-10-031-0/+5
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@219015 91177308-0d34-0410-b5e6-96231b3b80d8
* fix a typo in doumentation index.Jyoti Allur2014-09-261-1/+1
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@218504 91177308-0d34-0410-b5e6-96231b3b80d8
* Docs: add documentation for the coverage mapping format.Alex Lorenz2014-08-191-0/+3
| | | | | | | Differential Revision: http://reviews.llvm.org/D4729 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@215990 91177308-0d34-0410-b5e6-96231b3b80d8
* [ARM64-BE] Add sphinx documentation for the ARM64 NEON implementation.James Molloy2014-05-121-0/+6
| | | | | | | There are some interesting decisions based on non-obvious rationale in the ARM64-BE NEON implementation - decent documentation is definitely required. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@208577 91177308-0d34-0410-b5e6-96231b3b80d8
* blockfreq: Document BlockFrequencyInfo terminologyDuncan P. N. Exon Smith2014-04-111-0/+5
| | | | | | | | | Documents terminology used in the forthcoming rewrite of BlockFrequencyInfo. <rdar://problem/14292693> git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@206086 91177308-0d34-0410-b5e6-96231b3b80d8
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-19 23:38:01 +0000