summaryrefslogtreecommitdiffstats
path: root/llvm/docs/index.rst
Commit message (Collapse)AuthorAgeFilesLines
...
* 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 llvm-svn: 313798
* docs: remove dead doxygen tarball linkHans Wennborg2017-08-301-1/+0
| | | | llvm-svn: 312142
* 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 llvm-svn: 309891
* 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 llvm-svn: 306810
* Add documentation for various aspects of the AMDGPU backend.Tony Tye2017-06-061-2/+2
| | | | | | Differential Revision: https://reviews.llvm.org/D33736 llvm-svn: 304831
* [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. llvm-svn: 304161
* Add some tips on benchmarking.Rafael Espindola2017-05-241-0/+1
| | | | llvm-svn: 303769
* [XRay][docs] Add XRayExample to docindex.Dean Michael Berris2017-03-311-0/+1
| | | | llvm-svn: 299172
* [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 llvm-svn: 299133
* [PDB] Begin adding documentation for the PDB file format.Zachary Turner2016-11-101-0/+4
| | | | | | Differential Revision: https://reviews.llvm.org/D26374 llvm-svn: 286491
* [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 llvm-svn: 286319
* [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! llvm-svn: 286002
* 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 llvm-svn: 284077
* Adding document describing the use of the -opt-bisect-limit option.Andrew Kaylor2016-08-261-0/+4
| | | | llvm-svn: 279881
* [Docs] Add initial MemorySSA documentation.George Burgess IV2016-08-171-0/+4
| | | | | | | | Patch partially by Danny. Differential Revision: https://reviews.llvm.org/D23535 llvm-svn: 278875
* [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 llvm-svn: 276513
* [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. llvm-svn: 276325
* [docs] Add proposals to index fileRenato Golin2016-07-201-0/+19
| | | | llvm-svn: 276099
* 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 llvm-svn: 274268
* 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 llvm-svn: 273729
* [docs] fix the build by including ScudoHardenedAllocator into toc; mention ↵Kostya Serebryany2016-06-071-0/+4
| | | | | | SourceBasedCodeCoverage.html in libFuzzer docs llvm-svn: 272070
* [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 llvm-svn: 268096
* 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). llvm-svn: 263840
* [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! llvm-svn: 263834
* [docs] Remove references to autotools build.Alexey Samsonov2016-01-301-5/+0
| | | | llvm-svn: 259280
* 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. llvm-svn: 258873
* [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 llvm-svn: 252660
* Add initial documentation for the MIR serialization format.Alex Lorenz2015-08-061-0/+5
| | | | | | Differential Revision: http://reviews.llvm.org/D11736 llvm-svn: 244292
* Rename all references to old mailing lists to new lists.llvm.org address.Tanya Lattner2015-08-051-8/+8
| | | | llvm-svn: 243999
* Unbreak docs build from r239740.Sanjoy Das2015-06-151-0/+4
| | | | | | Add FaultMaps.rst to toctree. llvm-svn: 239747
* R600 -> AMDGPU renameTom Stellard2015-06-131-3/+3
| | | | llvm-svn: 239657
* 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 llvm-svn: 233638
* 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 llvm-svn: 232135
* [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 llvm-svn: 230807
* 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 llvm-svn: 230054
* [docs] Put an explicit link to InAlloca.rstSean Silva2015-02-041-0/+3
| | | | llvm-svn: 228192
* Add link to Go bindings documentation.Peter Collingbourne2015-01-131-0/+2
| | | | llvm-svn: 225815
* Added documentation for MergeFunctions pass:Stepan Dyatkovskiy2014-12-101-0/+4
| | | | | | Pass looks for equivalent functions that are mergable and folds them. llvm-svn: 223931
* Fix sphinx error from Statepoints.rstMatt Arsenault2014-12-031-0/+5
| | | | | | It was complaining it wasn't included in any toctree llvm-svn: 223254
* 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. llvm-svn: 221994
* Add a reference to Phabricator.rst to docs/index.rst.Adrian Prantl2014-10-031-0/+5
| | | | llvm-svn: 219015
* fix a typo in doumentation index.Jyoti Allur2014-09-261-1/+1
| | | | llvm-svn: 218504
* Docs: add documentation for the coverage mapping format.Alex Lorenz2014-08-191-0/+3
| | | | | | Differential Revision: http://reviews.llvm.org/D4729 llvm-svn: 215990
* [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. llvm-svn: 208577
* blockfreq: Document BlockFrequencyInfo terminologyDuncan P. N. Exon Smith2014-04-111-0/+5
| | | | | | | | | Documents terminology used in the forthcoming rewrite of BlockFrequencyInfo. <rdar://problem/14292693> llvm-svn: 206086
* [docs] Update link titleSean Silva2014-04-071-1/+1
| | | | | | | docs/TableGen/ is not really just "fundamentals" anymore, but rather more of a portal for all things TableGen. llvm-svn: 205743
* Recover TableGen/LangRef, make it officialRenato Golin2014-04-011-1/+1
| | | | | | | | | | | | | Making the new TableGen documentation official and marking the old file as "Moved". Also, reverting the original LangRef as the normative formal description of the language, while keeping the "new" LangRef as LangIntro for the less inlcined to reading language grammars. We should remove TableGenFundamentals.rst one day, but for now, just a warning that it moved will have to do, while we make sure there are no more links to it from elsewhere. llvm-svn: 205289
* Re-factor TableGen docsRenato Golin2014-03-201-1/+1
| | | | | | | | | | | | | This is mainly a movement of content around to give place to new content allowing different people to add bits to it in the right place. There is some new content, but mostly to fill the gaps left by text movement. I'm dropping the old syntax documentation as it has the problem of being quickly outdated by changes and largely unnecessary to people not involved in creating the language, but using it, which is the whole point of the documentation. llvm-svn: 204351
* [docs] Fix some Sphinx warnings.Sean Silva2014-03-021-0/+1
| | | | | | | | | | | | | | | | | | | | | | | The docs now build cleanly. Yay! The following warnings were fixed: /home/sean/pg/llvm/llvm/docs/HowToReleaseLLVM.rst:364: WARNING: Enumerated list ends without a blank line; unexpected unindent. /home/sean/pg/llvm/llvm/docs/InAlloca.rst:: WARNING: document isn't included in any toctree /home/sean/pg/llvm/llvm/docs/CodingStandards.rst:85: WARNING: Title underline too short. Supported C++11 Language and Library Features ------------------------------------------- /home/sean/pg/llvm/llvm/docs/CodingStandards.rst:85: WARNING: Title underline too short. Supported C++11 Language and Library Features ------------------------------------------- /home/sean/pg/llvm/llvm/docs/GettingStarted.rst:185: WARNING: Explicit markup ends without a blank line; unexpected unindent. /home/sean/pg/llvm/llvm/docs/GettingStarted.rst:565: WARNING: Explicit markup ends without a blank line; unexpected unindent. /home/sean/pg/llvm/llvm/docs/GettingStarted.rst:567: WARNING: Block quote ends without a blank line; unexpected unindent. llvm-svn: 202603
* LangRef documentation for the stackmap and patchpoint intrinsics.Andrew Trick2013-12-241-0/+4
| | | | | | | | | These still have "experimental" status, meaning we don't guarantee backward compatibility. However, they are already actively used by the open source WebKit project, and have started to be adopted by other projects. llvm-svn: 197930
OpenPOWER on IntegriCloud