X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FDeveloperPolicy.html;h=883509b4ffe354b35424579ee2b023a239ece10a;hb=e86ce7d94abaf7883a5d84dcb9a79c118b63672b;hp=e3e37f0bc1fc91b2f54ef075dd13d2cb57b177e6;hpb=8bb16ff2bbce53daf43693674ff2801e61458703;p=oota-llvm.git diff --git a/docs/DeveloperPolicy.html b/docs/DeveloperPolicy.html index e3e37f0bc1f..883509b4ffe 100644 --- a/docs/DeveloperPolicy.html +++ b/docs/DeveloperPolicy.html @@ -10,28 +10,28 @@

LLVM Developer Policy

Introduction
General Policies +
Developer Policies
Copyright and License +
Copyright, License, and Patents

Written by LLVM Oversight Team

Written by the LLVM Oversight Team

Introduction

@@ -47,10 +47,10 @@

Attract both users and developers to the LLVM project.
Make life as simple and easy for contributors as possible.
Keep the top of tree CVS/SVN trees as stable as possible.
Keep the top of Subversion trees as stable as possible.

This policy is aimed at regular contributors to LLVM. People interested in +

This policy is aimed at frequent contributors to LLVM. People interested in contributing one-off patches can do so in an informal way by sending them to the llvm-commits mailing list and engaging another developer to see it through @@ -59,14 +59,15 @@ -

General Policies

Developer Policies

This section contains policies that pertain generally to regular LLVM - developers. We always welcome random patches from - people who do not routinely contribute to LLVM, but expect more from regular - contributors to keep the system as efficient as possible for everyone. - Regular LLVM developers are expected to meet the following obligations in +

This section contains policies that pertain to frequent LLVM + developers. We always welcome one-off patches from + people who do not routinely contribute to LLVM, but we expect more from + frequent contributors to keep the system as efficient as possible for + everyone. + Frequent LLVM contributors are expected to meet the following requirements in order for LLVM to maintain a high standard of quality.

@@ -93,27 +94,28 @@

When making a patch for review, the goal is to make it as easy for the reviewer to read it as possible. As such, we recommend that you:

Make your patch against the CVS HEAD (main development trunk), - not a branch, and not an old version of LLVM. This makes it easy to - apply the patch.
Make your patch against the Subversion trunk, not a branch, and not an + old version of LLVM. This makes it easy to apply the patch.
Similarly, patches should be submitted soon after they are generated. Old patches may not apply correctly if the underlying code changes between the time the patch was created and the time it is applied.
Patches should be made with this command: -
```
cvs diff -Ntdup -5
```
- or with the utility utils/mkpatch. to make it easy to read the +
```
svn diff -x -u
```
+ or with the utility utils/mkpatch, which makes it easy to read the diff.
Patches should not include differences in generated code such as the code generated by flex, bison or tblgen. The utils/mkpatch utility takes care of this for you.
Contributions must not knowingly infringe on any patents. To the best of - our knowledge, LLVM is free of any existing patent violations and it is our - intent to keep it that way.

+ +

When sending a patch to a mailing list, it is a good idea to send it as an + attachment to the message, not embedded into the text of the + message. This ensures that your mailer will not mangle the patch when it + sends it (e.g. by making whitespace changes or by wrapping lines).

@@ -132,22 +134,69 @@ reviewed after commit.

The developer responsible for a code change is also responsible for making all necessary review-related changes.

Code review can be an iterative process, which goes until all the patch +

Code review can be an iterative process, which continues until the patch is ready to be committed.

Developers should participate in code reviews as both a reviewer and - a reviewee. We don't have a dedicated team of reviewers. If someone is - kind enough to review your code, you should return the favor for someone - else.

+ +

Developers should participate in code reviews as both reviewers and + reviewees. If someone is kind enough to review your code, you should + return the favor for someone else. Note that anyone is welcome to review + and give feedback on a patch, but only people with Subversion write access + can approve it.

+ + + + +

Code Owners

+ +

The LLVM Project relies on two features of its process to maintain rapid + development in addition to the high quality of its source base: the + combination of code review plus post-commit review for trusted maintainers. + Having both is a great way for the project to take advantage of the fact + that most people do the right thing most of the time, and only commit + patches without pre-commit review when they are confident they are + right.

+ +

The trick to this is that the project has to guarantee that all patches + that are committed are reviewed after they go in: you don't want everyone + to assume someone else will review it, allowing the patch to go unreviewed. + To solve this problem, we have a notion of an 'owner' for a piece of the + code. The sole responsibility of a code owner is to ensure that a commit + to their area of the code is appropriately reviewed, either by themself or + by someone else. The current code owners are:

+ +

Anton Korobeynikov: Exception handling, debug information, and + Windows codegen.
Duncan Sands: llvm-gcc 4.2.
Evan Cheng: Code generator and all targets.
Chris Lattner: Everything else.

+ +

Note that code ownership is completely different than reviewers: anyone can + review a piece of code, and we welcome code review from anyone who is + interested. Code owners are the "last line of defense" to guarantee that + all patches that are committed are actually reviewed.

