<div class="doc_text">
-<p>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:</p>
+
<p>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:</p>
<ol>
<li>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.</li>
the time the patch was created and the time it is applied.</li>
<li>Patches should be made with this command:
- <pre>svn diff -x -u</pre>
- or with the utility <tt>utils/mkpatch</tt>, which makes it easy to read the
- diff.</li>
+ <div class="doc_code"><pre>svn diff -x -u</pre></div>
+ or with the utility <tt>utils/mkpatch</tt>, which makes it easy to read the
+ diff.</li>
<li>Patches should not include differences in generated code such as the
- code generated by <tt>flex</tt>, <tt>bison</tt> or <tt>tblgen</tt>. The
+ code generated by <tt>autoconf</tt> or <tt>tblgen</tt>. The
<tt>utils/mkpatch</tt> utility takes care of this for you.</li>
-
</ol>
<p>When sending a patch to a mailing list, it is a good idea to send it as an
<em>attachment</em> 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).</p>
+
+ <p><em>For Thunderbird users:</em> Before submitting a patch, please open
+ <em>Preferences → Advanced → General → Config Editor</em>,
+ find the key <tt>mail.content_disposition_type</tt>, and set its value to
+ <tt>1</tt>. Without this setting, Thunderbird sends your attachment using
+ <tt>Content-Disposition: inline</tt> rather than <tt>Content-Disposition:
+ attachment</tt>. Apple Mail gamely displays such a file inline, making it
+ difficult to work with for reviewers using that program.</p>
</div>
<!-- _______________________________________________________________________ -->
<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 the change (more invasive changes require more testing). A reasonable
- subset is "<tt>llvm-test/MultiSource/Benchmarks</tt>".</li>
+ subset might be something like
+ "<tt>llvm-test/MultiSource/Benchmarks</tt>".</li>
</ol>
<p>Additionally, the committer is responsible for addressing any problems
found in the future that the change is responsible for. For example:</p>
<p>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 Guy" (this is noisy
- and distracting. In practice, the revision control system keeps a perfect
- history of who change what, and the CREDITS.txt file describes higher-level
- contributions.</p>
+ 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 Guy!" in the commit message.</p>
- <p>Overall, please do not add contributor names to the source base.</p>
+ <p>Overall, please do not add contributor names to the source code.</p>
</div>
Illinois/NCSA Open Source License</a>.</p>
<div class="doc_notes">
- <p><b>NOTE: This section deals with legal matters but does not provide
- legal advice. We are not lawyers, please seek legal counsel from an
- attorney.</b></p>
+ <p style="text-align:center;font-weight:bold">NOTE: This section
+ deals with legal matters but does not provide legal advice. We are not
+ lawyers, please seek legal counsel from an attorney.</p>
</div>
</div>
<hr>
<address>
<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
- src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
+ src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
<a href="http://validator.w3.org/check/referer"><img
- src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
+ src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
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>
projects / oota-llvm.git / blobdiff