summaryrefslogtreecommitdiffstats
path: root/llvm/docs/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* llvm docs: drop index.rst release version warningHans Wennborg2020-03-041-5/+0
|
* Make coding standards document more inclusiveDmitri Gribenko2019-11-211-1/+2
| | | | | | | | | | | | Summary: Patch by Doug Gregor, Tres Popp, and Dmitri Gribenko. Reviewers: chandlerc Subscribers: hfinkel, bmcreusillet, arsenm, doug.gregor, mgrang, arphaman, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D69354
* [Docs] Removes Subsystem Documentation pageDeForest Richards2019-10-061-4/+0
| | | | | | Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
* [Docs] Removes Programming Documentation pageDeForest Richards2019-10-061-4/+0
| | | | | | Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
* [Docs] Adds new Getting Started/Tutorials pageDeForest Richards2019-10-061-25/+6
| | | | | | Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
* [Docs] Moves article links to new pagesDeForest Richards2019-09-291-3/+0
| | | | | | Moves existing article links on the Programming, Subsystem, and Reference documentation pages to new locations. Also moves Github Repository and Publications links to the sidebar. llvm-svn: 373169
* [Docs] Moves Reference docs to new pageDeForest Richards2019-09-251-40/+4
| | | | | | Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
* [Docs] Adds new page for Getting Involved articlesDeForest Richards2019-09-211-197/+7
| | | | | | Adds a new page for existing Getting Involved, Development Process, and Community Proposals articles. Also moves Mailing Lists, Meetups and social events, and IRC sections. llvm-svn: 372487
* [Docs] Bug fix for document not included in toctreeDeForest Richards2019-09-211-0/+3
| | | | | | Fixes 'document not included in toctree' bug for FAQ and Lexicon topics. llvm-svn: 372470
* [Docs] Updates sidebar linksDeForest Richards2019-09-211-9/+0
| | | | | | Adds additional links to sidebar. Also removes Glossary and FAQ from LLVM Design & Overview section. (These links now reside on the sidebar.) llvm-svn: 372469
* [Docs] Move topics to new categoriesDeForest Richards2019-09-201-4/+24
| | | | | | This commit moves several topics to new categories. llvm-svn: 372428
* [Docs] Moves topics to new categoriesDeForest Richards2019-09-181-0/+8
| | | | | | This commit moves several topics to new categories. It also removes a few duplicate links in Subsystem Documentation. llvm-svn: 372274
* [Docs] Bug fix for docs homepageDeForest Richards2019-09-161-1/+0
| | | | | | Removes reference to non-existent Reference Documentation page. llvm-svn: 372032
* [Docs] Adds Getting Started/Tutorials, Reference to LLVM docs homepageDeForest Richards2019-09-161-3/+58
| | | | | | Adds a section for Getting Started/Tutorials and Reference topics to the LLVM docs homepage. llvm-svn: 372031
* [Docs] Bug fix for reference to nonexistent documentDeForest Richards2019-09-131-3/+5
| | | | | | This commit fixes a bug in which the toctree contained a reference to a non-existent document. llvm-svn: 371889
* [Docs] Adds page for reference docsDeForest Richards2019-09-121-0/+3
| | | | | | Adds a Reference Documentation page for LLVM and API reference documentation. llvm-svn: 371782
* Docs: Update Community section on homepageDeForest Richards2019-09-051-22/+41
| | | | | | This commit includes the following changes: Adds a Getting Involved section under Community. Moves the Development Process section under Community. Moves Sphinx Quickstart Template and How to submit an LLVM bug report from User Guides section to Getting Involved. llvm-svn: 371127
* Docs: Move Documentation sections to separate pages.DeForest Richards2019-09-051-415/+13
| | | | | | Updates the links on the homepage by moving the User Guides, Programming Documentation, and Subsystem Documentation sections to separate pages. Also changes "Overview" to "About" at the top of the LLVM Docs homepage. This work is part of the Google Season of Docs project. llvm-svn: 371096
* [docs] Add GwpAsan to toctree.Mitch Phillips2019-08-211-0/+4
| | | | | | Reverts rL369556 in the process, as it's no longer needed. llvm-svn: 369560
* Add LLVMLibC proposal to docs/index.rst.Siva Chandra2019-08-151-0/+4
| | | | | | | | | | | | Reviewers: rupprecht Subscribers: arphaman, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D66307 llvm-svn: 369030
* [docs] Fix sphinx doc generation errorsJordan Rupprecht2019-08-141-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | Summary: Errors fixed: - GettingStarted: Duplicate explicit target name: "cmake" - GlobalISel: Unexpected indentation - LoopTerminology: Explicit markup ends without a blank line; unexpected unindent - ORCv2: Definition list ends without a blank line; unexpected unindent - Misc: document isn't included in any toctree Verified that a clean docs build (`rm -rf docs/ && ninja docs-llvm-html`) passes with no errors. Spot checked the individual pages to make sure they look OK. Reviewers: thakis, dsanders Reviewed By: dsanders Subscribers: arphaman, llvm-commits, lhames, rovka, dsanders, reames Tags: #llvm Differential Revision: https://reviews.llvm.org/D66183 llvm-svn: 368932
* [ORC] Start adding ORCv1 to ORCv2 transition tips to the ORCv2 doc.Lang Hames2019-07-151-3/+3
| | | | llvm-svn: 366075
* [docs][Remarks] Add documentation for remarks in LLVMFrancis Visoiu Mistrih2019-07-091-0/+3
| | | | | | | | | | | | | | | This adds documentation that describes remarks in LLVM. It aims at explaining what remarks are, how to enable them, and what users can do with the different modes. It lists all the available flags in LLVM (excluding clang), and describes the expected YAML structure as well as the tools that support the YAML format today. Differential Revision: https://reviews.llvm.org/D64355 llvm-svn: 365578
* [docs] Add new document on building distributionsChris Bieneman2019-05-211-0/+5
| | | | | | | | | | | | | | | | | | | Summary: This document is an attempt to provide a guide for best practices for using the LLVM build system to generate distributable LLVM-based tools. Most of the document is geared toward distributions of LLVM-based toolchains, but much of it also applies to distributing other LLVM-based tools and libraries. Reviewers: tstellar, phosek, jroelofs, hans, sylvestre.ledru Reviewed By: tstellar Subscribers: smeenai, dschuff, arphaman, winksaville, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D62040 llvm-svn: 361272
* [docs][ORC] Start work on an ORC design doc. Very much a work in progress.Lang Hames2019-05-181-0/+5
| | | | | | | This initial version describes some of the high level design goals and basic symbol lookup rules. llvm-svn: 361089
* Add guidelines/recommendations for organizers of LLVM SocialsAlex Denisov2019-05-141-0/+15
| | | | | | Differential Revision: https://reviews.llvm.org/D61550 llvm-svn: 360651
* New document skeleton describing how to add a constrained floating-pointKevin P. Neal2019-04-111-0/+5
| | | | | | | | | intrinsic. Reviewed by: andrew.w.kaylor, cameron.mcinally Differential Revision: https://reviews.llvm.org/D59833 llvm-svn: 358194
* [Documentation] Proposal to change variable namesMichael Platings2019-03-281-0/+4
| | | | | | Differential Revision: https://reviews.llvm.org/D59251 llvm-svn: 357174
* index.rst: Remove bb-chapuni from list of IRC botsHans Wennborg2019-02-191-1/+0
| | | | llvm-svn: 354353
* index.rst: Remove Dragonegg linkHans Wennborg2019-02-191-5/+4
| | | | llvm-svn: 354352
* Update GettingStarted guide to recommend that people use the newJames Y Knight2019-01-141-1/+1
| | | | | | | | | | | | | | | | | | | | | official Git repository. Remove the directions for using git-svn, and demote the prominence of the svn instructions. Also, fix a few other issues while I'm in there: * Mention LLVM_ENABLE_PROJECTS more. * Getting started doesn't need to mention test-suite, but should mention clang and the other projects. * Remove mentions of "configure", since that's long gone. I've also adjusted a few other mentions of svn to point to github, but have not done so comprehensively. Differential Revision: https://reviews.llvm.org/D56654 llvm-svn: 351130
* [Unroll/UnrollAndJam/Vectorizer/Distribute] Add followup loop attributes.Michael Kruse2018-12-121-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When multiple loop transformation are defined in a loop's metadata, their order of execution is defined by the order of their respective passes in the pass pipeline. For instance, e.g. #pragma clang loop unroll_and_jam(enable) #pragma clang loop distribute(enable) is the same as #pragma clang loop distribute(enable) #pragma clang loop unroll_and_jam(enable) and will try to loop-distribute before Unroll-And-Jam because the LoopDistribute pass is scheduled after UnrollAndJam pass. UnrollAndJamPass only supports one inner loop, i.e. it will necessarily fail after loop distribution. It is not possible to specify another execution order. Also,t the order of passes in the pipeline is subject to change between versions of LLVM, optimization options and which pass manager is used. This patch adds 'followup' attributes to various loop transformation passes. These attributes define which attributes the resulting loop of a transformation should have. For instance, !0 = !{!0, !1, !2} !1 = !{!"llvm.loop.unroll_and_jam.enable"} !2 = !{!"llvm.loop.unroll_and_jam.followup_inner", !3} !3 = !{!"llvm.loop.distribute.enable"} defines a loop ID (!0) to be unrolled-and-jammed (!1) and then the attribute !3 to be added to the jammed inner loop, which contains the instruction to distribute the inner loop. Currently, in both pass managers, pass execution is in a fixed order and UnrollAndJamPass will not execute again after LoopDistribute. We hope to fix this in the future by allowing pass managers to run passes until a fixpoint is reached, use Polly to perform these transformations, or add a loop transformation pass which takes the order issue into account. For mandatory/forced transformations (e.g. by having been declared by #pragma omp simd), the user must be notified when a transformation could not be performed. It is not possible that the responsible pass emits such a warning because the transformation might be 'hidden' in a followup attribute when it is executed, or it is not present in the pipeline at all. For this reason, this patche introduces a WarnMissedTransformations pass, to warn about orphaned transformations. Since this changes the user-visible diagnostic message when a transformation is applied, two test cases in the clang repository need to be updated. To ensure that no other transformation is executed before the intended one, the attribute `llvm.loop.disable_nonforced` can be added which should disable transformation heuristics before the intended transformation is applied. E.g. it would be surprising if a loop is distributed before a #pragma unroll_and_jam is applied. With more supported code transformations (loop fusion, interchange, stripmining, offloading, etc.), transformations can be used as building blocks for more complex transformations (e.g. stripmining+stripmining+interchange -> tiling). Reviewed By: hfinkel, dmgreen Differential Revision: https://reviews.llvm.org/D49281 Differential Revision: https://reviews.llvm.org/D55288 llvm-svn: 348944
* [stack-safety] Analysis documentationVitaly Buka2018-11-261-0/+5
| | | | | | | | | | | | | | | | Summary: Basic documentation of the Stack Safety Analysis. It will be improved during review and upstream of an implementation. Reviewers: kcc, eugenis, vlad.tsyrklevich, glider Reviewed By: vlad.tsyrklevich Subscribers: arphaman, llvm-commits Differential Revision: https://reviews.llvm.org/D53336 llvm-svn: 347612
* Introduce bug life cycle documentation.Kristof Beyls2018-11-071-0/+4
| | | | | | | | | | | | | | | Document what is expected during: * triaging * actively working on a bug * closing/resolving Also document how we maintain: * product/component breakdown * default-cc lists per component Differential Revision: https://reviews.llvm.org/D53691 llvm-svn: 346299
* Add docs+a script for building clang/LLVM with PGOGeorge Burgess IV2018-10-261-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | Depending on who you ask, PGO grants a 15%-25% improvement in build times when using clang. Sadly, hooking everything up properly to generate a profile and apply it to clang isn't always straightforward. This script (and the accompanying docs) aim to make this process easier; ideally, a single invocation of the given script. In terms of testing, I've got a cronjob on my Debian box that's meant to run this a few times per week, and I tried manually running it on a puny Gentoo box I have (four whole Atom cores!). Nothing obviously broke. ¯\_(ツ)_/¯ I don't know if we have a Python style guide, so I just shoved this through yapf with all the defaults on. Finally, though the focus is clang at the moment, the hope is that this is easily applicable to other LLVM-y tools with minimal effort (e.g. lld, opt, ...). Hence, this lives in llvm/utils and tries to be somewhat ambiguous about naming. Differential Revision: https://reviews.llvm.org/D53598 llvm-svn: 345427
* [test-suite/doc] Add list of programs we might add.Michael Kruse2018-10-231-0/+4
| | | | | | | | | | | | | | | | | | | | | | Add a list of benchmarks, applications and algorithms which are under discussion to be added to the test-suite. The initial list includes the the benchmarks mentioned at https://llvm.org/PR34216, missing SPEC benchmarks, some image processing algorithms and a few others. The bug tracker only allows adding to the discussion, not removing, commenting, adding details to individual benchmarks. The first proposal was to add these benchmark into the test-suite repository, but after a discussion, adding it to llvm/docs/Proposals seem more appropriate. One advantage is that llvm.org will have a browsable web page with these suggestions. Suggested-by: Hal Finkel Differential Revision: https://reviews.llvm.org/D46714 llvm-svn: 345074
* [Docs] [Support] System Library to Support Library transition along with ↵Kristina Brooks2018-09-181-2/+3
| | | | | | | | | | | | minor corrections to reflect it. System Library has been a long deprecated term along with the path lib/System, having been superseded/renamed to the Support Library a long time ago. These patches reflect those changes in documentation as well as update some outdated examples and provide context to the origin of the Support Library. Differential Revision: https://reviews.llvm.org/D52107 llvm-svn: 342500
* Revamp test-suite documentationMatthias Braun2018-08-311-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Remove duplication: Both TestingGuide and TestSuiteMakefileGuide would give a similar overview over the test-suite. - Present cmake/lit as the default/normal way of running the test-suite: - Move information about the cmake/lit testsuite into the new TestSuiteGuide.rst file. Mark the remaining information in TestSuiteMakefilesGuide.rst as deprecated. - General simplification and shorting of language. - Remove paragraphs about tests known to fail as everything should pass nowadays. - Remove paragraph about zlib requirement; it's not required anymore since we copied a zlib source snapshot into the test-suite. - Remove paragraph about comparison with "native compiler". Correctness is always checked against reference outputs nowadays. - Change cmake/lit quickstart section to recommend `pip` for installing lit and use `CMAKE_C_COMPILER` and a cache file in the example as that is what most people will end up doing anyway. Also a section about compare.py to quickstart. - Document `Bitcode` and `MicroBenchmarks` directories. - Add section with commonly used cmake configuration options. - Add section about showing and comparing result files via compare.py. - Add section about using external benchmark suites. - Add section about using custom benchmark suites. - Add section about profile guided optimization. - Add section about cross-compilation and running on external devices. Differential Revision: https://reviews.llvm.org/D51465 llvm-svn: 341260
* [docs] Reinstate r337730 - Add support for Markdown documentation inChandler Carruth2018-08-061-0/+5
| | | | | | | | | | | | | Sphinx. We think the bot is updated now, so trying this again. I'm landing it (with permission) as Michael is at a con at the moment. Actual patch largely by Michael Spencer. Differential Revision: https://reviews.llvm.org/D44910 llvm-svn: 338977
* Revert "[docs] Add support for Markdown documentation in Sphinx"Michael J. Spencer2018-07-231-5/+0
| | | | | | Looks like this bot hasn't been updated yet. llvm-svn: 337731
* [docs] Add support for Markdown documentation in SphinxMichael J. Spencer2018-07-231-0/+5
| | | | | | Differential Revision: https://reviews.llvm.org/D44910 llvm-svn: 337730
* Revert "[docs] Add support for Markdown documentation in Sphinx"Michael J. Spencer2018-07-201-5/+0
| | | | | | The buildbots have an old version of Sphinx (need at least 1.3). Revert until they are upgraded. llvm-svn: 337513
* [docs] Add support for Markdown documentation in SphinxMichael J. Spencer2018-07-191-0/+5
| | | | | | Differential Revision: https://reviews.llvm.org/D44910 llvm-svn: 337509
* [Docs] Remove some WIP X86 documentation I accidentally leaked into r328031.Craig Topper2018-03-211-4/+0
| | | | | | I didn't mean to commit it, but I guess I failed to switch branches or stash it in my local tree. llvm-svn: 328124
* [TableGen] Pass result of std::unique to vector::erase instead of ↵Craig Topper2018-03-201-0/+4
| | | | | | calculating a size and calling resize. llvm-svn: 328031
* [Docs] Add Contributing page.Florian Hahn2018-01-041-0/+6
| | | | | | | | | | | | | | | | | | | | | | This new page acts as an entry point for (new) contributors to LLVM and provides information about * What to contribute * How to submit a patch * Where to start to learn more about LLVM's architecture and internals. This version of the page duplicates some information from the DeveloperPolicy and Phabricator pages. Subsequent changes should work towards moving information for new developers to this page, where it makes sense. Reviewers: reames, probinson, kristof.beyls, silvas, rengolin, asb Reviewed By: silvas Differential Revision: https://reviews.llvm.org/D41665 llvm-svn: 321804
* [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 llvm-svn: 317554
* 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. llvm-svn: 315544
* 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 llvm-svn: 313809
* 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. llvm-svn: 313804
OpenPOWER on IntegriCloud