+ +

Being a code owner is a somewhat unglamorous position, but it is incredibly + important for the ongoing success of the project. Because people get busy, + interests change, and unexpected things happen, code ownership is purely + opt-in, and anyone can choose to resign their "title" at any time. For now, + we do not have an official policy on how one gets elected to be a code + owner. +

Test Cases

Developers are required to create test cases for any bugs fixed and any new - features added. The following policies apply:

+ features added. Some tips for getting your testcase approved:

All feature and regression test cases must be added to the +
All feature and regression test cases are added to the llvm/test directory. The appropriate sub-directory should be selected (see the Testing Guide for details).

LLVM assembly language

Test cases, especially for regressions, should be reduced as much as - possible, by bugpoint or + possible, by bugpoint or manually. It is unacceptable to place an entire failing program into llvm/test as this creates a time-to-test burden on all developers. Please keep them short.
More extensive test cases (applications, benchmarks, etc.) should be - added to the llvm-test test suite. This test suite is for - coverage: not features or regressions.

+ +

Note that llvm/test is designed for regression and small feature tests + only. More extensive test cases (e.g., entire applications, benchmarks, + etc) should be added to the llvm-test test suite. The llvm-test + suite is for coverage (correctness, performance, etc) testing, not feature + or regression testing.

@@ -180,7 +232,7 @@

Bug fixes and new features should include a testcase so we know if the fix/feature ever regresses in the future.

Code must pass the dejagnu (llvm/test) test suite.

Code must pass the dejagnu (llvm/test) test suite.

The code must not cause regressions on a reasonable subset of llvm-test, where "reasonable" depends on the contributor's judgement and the scope of the change (more invasive changes require more testing). A reasonable @@ -189,10 +241,10 @@

Additionally, the committer is responsible for addressing any problems found in the future that the change is responsible for. For example:

The code should compile cleanly on all platforms.
The changes should not cause regressions in the llvm-test - suite including SPEC CINT2000, SPEC CFP2000, SPEC CINT2006, and - SPEC CFP2006.
The code should compile cleanly on all supported platforms.
The changes should not cause any correctness regressions in the + llvm-test suite and must not cause any major performance + regressions.
The change set should not cause performance or correctness regressions for the LLVM tools.
The changes should not cause performance or correctness regressions in @@ -201,8 +253,9 @@ bugs that result from your change.

We prefer for this to be handled before submission but understand that it's - not possible to test all of this for every submission. Our nightly testing +

We prefer for this to be handled before submission but understand that it + isn't possible to test all of this for every submission. Our nightly + testing infrastructure normally finds these problems. A good rule of thumb is to check the nightly testers for regressions the day after your change.

@@ -219,28 +272,55 @@

We grant commit access to contributors with a track record of submitting high -quality patches. If you would like commit access, please send an email to the -LLVM oversight group.

+quality patches. If you would like commit access, please send an email to +Chris with the following information:

+ +

The user name you want to commit with, e.g. "sabre".
The full name and email address you want message to llvm-commits to come + from, e.g. "Chris Lattner <sabre@nondot.org>".
A "password hash" of the password you want to use, e.g. "2ACR96qjUqsyM". + Note that you don't ever tell us what your password is, you just give it + to us in an encrypted form. To get this, run "htpasswd" (a utility that + comes with apache) in crypt mode (often enabled with "-d"), or find a web + page that will do it for you.

+ +

Once you've been granted commit access, you should be able to check out an + LLVM tree with an SVN URL of "https://username@llvm.org/..." instead of the + normal anonymous URL of "http://llvm.org/...". The first time you commit + you'll have to type in your password. Note that you may get a warning from + SVN about an untrusted key, you can ignore this. To verify that your commit + access works, please do a test commit (e.g. change a comment or add a blank + line). Your first commit to a repository may require the autogenerated email + to be approved by a mailing list. This is normal, and will be done when + the mailing list owner has time.

If you have recently been granted commit access, these policies apply:

