Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 450f40af1f2a0ffa785ce1ea5397b225f0370a8d / . / docs / DeveloperPolicy.html
blob: b7548c958665b33145a1faf07e1264e6e350cff0 [file] [log] [blame]
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <title>LLVM Developer Policy</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
7</head>
8<body>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]9
10<div class="doc_title">LLVM Developer Policy</div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]11<ol>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]12 <li><a href="#introduction">Introduction</a></li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]13 <li><a href="#general">General Policies</a>
14 <ol>
15 <li><a href="#informed">Stay Informed</a> </li>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]16 <li><a href="#newwork">Starting&nbsp;New&nbsp;Work</a></li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]17 <li><a href="#reviews">Code Reviews</a></li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]18 <li><a href="#quality">Quality</a></li>
19 <li><a href="#testcases">Test Cases</a></li>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]20 <li><a href="#c_new">Obtaining Commit Access</a></li>
21 <li><a href="#incremental">Incremental Development</a></li>
22 <li><a href="#attribution">Attribution</a></li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]23 </ol></li>
24 <li><a href="#patches">Patch Policies</a>
25 <ol>
26 <li><a href="#p_form">Patch Form</a></li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]27 <li><a href="#p_submission">Patch Submission</a></li>
Reid Spencer0e598722007-02-14 17:20:59 +0000[diff] [blame]28 <li><a href="#p_aftersub">After Submission</a></li>
29 <li><a href="#p_aftercommit">After Commit</a></li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]30 </ol></li>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]31 <li><a href="#candl">Copyright and License</a>
32 <ol>
33 <li><a href="#copyright">Copyright</a></li>
34 <li><a href="#license">License</a></li>
35 <li><a href="#devagree">Developer Agreements</a></li>
36 </ol></li>
Reid Spencer0e598722007-02-14 17:20:59 +0000[diff] [blame]37 <li><a href="#terms">Terminology</a></li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]38</ol>
39<div class="doc_author">Written by LLVM Oversight Team</div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]40
41<!--=========================================================================-->
Reid Spencere7bd7d62007-02-14 17:24:04 +0000[diff] [blame]42<div class="doc_section"><a name="introduction">Introduction</a></div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]43<!--=========================================================================-->
44<div class="doc_text">
45 <p>This document contains the LLVM Developer Policy which defines the
Reid Spencerbed92532007-02-13 17:04:09 +0000[diff] [blame]46 project's policy towards developers and their contributions. The intent of
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]47 this policy is to eliminate mis-communication, rework, and confusion that
48 might arise from the distributed nature of LLVM's development. By stating
49 the policy in clear terms, we hope each developer can know ahead of time
50 what to expect when making LLVM contributions.</p>
Reid Spencer5b9a6092007-02-14 22:55:40 +0000[diff] [blame]51 <p>This policy is also designed to accomplish the following objectives:</p>
52 <ol>
53 <li>Attract both users and developers to the LLVM project.</li>
54 <li>Make life as simple and easy for contributors as possible.</li>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]55 <li>Keep the top of tree CVS/SVN trees as stable as possible.</li>
Reid Spencer5b9a6092007-02-14 22:55:40 +0000[diff] [blame]56 </ol>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]57</div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]58
59<!--=========================================================================-->
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]60<div class="doc_section"><a name="general">General Policies</a></div>
61<!--=========================================================================-->
62<div class="doc_text">
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]63 <p>This section contains policies that pertain generally to regular LLVM
64 developers. We always welcome <a href="#patches">random patches</a> from
65 people who do not routinely contribute to LLVM, but expect more from regular
66 contributors to keep the system as efficient as possible for everyone.
67 Regular LLVM developers are expected to meet the following obligations in
68 order for LLVM to maintain a high standard of quality.<p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]69</div>
70
71<!-- _______________________________________________________________________ -->
72<div class="doc_subsection"> <a name="informed">Stay Informed</a> </div>
73<div class="doc_text">
74 <p>Developers should stay informed by reading at least the
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]75 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvmdev</a>
76 email list. If you are doing anything more than just casual work on LLVM,
77 it is suggested that you also subscribe to the
78 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a>
79 list and pay attention to changes being made by others.</p>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]80 <p>We recommend that active developers register an email account with
81 <a href="http://llvm.org/bugs/">LLVM Bugzilla</a> and preferably subscribe to
82 the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmbugs">llvm-bugs</a>
83 email list to keep track of bugs and enhancements occurring in LLVM.</p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]84</div>
85
86<!-- _______________________________________________________________________ -->
87<div class="doc_subsection"> <a name="newwork">Starting New Work</a></div>
88<div class="doc_text">
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]89 <p>When a developer begins a major new project with the aim of contributing
90 it back to LLVM, s/he should inform the community with an email to
91 the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvm-dev</a>
92 email list, to the extent possible. The reason for this is to:
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]93 <ol>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]94 <li>keep the community informed about future changes to LLVM, </li>
95 <li>avoid duplication of effort by having multiple parties working on the
96 same thing and not knowing about it, and</li>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]97 <li>ensure that any technical issues around the proposed work are
98 discussed and resolved before any significant work is done.</li>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]99 </ol>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]100 <p>The design of LLVM is carefully controlled to ensure that all the pieces
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]101 fit together well and are as consistent as possible. If you plan to make a
102 major change to the way LLVM works or
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]103 a major new extension, it is a good idea to get consensus with the development
104 community before you start working on it.</p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]105</div>
106
107<!-- _______________________________________________________________________ -->
108<div class="doc_subsection"> <a name="reviews">Code Reviews</a></div>
109<div class="doc_text">
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]110 <p>LLVM has a code review policy. Code review is one way to increase the
111 quality of software. We generally follow these policies:</p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]112 <ol>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]113 <li>All developers are required to have significant changes reviewed
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]114 before they are committed to the repository.</li>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]115 <li>Code reviews are conducted by email, usually on the llvm-commits
116 list.</li>
117 <li>Code can be reviewed either before it is committed or after. We expect
118 major changes to be reviewed before being committed, but smaller
119 changes (or changes where the developer owns the component) can be
120 reviewed after commit.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]121 <li>The developer responsible for a code change is also responsible for
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]122 making all necessary review-related changes.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]123 <li>Developers should participate in code reviews as both a reviewer and
124 a reviewee. We don't have a dedicated team of reviewers. If someone is
125 kind enough to review your code, you should return the favor for someone
126 else.</li>
127 </ol>
128</div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]129<!-- _______________________________________________________________________ -->
130<div class="doc_subsection"> <a name="quality">Quality</a></div>
131<div class="doc_text">
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]132 <p>The minimum quality standards that any change must satisfy before being
133 committed to the main development branch are:</p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]134 <ol>
135 <li>Code must adhere to the
136 <a href="CodingStandards.html">LLVM Coding Standards</a>.</li>
137 <li>Code must compile cleanly (no errors, no warnings) on at least one
138 platform.</li>
139 <li>Code must pass the deja gnu (llvm/test) test suite.</li>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]140 <li>The code must not cause regressions on a reasonable subset of llvm-test,
141 where "reasonable" depends on the contributor's judgement and the scope
142 of the change (more invasive changes require more testing). A reasonable
143 subset is "<tt>llvm-test/MultiSource/Benchmarks</tt>".</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]144 </ol>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]145 <p>Additionally, the committer is responsible for addressing any problems
146 found that the change is responsible for. For example:</p>
147 <ul>
Reid Spencerf1491da2007-02-14 08:19:16 +0000[diff] [blame]148 <li>The code should compile cleanly on all platforms.</li>
149 <li>The changes should not cause regressions in the <tt>llvm-test</tt>
150 suite including SPEC CINT2000, SPEC CFP2000, SPEC CINT2006, and
151 SPEC CFP2006.</li>
152 <li>The change set should not cause performance or correctness regressions
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]153 for the LLVM tools.</li>
Reid Spencerf1491da2007-02-14 08:19:16 +0000[diff] [blame]154 <li>The changes should not cause performance or correctness regressions in
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]155 code compiled by LLVM on all applicable targets.</li>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]156 <li>You are expected to address any <a href="http://llvm.org/bugs/">bugzilla
157 bugs</a> that result from your change.</li>
158 </ul>
159
160 <p>We prefer for this to be handled before submission but understand that it's
161 not possible to test all of this for every submission. Our nightly testing
162 infrastructure normally finds these problems. A good rule of thumb is to
163 check the nightly testers for regressions the day after your change.</p>
164
165 <p>Commits that violate these quality standards (e.g. are very broken) may
166 be reverted. This is necessary when the change blocks other developers from
167 making progress. The developer is welcome to re-commit the change after
168 the problem has been fixed.</p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]169</div>
170
171<!-- _______________________________________________________________________ -->
172<div class="doc_subsection"> <a name="testcases">Test Cases</a></div>
173<div class="doc_text">
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]174 <p>Developers are required to create test cases for any bugs fixed and any new
175 features added. The following policies apply:</p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]176 <ol>
177 <li>All feature and regression test cases must be added to the
Reid Spencer80483bb2007-02-13 09:20:14 +0000[diff] [blame]178 <tt>llvm/test</tt> directory. The appropriate sub-directory should be
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]179 selected (see the <a href="TestingGuide.html">Testing Guide</a> for
Reid Spencer40602962007-02-13 20:57:57 +0000[diff] [blame]180 details).</li>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]181 <li>Test cases should be written in
182 <a href="LangRef.html">LLVM assembly language</a> unless the
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]183 feature or regression being tested requires another language (e.g. the
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]184 bug being fixed or feature being implemented is in the llvm-gcc C++
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]185 front-end).</li>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]186 <li>Test cases, especially for regressions, should be reduced as much as
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]187 possible, by <a href="CommandGuide/html/bugpoint.html">bugpoint</a> or
188 manually. It is unacceptable
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]189 to place an entire failing program into <tt>llvm/test</tt> as this creates
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]190 a <i>time-to-test</i> burden on all developers. Please keep them short.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]191 <li>More extensive test cases (applications, benchmarks, etc.) should be
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]192 added to the <tt>llvm-test</tt> test suite. This test suite is for
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]193 coverage: not features or regressions.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]194 </ol>
195</div>
196
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]197<!-- _______________________________________________________________________ -->
198<div class="doc_subsection"> <a name="c_new">Obtaining Commit Access</a></div>
199<div class="doc_text">
200
201<p>
202We grant commit access to contributors with a track record of submitting high
203quality patches. If you would like commit access, please send an email to the
204<a href="mailto:llvm-oversight@cs.uiuc.edu">LLVM oversight group</a>.</p>
205
206<p>If you have recently been granted commit access, these policies apply:</p>
207<ol>
208 <li>You are granted <i>commit-after-approval</i> to all parts of LLVM.
209 To get approval, submit a <a href="#patches">patch</a> to
210 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">
211 llvm-commits</a>. When approved you may commit it yourself.</li>
212 <li>You are allowed to commit patches without approval which you think are
213 obvious. This is clearly a subjective decision. We simply expect you to
214 use good judgement. Examples include: fixing build breakage, reverting
215 obviously broken patches, documentation/comment changes, any other minor
216 changes.</li>
217 <li>You are allowed to commit patches without approval to those portions
218 of LLVM that you have contributed or maintain (have been assigned
219 responsibility for), with the proviso that such commits must not break the
220 build. This is a "trust but verify" policy and commits of this nature are
221 reviewed after they are committed.</li>
222 <li>Multiple violations of these policies or a single egregious violation
223 may cause commit access to be revoked.</li>
224</ol>
225
226</div>
227
228<!-- _______________________________________________________________________ -->
229<div class="doc_subsection"> <a name="incremental">Incremental Development</a>
230</div>
231<div class="doc_text">
232 <p>When making a large change to LLVM, we use a incremental style of
233 development instead of having long-term development branches. Long-term
234 development branches have a number of drawbacks:</p>
235
236 <ol>
237 <li>Branches must have mainline merged into them periodically. If the branch
238 development and mainline development occur in the same pieces of code,
239 resolving merge conflicts can take a lot of time.</li>
240 <li>Other people in the community tend to ignore work on branches.</li>
241 <li>Huge changes (produced when a branch is merged back onto mainline) are
242 extremely difficult to <a href="#reviews">code review</a>.</li>
243 <li>Branches are not routinely tested by our nightly tester
244 infrastructure.</li>
245 <li>Changes developed as monolithic large changes often don't work until the
246 entire set of changes is done. Breaking it down into a set of smaller
247 changes increases the odds that any of the work will be committed to the
248 main repository.</li>
249 </ol>
250
251 <p>
252 To address these problems, LLVM uses an incremental development style and we
253 require contributors to follow this practice when making a large/invasive
254 change. Some tips:</p>
255
256 <ul>
257 <li>Large/invasive changes usually have a number of secondary changes that
258 are required before the big change can be made (e.g. API cleanup, etc).
259 These sorts of changes can often be done before the major change is done,
260 independently of that work.</li>
261 <li>The remaining inter-related work should be decomposed into unrelated
262 sets of changes if possible. Once this is done, define the first increment
263 and get consensus on what the end goal of the change is.</li>
264 <li>Increments can be stand alone (e.g. to fix a bug), or part of a planned
265 series of increments towards some development goal.</li>
266 <li>Increments should be kept as small as possible. This simplifies your
267 work (into a logical progression), simplifies code review and reduces the
268 chance that you will get negative feedback on the change. Small increments
269 also facilitate the maintenance of a high quality code base.</li>
270 <li>Often, an independent precursor to a big change is to add a new API and
271 slowly migrate clients to use the new API. Each change to use the new
272 API is often "obvious" and can be committed without review. Once the
273 new API is in place and used, it is often easy to replace the underlying
274 implementation of the API.</li>
275 </ul>
276
277 <p>If you are interested in making a large change, and this scares you, please
278 make sure to first <a href="#newwork">discuss the change/gather
279 consensus</a> then feel free to ask about the best way to go about making
280 the change.</p>
281</div>
282
283<!-- _______________________________________________________________________ -->
284<div class="doc_subsection"><a name="attribution">Attribution</a></div>
285<div class="doc_text">
286 <p>We believe in correct attribution of contributions to
287 their contributors. However, we do not want the source code to be littered
288 with random attributions (this is noisy/distracting and revision control
289 keeps a perfect history of this anyway). As such, we follow these rules:</p>
290 <ol>
291 <li>Developers who originate new files in LLVM should place their name at
292 the top of the file per the
293 <a href="CodingStandards.html#scf_commenting">Coding Standards</a>.</li>
294 <li>There should be only one name at the top of the file and it should be
295 the person who created the file.</li>
296 <li>Placing your name in the file does not imply <a
297 href="#candl">copyright</a>: it is only used to attribute the file to
298 its original author.</li>
299 <li>Developers should be aware that after some time has passed, the name at
300 the top of a file may become meaningless as maintenance/ownership of files
301 changes. Revision control keeps an accurate history of contributions.</li>
302 <li>Developers should maintain their entry in the
303 <a href="http://llvm.org/cvsweb/cvsweb.cgi/llvm/CREDITS.TXT?rev=HEAD&amp;content-type=text/x-cvsweb-markup">CREDITS.txt</a>
304 file to summarize their contributions.</li>
305 <li>Commit comments should contain correct attribution of the person who
306 submitted the patch if that person is not the committer (i.e. when a
307 developer with commit privileges commits a patch for someone else).</li>
308 </ol>
309</div>
310
311
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]312<!--=========================================================================-->
313<div class="doc_section"><a name="patches">Patch Policies</a></div>
314<!--=========================================================================-->
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]315
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]316<div class="doc_text">
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]317 <p>This section describes policies that apply to developers who regularly
318 contribute code to LLVM. As usual, we often accept small patches and
319 contributions that do not follow this policy. In this case, one of the
320 regular contributors has to get the code in shape.</p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]321</div>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]322
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]323<!-- _______________________________________________________________________ -->
324<div class="doc_subsection"> <a name="p_form">Patch Form</a></div>
325<div class="doc_text">
326 <p>When submitting a patch, developers must follow these rules:</p>
327 <ol>
328 <li>Patches must be made against the CVS HEAD (main development trunk),
329 not a branch.</li>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]330 <li>Patches should be made with this command:
331 <pre>cvs diff -Ntdup -5</pre>
332 or with the utility <tt>utils/mkpatch</tt>.</li>
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]333 <li>Patches should not include differences in generated code such as the
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]334 code generated by <tt>flex</tt>, <tt>bison</tt> or <tt>tblgen</tt>. The
335 <tt>utils/mkpatch</tt> utility takes care of this for you.</li>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]336 <li>Contributions must not knowingly infringe on any patents. To the best of
337 our knowledge, LLVM is free of any existing patent violations and it is our
338 intent to keep it that way.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]339 </ol>
340</div>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]341
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]342<!-- _______________________________________________________________________ -->
343<div class="doc_subsection"> <a name="p_submission">Patch Submission</a></div>
344<div class="doc_text">
345 <p>When a patch is ready to be submitted, these policies apply:</p>
346 <ol>
347 <li>Patches should be submitted immediately after they are generated. Stale
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]348 patches may not apply correctly if the underlying code changes between the
349 time the patch was created and the time it is applied.</li>
350 <li>Patches should be submitted by e-mail to the
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]351 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">
352 llvm-commits</a> list.</li>
353 </ol>
354</div>
355
356<!-- _______________________________________________________________________ -->
Reid Spencer0e598722007-02-14 17:20:59 +0000[diff] [blame]357<div class="doc_subsection"> <a name="p_aftersub">After Submission</a></div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]358<div class="doc_text">
359 <p>After a patch has been submitted, these policies apply:</p>
360 <ol>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]361 <li>The patch is subject to review by anyone on the
362 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a>
363 email list.</li>
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]364 <li>Changes recommended by a reviewer should be incorporated into your
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]365 patch or you should explain why the reviewer is incorrect.
366 <li>Changes to the patch must be re-submitted to the
367 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a>
368 email list.</li>
369 <li>This process iterates until all review issues have been addressed.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]370 </ol>
371</div>
372
373<!-- _______________________________________________________________________ -->
Reid Spencer0e598722007-02-14 17:20:59 +0000[diff] [blame]374<div class="doc_subsection"> <a name="p_aftercommit">After Commit</a></div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]375<div class="doc_text">
376 <p>After a patch has been committed, these policies apply:</p>
377 <ol>
378 <li>The patch is subject to further review by anyone on the llvm-commits
379 email list.</li>
380 <li>The patch submitter is responsible for all aspects of the patch per
381 the <a href="quality">quality policy</a> above.</li>
382 <li>If the patch is discovered to not meet the
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]383 <a href="quality">quality policy</a> standards within a reasonable time
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]384 frame (24 hours), it may be subject to reversal.</li>
385 </ol>
386</div>
387
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]388<!--=========================================================================-->
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]389<div class="doc_section"><a name="candl">Copyright and License</a></div>
390<!--=========================================================================-->
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]391
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]392<div class="doc_text">
393 <p>We address here the issues of copyright and license for the LLVM project.
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]394 The object of the copyright and license is the LLVM source code and
395 documentation.
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]396 Currently, the University of Illinois is the LLVM copyright holder and the
397 terms of its license to LLVM users and developers is the
398 <a href="http://www.opensource.org/licenses/UoI-NCSA.php">University of
399 Illinois/NCSA Open Source License</a>.
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]400
401<div class="doc_notes">
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]402 <p><b>NOTE: This section deals with legal matters but does not provide
403 official legal advice. We are not lawyers, please seek legal counsel from an
404 attorney.</b></p>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]405</div>
406
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]407</div>
408
409<!-- _______________________________________________________________________ -->
410<div class="doc_subsection"><a name="copyright">Copyright</a></div>
411<div class="doc_text">
412 <p>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]413 <p>For consistency and ease of management, the project requires the
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]414 copyright for all LLVM software to be held by a single copyright holder:
415 the University of Illinois (UIUC).</p>
416
417 <p>
418 Although UIUC may eventually reassign the copyright of the software to another
419 entity (e.g. a dedicated non-profit "LLVM Organization", or something)
420 the intent for the project is to always have a single entity hold the
421 copyrights to LLVM at any given time.</p>
422
423 <p>We believe that having a single copyright
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]424 holder is in the best interests of all developers and users as it greatly
425 reduces the managerial burden for any kind of administrative or technical
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]426 decisions about LLVM. The goal of the LLVM project is to always keep the code
427 open and <a href="#license">licensed under a very liberal license</a>.</p>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]428</div>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]429
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]430<!-- _______________________________________________________________________ -->
431<div class="doc_subsection"><a name="license">License</a></div>
432<div class="doc_text">
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]433 <p>We intend to keep LLVM perpetually open source
434 and to use a liberal open source license. The current license is the
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]435 <a href="http://www.opensource.org/licenses/UoI-NCSA.php">
436 University of Illinois/NCSA Open Source License</a>, which boils
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]437 down to this:</p>
438 <ul>
439 <li>You can freely distribute LLVM.</li>
440 <li>You must retain the copyright notice if you redistribute LLVM.</li>
441 <li>Binaries derived from LLVM must reproduce the copyright notice.</li>
442 <li>You can't use our names to promote your LLVM derived products.</li>
443 <li>There's no warranty on LLVM at all.</li>
444 </ul>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]445
446 <p>We believe this fosters the widest adoption of LLVM because it <b>allows
447 commercial products to be derived from LLVM</b> with few restrictions and
Reid Spencer5b9a6092007-02-14 22:55:40 +0000[diff] [blame]448 without a requirement for making any derived works also open source (i.e.
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]449 LLVM's license is not a "copyleft" license like the GPL). We suggest that you
450 read the <a href="http://www.opensource.org/licenses/UoI-NCSA.php">License</a>
Reid Spencer853418d2007-02-14 22:58:39 +0000[diff] [blame]451 if further clarification is needed.</p>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]452
453 <p>Note that the LLVM Project does distribute some code that includes GPL
454 software (notably, llvm-gcc which is based on the GCC GPL source base).
455 This means that anything "linked" into to llvm-gcc must itself be compatible
456 with the GPL, and must be releasable under the terms of the GPL. This implies
457 that you <b>any code linked into llvm-gcc and distributed may be subject to
458 the viral aspects of the GPL</b>. This is not a problem for the main LLVM
459 distribution (which is already licensed under a more liberal license), but may
460 be a problem if you intend to do commercial development without redistributing
461 your source code.</p>
462
463 <p>We have no plans to change the license of LLVM. If you have questions
464 or comments about the license, please contact the <a
465 href="mailto:llvm-oversight@cs.uiuc.edu">LLVM Oversight Group</a>.</p>
466
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]467</div>
468<!-- _______________________________________________________________________ -->
469<div class="doc_subsection"><a name="devagree">Developer Agreements</a></div>
470<div class="doc_text">
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]471 <p>With regards to the LLVM copyright and licensing, developers agree to
472 assign their copyrights to UIUC for any contribution made so that
473 the entire software base can be managed by a single copyright holder. This
474 implies that any contributions can be licensed under the license that the
475 project uses.</li>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]476 </ul>
477</div>
478
479<!--=========================================================================-->
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]480<div class="doc_section"><a name="terms">Terminology</a></div>
481<!--=========================================================================-->
482<div class="doc_text">
483 <p>So that the policies defined in this document are clear, we define some
484 terms here.</p>
485 <dl>
486 <dt><a name="t_change">Change</a></dt>
487 <dd>Any modification to LLVM including documentation, tests, build system,
488 etc. either in <a href="#t_patch">patch</a> or
489 <a href="#t_commit">commit</a> form.</dd>
490 <dt><a name="t_commit">Commit</a><dt>
491 <dd>A <a href="t_change">change</a> submitted directly to LLVM software
492 repository via the <tt>cvs commit</tt> command.</dd>
493 <dt><a name="t_developer">Developer</a></dt>
494 <dd>Anyone who submits a <a href="#t_change">change</a> to LLVM.</dd>
495 <dt><a name="t_inrement">Increment</a></dt>
496 <dd>A <a href="#t_change">change</a> or set of changes, whether by
497 <a href="#t_patch">patch</a> or <a href="#t_commit">commit</a>, that are
498 related by a single common purpose. Increments are atomic as they
499 leave LLVM in a stable state (both compiling and working properly).</dd>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]500 <dt><a name="t_patch">Patch</a></dt>
501 <dd>A <a href="#t_change">change</a> submitted by email in patch (diff)
502 format generated by the <tt>cvs diff</tt> command.</dd>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]503 </dl>
504</div>
505
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]506<!-- *********************************************************************** -->
507<hr>
508<address>
509 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
510 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
511 <a href="http://validator.w3.org/check/referer"><img
512 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
Chris Lattner450f40a2007-02-19 03:50:31 +0000[diff] [blame^]513 Written by: the
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]514 <a href="mailto:llvm-oversight@cs.uiuc.edu">LLVM Oversight Group</a><br>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]515 <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
516 Last modified: $Date$
517</address>
518</body>
519</html>