1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
| Getting Involved
================
LLVM welcomes contributions of all kinds. To get started, please review the following topics:
.. contents::
:local:
.. toctree::
:hidden:
Contributing
DeveloperPolicy
SphinxQuickstartTemplate
Phabricator
HowToSubmitABug
BugLifeCycle
CodingStandards
:doc:`Contributing`
An overview on how to contribute to LLVM.
:doc:`DeveloperPolicy`
The LLVM project's policy towards developers and their contributions.
:doc:`SphinxQuickstartTemplate`
A template + tutorial for writing new Sphinx documentation. It is meant
to be read in source form.
:doc:`Phabricator`
Describes how to use the Phabricator code review tool hosted on
http://reviews.llvm.org/ and its command line interface, Arcanist.
:doc:`HowToSubmitABug`
Instructions for properly submitting information about any bugs you run into
in the LLVM system.
:doc:`BugLifeCycle`
Describes how bugs are reported, triaged and closed.
:doc:`CodingStandards`
Details the LLVM coding standards and provides useful information on writing
efficient C++ code.
.. _development-process:
Development Process
-------------------
Information about LLVM's development process.
.. toctree::
:hidden:
Projects
LLVMBuild
HowToReleaseLLVM
Packaging
ReleaseProcess
HowToAddABuilder
ReleaseNotes
: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:`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:`HowToAddABuilder`
Instructions for adding new builder to LLVM buildbot master.
:doc:`Packaging`
Advice on packaging LLVM into a distribution.
:doc:`Release notes for the current release <ReleaseNotes>`
This describes new features, known bugs, and other limitations.
.. _mailing-lists:
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 <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
* 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.
.. _meetups-social-events:
Meetups and social events
-------------------------
.. toctree::
:hidden:
MeetupGuidelines
Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,
there are several user groups called
`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to
join one in your city. Or start a new one if there is none:
:doc:`MeetupGuidelines`
.. _community-proposals:
Community wide proposals
------------------------
Proposals for massive changes in how the community behaves and how the work flow
can be better.
.. toctree::
:hidden:
CodeOfConduct
Proposals/GitHubMove
BugpointRedesign
Proposals/LLVMLibC
Proposals/TestSuite
Proposals/VariableNames
Proposals/VectorizationPlan
:doc:`CodeOfConduct`
Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,
IRC, etc).
:doc:`Proposals/GitHubMove`
Proposal to move from SVN/Git to GitHub.
:doc:`BugpointRedesign`
Design doc for a redesign of the Bugpoint tool.
:doc:`Proposals/LLVMLibC`
Proposal to add a libc implementation under the LLVM project.
:doc:`Proposals/TestSuite`
Proposals for additional benchmarks/programs for llvm's test-suite.
:doc:`Proposals/VariableNames`
Proposal to change the variable names coding standard.
:doc:`Proposals/VectorizationPlan`
Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer. |