maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/docs/index.rst

597 lines
16 KiB
ReStructuredText
Raw Normal View History

[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-20 00:31:37 +08:00
Overview
========
.. warning::
If you are using a released version of LLVM, see `the download page
<http://llvm.org/releases/>`_ to find your documentation.
The LLVM compiler infrastructure supports a wide range of projects, from
industrial strength compilers to specialized JIT applications to small
research projects.
Similarly, documentation is broken down into several high-level groupings
Fix typos found by http://github.com/lyda/misspell-check llvm-svn: 157885
2012-06-02 18:20:22 +08:00
targeted at different audiences:
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-20 00:31:37 +08:00
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
LLVM Design & Overview
======================
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-20 00:31:37 +08:00
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Several introductory papers and presentations.
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-20 00:31:37 +08:00
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
.. toctree::
:hidden:
LangRef
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`LangRef`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Defines the LLVM intermediate representation.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
`Introduction to the LLVM Compiler`__
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Presentation providing a users introduction to LLVM.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
.. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
`Intro to LLVM`__
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Book chapter providing a compiler hacker's introduction to LLVM.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
.. __: http://www.aosabook.org/en/llvm.html
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
`LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Design overview.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
.. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
`LLVM: An Infrastructure for Multi-Stage Optimization`__
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
More details (quite old now).
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
.. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
`Publications mentioning LLVM <http://llvm.org/pubs>`_
..
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
User Guides
===========
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.
.. toctree::
:hidden:
CMake
[Docs] Add CMake Primer document 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
2016-04-30 04:34:54 +08:00
CMakePrimer
Updates based on post-commit review of r263834 * 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
2016-03-19 05:57:51 +08:00
AdvancedBuilds
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
HowToBuildOnARM
Add docs+a script for building clang/LLVM with PGO 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
2018-10-27 04:56:03 +08:00
HowToBuildWithPGO
[docs][ARM] Add HowTo for cross compiling and testing compiler-rt builtins 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
2017-11-07 17:40:05 +08:00
HowToCrossCompileBuiltinsOnArm
Cross-compilation doc llvm-svn: 190282
2013-09-09 04:44:48 +08:00
HowToCrossCompileLLVM
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
CommandGuide/index
GettingStarted
GettingStartedVS
FAQ
Lexicon
HowToAddABuilder
yaml2obj
HowToSubmitABug
SphinxQuickstartTemplate
[docs] Reinstate r337730 - Add support for Markdown documentation in 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
2018-08-06 08:38:31 +08:00
MarkdownQuickstartTemplate
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Phabricator
TestingGuide
tutorial/index
ReleaseNotes
Passes
YamlIO
[docs] The GEP FAQ is not "design and overview" llvm-svn: 178422
2013-03-30 23:32:50 +08:00
GetElementPtr
[new docs] Performance Tips for Frontend Authors 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
2015-02-28 07:14:50 +08:00
Frontend/PerformanceTips
[docs] Fix some Sphinx toctree warnings. llvm-svn: 190326
2013-09-10 03:09:00 +08:00
MCJITDesignAndImplementation
Introduce a *draft* of a code of conduct for the LLVM community and the 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
2016-07-01 04:27:54 +08:00
CodeOfConduct
[doc] Compile CUDA with LLVM 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
2015-11-11 06:35:47 +08:00
CompileCudaWithLLVM
Introduce a *draft* of a code of conduct for the LLVM community and the 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
2016-07-01 04:27:54 +08:00
ReportingGuide
Add some tips on benchmarking. llvm-svn: 303769
2017-05-25 00:39:12 +08:00
Benchmarking
Added Dockerfiles to build clang from sources. 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
2017-06-30 17:46:45 +08:00
Docker
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`GettingStarted`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Discusses how to get up and running quickly with the LLVM infrastructure.
Everything from unpacking and compilation of the distribution to execution
of some tools.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`CMake`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
An addendum to the main Getting Started guide for those using the `CMake
build system <http://www.cmake.org>`_.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`HowToBuildOnARM`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Notes on building and testing LLVM/Clang on ARM.
Add docs+a script for building clang/LLVM with PGO 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
2018-10-27 04:56:03 +08:00
:doc:`HowToBuildWithPGO`
Notes on building LLVM/Clang with PGO.
[docs][ARM] Add HowTo for cross compiling and testing compiler-rt builtins 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
2017-11-07 17:40:05 +08:00
:doc:`HowToCrossCompileBuiltinsOnArm`
Notes on cross-building and testing the compiler-rt builtins for Arm.
Cross-compilation doc llvm-svn: 190282
2013-09-09 04:44:48 +08:00
:doc:`HowToCrossCompileLLVM`
Notes on cross-building and testing LLVM/Clang.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`GettingStartedVS`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
An addendum to the main Getting Started guide for those using Visual Studio
on Windows.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`tutorial/index`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Tutorials about using LLVM. Includes a tutorial about making a custom
language with LLVM.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`LLVM Command Guide <CommandGuide/index>`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
A reference manual for the LLVM command line utilities ("man" pages for LLVM
tools).
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-20 00:31:37 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`Passes`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
A list of optimizations and analyses implemented in LLVM.
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-20 00:31:37 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`FAQ`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
A list of common questions and problems and their solutions.
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-20 00:31:37 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`Release notes for the current release <ReleaseNotes>`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
This describes new features, known bugs, and other limitations.
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-20 00:31:37 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`HowToSubmitABug`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Instructions for properly submitting information about any bugs you run into
in the LLVM system.
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-20 00:31:37 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`SphinxQuickstartTemplate`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
A template + tutorial for writing new Sphinx documentation. It is meant
to be read in source form.
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-20 00:31:37 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
A reference manual for using the LLVM testing infrastructure.
Revamp test-suite documentation - 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
2018-09-01 05:47:01 +08:00
:doc:`TestSuiteGuide`
Describes how to compile and run the test-suite benchmarks.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
`How to build the C, C++, ObjC, and ObjC++ front end`__
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Instructions for building the clang front-end from source.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
.. __: http://clang.llvm.org/get_started.html
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`Lexicon`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Definition of acronyms, terms and concepts used in LLVM.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`HowToAddABuilder`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Instructions for adding new builder to LLVM buildbot master.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`YamlIO`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
A reference guide for using LLVM's YAML I/O library.
[docs] The GEP FAQ is not "design and overview" llvm-svn: 178422
2013-03-30 23:32:50 +08:00
:doc:`GetElementPtr`
Answers to some very frequent questions about LLVM's most frequently
misunderstood instruction.
[new docs] Performance Tips for Frontend Authors 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
2015-02-28 07:14:50 +08:00
:doc:`Frontend/PerformanceTips`
Introduce the llvm-cfi-verify tool (resubmission of D37937). 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
2017-09-21 04:38:14 +08:00
A collection of tips for frontend authors on how to generate IR
[new docs] Performance Tips for Frontend Authors 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
2015-02-28 07:14:50 +08:00
which LLVM is able to effectively optimize.
Added Dockerfiles to build clang from sources. 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
2017-06-30 17:46:45 +08:00
:doc:`Docker`
A reference for using Dockerfiles provided with LLVM.
[new docs] Performance Tips for Frontend Authors 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
2015-02-28 07:14:50 +08:00
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Programming Documentation
=========================
For developers of applications which use LLVM as a library.
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-20 00:31:37 +08:00
.. toctree::
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
:hidden:
Atomics
CodingStandards
CommandLine
CompilerWriterInfo
ExtendingLLVM
HowToSetUpLLVMStyleRTTI
ProgrammersManual
MC: Support COFF image-relative MCSymbolRefs Add support for the COFF relocation types IMAGE_REL_I386_DIR32NB and IMAGE_REL_AMD64_ADDR32NB for 32- and 64-bit respectively. These are similar to normal 4-byte relocations except that they do not include the base address of the image. Image-relative relocations are used for debug information (32-bit) and SEH unwind tables (64-bit). A new MCSymbolRef variant called 'VK_COFF_IMGREL32' is introduced to specify such relocations. For AT&T assembly, this variant can be accessed using the symbol suffix '@imgrel'. llvm-svn: 179240
2013-04-11 07:28:17 +08:00
Extensions
Move lib/Fuzzer docs from a README.txt to a proper .rst file. 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
2015-03-31 07:05:30 +08:00
LibFuzzer
docs: Add some information about Fuzzing LLVM itself This splits some content out of the libFuzzer docs and adds a fair amount of detail about the fuzzers in LLVM. llvm-svn: 315544
2017-10-12 09:44:24 +08:00
FuzzingLLVM
[docs] fix the build by including ScudoHardenedAllocator into toc; mention SourceBasedCodeCoverage.html in libFuzzer docs llvm-svn: 272070
2016-06-08 07:13:54 +08:00
ScudoHardenedAllocator
Adding document describing the use of the -opt-bisect-limit option. llvm-svn: 279881
2016-08-27 07:11:48 +08:00
OptBisect
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`LLVM Language Reference Manual <LangRef>`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Defines the LLVM intermediate representation and the assembly form of the
different nodes.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`Atomics`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Information about LLVM's concurrency model.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`ProgrammersManual`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Introduction to the general layout of the LLVM sourcebase, important classes
and APIs, and some tips & tricks.
MC: Support COFF image-relative MCSymbolRefs Add support for the COFF relocation types IMAGE_REL_I386_DIR32NB and IMAGE_REL_AMD64_ADDR32NB for 32- and 64-bit respectively. These are similar to normal 4-byte relocations except that they do not include the base address of the image. Image-relative relocations are used for debug information (32-bit) and SEH unwind tables (64-bit). A new MCSymbolRef variant called 'VK_COFF_IMGREL32' is introduced to specify such relocations. For AT&T assembly, this variant can be accessed using the symbol suffix '@imgrel'. llvm-svn: 179240
2013-04-11 07:28:17 +08:00
:doc:`Extensions`
LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`CommandLine`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Provides information on using the command line parsing library.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`CodingStandards`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Details the LLVM coding standards and provides useful information on writing
efficient C++ code.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`HowToSetUpLLVMStyleRTTI`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
class hierarchy.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`ExtendingLLVM`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Look here to see how to add instructions and intrinsics to LLVM.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
`Doxygen generated documentation <http://llvm.org/doxygen/>`_
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
(`classes <http://llvm.org/doxygen/inherits.html>`_)
Add link to Go bindings documentation. llvm-svn: 225815
2015-01-14 02:49:42 +08:00
`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
Update GettingStarted guide to recommend that people use the new 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
2019-01-15 06:27:32 +08:00
`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
..
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`CompilerWriterInfo`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
A list of helpful links for compiler writers.
Move lib/Fuzzer docs from a README.txt to a proper .rst file. 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
2015-03-31 07:05:30 +08:00
:doc:`LibFuzzer`
A library for writing in-process guided fuzzers.
docs: Add some information about Fuzzing LLVM itself This splits some content out of the libFuzzer docs and adds a fair amount of detail about the fuzzers in LLVM. llvm-svn: 315544
2017-10-12 09:44:24 +08:00
:doc:`FuzzingLLVM`
Information on writing and using Fuzzers to find bugs in LLVM.
[docs] fix the build by including ScudoHardenedAllocator into toc; mention SourceBasedCodeCoverage.html in libFuzzer docs llvm-svn: 272070
2016-06-08 07:13:54 +08:00
:doc:`ScudoHardenedAllocator`
A library that implements a security-hardened `malloc()`.
Adding document describing the use of the -opt-bisect-limit option. llvm-svn: 279881
2016-08-27 07:11:48 +08:00
:doc:`OptBisect`
A command line option for debugging optimization-induced failures.
[Docs] Add Contributing page. 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
2018-01-05 01:12:21 +08:00
.. _index-subsystem-docs:
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Subsystem Documentation
=======================
For API clients and LLVM developers.
.. toctree::
:hidden:
AliasAnalysis
[Docs] Add initial MemorySSA documentation. Patch partially by Danny. Differential Revision: https://reviews.llvm.org/D23535 llvm-svn: 278875
2016-08-17 08:17:29 +08:00
MemorySSA
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
BitCodeFormat
blockfreq: Document BlockFrequencyInfo terminology Documents terminology used in the forthcoming rewrite of BlockFrequencyInfo. <rdar://problem/14292693> llvm-svn: 206086
2014-04-12 07:21:07 +08:00
BlockFrequencyTerminology
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
BranchWeightMetadata
Bugpoint
CodeGenerator
ExceptionHandling
LinkTimeOptimization
SegmentedStacks
TableGenFundamentals
Re-factor TableGen docs 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
2014-03-21 00:08:34 +08:00
TableGen/index
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
DebuggingJITedCode
GoldPlugin
MarkedUpDisassembly
SystemLibrary
[Docs] [Support] System Library to Support Library transition along with 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
2018-09-19 02:05:38 +08:00
SupportLibrary
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
SourceLevelDebugging
Vectorizers
WritingAnLLVMBackend
GarbageCollection
WritingAnLLVMPass
Adding a HowTo for Attributes. This is based on Bill Wendling's email. No additional content has been added, but now there's a place for Attributes to capture future information. llvm-svn: 174961
2013-02-12 19:45:22 +08:00
HowToUseAttributes
Add start of user documentation for NVPTX Summary: This is the beginning of user documentation for the NVPTX back-end. I want to ensure I am integrating this properly into the rest of the LLVM documentation. Differential Revision: http://llvm-reviews.chandlerc.com/D600 llvm-svn: 178428
2013-03-31 00:41:14 +08:00
NVPTXUsage
R600 -> AMDGPU rename llvm-svn: 239657
2015-06-13 11:28:10 +08:00
AMDGPUUsage
LangRef documentation for the stackmap and patchpoint intrinsics. 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
2013-12-24 10:57:25 +08:00
StackMaps
[docs] Fix some Sphinx warnings. 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
2014-03-02 08:21:42 +08:00
InAlloca
[ARM64-BE] Add sphinx documentation for the ARM64 NEON implementation. There are some interesting decisions based on non-obvious rationale in the ARM64-BE NEON implementation - decent documentation is definitely required. llvm-svn: 208577
2014-05-12 23:13:39 +08:00
BigEndianNEON
Docs: add documentation for the coverage mapping format. Differential Revision: http://reviews.llvm.org/D4729 llvm-svn: 215990
2014-08-20 01:05:58 +08:00
CoverageMappingFormat
Fix sphinx error from Statepoints.rst It was complaining it wasn't included in any toctree llvm-svn: 223254
2014-12-04 02:35:11 +08:00
Statepoints
Added documentation for MergeFunctions pass: Pass looks for equivalent functions that are mergable and folds them. llvm-svn: 223931
2014-12-11 01:42:01 +08:00
MergeFunctions
IR: New representation for CFI and virtual call optimization pass metadata. 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
2016-06-25 05:21:32 +08:00
TypeMetadata
[Unroll/UnrollAndJam/Vectorizer/Distribute] Add followup loop attributes. 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
2018-12-13 01:32:52 +08:00
TransformMetadata
Unbreak docs build from r239740. Add FaultMaps.rst to toctree. llvm-svn: 239747
2015-06-16 03:38:15 +08:00
FaultMaps
Add initial documentation for the MIR serialization format. Differential Revision: http://reviews.llvm.org/D11736 llvm-svn: 244292
2015-08-07 06:55:19 +08:00
MIRLangRef
[coroutines] Part 1 of N: Documentation 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
2016-07-23 12:05:08 +08:00
Coroutines
[docs] Add initial Global ISel documentation. 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
2016-11-05 01:57:34 +08:00
GlobalISel
[XRay][Docs] Add documentation for XRay in LLVM 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
2016-11-09 08:24:58 +08:00
XRay
[XRay][docs] Add XRayExample to docindex. llvm-svn: 299172
2017-03-31 10:51:19 +08:00
XRayExample
Xray docs with description of Flight Data Recorder binary format. 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
2017-08-03 05:47:27 +08:00
XRayFDRFormat
[PDB] Begin adding documentation for the PDB file format. Differential Revision: https://reviews.llvm.org/D26374 llvm-svn: 286491
2016-11-11 03:24:21 +08:00
PDB/index
Introduce the llvm-cfi-verify tool (resubmission of D37937). 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
2017-09-21 04:38:14 +08:00
CFIVerify
[docs] Reinstate r337730 - Add support for Markdown documentation in 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
2018-08-06 08:38:31 +08:00
SpeculativeLoadHardening
[stack-safety] Analysis documentation 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
2018-11-27 07:16:07 +08:00
StackSafetyAnalysis
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`WritingAnLLVMPass`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Information on how to write LLVM transformations and analyses.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`WritingAnLLVMBackend`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Information on how to write LLVM backends for machine targets.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`CodeGenerator`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
The design and implementation of the LLVM code generator. Useful if you are
working on retargetting LLVM to a new architecture, designing a new codegen
pass, or enhancing existing components.
Add initial documentation for the MIR serialization format. Differential Revision: http://reviews.llvm.org/D11736 llvm-svn: 244292
2015-08-07 06:55:19 +08:00
:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
A reference manual for the MIR serialization format, which is used to test
LLVM's code generation passes.
[docs] Update link title docs/TableGen/ is not really just "fundamentals" anymore, but rather more of a portal for all things TableGen. llvm-svn: 205743
2014-04-08 06:42:53 +08:00
:doc:`TableGen <TableGen/index>`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Describes the TableGen tool, which is used heavily by the LLVM code
generator.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`AliasAnalysis`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Information on how to write a new alias analysis implementation or how to
use existing analyses.
[Docs] Add initial MemorySSA documentation. Patch partially by Danny. Differential Revision: https://reviews.llvm.org/D23535 llvm-svn: 278875
2016-08-17 08:17:29 +08:00
:doc:`MemorySSA`
Information about the MemorySSA utility in LLVM, as well as how to use it.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`GarbageCollection`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
The interfaces source-language compilers should use for compiling GC'd
programs.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
This document describes the design and philosophy behind the LLVM
source-level debugger.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`Vectorizers`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
This document describes the current status of vectorization in LLVM.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`ExceptionHandling`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
This document describes the design and implementation of exception handling
in LLVM.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`Bugpoint`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Automatic bug finder and test-case reducer description and usage
information.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`BitCodeFormat`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
This describes the file format and encoding used for LLVM "bc" files.
[Docs] [Support] System Library to Support Library transition along with 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
2018-09-19 02:05:38 +08:00
:doc:`Support Library <SupportLibrary>`
This document describes the LLVM Support Library (``lib/Support``) and
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
how to keep LLVM source code portable
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`LinkTimeOptimization`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
This document describes the interface between LLVM intermodular optimizer
and the linker and its design
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`GoldPlugin`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
How to build your programs with link-time optimization on Linux.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`DebuggingJITedCode`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
How to debug JITed code with GDB.
Adding a document to describe the MCJIT execution engine implementation. llvm-svn: 188943
2013-08-22 06:15:09 +08:00
:doc:`MCJITDesignAndImplementation`
Describes the inner workings of MCJIT execution engine.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`BranchWeightMetadata`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Provides information about Branch Prediction Information.
blockfreq: Document BlockFrequencyInfo terminology Documents terminology used in the forthcoming rewrite of BlockFrequencyInfo. <rdar://problem/14292693> llvm-svn: 206086
2014-04-12 07:21:07 +08:00
:doc:`BlockFrequencyTerminology`
Provides information about terminology used in the ``BlockFrequencyInfo``
analysis pass.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`SegmentedStacks`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
This document describes segmented stacks and how they are used in LLVM.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`MarkedUpDisassembly`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
This document describes the optional rich disassembly output syntax.
Adding a HowTo for Attributes. This is based on Bill Wendling's email. No additional content has been added, but now there's a place for Attributes to capture future information. llvm-svn: 174961
2013-02-12 19:45:22 +08:00
:doc:`HowToUseAttributes`
Answers some questions about the new Attributes infrastructure.
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Add start of user documentation for NVPTX Summary: This is the beginning of user documentation for the NVPTX back-end. I want to ensure I am integrating this properly into the rest of the LLVM documentation. Differential Revision: http://llvm-reviews.chandlerc.com/D600 llvm-svn: 178428
2013-03-31 00:41:14 +08:00
:doc:`NVPTXUsage`
Add documentation for various aspects of the AMDGPU backend. Differential Revision: https://reviews.llvm.org/D33736 llvm-svn: 304831
2017-06-07 04:31:59 +08:00
This document describes using the NVPTX backend to compile GPU kernels.
Add start of user documentation for NVPTX Summary: This is the beginning of user documentation for the NVPTX back-end. I want to ensure I am integrating this properly into the rest of the LLVM documentation. Differential Revision: http://llvm-reviews.chandlerc.com/D600 llvm-svn: 178428
2013-03-31 00:41:14 +08:00
R600 -> AMDGPU rename llvm-svn: 239657
2015-06-13 11:28:10 +08:00
:doc:`AMDGPUUsage`
Add documentation for various aspects of the AMDGPU backend. Differential Revision: https://reviews.llvm.org/D33736 llvm-svn: 304831
2017-06-07 04:31:59 +08:00
This document describes using the AMDGPU backend to compile GPU kernels.
R600/SI: Start implementing an assembler 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
2014-11-14 22:08:00 +08:00
LangRef documentation for the stackmap and patchpoint intrinsics. 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
2013-12-24 10:57:25 +08:00
:doc:`StackMaps`
LLVM support for mapping instruction addresses to the location of
values and allowing code to be patched.
Add start of user documentation for NVPTX Summary: This is the beginning of user documentation for the NVPTX back-end. I want to ensure I am integrating this properly into the rest of the LLVM documentation. Differential Revision: http://llvm-reviews.chandlerc.com/D600 llvm-svn: 178428
2013-03-31 00:41:14 +08:00
[ARM64-BE] Add sphinx documentation for the ARM64 NEON implementation. There are some interesting decisions based on non-obvious rationale in the ARM64-BE NEON implementation - decent documentation is definitely required. llvm-svn: 208577
2014-05-12 23:13:39 +08:00
:doc:`BigEndianNEON`
LLVM's support for generating NEON instructions on big endian ARM targets is
somewhat nonintuitive. This document explains the implementation and rationale.
Docs: add documentation for the coverage mapping format. Differential Revision: http://reviews.llvm.org/D4729 llvm-svn: 215990
2014-08-20 01:05:58 +08:00
:doc:`CoverageMappingFormat`
This describes the format and encoding used for LLVM’s code coverage mapping.
[ARM64-BE] Add sphinx documentation for the ARM64 NEON implementation. There are some interesting decisions based on non-obvious rationale in the ARM64-BE NEON implementation - decent documentation is definitely required. llvm-svn: 208577
2014-05-12 23:13:39 +08:00
Fix sphinx error from Statepoints.rst It was complaining it wasn't included in any toctree llvm-svn: 223254
2014-12-04 02:35:11 +08:00
:doc:`Statepoints`
This describes a set of experimental extensions for garbage
collection support.
Added documentation for MergeFunctions pass: Pass looks for equivalent functions that are mergable and folds them. llvm-svn: 223931
2014-12-11 01:42:01 +08:00
:doc:`MergeFunctions`
Describes functions merging optimization.
[docs] Put an explicit link to InAlloca.rst llvm-svn: 228192
2015-02-05 04:51:19 +08:00
:doc:`InAlloca`
Description of the ``inalloca`` argument attribute.
Unbreak docs build from r239740. Add FaultMaps.rst to toctree. llvm-svn: 239747
2015-06-16 03:38:15 +08:00
:doc:`FaultMaps`
LLVM support for folding control flow into faulting machine instructions.
[doc] Compile CUDA with LLVM 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
2015-11-11 06:35:47 +08:00
:doc:`CompileCudaWithLLVM`
LLVM support for CUDA.
[coroutines] Part 1 of N: Documentation 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
2016-07-23 12:05:08 +08:00
:doc:`Coroutines`
LLVM support for coroutines.
[docs] Add initial Global ISel documentation. 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
2016-11-05 01:57:34 +08:00
:doc:`GlobalISel`
This describes the prototype instruction selection replacement, GlobalISel.
[XRay][Docs] Add documentation for XRay in LLVM 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
2016-11-09 08:24:58 +08:00
:doc:`XRay`
High-level documentation of how to use XRay in LLVM.
[XRay][docs] Examples for how to use XRay 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
2017-03-31 07:46:36 +08:00
:doc:`XRayExample`
An example of how to debug an application with XRay.
[PDB] Begin adding documentation for the PDB file format. Differential Revision: https://reviews.llvm.org/D26374 llvm-svn: 286491
2016-11-11 03:24:21 +08:00
:doc:`The Microsoft PDB File Format <PDB/index>`
A detailed description of the Microsoft PDB (Program Database) file format.
Introduce the llvm-cfi-verify tool (resubmission of D37937). 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
2017-09-21 04:38:14 +08:00
:doc:`CFIVerify`
A description of the verification tool for Control Flow Integrity.
[docs] Reinstate r337730 - Add support for Markdown documentation in 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
2018-08-06 08:38:31 +08:00
:doc:`SpeculativeLoadHardening`
A description of the Speculative Load Hardening mitigation for Spectre v1.
[stack-safety] Analysis documentation 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
2018-11-27 07:16:07 +08:00
:doc:`StackSafetyAnalysis`
This document describes the design of the stack safety analysis of local
variables.
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Development Process Documentation
=================================
Information about LLVM's development process.
.. toctree::
:hidden:
[Docs] Add Contributing page. 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
2018-01-05 01:12:21 +08:00
Contributing
[docs] Put DeveloperPolicy under "Development Process Documentation" llvm-svn: 178421
2013-03-30 23:32:47 +08:00
DeveloperPolicy
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Projects
LLVMBuild
HowToReleaseLLVM
docs: reorganize front page slightly llvm-svn: 173718
2013-01-29 05:28:10 +08:00
Packaging
[docs] Fix some Sphinx toctree warnings. llvm-svn: 190326
2013-09-10 03:09:00 +08:00
ReleaseProcess
Add a reference to Phabricator.rst to docs/index.rst. llvm-svn: 219015
2014-10-04 04:17:32 +08:00
Phabricator
Introduce bug life cycle documentation. 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
2018-11-07 16:49:36 +08:00
BugLifeCycle
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
[Docs] Add Contributing page. 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
2018-01-05 01:12:21 +08:00
:doc:`Contributing`
An overview on how to contribute to LLVM.
[docs] Put DeveloperPolicy under "Development Process Documentation" llvm-svn: 178421
2013-03-30 23:32:47 +08:00
:doc:`DeveloperPolicy`
The LLVM project's policy towards developers and their contributions.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`Projects`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
How-to guide and templates for new projects that *use* the LLVM
infrastructure. The templates (directory organization, Makefiles, and test
tree) allow the project code to be located outside (or inside) the ``llvm/``
tree, while using LLVM header files and libraries.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`LLVMBuild`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Describes the LLVMBuild organization and files used by LLVM to specify
component descriptions.
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
:doc:`HowToReleaseLLVM`
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
This is a guide to preparing LLVM releases. Most developers can ignore it.
Linking ReleaseProcess doc with the world llvm-svn: 182763
2013-05-28 18:32:55 +08:00
:doc:`ReleaseProcess`
fix a typo in doumentation index. llvm-svn: 218504
2014-09-26 14:59:15 +08:00
This is a guide to validate a new release, during the release process. Most developers can ignore it.
Linking ReleaseProcess doc with the world llvm-svn: 182763
2013-05-28 18:32:55 +08:00
docs: reorganize front page slightly llvm-svn: 173718
2013-01-29 05:28:10 +08:00
:doc:`Packaging`
Advice on packaging LLVM into a distribution.
Add a reference to Phabricator.rst to docs/index.rst. llvm-svn: 219015
2014-10-04 04:17:32 +08:00
:doc:`Phabricator`
Describes how to use the Phabricator code review tool hosted on
http://reviews.llvm.org/ and its command line interface, Arcanist.
Introduce bug life cycle documentation. 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
2018-11-07 16:49:36 +08:00
:doc:`BugLifeCycle`
Describes how bugs are reported, triaged and closed.
[docs] Pull IRC and Mailing Lists under a new "Community" heading. llvm-svn: 178423
2013-03-30 23:32:51 +08:00
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.
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Mailing Lists
[docs] Pull IRC and Mailing Lists under a new "Community" heading. llvm-svn: 178423
2013-03-30 23:32:51 +08:00
-------------
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
If you can't find what you need in these docs, try consulting the mailing
lists.
Rename all references to old mailing lists to new lists.llvm.org address. llvm-svn: 243999
2015-08-05 11:51:17 +08:00
`Developer's List (llvm-dev)`__
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
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.
Rename all references to old mailing lists to new lists.llvm.org address. llvm-svn: 243999
2015-08-05 11:51:17 +08:00
.. __: http://lists.llvm.org/mailman/listinfo/llvm-dev
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
[docs] Annotate mailing lists with their "name". Nobody says "the developer's list" or "commits archive"; they always say "llvmdev" or "llvm-commits". It makes sense for our documentation to at least make that association explicitly. llvm-svn: 178425
2013-03-30 23:33:01 +08:00
`Commits Archive (llvm-commits)`__
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
This list contains all commit messages that are made when LLVM developers
[docs] llvmbugs is not the place for patches. llvm-svn: 178426
2013-03-30 23:33:02 +08:00
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.
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Rename all references to old mailing lists to new lists.llvm.org address. llvm-svn: 243999
2015-08-05 11:51:17 +08:00
.. __: http://lists.llvm.org/pipermail/llvm-commits/
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
Rename all references to old mailing lists to new lists.llvm.org address. llvm-svn: 243999
2015-08-05 11:51:17 +08:00
`Bugs & Patches Archive (llvm-bugs)`__
[docs] llvmbugs is not the place for patches. llvm-svn: 178426
2013-03-30 23:33:02 +08:00
This list gets emailed every time a bug is opened and closed. It is
Rename all references to old mailing lists to new lists.llvm.org address. llvm-svn: 243999
2015-08-05 11:51:17 +08:00
higher volume than the LLVM-dev list.
[docs] Reorganize mailing lists. Order them roughly by "which one should a newbie join first". llvm-svn: 178424
2013-03-30 23:32:54 +08:00
Rename all references to old mailing lists to new lists.llvm.org address. llvm-svn: 243999
2015-08-05 11:51:17 +08:00
.. __: http://lists.llvm.org/pipermail/llvm-bugs/
[docs] Reorganize mailing lists. Order them roughly by "which one should a newbie join first". llvm-svn: 178424
2013-03-30 23:32:54 +08:00
[docs] Annotate mailing lists with their "name". Nobody says "the developer's list" or "commits archive"; they always say "llvmdev" or "llvm-commits". It makes sense for our documentation to at least make that association explicitly. llvm-svn: 178425
2013-03-30 23:33:01 +08:00
`Test Results Archive (llvm-testresults)`__
docs: Inline documentation structure into homepage. This brings back {Ctrl,Cmd}-f'ability, and makes some really bad organizational choices easier to see (and therefore fix). llvm-svn: 172949
2013-01-20 10:19:36 +08:00
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.
Rename all references to old mailing lists to new lists.llvm.org address. llvm-svn: 243999
2015-08-05 11:51:17 +08:00
.. __: http://lists.llvm.org/pipermail/llvm-testresults/
docs: Use proper markup. These are really definition lists. llvm-svn: 172950
2013-01-20 10:19:42 +08:00
[docs] Annotate mailing lists with their "name". Nobody says "the developer's list" or "commits archive"; they always say "llvmdev" or "llvm-commits". It makes sense for our documentation to at least make that association explicitly. llvm-svn: 178425
2013-03-30 23:33:01 +08:00
`LLVM Announcements List (llvm-announce)`__
[docs] Reorganize mailing lists. Order them roughly by "which one should a newbie join first". llvm-svn: 178424
2013-03-30 23:32:54 +08:00
This is a low volume list that provides important announcements regarding
LLVM. It gets email about once a month.
Rename all references to old mailing lists to new lists.llvm.org address. llvm-svn: 243999
2015-08-05 11:51:17 +08:00
.. __: http://lists.llvm.org/mailman/listinfo/llvm-announce
[docs] Reorganize mailing lists. Order them roughly by "which one should a newbie join first". llvm-svn: 178424
2013-03-30 23:32:54 +08:00
[docs] Pull IRC and Mailing Lists under a new "Community" heading. llvm-svn: 178423
2013-03-30 23:32:51 +08:00
IRC
---
Users and developers of the LLVM project (including subprojects such as Clang)
can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
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 <number>
* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
near-trunk clang instead of gcc.
[docs] Add proposals to index file llvm-svn: 276099
2016-07-20 17:38:04 +08:00
Community wide proposals
------------------------
Proposals for massive changes in how the community behaves and how the work flow
can be better.
.. toctree::
:hidden:
CodeOfConduct
Moving to GitHub - Unified Proposal 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
2016-10-13 07:02:02 +08:00
Proposals/GitHubMove
[test-suite/doc] Add list of programs we might add. 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
2018-10-24 03:46:29 +08:00
Proposals/TestSuite
[Docs] Add VectorizationPlan to docs/Proposals. 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
2017-05-29 23:36:23 +08:00
Proposals/VectorizationPlan
[docs] Add proposals to index file llvm-svn: 276099
2016-07-20 17:38:04 +08:00
:doc:`CodeOfConduct`
Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,
IRC, etc).
Moving to GitHub - Unified Proposal 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
2016-10-13 07:02:02 +08:00
:doc:`Proposals/GitHubMove`
[docs] Add proposals to index file llvm-svn: 276099
2016-07-20 17:38:04 +08:00
Proposal to move from SVN/Git to GitHub.
[test-suite/doc] Add list of programs we might add. 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
2018-10-24 03:46:29 +08:00
:doc:`Proposals/TestSuite`
Proposals for additional benchmarks/programs for llvm's test-suite.
[Docs] Add VectorizationPlan to docs/Proposals. 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
2017-05-29 23:36:23 +08:00
:doc:`Proposals/VectorizationPlan`
Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
[docs] Pull IRC and Mailing Lists under a new "Community" heading. llvm-svn: 178423
2013-03-30 23:32:51 +08:00
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133
2012-04-20 00:31:37 +08:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`