From 0cca50c912b4afda1aad22407f2ccd411d2f9f9f Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Mon, 19 Feb 2007 06:57:16 +0000 Subject: [PATCH] more wording changes and some minor additions git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@34413 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/DeveloperPolicy.html | 101 ++++++++++++++++++++++---------------- 1 file changed, 60 insertions(+), 41 deletions(-) diff --git a/docs/DeveloperPolicy.html b/docs/DeveloperPolicy.html index 0818a1502e7..dd1742b383a 100644 --- a/docs/DeveloperPolicy.html +++ b/docs/DeveloperPolicy.html @@ -49,7 +49,7 @@
  • Keep the top of tree CVS/SVN 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 @@ -61,11 +61,11 @@

    Developer Policies
    -

    This section contains policies that pertain generally to regular LLVM +

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

    @@ -110,6 +110,11 @@ utils/mkpatch utility takes care of this for you. + +

    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).

    @@ -128,22 +133,25 @@ 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 goes 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 + a 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 CVS write access can approve it.

    +
    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:

      -
    1. All feature and regression test cases must be added to the +
    2. 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).
      3. @@ -151,16 +159,19 @@ LLVM assembly language unless the feature or regression being tested requires another language (e.g. the bug being fixed or feature being implemented is in the llvm-gcc C++ - front-end). + front-end, in which case it must be written in C++).
    3. Test cases, especially for regressions, should be reduced as much as 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.
      4. -
    4. 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.

    @@ -176,7 +187,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 @@ -185,10 +196,10 @@

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

    -

    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.

    @@ -225,18 +237,23 @@ quality patches. If you would like commit access, please send an email to the 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 your aren't required to.

    @@ -245,20 +262,20 @@ 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:

    1. keep the community informed about future changes to LLVM,
      2. -
    2. avoid duplication of effort by having multiple parties working on the - same thing and not knowing about it, and
      3. +
    3. avoid duplication of effort by preventing multiple parties working on + the same thing and not knowing about it, and
    4. 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 @@ -316,13 +333,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.
    • + new API is in place and used, it is much easier to replace the + underlying implementation of the API. This implementation change is + logically separate from the API change.

    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.

    @@ -345,7 +363,8 @@ Changes 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 file to summarize their contributions.
    • @@ -364,13 +383,12 @@ Changes
    -

    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 and license 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 @@ -428,11 +446,12 @@ Changes

    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 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 + that you any code linked into llvm-gcc and distributed to others 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.

    + 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