diff options
Diffstat (limited to 'docs/DeveloperPolicy.html')
| -rw-r--r-- | docs/DeveloperPolicy.html | 54 |
1 files changed, 31 insertions, 23 deletions
diff --git a/docs/DeveloperPolicy.html b/docs/DeveloperPolicy.html index 37bfb8990e01b..47352009ea043 100644 --- a/docs/DeveloperPolicy.html +++ b/docs/DeveloperPolicy.html @@ -43,7 +43,8 @@ is to eliminate miscommunication, rework, and confusion that might arise from the distributed nature of LLVM's development. By stating the policy in clear terms, we hope each developer can know ahead of time what to expect when - making LLVM contributions.</p> + making LLVM contributions. This policy covers all llvm.org subprojects, + including Clang, LLDB, etc.</p> <p>This policy is also designed to accomplish the following objectives:</p> <ol> @@ -77,17 +78,28 @@ <!-- _______________________________________________________________________ --> <div class="doc_subsection"> <a name="informed">Stay Informed</a> </div> <div class="doc_text"> -<p>Developers should stay informed by reading at least the - <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvmdev</a> email - list. If you are doing anything more than just casual work on LLVM, it is - suggested that you also subscribe to the - <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a> - list and pay attention to changes being made by others.</p> +<p>Developers should stay informed by reading at least the "dev" mailing list + for the projects you are interested in, such as + <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvmdev</a> for + LLVM, <a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev</a> + for Clang, or <a + href="http://lists.cs.uiuc.edu/mailman/listinfo/lldb-dev">lldb-dev</a> + for LLDB. If you are doing anything more than just casual work on LLVM, it + is suggested that you also subscribe to the "commits" mailing list for the + subproject you're interested in, such as + <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a>, + <a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits</a>, + or <a href="http://lists.cs.uiuc.edu/mailman/listinfo/lldb-commits">lldb-commits</a>. + Reading the "commits" list and paying attention to changes being made by + others is a good way to see what other people are interested in and watching + the flow of the project as a whole.</p> <p>We recommend that active developers register an email account with <a href="http://llvm.org/bugs/">LLVM Bugzilla</a> and preferably subscribe to the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmbugs">llvm-bugs</a> - email list to keep track of bugs and enhancements occurring in LLVM.</p> + email list to keep track of bugs and enhancements occurring in LLVM. We + really appreciate people who are proactive at catching incoming bugs in their + components and dealing with them promptly.</p> </div> <!-- _______________________________________________________________________ --> @@ -107,18 +119,13 @@ patches may not apply correctly if the underlying code changes between the time the patch was created and the time it is applied.</li> - <li>Patches should be made with this command: -<div class="doc_code"> -<pre> -svn diff -</pre> -</div> - or with the utility <tt>utils/mkpatch</tt>, which makes it easy to read - the diff.</li> + <li>Patches should be made with <tt>svn diff</tt>, or similar. If you use + a different tool, make sure it uses the <tt>diff -u</tt> format and + that it doesn't contain clutter which makes it hard to read.</li> - <li>Patches should not include differences in generated code such as the code - generated by <tt>autoconf</tt> or <tt>tblgen</tt>. The - <tt>utils/mkpatch</tt> utility takes care of this for you.</li> + <li>If you are modifying generated files, such as the top-level + <tt>configure</tt> script, please separate out those changes into + a separate patch from the rest of your changes.</li> </ol> <p>When sending a patch to a mailing list, it is a good idea to send it as an @@ -239,8 +246,9 @@ svn diff them short.</li> </ol> -<p>Note that llvm/test is designed for regression and small feature tests - only. More extensive test cases (e.g., entire applications, benchmarks, etc) +<p>Note that llvm/test and clang/test are designed for regression and small + feature tests only. More extensive test cases (e.g., entire applications, + benchmarks, etc) should be added to the <tt>llvm-test</tt> test suite. The llvm-test suite is for coverage (correctness, performance, etc) testing, not feature or regression testing.</p> @@ -263,7 +271,7 @@ svn diff testcase</a> so we know if the fix/feature ever regresses in the future.</li> - <li>Code must pass the dejagnu (<tt>llvm/test</tt>) test suite.</li> + <li>Code must pass the <tt>llvm/test</tt> test suite.</li> <li>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 @@ -601,7 +609,7 @@ Changes</a></div> Written by the <a href="mailto:llvm-oversight@cs.uiuc.edu">LLVM Oversight Group</a><br> <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + Last modified: $Date: 2010-09-02 02:09:17 +0200 (Thu, 02 Sep 2010) $ </address> </body> </html> |