You are granted commit-after-approval to all parts of LLVM. To get approval, submit a patch to llvm-commits. When approved you may commit it yourself.
You are allowed to commit patches without approval which you think are - obvious. This is clearly a subjective decision. We simply expect you to - use good judgement. Examples include: fixing build breakage, reverting + obvious. This is clearly a subjective decision — we simply expect you + to use good judgement. Examples include: fixing build breakage, reverting obviously broken patches, documentation/comment changes, any other minor changes.
You are allowed to commit patches without approval to those portions - of LLVM that you have contributed or maintain (have been assigned + of LLVM that you have contributed or maintain (i.e., have been assigned responsibility for), with the proviso that such commits must not break the build. This is a "trust but verify" policy and commits of this nature are reviewed after they are committed.
Multiple violations of these policies or a single egregious violation may cause commit access to be revoked.

+ +

In any case, your changes are still subject to code +review (either before or after they are committed, depending on the nature +of the change). You are encouraged to review other peoples' patches as well, +but you aren't required to.

@@ -249,31 +329,36 @@ quality patches. If you would like commit access, please send an email to the

When a developer begins a major new project with the aim of contributing it back to LLVM, s/he should inform the community with an email to - the llvm-dev + the llvmdev email list, to the extent possible. The reason for this is to:

keep the community informed about future changes to LLVM,
avoid duplication of effort by having multiple parties working on the - same thing and not knowing about it, and
avoid duplication of effort by preventing multiple parties working on + the same thing and not knowing about it, and
ensure that any technical issues around the proposed work are discussed and resolved before any significant work is done.

The design of LLVM is carefully controlled to ensure that all the pieces fit together well and are as consistent as possible. If you plan to make a - major change to the way LLVM works or - a major new extension, it is a good idea to get consensus with the development + major change to the way LLVM works or want to add a major new extension, it + is a good idea to get consensus with the development community before you start working on it.

Once the design of the new feature is finalized, the work itself should be + done as a series of incremental changes, not as + a long-term development branch.

Incremental Development +

Incremental Development

Once the design of the new feature is finalized, the work itself should be - done as a series of incremental changes, not as a long-term development - branch. Long-term development branches have a number of drawbacks:

In the LLVM project, we do all significant changes as a series of + incremental patches. We have a strong dislike for huge changes or + long-term development branches. Long-term development branches have a + number of drawbacks:

Branches must have mainline merged into them periodically. If the branch @@ -315,13 +400,14 @@ quality patches. If you would like commit access, please send an email to the
Often, an independent precursor to a big change is to add a new API and slowly migrate clients to use the new API. Each change to use the new API is often "obvious" and can be committed without review. Once the - new API is in place and used, it is often easy to replace the underlying - implementation of the API.

If you are interested in making a large change, and this scares you, please make sure to first discuss the change/gather - consensus then feel free to ask about the best way to go about making + consensus then ask about the best way to go about making the change.

@@ -340,13 +426,14 @@ Changes

There should be only one name at the top of the file and it should be the person who created the file.

Placing your name in the file does not imply copyright: it is only used to attribute the file to + href="#clp">copyright: it is only used to attribute the file to its original author.

Developers should be aware that after some time has passed, the name at the top of a file may become meaningless as maintenance/ownership of files - changes. Revision control keeps an accurate history of contributions.

+ changes. Despite this, once set, the attribution of a file never changes. + Revision control keeps an accurate history of contributions.

Developers should maintain their entry in the - CREDITS.txt + CREDITS.txt file to summarize their contributions.

Commit comments should contain correct attribution of the person who submitted the patch if that person is not the committer (i.e. when a @@ -357,24 +444,24 @@ Changes -

+ Copyright, License, and Patents +

We address here the issues of copyright and license for the LLVM project. - The object of the copyright and license is the LLVM source code and - documentation. +

This section addresses the issues of copyright, license and patents for + the LLVM project. Currently, the University of Illinois is the LLVM copyright holder and the terms of its license to LLVM users and developers is the University of - Illinois/NCSA Open Source License. + Illinois/NCSA Open Source License.

NOTE: This section deals with legal matters but does not provide - official legal advice. We are not lawyers, please seek legal counsel from an + legal advice. We are not lawyers, please seek legal counsel from an attorney.

@@ -421,21 +508,43 @@ Changes read the License if further clarification is needed.

Note that the LLVM Project does distribute some code that includes GPL - software (notably, llvm-gcc which is based on the GCC GPL source base). - This means that anything "linked" into to llvm-gcc must itself be compatible +

Note that the LLVM Project does distribute llvm-gcc, which is GPL. + This means that anything "linked" into llvm-gcc must itself be compatible with the GPL, and must be releasable under the terms of the GPL. This implies - that you any code linked into llvm-gcc and distributed may be subject to - the viral aspects of the GPL. This is not a problem for the main LLVM - distribution (which is already licensed under a more liberal license), but may - be a problem if you intend to do commercial development without redistributing - your source code.

+ that any code linked into llvm-gcc and distributed to others may be subject + to the viral aspects of the GPL (for example, a proprietary code generator + linked into llvm-gcc must be made available under the GPL). This is not a + problem for code already distributed under a more liberal license (like the + UIUC license), and does not affect code generated by llvm-gcc. It may be a + problem if you intend to base commercial development on llvm-gcc without + redistributing your source code.

We have no plans to change the license of LLVM. If you have questions or comments about the license, please contact the LLVM Oversight Group.

+ + +

Patents

+ +

To the best of our knowledge, LLVM does not infringe on any patents (we have + actually removed code from LLVM in the past that was found to infringe). + Having code in LLVM that infringes on patents would violate an important + goal of the project by making it hard or impossible to reuse the code for + arbitrary purposes (including commercial use).

+ +

When contributing code, we expect contributors to notify us of any potential + for patent-related trouble with their changes. If you own the rights to a + patent and would like to contribute code to LLVM that relies on it, we + require that you sign an agreement that allows any other user of LLVM to + freely use your patent. Please contact the oversight group for more + details.

+ +

Developer Agreements

@@ -453,7 +562,7 @@ Changes

src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!">

- Written by: the + Written by the LLVM Oversight Group
The LLVM Compiler Infrastructure
Last modified: $Date$