Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 853418d158ea6ea7f1001b877490e4c79c1da7c2 / . / docs / DeveloperPolicy.html
blob: 5fab3e79478539857437d257cf9ac21d13f0dd2e [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 Spencerbb15b1c2007-02-13 09:09:20 +0000[diff] [blame]9 <div class="doc_warning">DRAFT Only. DRAFT Only. DRAFT Only. DRAFT Only.</div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]10
11<div class="doc_title">LLVM Developer Policy</div>
12<table class="layout"><tr class="layout"><td class="layout">
13<h2>Contents</h2>
14<ol>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]15 <li><a href="#introduction">Introduction</a></li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]16 <li><a href="#general">General Policies</a>
17 <ol>
18 <li><a href="#informed">Stay Informed</a> </li>
19 <li><a href="#newwork">Starting New Work</a></li>
20 <li><a href="#reviews">Code Reviews</a></li>
21 <li><a href="#incremental">Incremental Development</a></li>
22 <li><a href="#quality">Quality</a></li>
23 <li><a href="#testcases">Test Cases</a></li>
24 </ol></li>
25 <li><a href="#patches">Patch Policies</a>
26 <ol>
27 <li><a href="#p_form">Patch Form</a></li>
28 <li><a href="#p_testing">Patch Testing</a></li>
29 <li><a href="#p_submission">Patch Submission</a></li>
Reid Spencer0e598722007-02-14 17:20:59 +0000[diff] [blame]30 <li><a href="#p_aftersub">After Submission</a></li>
31 <li><a href="#p_aftercommit">After Commit</a></li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]32 <li><a href="#c_access">Obtaining Commit Access</a></li>
33 <li><a href="#c_new">New Committers</a></li>
34 </ol></li>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]35 <li><a href="#candl">Copyright and License</a>
36 <ol>
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]37 <li><a href="#attribution">Attribution</a></li>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]38 <li><a href="#copyright">Copyright</a></li>
39 <li><a href="#license">License</a></li>
40 <li><a href="#devagree">Developer Agreements</a></li>
41 </ol></li>
Reid Spencer0e598722007-02-14 17:20:59 +0000[diff] [blame]42 <li><a href="#terms">Terminology</a></li>
43 <li><a href="#polnotes">Policy Notes</a></li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]44</ol>
45<div class="doc_author">Written by LLVM Oversight Team</div>
46</td><td class="layout">
47
48<!--=========================================================================-->
Reid Spencere7bd7d62007-02-14 17:24:04 +0000[diff] [blame]49<div class="doc_section"><a name="introduction">Introduction</a></div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]50<!--=========================================================================-->
51<div class="doc_text">
52 <p>This document contains the LLVM Developer Policy which defines the
Reid Spencerbed92532007-02-13 17:04:09 +0000[diff] [blame]53 project's policy towards developers and their contributions. The intent of
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]54 this policy is to eliminate mis-communication, rework, and confusion that
55 might arise from the distributed nature of LLVM's development. By stating
56 the policy in clear terms, we hope each developer can know ahead of time
57 what to expect when making LLVM contributions.</p>
Reid Spencer5b9a6092007-02-14 22:55:40 +0000[diff] [blame]58 <p>This policy is also designed to accomplish the following objectives:</p>
59 <ol>
60 <li>Attract both users and developers to the LLVM project.</li>
61 <li>Make life as simple and easy for contributors as possible.</li>
62 <li>Indicate that LLVM is a mature project with a thriving community and
63 sensible policies directing its ongoing development.</li>
64 </ol>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]65</div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]66
67<!--=========================================================================-->
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]68<div class="doc_section"><a name="general">General Policies</a></div>
69<!--=========================================================================-->
70<div class="doc_text">
71 <p>This section contains policies that pertain generally to LLVM developers.
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]72 LLVM Developers are expected to meet the following obligations in order
Reid Spencer25f9b9b2007-02-14 08:09:40 +0000[diff] [blame]73 for LLVM to maintain a high standard of quality.<p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]74</div>
75
76<!-- _______________________________________________________________________ -->
77<div class="doc_subsection"> <a name="informed">Stay Informed</a> </div>
78<div class="doc_text">
79 <p>Developers should stay informed by reading at least the
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]80 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvmdev</a>
81 email list. If you are doing anything more than just casual work on LLVM,
82 it is suggested that you also subscribe to the
83 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a>
84 list and pay attention to changes being made by others.</p>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]85 <p>We recommend that active developers register an email account with
86 <a href="http://llvm.org/bugs/">LLVM Bugzilla</a> and preferably subscribe to
87 the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmbugs">llvm-bugs</a>
88 email list to keep track of bugs and enhancements occurring in LLVM.</p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]89</div>
90
91<!-- _______________________________________________________________________ -->
92<div class="doc_subsection"> <a name="newwork">Starting New Work</a></div>
93<div class="doc_text">
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]94 <p>When a developer begins a major new project with the aim of contributing
95 it back to LLVM, s/he should inform the community with an email to
96 the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvm-dev</a>
97 email list, to the extent possible. The reason for this is to:
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]98 <ul>
99 <li>keep the community informed about future changes to LLVM, </li>
100 <li>avoid duplication of effort by having multiple parties working on the
101 same thing and not knowing about it, and</li>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]102 <li>ensure that any technical issues around the proposed work are
103 discussed and resolved before any significant work is done.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]104 </ul>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]105 <p>The design of LLVM is carefully controlled to ensure that all the pieces
106 fit together well. If you plan to make a major change to the way LLVM works or
107 a major new extension, it is a good idea to get consensus with the development
108 community before you start working on it.</p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]109</div>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]110</td></tr></table>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]111
112<!-- _______________________________________________________________________ -->
113<div class="doc_subsection"> <a name="reviews">Code Reviews</a></div>
114<div class="doc_text">
115 <p>LLVM has a code review policy. Code review is an excellent way to ensure
116 high quality in the software. The following policies apply:</p>
117 <ol>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]118 <li>All developers are required to have significant changes reviewed
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]119 before they are committed to the repository.</li>
120 <li>Code reviews are conducted by email.</li>
121 <li>Code can be reviewed either before it is committed or after.</li>
122 <li>The developer responsible for a code change is also responsible for
123 making all necessary review changes.</li>
124 <li>Developers should participate in code reviews as both a reviewer and
125 a reviewee. We don't have a dedicated team of reviewers. If someone is
126 kind enough to review your code, you should return the favor for someone
127 else.</li>
128 </ol>
129</div>
130
131<!-- _______________________________________________________________________ -->
132<div class="doc_subsection"> <a name="incremental">Incremental Development</a>
133</div>
134<div class="doc_text">
135 <p>LLVM uses an incremental development style and all developers are expected
136 to follow this practice. Incremental development is a big key to LLVM's
137 success and it is essential that developers submit incremental patches. The
138 following defines the incremental development approach:</p>
139 <ol>
140 <li>The first task is to define the increment and get consensus (with the
141 LLVM development community) on what the end goal of the change is. Making
142 random small changes that go nowhere is not useful for anyone.</li>
143 <li>An increment is the smallest patch size necessary to effect one change
144 in LLVM.</li>
145 <li>Increments can be stand alone (e.g. to fix a bug), or part of a planned
146 series of increments towards some development goal.</li>
147 <li>Increments should be kept as small as possible. This simplifies your
148 work (into a logical progression), simplifies code review and reduces the
149 chance that you will get negative feedback on the change. Small increments
150 also facilitate the maintenance of a high quality code base.</li>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]151 <li>Larger increments require a larger testing effort.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]152 </ol>
153</div>
154
155<!-- _______________________________________________________________________ -->
156<div class="doc_subsection"> <a name="quality">Quality</a></div>
157<div class="doc_text">
158 <p>The minimum quality standards for any change to the main development
159 branch are:</p>
160 <ol>
161 <li>Code must adhere to the
162 <a href="CodingStandards.html">LLVM Coding Standards</a>.</li>
163 <li>Code must compile cleanly (no errors, no warnings) on at least one
164 platform.</li>
165 <li>Code must pass the deja gnu (llvm/test) test suite.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]166 </ol>
Reid Spencerf1491da2007-02-14 08:19:16 +0000[diff] [blame]167 <p>Additionally, the committer is responsible for addressing all of the
168 following items (preferably before submission):</p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]169 <ol>
Reid Spencerf1491da2007-02-14 08:19:16 +0000[diff] [blame]170 <li>The code should compile cleanly on all platforms.</li>
171 <li>The changes should not cause regressions in the <tt>llvm-test</tt>
172 suite including SPEC CINT2000, SPEC CFP2000, SPEC CINT2006, and
173 SPEC CFP2006.</li>
174 <li>The change set should not cause performance or correctness regressions
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]175 for the LLVM tools.</li>
Reid Spencerf1491da2007-02-14 08:19:16 +0000[diff] [blame]176 <li>The changes should not cause performance or correctness regressions in
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]177 code compiled by LLVM on all applicable targets.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]178 </ol>
179</div>
180
181<!-- _______________________________________________________________________ -->
182<div class="doc_subsection"> <a name="testcases">Test Cases</a></div>
183<div class="doc_text">
184 <p>Developers are required to create test cases for regressions and new
185 features and include them with their changes. The following policies
186 apply:</p>
187 <ol>
188 <li>All feature and regression test cases must be added to the
Reid Spencer80483bb2007-02-13 09:20:14 +0000[diff] [blame]189 <tt>llvm/test</tt> directory. The appropriate sub-directory should be
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]190 selected (see the <a href="TestingGuide.html">Testing Guide</a> for
Reid Spencer40602962007-02-13 20:57:57 +0000[diff] [blame]191 details).</li>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]192 <li>Test cases should be written in
193 <a href="LangRef.html">LLVM assembly language</a> unless the
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]194 feature or regression being tested requires another language (e.g. the
Reid Spencerf1491da2007-02-14 08:19:16 +0000[diff] [blame]195 bug being fixed or feature being implemented is in the lvm-gcc C++
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]196 front-end).</li>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]197 <li>Test cases, especially for regressions, should be reduced as much as
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]198 possible, by <a href="CommandGuide/html/bugpoint.html">bugpoint</a> or
199 manually. It is unacceptable
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]200 to place an entire failing program into <tt>llvm/test</tt> as this creates
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]201 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]202 <li>More extensive test cases (applications, benchmarks, etc.) should be
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]203 added to the <tt>llvm-test</tt> test suite. This test suite is for
204 coverage not features or regressions.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]205 </ol>
206</div>
207
208<!--=========================================================================-->
209<div class="doc_section"><a name="patches">Patch Policies</a></div>
210<!--=========================================================================-->
211<div class="doc_text">
212 <p>This section contains policies that pertain to submitting patches
213 to LLVM and committing code to the repository</p>
214</div>
215<!-- _______________________________________________________________________ -->
216<div class="doc_subsection"> <a name="p_form">Patch Form</a></div>
217<div class="doc_text">
218 <p>When submitting a patch, developers must follow these rules:</p>
219 <ol>
220 <li>Patches must be made against the CVS HEAD (main development trunk),
221 not a branch.</li>
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]222 <li>Patches should be made with this command:<pre>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]223 cvs diff -Ntdup -5</pre> or with the utility <tt>utils/mkpatch</tt>.</li>
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]224 <li>Patches should not include differences in generated code such as the
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]225 code generated by <tt>flex</tt>, <tt>bison</tt> or <tt>tblgen</tt>. The
226 <tt>utils/mkpatch</tt> utility takes care of this for you.</li>
Reid Spencer5b9a6092007-02-14 22:55:40 +0000[diff] [blame]227 <li>Patches must not include any patent violations. To the best of our
228 knowledge, LLVM is free of any existing patent violations and it is our
229 intent to keep it that way. </li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]230 </ol>
231</div>
232<!-- _______________________________________________________________________ -->
233<div class="doc_subsection"> <a name="p_testing">Patch Testing</a></div>
234<div class="doc_text">
235 <p>Before a patch is submitted for review, it should be tested to ensure
236 that:</p>
237 <ol>
238 <li>The patch must compile against the CVS HEAD cleanly (zero warnings, zero
239 errors).</li>
240 <li>All the llvm/test (Deja Gnu) tests must pass.</li>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]241 <li>The patch should cause no regressions in the llvm-test test suite. How
242 much testing is appropriate depends on the nature of the patch. We leave it
243 to your good judgement, but you will be responsible for fixing any
244 regressions or reverting the patch.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]245 </ol>
246</div>
247<!-- _______________________________________________________________________ -->
248<div class="doc_subsection"> <a name="p_submission">Patch Submission</a></div>
249<div class="doc_text">
250 <p>When a patch is ready to be submitted, these policies apply:</p>
251 <ol>
252 <li>Patches should be submitted immediately after they are generated. Stale
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]253 patches may not apply correctly if the underlying code changes between the
254 time the patch was created and the time it is applied.</li>
255 <li>Patches should be submitted by e-mail to the
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]256 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">
257 llvm-commits</a> list.</li>
258 </ol>
259</div>
260
261<!-- _______________________________________________________________________ -->
Reid Spencer0e598722007-02-14 17:20:59 +0000[diff] [blame]262<div class="doc_subsection"> <a name="p_aftersub">After Submission</a></div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]263<div class="doc_text">
264 <p>After a patch has been submitted, these policies apply:</p>
265 <ol>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]266 <li>The patch is subject to review by anyone on the
267 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a>
268 email list.</li>
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]269 <li>Changes recommended by a reviewer should be incorporated into your
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]270 patch or you should explain why the reviewer is incorrect.
271 <li>Changes to the patch must be re-submitted to the
272 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a>
273 email list.</li>
274 <li>This process iterates until all review issues have been addressed.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]275 </ol>
276</div>
277
278<!-- _______________________________________________________________________ -->
Reid Spencer0e598722007-02-14 17:20:59 +0000[diff] [blame]279<div class="doc_subsection"> <a name="p_aftercommit">After Commit</a></div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]280<div class="doc_text">
281 <p>After a patch has been committed, these policies apply:</p>
282 <ol>
283 <li>The patch is subject to further review by anyone on the llvm-commits
284 email list.</li>
285 <li>The patch submitter is responsible for all aspects of the patch per
286 the <a href="quality">quality policy</a> above.</li>
287 <li>If the patch is discovered to not meet the
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]288 <a href="quality">quality policy</a> standards within a reasonable time
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]289 frame (24 hours), it may be subject to reversal.</li>
290 </ol>
291</div>
292
293<!-- _______________________________________________________________________ -->
Reid Spencere7bd7d62007-02-14 17:24:04 +0000[diff] [blame]294<div class="doc_subsection"> <a name="c_access">Obtaining Commit Access</a></div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]295<div class="doc_text">
296 <p>Commit access to the repository is granted according to this policy:</p>
297 <ol>
298 <li>Commit access is not granted to anyone unless they specifically ask for
299 it.</li>
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]300 <li>Requests for commit access must be sent to the
301 <a href="mailto:llvm-oversight@cs.uiuc.edu">LLVM Oversight Group</a>.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]302 <li>Granting commit access is at the sole discretion of the LLVM Oversight
303 Group.</li>
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]304 </ol>
305 <p>Submitting patches to LLVM via the patch policy above will greatly
306 increase the chance that your request for commit access is granted. Getting
307 to know the members of the LLVM community (email, IRC, in person contact,
308 etc.) will also increase your chances.</p>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]309 </ol>
310</div>
311
312<!-- _______________________________________________________________________ -->
313<div class="doc_subsection"> <a name="c_new">New Committers</a></div>
314<div class="doc_text">
315 <p>For those who have recently obtained commit access, the following policies
316 apply:</p>
317 <ol>
318 <li>You are granted <i>commit-after-approval</i> to all parts of LLVM.
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]319 To get approval, submit a patch to
320 <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]321 per the <a href="#patches">patch policies</a> above. When approved you
322 may commit it yourself.</li>
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]323 <li>You are allowed to commit patches without approval which you think are
324 obvious. This is clearly a subjective decision. We simply expect you to
325 use good judgement.</li>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]326 <li>You are allowed to commit patches without approval to those portions
327 of LLVM that you own (contributed) or maintain (have been assigned
328 responsibility for), with the proviso that such commits must not break the
329 build. This is a "trust but verify" policy and commits of this nature are
330 reviewed after they are committed.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]331 <li>Commits that violate the <a href="quality">quality standards</a> may
332 be reverted. This is necessary when the change blocks other developers from
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]333 making progress. The developer is welcome to re-commit the change after
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]334 the problem has been fixed.</li>
Reid Spencer80483bb2007-02-13 09:20:14 +0000[diff] [blame]335 <li>Multiple violations of these policies or a single egregious violation
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]336 may cause commit access to be revoked.</li>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]337 </ol>
338</div>
339
340<!--=========================================================================-->
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]341<div class="doc_section"><a name="candl">Copyright and License</a></div>
342<!--=========================================================================-->
343<div class="doc_text">
344 <p>We address here the issues of copyright and license for the LLVM project.
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]345 The object of the copyright and license is the LLVM source code and
346 documentation.
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]347 Currently, the University of Illinois is the LLVM copyright holder and the
348 terms of its license to LLVM users and developers is the
349 <a href="http://www.opensource.org/licenses/UoI-NCSA.php">University of
350 Illinois/NCSA Open Source License</a>.
351</div>
352
353<div class="doc_notes">
354 <p>NOTE: This section deals with legal matters but does not provide legal
Reid Spencer134400b2007-02-14 16:21:54 +0000[diff] [blame]355 advice. It is intended only as a general guideline.</p>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]356</div>
357
358<!-- _______________________________________________________________________ -->
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]359<div class="doc_subsection"><a name="attribution">Attribution</a></div>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]360<div class="doc_text">
361 <p>The LLVM project believes in correct attribution of contributions to
362 their contributors, as follows:</p>
363 <ol>
364 <li>Developers who originate new files in LLVM should place their name at
365 the top of the file per the
366 <a href="CodingStandards.html">Coding Standards</a>.</li>
367 <li>There should be only one name at the top of the file and it should be
368 the person who created the file.</li>
369 <li>Placing your name in the file does not imply copyright but does
370 correctly attribute the file to its author.</li>
371 <li>Developers should be aware that after some time has passed, the name at
372 the top of a file may become meaningless as maintenance/ownership of files
373 changes.</li>
374 <li>Developers should submit or commit patches to the
375 <a href="http://llvm.org/cvsweb/cvsweb.cgi/llvm/CREDITS.TXT?rev=1.67&content-type=text/x-cvsweb-markup">CREDITS.txt</a>
376 file to summarize their contributions.</li>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]377 <li>Commit comments should contain correct attribution of the person who
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]378 submitted the patch if that person is not the committer (i.e. when a
379 developer with commit privileges commits a patch for someone else).</li>
380 </ol>
381</div>
382
383<!-- _______________________________________________________________________ -->
384<div class="doc_subsection"><a name="copyright">Copyright</a></div>
385<div class="doc_text">
386 <p>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]387 <p>For consistency and ease of management, the project requires the
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]388 copyright for all LLVM software to be held by a single copyright holder.
389 Although UIUC may assign the copyright of the software to another entity,
390 the intent for the project is to always have a single entity hold the copy
391 rights to LLVM at any given time.
392 <p>Having multiple copyright holders for various portions of LLVM is
393 problematic in the management of the software. Having a single copyright
394 holder is in the best interests of all developers and users as it greatly
395 reduces the managerial burden for any kind of administrative or technical
396 decisions about LLVM.</p>
397</div>
398<!-- _______________________________________________________________________ -->
399<div class="doc_subsection"><a name="license">License</a></div>
400<div class="doc_text">
401 <p>LLVM licensing decisions will be made by the LLVM Oversight Group. Any
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]402 issues, comments or suggestions with the licensing should be sent to the
403 <a href="mailto:llvm-oversight@cs.uiuc.edu">LLVM Oversight Group</a>.</p>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]404 <p>The LLVM Oversight Group intends to keep LLVM perpetually open source
405 and to use liberal open source licenses. The current license is the
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]406 <a href="http://www.opensource.org/licenses/UoI-NCSA.php">
407 University of Illinois/NCSA Open Source License</a>, which boils
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]408 down to this:</p>
409 <ul>
410 <li>You can freely distribute LLVM.</li>
411 <li>You must retain the copyright notice if you redistribute LLVM.</li>
412 <li>Binaries derived from LLVM must reproduce the copyright notice.</li>
413 <li>You can't use our names to promote your LLVM derived products.</li>
414 <li>There's no warranty on LLVM at all.</li>
415 </ul>
416 <p>We believe this fosters the widest adoption of LLVM because it allows
417 commercial products to be derived from LLVM with few restrictions and
Reid Spencer5b9a6092007-02-14 22:55:40 +0000[diff] [blame]418 without a requirement for making any derived works also open source (i.e.
Reid Spencer853418d2007-02-14 22:58:39 +0000[diff] [blame^]419 LLVM's license is not a <i>copyleft</i> license). We suggest that you read
420 the <a href="http://www.opensource.org/licenses/UoI-NCSA.php">License</a>
421 if further clarification is needed.</p>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]422</div>
423<!-- _______________________________________________________________________ -->
424<div class="doc_subsection"><a name="devagree">Developer Agreements</a></div>
425<div class="doc_text">
426 <p>With regards to the LLVM copyright and licensing, developers agree to:</p>
427 <ul>
428 <li>assign their copy rights to UIUC for any contribution made so that
429 the entire software base can be managed by a single copyright holder.</li>
430 <li>allow their contribution(s) to be licensed as open source by the then
431 current license chosen by the LLVM Oversight Group.</li>
Reid Spencer78bade22007-02-14 07:22:19 +0000[diff] [blame]432 </ul>
433</div>
434
435<!--=========================================================================-->
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]436<div class="doc_section"><a name="terms">Terminology</a></div>
437<!--=========================================================================-->
438<div class="doc_text">
439 <p>So that the policies defined in this document are clear, we define some
440 terms here.</p>
441 <dl>
442 <dt><a name="t_change">Change</a></dt>
443 <dd>Any modification to LLVM including documentation, tests, build system,
444 etc. either in <a href="#t_patch">patch</a> or
445 <a href="#t_commit">commit</a> form.</dd>
446 <dt><a name="t_commit">Commit</a><dt>
447 <dd>A <a href="t_change">change</a> submitted directly to LLVM software
448 repository via the <tt>cvs commit</tt> command.</dd>
Reid Spencer5b9a6092007-02-14 22:55:40 +0000[diff] [blame]449 <dt><a name="t_copleft">Copyleft</a></dt>
450 <dd>A licensing policy that requires the licensee to adopt the terms of the
451 license for <i>derived</i> works. LLVM does not subscribe to this
452 policy.</dd>
Reid Spencer01f56be2007-02-14 16:21:10 +0000[diff] [blame]453 <dt><a name="t_developer">Developer</a></dt>
454 <dd>Anyone who submits a <a href="#t_change">change</a> to LLVM.</dd>
455 <dt><a name="t_inrement">Increment</a></dt>
456 <dd>A <a href="#t_change">change</a> or set of changes, whether by
457 <a href="#t_patch">patch</a> or <a href="#t_commit">commit</a>, that are
458 related by a single common purpose. Increments are atomic as they
459 leave LLVM in a stable state (both compiling and working properly).</dd>
460 <dt><a name="t_must">Must</a></dt>
461 <dd>When used in a policy statement, the term <i>must</i> implies a
462 non-optional requirement on the developer.</dd>
463 <dt><a name="t_patch">Patch</a></dt>
464 <dd>A <a href="#t_change">change</a> submitted by email in patch (diff)
465 format generated by the <tt>cvs diff</tt> command.</dd>
466 <dt><a name="t_should">Should</a></dt>
467 <dd>When used in a policy statement, the term <i>should</i> implies a
468 recommended but optional requirement on the developer.</dd>
469 </dl>
470</div>
471
472<!--=========================================================================-->
Reid Spencer0e598722007-02-14 17:20:59 +0000[diff] [blame]473<div class="doc_section"><a name="polnotes">Policy Notes</a></div>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]474<!--=========================================================================-->
475<div class="doc_text">
476 <p>This section contains some notes on policy topics that need to be
477 resolved and incorporated into the main body of the document above.</p>
478 <ol>
479 <li>When to open a new bug and when to re-use an existing one. For example
480 PR1158. If the same assertion happens do you open a new bug or reopen
481 1158?</li>
482 </ol>
483</div>
484
485<!-- *********************************************************************** -->
486<hr>
487<address>
488 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
489 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
490 <a href="http://validator.w3.org/check/referer"><img
491 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
Reid Spencer3eedbd32007-02-14 07:57:48 +0000[diff] [blame]492 Written By: the
493 <a href="mailto:llvm-oversight@cs.uiuc.edu">LLVM Oversight Group</a><br>
Reid Spencer8d0ac692007-02-13 09:06:01 +0000[diff] [blame]494 <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
495 Last modified: $Date$
496</address>
497</body>
498</html>