Add C API guidelines to the developer policy to match discussions
[oota-llvm.git] / docs / DeveloperPolicy.rst
1 =====================
2 LLVM Developer Policy
3 =====================
4
5 .. contents::
6    :local:
7
8 Introduction
9 ============
10
11 This document contains the LLVM Developer Policy which defines the project's
12 policy towards developers and their contributions. The intent of this policy is
13 to eliminate miscommunication, rework, and confusion that might arise from the
14 distributed nature of LLVM's development.  By stating the policy in clear terms,
15 we hope each developer can know ahead of time what to expect when making LLVM
16 contributions.  This policy covers all llvm.org subprojects, including Clang,
17 LLDB, libc++, etc.
18
19 This policy is also designed to accomplish the following objectives:
20
21 #. Attract both users and developers to the LLVM project.
22
23 #. Make life as simple and easy for contributors as possible.
24
25 #. Keep the top of Subversion trees as stable as possible.
26
27 #. Establish awareness of the project's :ref:`copyright, license, and patent
28    policies <copyright-license-patents>` with contributors to the project.
29
30 This policy is aimed at frequent contributors to LLVM. People interested in
31 contributing one-off patches can do so in an informal way by sending them to the
32 `llvm-commits mailing list
33 <http://lists.llvm.org/mailman/listinfo/llvm-commits>`_ and engaging another
34 developer to see it through the process.
35
36 Developer Policies
37 ==================
38
39 This section contains policies that pertain to frequent LLVM developers.  We
40 always welcome `one-off patches`_ from people who do not routinely contribute to
41 LLVM, but we expect more from frequent contributors to keep the system as
42 efficient as possible for everyone.  Frequent LLVM contributors are expected to
43 meet the following requirements in order for LLVM to maintain a high standard of
44 quality.
45
46 Stay Informed
47 -------------
48
49 Developers should stay informed by reading at least the "dev" mailing list for
50 the projects you are interested in, such as `llvm-dev
51 <http://lists.llvm.org/mailman/listinfo/llvm-dev>`_ for LLVM, `cfe-dev
52 <http://lists.llvm.org/mailman/listinfo/cfe-dev>`_ for Clang, or `lldb-dev
53 <http://lists.llvm.org/mailman/listinfo/lldb-dev>`_ for LLDB.  If you are
54 doing anything more than just casual work on LLVM, it is suggested that you also
55 subscribe to the "commits" mailing list for the subproject you're interested in,
56 such as `llvm-commits
57 <http://lists.llvm.org/mailman/listinfo/llvm-commits>`_, `cfe-commits
58 <http://lists.llvm.org/mailman/listinfo/cfe-commits>`_, or `lldb-commits
59 <http://lists.llvm.org/mailman/listinfo/lldb-commits>`_.  Reading the
60 "commits" list and paying attention to changes being made by others is a good
61 way to see what other people are interested in and watching the flow of the
62 project as a whole.
63
64 We recommend that active developers register an email account with `LLVM
65 Bugzilla <http://llvm.org/bugs/>`_ and preferably subscribe to the `llvm-bugs
66 <http://lists.llvm.org/mailman/listinfo/llvm-bugs>`_ email list to keep track
67 of bugs and enhancements occurring in LLVM.  We really appreciate people who are
68 proactive at catching incoming bugs in their components and dealing with them
69 promptly.
70
71 Please be aware that all public LLVM mailing lists are public and archived, and
72 that notices of confidentiality or non-disclosure cannot be respected.
73
74 .. _patch:
75 .. _one-off patches:
76
77 Making and Submitting a Patch
78 -----------------------------
79
80 When making a patch for review, the goal is to make it as easy for the reviewer
81 to read it as possible.  As such, we recommend that you:
82
83 #. Make your patch against the Subversion trunk, not a branch, and not an old
84    version of LLVM.  This makes it easy to apply the patch.  For information on
85    how to check out SVN trunk, please see the `Getting Started
86    Guide <GettingStarted.html#checkout>`_.
87
88 #. Similarly, patches should be submitted soon after they are generated.  Old
89    patches may not apply correctly if the underlying code changes between the
90    time the patch was created and the time it is applied.
91
92 #. Patches should be made with ``svn diff``, or similar. If you use a
93    different tool, make sure it uses the ``diff -u`` format and that it
94    doesn't contain clutter which makes it hard to read.
95
96 #. If you are modifying generated files, such as the top-level ``configure``
97    script, please separate out those changes into a separate patch from the rest
98    of your changes.
99
100 Once your patch is ready, submit it by emailing it to the appropriate project's
101 commit mailing list (or commit it directly if applicable). Alternatively, some
102 patches get sent to the project's development list or component of the LLVM bug
103 tracker, but the commit list is the primary place for reviews and should
104 generally be preferred.
105
106 When sending a patch to a mailing list, it is a good idea to send it as an
107 *attachment* to the message, not embedded into the text of the message.  This
108 ensures that your mailer will not mangle the patch when it sends it (e.g. by
109 making whitespace changes or by wrapping lines).
110
111 *For Thunderbird users:* Before submitting a patch, please open *Preferences >
112 Advanced > General > Config Editor*, find the key
113 ``mail.content_disposition_type``, and set its value to ``1``. Without this
114 setting, Thunderbird sends your attachment using ``Content-Disposition: inline``
115 rather than ``Content-Disposition: attachment``. Apple Mail gamely displays such
116 a file inline, making it difficult to work with for reviewers using that
117 program.
118
119 When submitting patches, please do not add confidentiality or non-disclosure
120 notices to the patches themselves.  These notices conflict with the `LLVM
121 License`_ and may result in your contribution being excluded.
122
123 .. _code review:
124
125 Code Reviews
126 ------------
127
128 LLVM has a code review policy. Code review is one way to increase the quality of
129 software. We generally follow these policies:
130
131 #. All developers are required to have significant changes reviewed before they
132    are committed to the repository.
133
134 #. Code reviews are conducted by email on the relevant project's commit mailing
135    list, or alternatively on the project's development list or bug tracker.
136
137 #. Code can be reviewed either before it is committed or after.  We expect major
138    changes to be reviewed before being committed, but smaller changes (or
139    changes where the developer owns the component) can be reviewed after commit.
140
141 #. The developer responsible for a code change is also responsible for making
142    all necessary review-related changes.
143
144 #. Code review can be an iterative process, which continues until the patch is
145    ready to be committed. Specifically, once a patch is sent out for review, it
146    needs an explicit "looks good" before it is submitted. Do not assume silent
147    approval, or request active objections to the patch with a deadline.
148
149 Sometimes code reviews will take longer than you would hope for, especially for
150 larger features. Accepted ways to speed up review times for your patches are:
151
152 * Review other people's patches. If you help out, everybody will be more
153   willing to do the same for you; goodwill is our currency.
154 * Ping the patch. If it is urgent, provide reasons why it is important to you to
155   get this patch landed and ping it every couple of days. If it is
156   not urgent, the common courtesy ping rate is one week. Remember that you're
157   asking for valuable time from other professional developers.
158 * Ask for help on IRC. Developers on IRC will be able to either help you
159   directly, or tell you who might be a good reviewer.
160 * Split your patch into multiple smaller patches that build on each other. The
161   smaller your patch, the higher the probability that somebody will take a quick
162   look at it.
163
164 Developers should participate in code reviews as both reviewers and
165 reviewees. If someone is kind enough to review your code, you should return the
166 favor for someone else.  Note that anyone is welcome to review and give feedback
167 on a patch, but only people with Subversion write access can approve it.
168
169 There is a web based code review tool that can optionally be used
170 for code reviews. See :doc:`Phabricator`.
171
172 Code Owners
173 -----------
174
175 The LLVM Project relies on two features of its process to maintain rapid
176 development in addition to the high quality of its source base: the combination
177 of code review plus post-commit review for trusted maintainers.  Having both is
178 a great way for the project to take advantage of the fact that most people do
179 the right thing most of the time, and only commit patches without pre-commit
180 review when they are confident they are right.
181
182 The trick to this is that the project has to guarantee that all patches that are
183 committed are reviewed after they go in: you don't want everyone to assume
184 someone else will review it, allowing the patch to go unreviewed.  To solve this
185 problem, we have a notion of an 'owner' for a piece of the code.  The sole
186 responsibility of a code owner is to ensure that a commit to their area of the
187 code is appropriately reviewed, either by themself or by someone else.  The list
188 of current code owners can be found in the file
189 `CODE_OWNERS.TXT <http://llvm.org/viewvc/llvm-project/llvm/trunk/CODE_OWNERS.TXT?view=markup>`_
190 in the root of the LLVM source tree.
191
192 Note that code ownership is completely different than reviewers: anyone can
193 review a piece of code, and we welcome code review from anyone who is
194 interested.  Code owners are the "last line of defense" to guarantee that all
195 patches that are committed are actually reviewed.
196
197 Being a code owner is a somewhat unglamorous position, but it is incredibly
198 important for the ongoing success of the project.  Because people get busy,
199 interests change, and unexpected things happen, code ownership is purely opt-in,
200 and anyone can choose to resign their "title" at any time. For now, we do not
201 have an official policy on how one gets elected to be a code owner.
202
203 .. _include a testcase:
204
205 Test Cases
206 ----------
207
208 Developers are required to create test cases for any bugs fixed and any new
209 features added.  Some tips for getting your testcase approved:
210
211 * All feature and regression test cases are added to the ``llvm/test``
212   directory. The appropriate sub-directory should be selected (see the
213   :doc:`Testing Guide <TestingGuide>` for details).
214
215 * Test cases should be written in :doc:`LLVM assembly language <LangRef>`.
216
217 * Test cases, especially for regressions, should be reduced as much as possible,
218   by :doc:`bugpoint <Bugpoint>` or manually. It is unacceptable to place an
219   entire failing program into ``llvm/test`` as this creates a *time-to-test*
220   burden on all developers. Please keep them short.
221
222 Note that llvm/test and clang/test are designed for regression and small feature
223 tests only. More extensive test cases (e.g., entire applications, benchmarks,
224 etc) should be added to the ``llvm-test`` test suite.  The llvm-test suite is
225 for coverage (correctness, performance, etc) testing, not feature or regression
226 testing.
227
228 Quality
229 -------
230
231 The minimum quality standards that any change must satisfy before being
232 committed to the main development branch are:
233
234 #. Code must adhere to the `LLVM Coding Standards <CodingStandards.html>`_.
235
236 #. Code must compile cleanly (no errors, no warnings) on at least one platform.
237
238 #. Bug fixes and new features should `include a testcase`_ so we know if the
239    fix/feature ever regresses in the future.
240
241 #. Code must pass the ``llvm/test`` test suite.
242
243 #. The code must not cause regressions on a reasonable subset of llvm-test,
244    where "reasonable" depends on the contributor's judgement and the scope of
245    the change (more invasive changes require more testing). A reasonable subset
246    might be something like "``llvm-test/MultiSource/Benchmarks``".
247
248 Additionally, the committer is responsible for addressing any problems found in
249 the future that the change is responsible for.  For example:
250
251 * The code should compile cleanly on all supported platforms.
252
253 * The changes should not cause any correctness regressions in the ``llvm-test``
254   suite and must not cause any major performance regressions.
255
256 * The change set should not cause performance or correctness regressions for the
257   LLVM tools.
258
259 * The changes should not cause performance or correctness regressions in code
260   compiled by LLVM on all applicable targets.
261
262 * You are expected to address any `Bugzilla bugs <http://llvm.org/bugs/>`_ that
263   result from your change.
264
265 We prefer for this to be handled before submission but understand that it isn't
266 possible to test all of this for every submission.  Our build bots and nightly
267 testing infrastructure normally finds these problems.  A good rule of thumb is
268 to check the nightly testers for regressions the day after your change.  Build
269 bots will directly email you if a group of commits that included yours caused a
270 failure.  You are expected to check the build bot messages to see if they are
271 your fault and, if so, fix the breakage.
272
273 Commits that violate these quality standards (e.g. are very broken) may be
274 reverted. This is necessary when the change blocks other developers from making
275 progress. The developer is welcome to re-commit the change after the problem has
276 been fixed.
277
278 .. _commit messages:
279
280 Commit messages
281 ---------------
282
283 Although we don't enforce the format of commit messages, we prefer that
284 you follow these guidelines to help review, search in logs, email formatting
285 and so on. These guidelines are very similar to rules used by other open source
286 projects.
287
288 Most importantly, the contents of the message should be carefully written to
289 convey the rationale of the change (without delving too much in detail). It
290 also should avoid being vague or overly specific. For example, "bits were not
291 set right" will leave the reviewer wondering about which bits, and why they
292 weren't right, while "Correctly set overflow bits in TargetInfo" conveys almost
293 all there is to the change.
294
295 Below are some guidelines about the format of the message itself:
296
297 * Separate the commit message into title, body and, if you're not the original
298   author, a "Patch by" attribution line (see below).
299
300 * The title should be concise. Because all commits are emailed to the list with
301   the first line as the subject, long titles are frowned upon.  Short titles
302   also look better in `git log`.
303
304 * When the changes are restricted to a specific part of the code (e.g. a
305   back-end or optimization pass), it is customary to add a tag to the
306   beginning of the line in square brackets.  For example, "[SCEV] ..."
307   or "[OpenMP] ...". This helps email filters and searches for post-commit
308   reviews.
309
310 * The body, if it exists, should be separated from the title by an empty line.
311
312 * The body should be concise, but explanatory, including a complete
313   reasoning.  Unless it is required to understand the change, examples,
314   code snippets and gory details should be left to bug comments, web
315   review or the mailing list.
316
317 * If the patch fixes a bug in bugzilla, please include the PR# in the message.
318
319 * `Attribution of Changes`_ should be in a separate line, after the end of
320   the body, as simple as "Patch by John Doe.". This is how we officially
321   handle attribution, and there are automated processes that rely on this
322   format.
323
324 * Text formatting and spelling should follow the same rules as documentation
325   and in-code comments, ex. capitalization, full stop, etc.
326
327 * If the commit is a bug fix on top of another recently committed patch, or a
328   revert or reapply of a patch, include the svn revision number of the prior
329   related commit. This could be as simple as "Revert rNNNN because it caused
330   PR#".
331
332 For minor violations of these recommendations, the community normally favors
333 reminding the contributor of this policy over reverting. Minor corrections and
334 omissions can be handled by sending a reply to the commits mailing list.
335
336 Obtaining Commit Access
337 -----------------------
338
339 We grant commit access to contributors with a track record of submitting high
340 quality patches.  If you would like commit access, please send an email to
341 `Chris <mailto:sabre@nondot.org>`_ with the following information:
342
343 #. The user name you want to commit with, e.g. "hacker".
344
345 #. The full name and email address you want message to llvm-commits to come
346    from, e.g. "J. Random Hacker <hacker@yoyodyne.com>".
347
348 #. A "password hash" of the password you want to use, e.g. "``2ACR96qjUqsyM``".
349    Note that you don't ever tell us what your password is; you just give it to
350    us in an encrypted form.  To get this, run "``htpasswd``" (a utility that
351    comes with apache) in crypt mode (often enabled with "``-d``"), or find a web
352    page that will do it for you.
353
354 Once you've been granted commit access, you should be able to check out an LLVM
355 tree with an SVN URL of "https://username@llvm.org/..." instead of the normal
356 anonymous URL of "http://llvm.org/...".  The first time you commit you'll have
357 to type in your password.  Note that you may get a warning from SVN about an
358 untrusted key; you can ignore this.  To verify that your commit access works,
359 please do a test commit (e.g. change a comment or add a blank line).  Your first
360 commit to a repository may require the autogenerated email to be approved by a
361 mailing list.  This is normal and will be done when the mailing list owner has
362 time.
363
364 If you have recently been granted commit access, these policies apply:
365
366 #. You are granted *commit-after-approval* to all parts of LLVM.  To get
367    approval, submit a `patch`_ to `llvm-commits
368    <http://lists.llvm.org/mailman/listinfo/llvm-commits>`_. When approved,
369    you may commit it yourself.
370
371 #. You are allowed to commit patches without approval which you think are
372    obvious. This is clearly a subjective decision --- we simply expect you to
373    use good judgement.  Examples include: fixing build breakage, reverting
374    obviously broken patches, documentation/comment changes, any other minor
375    changes.
376
377 #. You are allowed to commit patches without approval to those portions of LLVM
378    that you have contributed or maintain (i.e., have been assigned
379    responsibility for), with the proviso that such commits must not break the
380    build.  This is a "trust but verify" policy, and commits of this nature are
381    reviewed after they are committed.
382
383 #. Multiple violations of these policies or a single egregious violation may
384    cause commit access to be revoked.
385
386 In any case, your changes are still subject to `code review`_ (either before or
387 after they are committed, depending on the nature of the change).  You are
388 encouraged to review other peoples' patches as well, but you aren't required
389 to do so.
390
391 .. _discuss the change/gather consensus:
392
393 Making a Major Change
394 ---------------------
395
396 When a developer begins a major new project with the aim of contributing it back
397 to LLVM, they should inform the community with an email to the `llvm-dev
398 <http://lists.llvm.org/mailman/listinfo/llvm-dev>`_ email list, to the extent
399 possible. The reason for this is to:
400
401 #. keep the community informed about future changes to LLVM,
402
403 #. avoid duplication of effort by preventing multiple parties working on the
404    same thing and not knowing about it, and
405
406 #. ensure that any technical issues around the proposed work are discussed and
407    resolved before any significant work is done.
408
409 The design of LLVM is carefully controlled to ensure that all the pieces fit
410 together well and are as consistent as possible. If you plan to make a major
411 change to the way LLVM works or want to add a major new extension, it is a good
412 idea to get consensus with the development community before you start working on
413 it.
414
415 Once the design of the new feature is finalized, the work itself should be done
416 as a series of `incremental changes`_, not as a long-term development branch.
417
418 .. _incremental changes:
419
420 Incremental Development
421 -----------------------
422
423 In the LLVM project, we do all significant changes as a series of incremental
424 patches.  We have a strong dislike for huge changes or long-term development
425 branches.  Long-term development branches have a number of drawbacks:
426
427 #. Branches must have mainline merged into them periodically.  If the branch
428    development and mainline development occur in the same pieces of code,
429    resolving merge conflicts can take a lot of time.
430
431 #. Other people in the community tend to ignore work on branches.
432
433 #. Huge changes (produced when a branch is merged back onto mainline) are
434    extremely difficult to `code review`_.
435
436 #. Branches are not routinely tested by our nightly tester infrastructure.
437
438 #. Changes developed as monolithic large changes often don't work until the
439    entire set of changes is done.  Breaking it down into a set of smaller
440    changes increases the odds that any of the work will be committed to the main
441    repository.
442
443 To address these problems, LLVM uses an incremental development style and we
444 require contributors to follow this practice when making a large/invasive
445 change.  Some tips:
446
447 * Large/invasive changes usually have a number of secondary changes that are
448   required before the big change can be made (e.g. API cleanup, etc).  These
449   sorts of changes can often be done before the major change is done,
450   independently of that work.
451
452 * The remaining inter-related work should be decomposed into unrelated sets of
453   changes if possible.  Once this is done, define the first increment and get
454   consensus on what the end goal of the change is.
455
456 * Each change in the set can be stand alone (e.g. to fix a bug), or part of a
457   planned series of changes that works towards the development goal.
458
459 * Each change should be kept as small as possible. This simplifies your work
460   (into a logical progression), simplifies code review and reduces the chance
461   that you will get negative feedback on the change. Small increments also
462   facilitate the maintenance of a high quality code base.
463
464 * Often, an independent precursor to a big change is to add a new API and slowly
465   migrate clients to use the new API.  Each change to use the new API is often
466   "obvious" and can be committed without review.  Once the new API is in place
467   and used, it is much easier to replace the underlying implementation of the
468   API.  This implementation change is logically separate from the API
469   change.
470
471 If you are interested in making a large change, and this scares you, please make
472 sure to first `discuss the change/gather consensus`_ then ask about the best way
473 to go about making the change.
474
475 Attribution of Changes
476 ----------------------
477
478 When contributors submit a patch to an LLVM project, other developers with
479 commit access may commit it for the author once appropriate (based on the
480 progression of code review, etc.). When doing so, it is important to retain
481 correct attribution of contributions to their contributors. However, we do not
482 want the source code to be littered with random attributions "this code written
483 by J. Random Hacker" (this is noisy and distracting). In practice, the revision
484 control system keeps a perfect history of who changed what, and the CREDITS.txt
485 file describes higher-level contributions. If you commit a patch for someone
486 else, please follow the attribution of changes in the simple manner as outlined
487 by the `commit messages`_ section. Overall, please do not add contributor names
488 to the source code.
489
490 Also, don't commit patches authored by others unless they have submitted the
491 patch to the project or you have been authorized to submit them on their behalf
492 (you work together and your company authorized you to contribute the patches,
493 etc.). The author should first submit them to the relevant project's commit
494 list, development list, or LLVM bug tracker component. If someone sends you
495 a patch privately, encourage them to submit it to the appropriate list first.
496
497
498 IR Backwards Compatibility
499 --------------------------
500
501 When the IR format has to be changed, keep in mind that we try to maintain some
502 backwards compatibility. The rules are intended as a balance between convenience
503 for llvm users and not imposing a big burden on llvm developers:
504
505 * The textual format is not backwards compatible. We don't change it too often,
506   but there are no specific promises.
507
508 * Additions and changes to the IR should be reflected in
509   ``test/Bitcode/compatibility.ll``.
510
511 * The bitcode format produced by a X.Y release will be readable by all
512   following X.Z releases and the (X+1).0 release.
513
514 * After each X.Y release, ``compatibility.ll`` must be copied to
515   ``compatibility-X.Y.ll``. The corresponding bitcode file should be assembled
516   using the X.Y build and committed as ``compatibility-X.Y.ll.bc``.
517
518 * Newer releases can ignore features from older releases, but they cannot
519   miscompile them. For example, if nsw is ever replaced with something else,
520   dropping it would be a valid way to upgrade the IR.
521
522 * Debug metadata is special in that it is currently dropped during upgrades.
523
524 * Non-debug metadata is defined to be safe to drop, so a valid way to upgrade
525   it is to drop it. That is not very user friendly and a bit more effort is
526   expected, but no promises are made.
527
528 C API Changes
529 ----------------
530
531 * Stability Guarantees: The C API is, in general, a “best effort” for stability.
532 This means that we make every attempt to keep the C API stable, but that
533 stability will be limited by the abstractness of the interface and the stability
534 of the C++ API that it wraps. In practice, this means that things like “create
535 debug info” or “create this type of instruction” are likely to be less stable
536 than “take this IR file and JIT it for my current machine”.
537
538 * Release stability: We won’t break the C API on the release branch with patches
539 that go on that branch, with the exception that if we will fix an unintentional
540 C API break that will keep the release consistent with both the previous and next
541 release.
542
543 * Testing: Patches to the C API are expected to come with tests just like any
544 other patch.
545
546 * Including new things into the API: If an LLVM subcomponent has a C API already
547 included, then expanding that C API is acceptable. Adding C API for subcomponents
548 that don't currently have one is fine, and the details of how best to design that
549 API should be discussed on the mailing list.
550
551 * Documentation: Any changes to the C API are required to be documented in the
552 release notes so that it’s clear to external users who do not follow the project
553 how the C API is changing and evolving.
554
555 .. _copyright-license-patents:
556
557 Copyright, License, and Patents
558 ===============================
559
560 .. note::
561
562    This section deals with legal matters but does not provide legal advice.  We
563    are not lawyers --- please seek legal counsel from an attorney.
564
565 This section addresses the issues of copyright, license and patents for the LLVM
566 project.  The copyright for the code is held by the individual contributors of
567 the code and the terms of its license to LLVM users and developers is the
568 `University of Illinois/NCSA Open Source License
569 <http://www.opensource.org/licenses/UoI-NCSA.php>`_ (with portions dual licensed
570 under the `MIT License <http://www.opensource.org/licenses/mit-license.php>`_,
571 see below).  As contributor to the LLVM project, you agree to allow any
572 contributions to the project to licensed under these terms.
573
574 Copyright
575 ---------
576
577 The LLVM project does not require copyright assignments, which means that the
578 copyright for the code in the project is held by its respective contributors who
579 have each agreed to release their contributed code under the terms of the `LLVM
580 License`_.
581
582 An implication of this is that the LLVM license is unlikely to ever change:
583 changing it would require tracking down all the contributors to LLVM and getting
584 them to agree that a license change is acceptable for their contribution.  Since
585 there are no plans to change the license, this is not a cause for concern.
586
587 As a contributor to the project, this means that you (or your company) retain
588 ownership of the code you contribute, that it cannot be used in a way that
589 contradicts the license (which is a liberal BSD-style license), and that the
590 license for your contributions won't change without your approval in the
591 future.
592
593 .. _LLVM License:
594
595 License
596 -------
597
598 We intend to keep LLVM perpetually open source and to use a liberal open source
599 license. **As a contributor to the project, you agree that any contributions be
600 licensed under the terms of the corresponding subproject.** All of the code in
601 LLVM is available under the `University of Illinois/NCSA Open Source License
602 <http://www.opensource.org/licenses/UoI-NCSA.php>`_, which boils down to
603 this:
604
605 * You can freely distribute LLVM.
606 * You must retain the copyright notice if you redistribute LLVM.
607 * Binaries derived from LLVM must reproduce the copyright notice (e.g. in an
608   included readme file).
609 * You can't use our names to promote your LLVM derived products.
610 * There's no warranty on LLVM at all.
611
612 We believe this fosters the widest adoption of LLVM because it **allows
613 commercial products to be derived from LLVM** with few restrictions and without
614 a requirement for making any derived works also open source (i.e.  LLVM's
615 license is not a "copyleft" license like the GPL). We suggest that you read the
616 `License <http://www.opensource.org/licenses/UoI-NCSA.php>`_ if further
617 clarification is needed.
618
619 In addition to the UIUC license, the runtime library components of LLVM
620 (**compiler_rt, libc++, and libclc**) are also licensed under the `MIT License
621 <http://www.opensource.org/licenses/mit-license.php>`_, which does not contain
622 the binary redistribution clause.  As a user of these runtime libraries, it
623 means that you can choose to use the code under either license (and thus don't
624 need the binary redistribution clause), and as a contributor to the code that
625 you agree that any contributions to these libraries be licensed under both
626 licenses.  We feel that this is important for runtime libraries, because they
627 are implicitly linked into applications and therefore should not subject those
628 applications to the binary redistribution clause. This also means that it is ok
629 to move code from (e.g.)  libc++ to the LLVM core without concern, but that code
630 cannot be moved from the LLVM core to libc++ without the copyright owner's
631 permission.
632
633 Note that the LLVM Project does distribute dragonegg, **which is
634 GPL.** This means that anything "linked" into dragonegg must itself be compatible
635 with the GPL, and must be releasable under the terms of the GPL.  This implies
636 that **any code linked into dragonegg and distributed to others may be subject to
637 the viral aspects of the GPL** (for example, a proprietary code generator linked
638 into dragonegg must be made available under the GPL).  This is not a problem for
639 code already distributed under a more liberal license (like the UIUC license),
640 and GPL-containing subprojects are kept in separate SVN repositories whose
641 LICENSE.txt files specifically indicate that they contain GPL code.
642
643 We have no plans to change the license of LLVM.  If you have questions or
644 comments about the license, please contact the `LLVM Developer's Mailing
645 List <mailto:llvm-dev@lists.llvm.org>`_.
646
647 Patents
648 -------
649
650 To the best of our knowledge, LLVM does not infringe on any patents (we have
651 actually removed code from LLVM in the past that was found to infringe).  Having
652 code in LLVM that infringes on patents would violate an important goal of the
653 project by making it hard or impossible to reuse the code for arbitrary purposes
654 (including commercial use).
655
656 When contributing code, we expect contributors to notify us of any potential for
657 patent-related trouble with their changes (including from third parties).  If
658 you or your employer own the rights to a patent and would like to contribute
659 code to LLVM that relies on it, we require that the copyright owner sign an
660 agreement that allows any other user of LLVM to freely use your patent.  Please
661 contact the `LLVM Foundation Board of Directors <mailto:board@llvm.org>`_ for more
662 details.