diff options
author | Stephen Hines <srhines@google.com> | 2014-04-23 16:57:46 -0700 |
---|---|---|
committer | Stephen Hines <srhines@google.com> | 2014-04-24 15:53:16 -0700 |
commit | 36b56886974eae4f9c5ebc96befd3e7bfe5de338 (patch) | |
tree | e6cfb69fbbd937f450eeb83bfb83b9da3b01275a /docs/DeveloperPolicy.rst | |
parent | 69a8640022b04415ae9fac62f8ab090601d8f889 (diff) | |
download | external_llvm-36b56886974eae4f9c5ebc96befd3e7bfe5de338.zip external_llvm-36b56886974eae4f9c5ebc96befd3e7bfe5de338.tar.gz external_llvm-36b56886974eae4f9c5ebc96befd3e7bfe5de338.tar.bz2 |
Update to LLVM 3.5a.
Change-Id: Ifadecab779f128e62e430c2b4f6ddd84953ed617
Diffstat (limited to 'docs/DeveloperPolicy.rst')
-rw-r--r-- | docs/DeveloperPolicy.rst | 53 |
1 files changed, 33 insertions, 20 deletions
diff --git a/docs/DeveloperPolicy.rst b/docs/DeveloperPolicy.rst index ea5a7d1..b9ac576 100644 --- a/docs/DeveloperPolicy.rst +++ b/docs/DeveloperPolicy.rst @@ -74,8 +74,8 @@ that notices of confidentiality or non-disclosure cannot be respected. .. _patch: .. _one-off patches: -Making a Patch --------------- +Making and Submitting a Patch +----------------------------- 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: @@ -97,6 +97,12 @@ to read it as possible. As such, we recommend that you: script, please separate out those changes into a separate patch from the rest of your changes. +Once your patch is ready, submit it by emailing it to the appropriate project's +commit mailing list (or commit it directly if applicable). Alternatively, some +patches get sent to the project's development list or component of the LLVM bug +tracker, but the commit list is the primary place for reviews and should +generally be preferred. + 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 @@ -125,7 +131,8 @@ software. We generally follow these policies: #. All developers are required to have significant changes reviewed before they are committed to the repository. -#. Code reviews are conducted by email, usually on the llvm-commits list. +#. Code reviews are conducted by email on the relevant project's commit mailing + list, or alternatively on the project's development list or bug tracker. #. Code can be reviewed either before it is committed or after. We expect major changes to be reviewed before being committed, but smaller changes (or @@ -205,13 +212,10 @@ features added. Some tips for getting your testcase approved: directory. The appropriate sub-directory should be selected (see the :doc:`Testing Guide <TestingGuide>` for details). -* Test cases should be written in `LLVM assembly language <LangRef.html>`_ - 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, in which case it must be written in C++). +* Test cases should be written in :doc:`LLVM assembly language <LangRef>`. * Test cases, especially for regressions, should be reduced as much as possible, - by `bugpoint <Bugpoint.html>`_ or manually. It is unacceptable to place an + by :doc:`bugpoint <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. @@ -413,15 +417,24 @@ to go about making the change. Attribution of Changes ---------------------- -We believe in correct attribution of contributions to their contributors. -However, we do not want the source code to be littered with random attributions -"this code written by J. Random Hacker" (this is noisy and distracting). In -practice, the revision control system keeps a perfect history of who changed -what, and the CREDITS.txt file describes higher-level contributions. If you -commit a patch for someone else, please say "patch contributed by J. Random -Hacker!" in the commit message. +When contributors submit a patch to an LLVM project, other developers with +commit access may commit it for the author once appropriate (based on the +progression of code review, etc.). When doing so, it is important to retain +correct attribution of contributions to their contributors. However, we do not +want the source code to be littered with random attributions "this code written +by J. Random Hacker" (this is noisy and distracting). In practice, the revision +control system keeps a perfect history of who changed what, and the CREDITS.txt +file describes higher-level contributions. If you commit a patch for someone +else, please say "patch contributed by J. Random Hacker!" in the commit +message. Overall, please do not add contributor names to the source code. + +Also, don't commit patches authored by others unless they have submitted the +patch to the project or you have been authorized to submit them on their behalf +(you work together and your company authorized you to contribute the patches, +etc.). The author should first submit them to the relevant project's commit +list, development list, or LLVM bug tracker component. If someone sends you +a patch privately, encourage them to submit it to the appropriate list first. -Overall, please do not add contributor names to the source code. .. _copyright-license-patents: @@ -501,12 +514,12 @@ to move code from (e.g.) libc++ to the LLVM core without concern, but that code cannot be moved from the LLVM core to libc++ without the copyright owner's permission. -Note that the LLVM Project does distribute llvm-gcc and dragonegg, **which are -GPL.** This means that anything "linked" into llvm-gcc must itself be compatible +Note that the LLVM Project does distribute dragonegg, **which is +GPL.** This means that anything "linked" into dragonegg must itself be compatible with the GPL, and must be releasable under the terms of the GPL. This implies -that **any code linked into llvm-gcc and distributed to others may be subject to +that **any code linked into dragonegg 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 +into dragonegg 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 GPL-containing subprojects are kept in separate SVN repositories whose LICENSE.txt files specifically indicate that they contain GPL code. |