On Tue, Mar 25, 2003 at 06:52:21PM +0000, Philip Martin wrote:
> Matt Kraai <kraai@alumni.cmu.edu> writes:
>
> > > Again, please please please write more than "fixed issue N". Now I
> > > have to go look up this issue in the database to even know what it's
> > > about. :-) A single sentence would suffice:
> > >
> > > "Fix issue #1193: don't use os.path.join in python tests"
> >
> > The next lines were
> >
> > * subversion/tests/clients/cmdline/basic_tests.py
> > (basic_checkout, basic_switch, basic_checkout_deleted): Use string
> > concatenation instead of os.path.join to construct URLs.
>
> That doesn't tell me that issue 1193 has anything to do with
> os.path.join. You may have changed the code to use os.path.join as
> part of some larger issue, or you may simply have fixed it in passing
> to make it consistent with the rest of the testsuite.
I disagree. The log message should describe the change, not the
issue that motivated it. That said, if this is the policy, it
should be documented. How about the following patch?
Index: HACKING
===================================================================
--- HACKING (revision 5448)
+++ HACKING (working copy)
@@ -741,11 +741,11 @@
automatically.
If your change is related to a specific issue in the issue tracker,
-then include a string like "issue #N" in the log message. For
-example, if a patch resolves issue 1729, then the log message might
-be:
+then include a string like "issue #N" and the issue summary in the log
+message. For example, if a patch resolves issue 1729, then the log
+message might be:
- Fix issue #1729:
+ Fix issue #1729 (Crashes if file is missing):
* get_editor.c
(frobnicate_file): Check that file exists first.
Matt
--
It's most certainly GNU/Linux, not Linux. Read more at
http://www.gnu.org/gnu/why-gnu-linux.html.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Tue Mar 25 20:07:56 2003