Author: sebor
Date: Sun Jan 15 15:19:10 2006
New Revision: 369277
URL: http://svn.apache.org/viewcvs?rev=369277&view=rev
Log:
2006-01-15 Martin Sebor <[EMAIL PROTECTED]>
* bugs.html: Added more detail on the format of patches.
Modified:
incubator/stdcxx/site/bugs.html
Modified: incubator/stdcxx/site/bugs.html
URL:
http://svn.apache.org/viewcvs/incubator/stdcxx/site/bugs.html?rev=369277&r1=369276&r2=369277&view=diff
==============================================================================
--- incubator/stdcxx/site/bugs.html (original)
+++ incubator/stdcxx/site/bugs.html Sun Jan 15 15:19:10 2006
@@ -324,8 +324,10 @@
<li>
Detailed explanation of the change. It should be obvious from reading
-this narrative alone (i.e., without looking at the source code) what
-the change does and why.
+this narrative alone (i.e., without reading the ChangeLog or looking
+at the source code) what the change does and why. See <a
+href="http://mail-archives.apache.org/mod_mbox/incubator-stdcxx-dev/200512.mbox/[EMAIL
PROTECTED]">this
+post</a> for an example of such a description.
</li>
<li>
@@ -341,11 +343,17 @@
</p>
<p>
-Each Change Log entry consists of a reference to the <i>issue key</i>
+Each Change Log entry starts with a submission date followed by the
+name and email address of the submitter, all on the same
+line. Separated by a blank line is a reference to the <i>issue key</i>
representing the corresponding issue in the bug tracking database (if
-applicable), the name of the submitter, the submission date, and a
-description of all changes arranged by files and symbols modified by
-the change.
+applicable). The rest of the entry consists of a bullet list of
+changed files and the names and descriptions of the symbols affected
+by the change in each file. For examples of stdcxx Change Log entries
+view the logs of some stdcxx source files, such as <a
+href="http://svn.apache.org/viewcvs.cgi/incubator/stdcxx/trunk/src/time_put.cpp?rev=368527&view=log";>time_put.cpp</a>,
+or <a
+href="http://svn.apache.org/viewcvs.cgi/incubator/stdcxx/trunk/src/wcodecvt.cpp?rev=369110&view=log";>wcodecvt.cpp</a>.
</p>
<p>
@@ -375,7 +383,15 @@
class="external"
href="http://www.gnu.org/software/diffutils/diffutils.html";><code>diff</code></a>
utility and understood by GNU <a class="external"
-href="http://www.gnu.org/software/patch/patch.html";><code>patch</code></a>.
+href="http://www.gnu.org/software/patch/patch.html";><code>patch</code></a>.
When
+creating patches on Windows it's important to keep in mind that the
+newline sequences (carriage-return followed by line-feed, or <CR><LF>)
+may not be recognized by traditional UNIX implementations of the patch
+utility (as is the case on Solaris). For portability, it is best to
+strip the carriage-returns from the patch before posting it. The
+standard <a class="external"
+href="http://www.opengroup.org/onlinepubs/009695399/utilities/tr.html";>tr</a>
+utility can be used to do that.
</li>
</ol>
