This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Suggestion for ChangeLog patch change
>From Geoff's checklist, derived presumably from contribute.html:
Geoff> [ ] There is a ChangeLog entry before the patch, but not part
Geoff> of the patch itself.
I'd like to propose we change this requirement to encourage the
ChangeLog to be part of the patch.
In the past, having a separate ChangeLog entry was convenient because
it was, and remains, a pain to apply a raw ChangeLog patch.
However, these days there are tools (from Alexandre Oliva) to make
this situation easier. With these tools, I now find it is much *more*
convenient to have the ChangeLog entry in the patch itself; I can
simply feed an email message directly into the script and have all the
parts, including the ChangeLog entry, correctly apply. Having
separate ChangeLog entries means more time in the editor.
Alexandre's scripts are easy to get -- they are on subversions.gnu.org.
We can also check them in to contrib/ if need be.
Appended is my proposed change to contribute.html.
Tom
Index: contribute.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/contribute.html,v
retrieving revision 1.48
diff -u -r1.48 contribute.html
--- contribute.html 20 Mar 2002 18:39:42 -0000 1.48
+++ contribute.html 22 Jan 2003 20:41:21 -0000
@@ -151,9 +151,8 @@
coding conventions</a> and <a
href="http://www.gnu.org/prep/standards_toc.html";>GNU Coding
Standards</a> for further information. The ChangeLog entries should
-be plaintext rather than part of the patch since the top of the
-ChangeLog changes rapidly and a patch to the ChangeLog would probably
-no longer apply by the time your patch is reviewed.
+either be part of the patch or should be in <code>clcleanup</code> format;
+maintainers can use the <code>cl2patch</code> script to apply these patches.
If your change fixes a PR, put text in the ChangeLog entry mentioning
the PR. The <code>cvs commit</code> machinery understands how to
extract this information and automatically append the commit log to
@@ -236,10 +235,8 @@
<p>Everything listed here still applies if you can check in the patch
without further approval under the <a
href="cvswrite.html#policies">GCC write access policies</a>, except
-that ChangeLog entries may be included as part of the patch since
-no-one else will need to apply it to the tree later and diffs representing
-totally new files may be omitted (especially if large) since they can be
-accessed directly from the repository.</p>
+that diffs representing totally new files may be omitted (especially
+if large) since they can be accessed directly from the repository.</p>
</body>
</html>