Index: vendor/llvm/dist/docs/ReleaseNotes.rst
===================================================================
--- vendor/llvm/dist/docs/ReleaseNotes.rst (revision 296357)
+++ vendor/llvm/dist/docs/ReleaseNotes.rst (revision 296358)
@@ -1,305 +1,303 @@
======================
LLVM 3.8 Release Notes
======================
.. contents::
:local:
Introduction
============
This document contains the release notes for the LLVM Compiler Infrastructure,
release 3.8. Here we describe the status of LLVM, including major improvements
from the previous release, improvements in various subprojects of LLVM, and
some of the current users of the code. All LLVM releases may be downloaded
from the `LLVM releases web site `_.
For more information about LLVM, including information about the latest
release, please check out the `main LLVM web site `_. If you
have questions or comments, the `LLVM Developer's Mailing List
`_ is a good place to send
them.
Non-comprehensive list of changes in this release
=================================================
* With this release, the minimum Windows version required for running LLVM is
Windows 7. Earlier versions, including Windows Vista and XP are no longer
supported.
* With this release, the autoconf build system is deprecated. It will be removed
in the 3.9 release. Please migrate to using CMake. For more information see:
`Building LLVM with CMake `_
-* The C API function LLVMLinkModules is deprecated. It will be removed in the
- 3.9 release. Please migrate to LLVMLinkModules2. Unlike the old function the
+* We have documented our C API stability guarantees for both development and
+ release branches, as well as documented how to extend the C API. Please see
+ the `developer documentation `_ for more
+ information.
+
+* The C API function ``LLVMLinkModules`` is deprecated. It will be removed in the
+ 3.9 release. Please migrate to ``LLVMLinkModules2``. Unlike the old function the
new one
* Doesn't take an unused parameter.
* Destroys the source instead of only damaging it.
* Does not record a message. Use the diagnostic handler instead.
-* The C API functions LLVMParseBitcode, LLVMParseBitcodeInContext,
- LLVMGetBitcodeModuleInContext and LLVMGetBitcodeModule have been deprecated.
+* The C API functions ``LLVMParseBitcode``, ``LLVMParseBitcodeInContext``,
+ ``LLVMGetBitcodeModuleInContext`` and ``LLVMGetBitcodeModule`` have been deprecated.
They will be removed in 3.9. Please migrate to the versions with a 2 suffix.
Unlike the old ones the new ones do not record a diagnostic message. Use
the diagnostic handler instead.
-* The deprecated C APIs LLVMGetBitcodeModuleProviderInContext and
- LLVMGetBitcodeModuleProvider have been removed.
+* The deprecated C APIs ``LLVMGetBitcodeModuleProviderInContext`` and
+ ``LLVMGetBitcodeModuleProvider`` have been removed.
-* The deprecated C APIs LLVMCreateExecutionEngine, LLVMCreateInterpreter,
- LLVMCreateJITCompiler, LLVMAddModuleProvider and LLVMRemoveModuleProvider
+* The deprecated C APIs ``LLVMCreateExecutionEngine``, ``LLVMCreateInterpreter``,
+ ``LLVMCreateJITCompiler``, ``LLVMAddModuleProvider`` and ``LLVMRemoveModuleProvider``
have been removed.
* With this release, the C API headers have been reorganized to improve build
time. Type specific declarations have been moved to Type.h, and error
handling routines have been moved to ErrorHandling.h. Both are included in
Core.h so nothing should change for projects directly including the headers,
but transitive dependencies may be affected.
-* llvm-ar now suports thin archives.
+* llvm-ar now supports thin archives.
-* llvm doesn't produce .data.rel.ro.local or .data.rel sections anymore.
+* llvm doesn't produce ``.data.rel.ro.local`` or ``.data.rel`` sections anymore.
-* aliases to available_externally globals are now rejected by the verifier.
+* Aliases to ``available_externally`` globals are now rejected by the verifier.
-* the IR Linker has been split into IRMover that moves bits from one module to
+* The IR Linker has been split into ``IRMover`` that moves bits from one module to
another and Linker proper that decides what to link.
* Support for dematerializing has been dropped.
-* RegisterScheduler::setDefault was removed. Targets that used to call into the
- command line parser to set the DAGScheduler, and that don't have enough
- control with setSchedulingPreference, should look into overriding the
- SubTargetHook "getDAGScheduler()".
+* ``RegisterScheduler::setDefault`` was removed. Targets that used to call into the
+ command line parser to set the ``DAGScheduler``, and that don't have enough
+ control with ``setSchedulingPreference``, should look into overriding the
+ ``SubTargetHook`` "``getDAGScheduler()``".
* ``ilist_iterator`` no longer has implicit conversions to and from ``T*``,
since ``ilist_iterator`` may be pointing at the sentinel (which is usually
not of type ``T`` at all). To convert from an iterator ``I`` to a pointer,
use ``&*I``; to convert from a pointer ``P`` to an iterator, use
``P->getIterator()``. Alternatively, explicit conversions via
``static_cast(U)`` are still available.
* ``ilist_node::getNextNode()`` and ``ilist_node::getPrevNode()`` now
fail at compile time when the node cannot access its parent list.
Previously, when the sentinel was was an ``ilist_half_node``, this API
- could return the sentinal instead of ``nullptr``. Frustrated callers should
+ could return the sentinel instead of ``nullptr``. Frustrated callers should
be updated to use ``iplist::getNextNode(T*)`` instead. Alternatively, if
the node ``N`` is guaranteed not to be the last in the list, it is safe to
call ``&*++N->getIterator()`` directly.
* The `Kaleidoscope tutorials `_ have been updated to use
the ORC JIT APIs.
* ORC now has a basic set of C bindings.
* Optional support for linking clang and the LLVM tools with a single libLLVM
shared library. To enable this, pass ``-DLLVM_LINK_LLVM_DYLIB=ON`` to CMake.
See `Building LLVM with CMake`_ for more details.
* The optimization to move the prologue and epilogue of functions in colder
code path (shrink-wrapping) is now enabled by default.
* A new target-independent gcc-compatible emulated Thread Local Storage mode
is added. When ``-femultated-tls`` flag is used, all accesses to TLS
variables are converted to calls to ``__emutls_get_address`` in the runtime
library.
-* MSVC compatible exception handling has been completely overhauled. New
+* MSVC-compatible exception handling has been completely overhauled. New
instructions have been introduced to facilitate this:
`New exception handling instructions `_.
While we have done our best to test this feature thoroughly, it would
not be completely surprising if there were a few lingering issues that
early adopters might bump into.
-.. NOTE
- For small 1-3 sentence descriptions, just add an entry at the end of
- this list. If your description won't fit comfortably in one bullet
- point (e.g. maybe you would like to give an example of the
- functionality, or simply have a lot to talk about), see the `NOTE` below
- for adding a new subsection.
-* ... next change ...
-
-.. NOTE
- If you would like to document a larger change, then you can add a
- subsection about it right here. You can copy the following boilerplate
- and un-indent it (the indentation causes it to be inside this comment).
-
- Special New Feature
- -------------------
-
- Makes programs 10x faster by doing Special New Thing.
-
-
Changes to the ARM Backends
---------------------------
During this release the AArch64 target has:
* Added support for more sanitizers (MSAN, TSAN) and made them compatible with
all VMA kernel configurations (currently tested on 39 and 42 bits).
* Gained initial LLD support in the new ELF back-end
* Extended the Load/Store optimiser and cleaned up some of the bad decisions
made earlier.
* Expanded LLDB support, including watchpoints, native building, Renderscript,
LLDB-server, debugging 32-bit applications.
* Added support for the ``Exynos M1`` chip.
During this release the ARM target has:
* Gained massive performance improvements on embedded benchmarks due to finally
running the stride vectorizer in full form, incrementing the performance gains
that we already had in the previous releases with limited stride vectorization.
* Expanded LLDB support, including watchpoints, unwind tables
* Extended the Load/Store optimiser and cleaned up some of the bad decisions
made earlier.
* Simplified code generation for global variable addresses in ELF, resulting in
a significant (4% in Chromium) reduction in code size.
* Gained some additional code size improvements, though there's still a long road
ahead, especially for older cores.
* Added some EABI floating point comparison functions to Compiler-RT
-* Added support for Windows+GNU triple, +features in -mcpu/-march options.
+* Added support for Windows+GNU triple, ``+features`` in ``-mcpu``/``-march`` options.
Changes to the MIPS Target
--------------------------
During this release the MIPS target has:
* Significantly extended support for the Integrated Assembler. See below for
more information
* Added support for the ``P5600`` processor.
* Added support for the ``interrupt`` attribute for MIPS32R2 and later. This
attribute will generate a function which can be used as a interrupt handler
on bare metal MIPS targets using the static relocation model.
* Added support for the ``ERETNC`` instruction found in MIPS32R5 and later.
* Added support for OpenCL. See http://portablecl.org/.
- * Address spaces 1 to 255 are now reserved for software use and conversions
- between them are no-op casts.
+* Address spaces 1 to 255 are now reserved for software use and conversions
+ between them are no-op casts.
-* Removed the ``mips16`` value for the -mcpu option since it is an :abbr:`ASE
+* Removed the ``mips16`` value for the ``-mcpu`` option since it is an :abbr:`ASE
(Application Specific Extension)` and not a processor. If you were using this,
please specify another CPU and use ``-mips16`` to enable MIPS16.
* Removed ``copy_u.w`` from 32-bit MSA and ``copy_u.d`` from 64-bit MSA since
they have been removed from the MSA specification due to forward compatibility
issues. For example, 32-bit MSA code containing ``copy_u.w`` would behave
differently on a 64-bit processor supporting MSA. The corresponding intrinsics
are still available and may expand to ``copy_s.[wd]`` where this is
appropriate for forward compatibility purposes.
* Relaxed the ``-mnan`` option to allow ``-mnan=2008`` on MIPS32R2/MIPS64R2 for
compatibility with GCC.
* Made MIPS64R6 the default CPU for 64-bit Android triples.
The MIPS target has also fixed various bugs including the following notable
fixes:
* Fixed reversed operands on ``mthi``/``mtlo`` in the DSP :abbr:`ASE
(Application Specific Extension)`.
* The code generator no longer uses ``jal`` for calls to absolute immediate
addresses.
* Disabled fast instruction selection on MIPS32R6 and MIPS64R6 since this is not
yet supported.
* Corrected addend for ``R_MIPS_HI16`` and ``R_MIPS_PCHI16`` in MCJIT
* The code generator no longer crashes when handling subregisters of an 64-bit
FPU register with undefined value.
* The code generator no longer attempts to use ``$zero`` for operands that do
not permit ``$zero``.
* Corrected the opcode used for ``ll``/``sc`` when using MIPS32R6/MIPS64R6 and
the Integrated Assembler.
* Added support for atomic load and atomic store.
* Corrected debug info when dynamically re-aligning the stack.
-Integrated Assembler
-^^^^^^^^^^^^^^^^^^^^
We have made a large number of improvements to the integrated assembler for
MIPS. In this release, the integrated assembler isn't quite production-ready
since there are a few known issues related to bare-metal support, checking
immediates on instructions, and the N32/N64 ABI's. However, the current support
should be sufficient for many users of the O32 ABI, particularly those targeting
MIPS32 on Linux or bare-metal MIPS32.
If you would like to try the integrated assembler, please use
``-fintegrated-as``.
Changes to the PowerPC Target
-----------------------------
- During this release ...
+There are numerous improvements to the PowerPC target in this release:
+* Shrink wrapping optimization has been enabled for PowerPC Little Endian
+* Direct move instructions are used when converting scalars to vectors
+
+* Thread Sanitizer (TSAN) is now supported for PowerPC
+
+* New MI peephole pass to clean up redundant XXPERMDI instructions
+
+* Add branch hints to highly biased branch instructions (code reaching
+ unreachable terminators and exceptional control flow constructs)
+
+* Promote boolean return values to integer to prevent excessive usage of
+ condition registers
+
+* Additional vector APIs for vector comparisons and vector merges have been
+ added to altivec.h
+
+* Many bugs have been identified and fixed
+
+
Changes to the X86 Target
-----------------------------
- During this release ...
-
* TLS is enabled for Cygwin as emutls.
* Smaller code for materializing 32-bit 1 and -1 constants at ``-Os``.
* More efficient code for wide integer compares. (E.g. 64-bit compares
on 32-bit targets.)
* Tail call support for ``thiscall``, ``stdcall``, ``vectorcall``, and
``fastcall`` functions.
Changes to the Hexagon Target
-----------------------------
In addition to general code size and performance improvements, Hexagon target
now has basic support for Hexagon V60 architecture and Hexagon Vector
Extensions (HVX).
Changes to the AVR Target
-------------------------
Slightly less than half of the AVR backend has been merged in at this point. It is still
missing a number large parts which cause it to be unusable, but is well on the
road to being completely merged and workable.
Changes to the OCaml bindings
-----------------------------
- During this release ...
-
* The ocaml function link_modules has been replaced with link_modules' which
uses LLVMLinkModules2.
External Open Source Projects Using LLVM 3.8
============================================
An exciting aspect of LLVM is that it is used as an enabling technology for
a lot of other language and tools projects. This section lists some of the
projects that have already been updated to work with LLVM 3.8.
LDC - the LLVM-based D compiler
-------------------------------
`D `_ is a language with C-like syntax and static typing. It
pragmatically combines efficiency, control, and modeling power, with safety and
programmer productivity. D supports powerful concepts like Compile-Time Function
Execution (CTFE) and Template Meta-Programming, provides an innovative approach
to concurrency and offers many classical paradigms.
`LDC `_ uses the frontend from the reference compiler
combined with LLVM as backend to produce efficient native code. LDC targets
x86/x86_64 systems like Linux, OS X and Windows and also PowerPC (32/64 bit)
and ARM. Ports to other architectures like AArch64 and MIPS64 are underway.
Additional Information
======================
A wide variety of additional information is available on the `LLVM web page
`_, in particular in the `documentation
`_ section. The web page also contains versions of the
API documentation which is up-to-date with the Subversion version of the source
code. You can access versions of these documents specific to this release by
going into the ``llvm/docs/`` directory in the LLVM tree.
If you have any questions or comments about LLVM, please feel free to contact
us via the `mailing lists `_.
-
Index: vendor/llvm/dist/docs/index.rst
===================================================================
--- vendor/llvm/dist/docs/index.rst (revision 296357)
+++ vendor/llvm/dist/docs/index.rst (revision 296358)
@@ -1,497 +1,492 @@
Overview
========
-.. warning::
-
- If you are using a released version of LLVM, see `the download page
- `_ 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
targeted at different audiences:
LLVM Design & Overview
======================
Several introductory papers and presentations.
.. toctree::
:hidden:
LangRef
:doc:`LangRef`
Defines the LLVM intermediate representation.
`Introduction to the LLVM Compiler`__
Presentation providing a users introduction to LLVM.
.. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
`Intro to LLVM`__
Book chapter providing a compiler hacker's introduction to LLVM.
.. __: http://www.aosabook.org/en/llvm.html
`LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
Design overview.
.. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
`LLVM: An Infrastructure for Multi-Stage Optimization`__
More details (quite old now).
.. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
`Publications mentioning LLVM `_
..
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 `_ or
`DragonEgg `_ instead. The documentation here is
intended for users who have a need to work with the intermediate LLVM
representation.
.. toctree::
:hidden:
CMake
HowToBuildOnARM
HowToCrossCompileLLVM
CommandGuide/index
GettingStarted
GettingStartedVS
BuildingLLVMWithAutotools
FAQ
Lexicon
HowToAddABuilder
yaml2obj
HowToSubmitABug
SphinxQuickstartTemplate
Phabricator
TestingGuide
tutorial/index
ReleaseNotes
Passes
YamlIO
GetElementPtr
Frontend/PerformanceTips
MCJITDesignAndImplementation
CompileCudaWithLLVM
:doc:`GettingStarted`
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.
:doc:`CMake`
An addendum to the main Getting Started guide for those using the `CMake
build system `_.
:doc:`HowToBuildOnARM`
Notes on building and testing LLVM/Clang on ARM.
:doc:`HowToCrossCompileLLVM`
Notes on cross-building and testing LLVM/Clang.
:doc:`GettingStartedVS`
An addendum to the main Getting Started guide for those using Visual Studio
on Windows.
:doc:`BuildingLLVMWithAutotools`
An addendum to the Getting Started guide with instructions for building LLVM
with the Autotools build system.
:doc:`tutorial/index`
Tutorials about using LLVM. Includes a tutorial about making a custom
language with LLVM.
:doc:`LLVM Command Guide `
A reference manual for the LLVM command line utilities ("man" pages for LLVM
tools).
:doc:`Passes`
A list of optimizations and analyses implemented in LLVM.
:doc:`FAQ`
A list of common questions and problems and their solutions.
:doc:`Release notes for the current release `
This describes new features, known bugs, and other limitations.
:doc:`HowToSubmitABug`
Instructions for properly submitting information about any bugs you run into
in the LLVM system.
:doc:`SphinxQuickstartTemplate`
A template + tutorial for writing new Sphinx documentation. It is meant
to be read in source form.
:doc:`LLVM Testing Infrastructure Guide `
A reference manual for using the LLVM testing infrastructure.
`How to build the C, C++, ObjC, and ObjC++ front end`__
Instructions for building the clang front-end from source.
.. __: http://clang.llvm.org/get_started.html
:doc:`Lexicon`
Definition of acronyms, terms and concepts used in LLVM.
:doc:`HowToAddABuilder`
Instructions for adding new builder to LLVM buildbot master.
:doc:`YamlIO`
A reference guide for using LLVM's YAML I/O library.
:doc:`GetElementPtr`
Answers to some very frequent questions about LLVM's most frequently
misunderstood instruction.
:doc:`Frontend/PerformanceTips`
A collection of tips for frontend authors on how to generate IR
which LLVM is able to effectively optimize.
Programming Documentation
=========================
For developers of applications which use LLVM as a library.
.. toctree::
:hidden:
Atomics
CodingStandards
CommandLine
CompilerWriterInfo
ExtendingLLVM
HowToSetUpLLVMStyleRTTI
ProgrammersManual
Extensions
LibFuzzer
:doc:`LLVM Language Reference Manual `
Defines the LLVM intermediate representation and the assembly form of the
different nodes.
:doc:`Atomics`
Information about LLVM's concurrency model.
:doc:`ProgrammersManual`
Introduction to the general layout of the LLVM sourcebase, important classes
and APIs, and some tips & tricks.
:doc:`Extensions`
LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
:doc:`CommandLine`
Provides information on using the command line parsing library.
:doc:`CodingStandards`
Details the LLVM coding standards and provides useful information on writing
efficient C++ code.
:doc:`HowToSetUpLLVMStyleRTTI`
How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
class hierarchy.
:doc:`ExtendingLLVM`
Look here to see how to add instructions and intrinsics to LLVM.
`Doxygen generated documentation `_
(`classes `_)
(`tarball `_)
`Documentation for Go bindings `_
`ViewVC Repository Browser `_
..
:doc:`CompilerWriterInfo`
A list of helpful links for compiler writers.
:doc:`LibFuzzer`
A library for writing in-process guided fuzzers.
Subsystem Documentation
=======================
For API clients and LLVM developers.
.. toctree::
:hidden:
AliasAnalysis
BitCodeFormat
BlockFrequencyTerminology
BranchWeightMetadata
Bugpoint
CodeGenerator
ExceptionHandling
LinkTimeOptimization
SegmentedStacks
TableGenFundamentals
TableGen/index
DebuggingJITedCode
GoldPlugin
MarkedUpDisassembly
SystemLibrary
SourceLevelDebugging
Vectorizers
WritingAnLLVMBackend
GarbageCollection
WritingAnLLVMPass
HowToUseAttributes
NVPTXUsage
AMDGPUUsage
StackMaps
InAlloca
BigEndianNEON
CoverageMappingFormat
Statepoints
MergeFunctions
BitSets
FaultMaps
MIRLangRef
:doc:`WritingAnLLVMPass`
Information on how to write LLVM transformations and analyses.
:doc:`WritingAnLLVMBackend`
Information on how to write LLVM backends for machine targets.
:doc:`CodeGenerator`
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.
:doc:`Machine IR (MIR) Format Reference Manual `
A reference manual for the MIR serialization format, which is used to test
LLVM's code generation passes.
:doc:`TableGen `
Describes the TableGen tool, which is used heavily by the LLVM code
generator.
:doc:`AliasAnalysis`
Information on how to write a new alias analysis implementation or how to
use existing analyses.
:doc:`GarbageCollection`
The interfaces source-language compilers should use for compiling GC'd
programs.
:doc:`Source Level Debugging with LLVM `
This document describes the design and philosophy behind the LLVM
source-level debugger.
:doc:`Vectorizers`
This document describes the current status of vectorization in LLVM.
:doc:`ExceptionHandling`
This document describes the design and implementation of exception handling
in LLVM.
:doc:`Bugpoint`
Automatic bug finder and test-case reducer description and usage
information.
:doc:`BitCodeFormat`
This describes the file format and encoding used for LLVM "bc" files.
:doc:`System Library `
This document describes the LLVM System Library (``lib/System``) and
how to keep LLVM source code portable
:doc:`LinkTimeOptimization`
This document describes the interface between LLVM intermodular optimizer
and the linker and its design
:doc:`GoldPlugin`
How to build your programs with link-time optimization on Linux.
:doc:`DebuggingJITedCode`
How to debug JITed code with GDB.
:doc:`MCJITDesignAndImplementation`
Describes the inner workings of MCJIT execution engine.
:doc:`BranchWeightMetadata`
Provides information about Branch Prediction Information.
:doc:`BlockFrequencyTerminology`
Provides information about terminology used in the ``BlockFrequencyInfo``
analysis pass.
:doc:`SegmentedStacks`
This document describes segmented stacks and how they are used in LLVM.
:doc:`MarkedUpDisassembly`
This document describes the optional rich disassembly output syntax.
:doc:`HowToUseAttributes`
Answers some questions about the new Attributes infrastructure.
:doc:`NVPTXUsage`
This document describes using the NVPTX back-end to compile GPU kernels.
:doc:`AMDGPUUsage`
This document describes how to use the AMDGPU back-end.
:doc:`StackMaps`
LLVM support for mapping instruction addresses to the location of
values and allowing code to be patched.
:doc:`BigEndianNEON`
LLVM's support for generating NEON instructions on big endian ARM targets is
somewhat nonintuitive. This document explains the implementation and rationale.
:doc:`CoverageMappingFormat`
This describes the format and encoding used for LLVM’s code coverage mapping.
:doc:`Statepoints`
This describes a set of experimental extensions for garbage
collection support.
:doc:`MergeFunctions`
Describes functions merging optimization.
:doc:`InAlloca`
Description of the ``inalloca`` argument attribute.
:doc:`FaultMaps`
LLVM support for folding control flow into faulting machine instructions.
:doc:`CompileCudaWithLLVM`
LLVM support for CUDA.
Development Process Documentation
=================================
Information about LLVM's development process.
.. toctree::
:hidden:
DeveloperPolicy
MakefileGuide
Projects
LLVMBuild
HowToReleaseLLVM
Packaging
ReleaseProcess
Phabricator
:doc:`DeveloperPolicy`
The LLVM project's policy towards developers and their contributions.
:doc:`Projects`
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.
:doc:`LLVMBuild`
Describes the LLVMBuild organization and files used by LLVM to specify
component descriptions.
:doc:`MakefileGuide`
Describes how the LLVM makefiles work and how to use them.
:doc:`HowToReleaseLLVM`
This is a guide to preparing LLVM releases. Most developers can ignore it.
:doc:`ReleaseProcess`
This is a guide to validate a new release, during the release process. Most developers can ignore it.
:doc:`Packaging`
Advice on packaging LLVM into a distribution.
:doc:`Phabricator`
Describes how to use the Phabricator code review tool hosted on
http://reviews.llvm.org/ and its command line interface, Arcanist.
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.
Mailing Lists
-------------
If you can't find what you need in these docs, try consulting the mailing
lists.
`Developer's List (llvm-dev)`__
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.
.. __: http://lists.llvm.org/mailman/listinfo/llvm-dev
`Commits Archive (llvm-commits)`__
This list contains all commit messages that are made when LLVM developers
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.
.. __: http://lists.llvm.org/pipermail/llvm-commits/
`Bugs & Patches Archive (llvm-bugs)`__
This list gets emailed every time a bug is opened and closed. It is
higher volume than the LLVM-dev list.
.. __: http://lists.llvm.org/pipermail/llvm-bugs/
`Test Results Archive (llvm-testresults)`__
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.
.. __: http://lists.llvm.org/pipermail/llvm-testresults/
`LLVM Announcements List (llvm-announce)`__
This is a low volume list that provides important announcements regarding
LLVM. It gets email about once a month.
.. __: http://lists.llvm.org/mailman/listinfo/llvm-announce
IRC
---
Users and developers of the LLVM project (including subprojects such as Clang)
can be found in #llvm on `irc.oftc.net `_.
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
* clang-bot - A `geordi `_ instance running
near-trunk clang instead of gcc.
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`