1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
5 <title>LLVM Developer Policy</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
10 <div class="doc_title">LLVM Developer Policy</div>
12 <li><a href="#introduction">Introduction</a></li>
13 <li><a href="#policies">Developer Policies</a>
15 <li><a href="#informed">Stay Informed</a></li>
16 <li><a href="#patches">Making a Patch</a></li>
17 <li><a href="#reviews">Code Reviews</a></li>
18 <li><a href="#testcases">Test Cases</a></li>
19 <li><a href="#quality">Quality</a></li>
20 <li><a href="#commitaccess">Obtaining Commit Access</a></li>
21 <li><a href="#newwork">Making a Major Change</a></li>
22 <li><a href="#incremental">Incremental Development</a></li>
23 <li><a href="#attribution">Attribution of Changes</a></li>
25 <li><a href="#clp">Copyright, License, and Patents</a>
27 <li><a href="#copyright">Copyright</a></li>
28 <li><a href="#license">License</a></li>
29 <li><a href="#patents">Patents</a></li>
30 <li><a href="#devagree">Developer Agreements</a></li>
33 <div class="doc_author">Written by the LLVM Oversight Team</div>
35 <!--=========================================================================-->
36 <div class="doc_section"><a name="introduction">Introduction</a></div>
37 <!--=========================================================================-->
38 <div class="doc_text">
39 <p>This document contains the LLVM Developer Policy which defines the
40 project's policy towards developers and their contributions. The intent of
41 this policy is to eliminate mis-communication, rework, and confusion that
42 might arise from the distributed nature of LLVM's development. By stating
43 the policy in clear terms, we hope each developer can know ahead of time
44 what to expect when making LLVM contributions.</p>
45 <p>This policy is also designed to accomplish the following objectives:</p>
47 <li>Attract both users and developers to the LLVM project.</li>
48 <li>Make life as simple and easy for contributors as possible.</li>
49 <li>Keep the top of Subversion trees as stable as possible.</li>
52 <p>This policy is aimed at frequent contributors to LLVM. People interested in
53 contributing one-off patches can do so in an informal way by sending them to
54 the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">
55 llvm-commits mailing list</a> and engaging another developer to see it through
60 <!--=========================================================================-->
61 <div class="doc_section"><a name="policies">Developer Policies</a></div>
62 <!--=========================================================================-->
63 <div class="doc_text">
64 <p>This section contains policies that pertain to frequent LLVM
65 developers. We always welcome <a href="#patches">one-off patches</a> from
66 people who do not routinely contribute to LLVM, but we expect more from
67 frequent contributors to keep the system as efficient as possible for
69 Frequent LLVM contributors are expected to meet the following requirements in
70 order for LLVM to maintain a high standard of quality.<p>
73 <!-- _______________________________________________________________________ -->
74 <div class="doc_subsection"> <a name="informed">Stay Informed</a> </div>
75 <div class="doc_text">
76 <p>Developers should stay informed by reading at least the
77 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvmdev</a>
78 email list. If you are doing anything more than just casual work on LLVM,
79 it is suggested that you also subscribe to the
80 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a>
81 list and pay attention to changes being made by others.</p>
82 <p>We recommend that active developers register an email account with
83 <a href="http://llvm.org/bugs/">LLVM Bugzilla</a> and preferably subscribe to
84 the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmbugs">llvm-bugs</a>
85 email list to keep track of bugs and enhancements occurring in LLVM.</p>
88 <!-- _______________________________________________________________________ -->
89 <div class="doc_subsection"> <a name="patches">Making a Patch</a></div>
91 <div class="doc_text">
93 <p>When making a patch for review, the goal is to make it as easy for the
94 reviewer to read it as possible. As such, we recommend that you:</p>
96 <li>Make your patch against the Subversion trunk, not a branch, and not an
97 old version of LLVM. This makes it easy to apply the patch.</li>
99 <li>Similarly, patches should be submitted soon after they are generated.
100 Old patches may not apply correctly if the underlying code changes between
101 the time the patch was created and the time it is applied.</li>
103 <li>Patches should be made with this command:
104 <pre>svn diff -x -u</pre>
105 or with the utility <tt>utils/mkpatch</tt>, which makes it easy to read the
108 <li>Patches should not include differences in generated code such as the
109 code generated by <tt>flex</tt>, <tt>bison</tt> or <tt>tblgen</tt>. The
110 <tt>utils/mkpatch</tt> utility takes care of this for you.</li>
114 <p>When sending a patch to a mailing list, it is a good idea to send it as an
115 <em>attachment</em> to the message, not embedded into the text of the
116 message. This ensures that your mailer will not mangle the patch when it
117 sends it (e.g. by making whitespace changes or by wrapping lines).</p>
120 <!-- _______________________________________________________________________ -->
121 <div class="doc_subsection"> <a name="reviews">Code Reviews</a></div>
122 <div class="doc_text">
123 <p>LLVM has a code review policy. Code review is one way to increase the
124 quality of software. We generally follow these policies:</p>
126 <li>All developers are required to have significant changes reviewed
127 before they are committed to the repository.</li>
128 <li>Code reviews are conducted by email, usually on the llvm-commits
130 <li>Code can be reviewed either before it is committed or after. We expect
131 major changes to be reviewed before being committed, but smaller
132 changes (or changes where the developer owns the component) can be
133 reviewed after commit.</li>
134 <li>The developer responsible for a code change is also responsible for
135 making all necessary review-related changes.</li>
136 <li>Code review can be an iterative process, which continues until the patch
137 is ready to be committed.</li>
140 <p>Developers should participate in code reviews as both reviewers and
141 reviewees. If someone is kind enough to review your code, you should
142 return the favor for someone else. Note that anyone is welcome to review
143 and give feedback on a patch, but only people with Subversion write access
148 <!-- _______________________________________________________________________ -->
149 <div class="doc_subsection"> <a name="testcases">Test Cases</a></div>
150 <div class="doc_text">
151 <p>Developers are required to create test cases for any bugs fixed and any new
152 features added. Some tips for getting your testcase approved:</p>
154 <li>All feature and regression test cases are added to the
155 <tt>llvm/test</tt> directory. The appropriate sub-directory should be
156 selected (see the <a href="TestingGuide.html">Testing Guide</a> for
158 <li>Test cases should be written in
159 <a href="LangRef.html">LLVM assembly language</a> unless the
160 feature or regression being tested requires another language (e.g. the
161 bug being fixed or feature being implemented is in the llvm-gcc C++
162 front-end, in which case it must be written in C++).</li>
163 <li>Test cases, especially for regressions, should be reduced as much as
164 possible, by <a href="Bugpoint.html">bugpoint</a> or
165 manually. It is unacceptable
166 to place an entire failing program into <tt>llvm/test</tt> as this creates
167 a <i>time-to-test</i> burden on all developers. Please keep them short.</li>
170 <p>Note that llvm/test is designed for regression and small feature tests
171 only. More extensive test cases (e.g., entire applications, benchmarks,
172 etc) should be added to the <tt>llvm-test</tt> test suite. The llvm-test
173 suite is for coverage (correctness, performance, etc) testing, not feature
174 or regression testing.</p>
177 <!-- _______________________________________________________________________ -->
178 <div class="doc_subsection"> <a name="quality">Quality</a></div>
179 <div class="doc_text">
180 <p>The minimum quality standards that any change must satisfy before being
181 committed to the main development branch are:</p>
183 <li>Code must adhere to the
184 <a href="CodingStandards.html">LLVM Coding Standards</a>.</li>
185 <li>Code must compile cleanly (no errors, no warnings) on at least one
187 <li>Bug fixes and new features should <a href="#testcases">include a
188 testcase</a> so we know if the fix/feature ever regresses in the
190 <li>Code must pass the dejagnu (<tt>llvm/test</tt>) test suite.</li>
191 <li>The code must not cause regressions on a reasonable subset of llvm-test,
192 where "reasonable" depends on the contributor's judgement and the scope
193 of the change (more invasive changes require more testing). A reasonable
194 subset is "<tt>llvm-test/MultiSource/Benchmarks</tt>".</li>
196 <p>Additionally, the committer is responsible for addressing any problems
197 found in the future that the change is responsible for. For example:</p>
199 <li>The code should compile cleanly on all supported platforms.</li>
200 <li>The changes should not cause any correctness regressions in the
201 <tt>llvm-test</tt> suite and must not cause any major performance
203 <li>The change set should not cause performance or correctness regressions
204 for the LLVM tools.</li>
205 <li>The changes should not cause performance or correctness regressions in
206 code compiled by LLVM on all applicable targets.</li>
207 <li>You are expected to address any <a href="http://llvm.org/bugs/">bugzilla
208 bugs</a> that result from your change.</li>
211 <p>We prefer for this to be handled before submission but understand that it
212 isn't possible to test all of this for every submission. Our nightly
214 infrastructure normally finds these problems. A good rule of thumb is to
215 check the nightly testers for regressions the day after your change.</p>
217 <p>Commits that violate these quality standards (e.g. are very broken) may
218 be reverted. This is necessary when the change blocks other developers from
219 making progress. The developer is welcome to re-commit the change after
220 the problem has been fixed.</p>
223 <!-- _______________________________________________________________________ -->
224 <div class="doc_subsection">
225 <a name="commitaccess">Obtaining Commit Access</a></div>
226 <div class="doc_text">
229 We grant commit access to contributors with a track record of submitting high
230 quality patches. If you would like commit access, please send an email to
231 <a href="mailto:sabre@nondot.org">Chris</a> with the following information:</p>
234 <li>The user name you want to commit with, e.g. "sabre".</li>
235 <li>The full name and email address you want message to llvm-commits to come
236 from, e.g. "Chris Lattner <sabre@nondot.org>".</li>
237 <li>A "password hash" of the password you want to use, e.g. "2ACR96qjUqsyM".
238 Note that you don't ever tell us what your password is, you just give it
239 to us in an encrypted form. To get this, run "htpasswd" (a utility that
240 comes with apache) in crypt mode (often enabled with "-d"), or find a web
241 page that will do it for you.</li>
244 <p>Once you've been granted commit access, you should be able to check out an
245 LLVM tree with an SVN URL of "https://username@llvm.org/..." instead of the
246 normal anonymous URL of "http://llvm.org/...". The first time you commit
247 you'll have to type in your password. Note that you may get a warning from
248 SVN about an untrusted key, you can ignore this. To verify that your commit
249 access works, please do a test commit (e.g. change a comment or add a blank
250 line). Your first commit to a repository may require the autogenerated email
251 to be approved by a mailing list. This is normal, and will be done when
252 the mailing list owner has time.</p>
254 <p>If you have recently been granted commit access, these policies apply:</p>
257 <li>You are granted <i>commit-after-approval</i> to all parts of LLVM.
258 To get approval, submit a <a href="#patches">patch</a> to
259 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">
260 llvm-commits</a>. When approved you may commit it yourself.</li>
261 <li>You are allowed to commit patches without approval which you think are
262 obvious. This is clearly a subjective decision — we simply expect you
263 to use good judgement. Examples include: fixing build breakage, reverting
264 obviously broken patches, documentation/comment changes, any other minor
266 <li>You are allowed to commit patches without approval to those portions
267 of LLVM that you have contributed or maintain (i.e., have been assigned
268 responsibility for), with the proviso that such commits must not break the
269 build. This is a "trust but verify" policy and commits of this nature are
270 reviewed after they are committed.</li>
271 <li>Multiple violations of these policies or a single egregious violation
272 may cause commit access to be revoked.</li>
275 <p>In any case, your changes are still subject to <a href="#reviews">code
276 review</a> (either before or after they are committed, depending on the nature
277 of the change). You are encouraged to review other peoples' patches as well,
278 but you aren't required to.</p>
282 <!-- _______________________________________________________________________ -->
283 <div class="doc_subsection"> <a name="newwork">Making a Major Change</a></div>
284 <div class="doc_text">
285 <p>When a developer begins a major new project with the aim of contributing
286 it back to LLVM, s/he should inform the community with an email to
287 the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvmdev</a>
288 email list, to the extent possible. The reason for this is to:
290 <li>keep the community informed about future changes to LLVM, </li>
291 <li>avoid duplication of effort by preventing multiple parties working on
292 the same thing and not knowing about it, and</li>
293 <li>ensure that any technical issues around the proposed work are
294 discussed and resolved before any significant work is done.</li>
297 <p>The design of LLVM is carefully controlled to ensure that all the pieces
298 fit together well and are as consistent as possible. If you plan to make a
299 major change to the way LLVM works or want to add a major new extension, it
300 is a good idea to get consensus with the development
301 community before you start working on it.</p>
303 <p>Once the design of the new feature is finalized, the work itself should be
304 done as a series of <a href="#incremental">incremental changes</a>, not as
305 a long-term development branch.</p>
309 <!-- _______________________________________________________________________ -->
310 <div class="doc_subsection"> <a name="incremental">Incremental Development</a>
312 <div class="doc_text">
313 <p>In the LLVM project, we do all significant changes as a series of
314 incremental patches. We have a strong dislike for huge changes or
315 long-term development branches. Long-term development branches have a
316 number of drawbacks:</p>
319 <li>Branches must have mainline merged into them periodically. If the branch
320 development and mainline development occur in the same pieces of code,
321 resolving merge conflicts can take a lot of time.</li>
322 <li>Other people in the community tend to ignore work on branches.</li>
323 <li>Huge changes (produced when a branch is merged back onto mainline) are
324 extremely difficult to <a href="#reviews">code review</a>.</li>
325 <li>Branches are not routinely tested by our nightly tester
327 <li>Changes developed as monolithic large changes often don't work until the
328 entire set of changes is done. Breaking it down into a set of smaller
329 changes increases the odds that any of the work will be committed to the
330 main repository.</li>
334 To address these problems, LLVM uses an incremental development style and we
335 require contributors to follow this practice when making a large/invasive
336 change. Some tips:</p>
339 <li>Large/invasive changes usually have a number of secondary changes that
340 are required before the big change can be made (e.g. API cleanup, etc).
341 These sorts of changes can often be done before the major change is done,
342 independently of that work.</li>
343 <li>The remaining inter-related work should be decomposed into unrelated
344 sets of changes if possible. Once this is done, define the first increment
345 and get consensus on what the end goal of the change is.</li>
347 <li>Each change in the set can be stand alone (e.g. to fix a bug), or part
348 of a planned series of changes that works towards the development goal.</li>
350 <li>Each change should be kept as small as possible. This simplifies your
351 work (into a logical progression), simplifies code review and reduces the
352 chance that you will get negative feedback on the change. Small increments
353 also facilitate the maintenance of a high quality code base.</li>
355 <li>Often, an independent precursor to a big change is to add a new API and
356 slowly migrate clients to use the new API. Each change to use the new
357 API is often "obvious" and can be committed without review. Once the
358 new API is in place and used, it is much easier to replace the
359 underlying implementation of the API. This implementation change is
360 logically separate from the API change.</li>
363 <p>If you are interested in making a large change, and this scares you, please
364 make sure to first <a href="#newwork">discuss the change/gather
365 consensus</a> then ask about the best way to go about making
369 <!-- _______________________________________________________________________ -->
370 <div class="doc_subsection"><a name="attribution">Attribution of
372 <div class="doc_text">
373 <p>We believe in correct attribution of contributions to
374 their contributors. However, we do not want the source code to be littered
375 with random attributions (this is noisy/distracting and revision control
376 keeps a perfect history of this anyway). As such, we follow these rules:</p>
378 <li>Developers who originate new files in LLVM should place their name at
379 the top of the file per the
380 <a href="CodingStandards.html#scf_commenting">Coding Standards</a>.</li>
381 <li>There should be only one name at the top of the file and it should be
382 the person who created the file.</li>
383 <li>Placing your name in the file does not imply <a
384 href="#clp">copyright</a>: it is only used to attribute the file to
385 its original author.</li>
386 <li>Developers should be aware that after some time has passed, the name at
387 the top of a file may become meaningless as maintenance/ownership of files
388 changes. Despite this, once set, the attribution of a file never changes.
389 Revision control keeps an accurate history of contributions.</li>
390 <li>Developers should maintain their entry in the
391 <a href="http://llvm.org/svn/llvm-project/llvm/trunk/CREDITS.TXT">CREDITS.txt</a>
392 file to summarize their contributions.</li>
393 <li>Commit comments should contain correct attribution of the person who
394 submitted the patch if that person is not the committer (i.e. when a
395 developer with commit privileges commits a patch for someone else).</li>
401 <!--=========================================================================-->
402 <div class="doc_section">
403 <a name="clp">Copyright, License, and Patents</a>
405 <!--=========================================================================-->
407 <div class="doc_text">
408 <p>This section addresses the issues of copyright, license and patents for
410 Currently, the University of Illinois is the LLVM copyright holder and the
411 terms of its license to LLVM users and developers is the
412 <a href="http://www.opensource.org/licenses/UoI-NCSA.php">University of
413 Illinois/NCSA Open Source License</a>.</p>
415 <div class="doc_notes">
416 <p><b>NOTE: This section deals with legal matters but does not provide
417 legal advice. We are not lawyers, please seek legal counsel from an
422 <!-- _______________________________________________________________________ -->
423 <div class="doc_subsection"><a name="copyright">Copyright</a></div>
424 <div class="doc_text">
426 <p>For consistency and ease of management, the project requires the
427 copyright for all LLVM software to be held by a single copyright holder:
428 the University of Illinois (UIUC).</p>
431 Although UIUC may eventually reassign the copyright of the software to another
432 entity (e.g. a dedicated non-profit "LLVM Organization", or something)
433 the intent for the project is to always have a single entity hold the
434 copyrights to LLVM at any given time.</p>
436 <p>We believe that having a single copyright
437 holder is in the best interests of all developers and users as it greatly
438 reduces the managerial burden for any kind of administrative or technical
439 decisions about LLVM. The goal of the LLVM project is to always keep the code
440 open and <a href="#license">licensed under a very liberal license</a>.</p>
443 <!-- _______________________________________________________________________ -->
444 <div class="doc_subsection"><a name="license">License</a></div>
445 <div class="doc_text">
446 <p>We intend to keep LLVM perpetually open source
447 and to use a liberal open source license. The current license is the
448 <a href="http://www.opensource.org/licenses/UoI-NCSA.php">
449 University of Illinois/NCSA Open Source License</a>, which boils
452 <li>You can freely distribute LLVM.</li>
453 <li>You must retain the copyright notice if you redistribute LLVM.</li>
454 <li>Binaries derived from LLVM must reproduce the copyright notice.</li>
455 <li>You can't use our names to promote your LLVM derived products.</li>
456 <li>There's no warranty on LLVM at all.</li>
459 <p>We believe this fosters the widest adoption of LLVM because it <b>allows
460 commercial products to be derived from LLVM</b> with few restrictions and
461 without a requirement for making any derived works also open source (i.e.
462 LLVM's license is not a "copyleft" license like the GPL). We suggest that you
463 read the <a href="http://www.opensource.org/licenses/UoI-NCSA.php">License</a>
464 if further clarification is needed.</p>
466 <p>Note that the LLVM Project does distribute llvm-gcc, <b>which is GPL.</b>
467 This means that anything "linked" into llvm-gcc must itself be compatible
468 with the GPL, and must be releasable under the terms of the GPL. This implies
469 that <b>any code linked into llvm-gcc and distributed to others may be subject
470 to the viral aspects of the GPL</b> (for example, a proprietary code generator
471 linked into llvm-gcc must be made available under the GPL). This is not a
472 problem for code already distributed under a more liberal license (like the
473 UIUC license), and does not affect code generated by llvm-gcc. It may be a
474 problem if you intend to base commercial development on llvm-gcc without
475 redistributing your source code.</p>
477 <p>We have no plans to change the license of LLVM. If you have questions
478 or comments about the license, please contact the <a
479 href="mailto:llvm-oversight@cs.uiuc.edu">LLVM Oversight Group</a>.</p>
483 <!-- _______________________________________________________________________ -->
484 <div class="doc_subsection"><a name="patents">Patents</a></div>
485 <div class="doc_text">
487 <p>To the best of our knowledge, LLVM does not infringe on any patents (we have
488 actually removed code from LLVM in the past that was found to infringe).
489 Having code in LLVM that infringes on patents would violate an important
490 goal of the project by making it hard or impossible to reuse the code for
491 arbitrary purposes (including commercial use).</p>
493 <p>When contributing code, we expect contributors to notify us of any potential
494 for patent-related trouble with their changes. If you own the rights to a
495 patent and would like to contribute code to LLVM that relies on it, we
496 require that you sign an agreement that allows any other user of LLVM to
497 freely use your patent. Please contact the <a
498 href="mailto:llvm-oversight@cs.uiuc.edu">oversight group</a> for more
503 <!-- _______________________________________________________________________ -->
504 <div class="doc_subsection"><a name="devagree">Developer Agreements</a></div>
505 <div class="doc_text">
506 <p>With regards to the LLVM copyright and licensing, developers agree to
507 assign their copyrights to UIUC for any contribution made so that
508 the entire software base can be managed by a single copyright holder. This
509 implies that any contributions can be licensed under the license that the
513 <!-- *********************************************************************** -->
516 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
517 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
518 <a href="http://validator.w3.org/check/referer"><img
519 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
521 <a href="mailto:llvm-oversight@cs.uiuc.edu">LLVM Oversight Group</a><br>
522 <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
523 Last modified: $Date$