You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by Filip Hanik - Dev Lists <de...@hanik.com> on 2008/10/09 01:24:04 UTC
tomcat trunk - changelog
I'd like for us to start using the changelog for trunk, we're losing a
lot of changes being documented, not everything gets ported to 6.0 etc
do you guys have any thoughts on this?
Filip
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: tomcat trunk - changelog
Posted by Mark Thomas <ma...@apache.org>.
Filip Hanik - Dev Lists wrote:
> I'd like for us to start using the changelog for trunk, we're losing a
> lot of changes being documented, not everything gets ported to 6.0 etc
> do you guys have any thoughts on this?
There is a need to do a diff of trunk against 6.0.x and check that nothing
has fallen through the cracks. I suspect there will be the odd commit here
and there. I started to do this but got side-tracked. On reflection it
makes sense to temporarily add a short text file to trunk just to record
what has been checked and what hasn't. That way we can do it package by
package as people have the time.
Assuming that trunk becomes the basis for 7.x then I think the only entries
that are in it should be the ones that aren't in 6.0.x. We didn't start the
6.x changelog with the 5.5.x changelog we started with a clean sheet and I
think 7.x should be the same. ie the trunk/7.x changelog should be the
differences between trunk and 6.0.x, not trunk and 5.5.x. The trunk
changelog can be updated as part of the trunk/6.0.x diff.
Mark
>
> Filip
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: dev-help@tomcat.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: tomcat trunk - changelog
Posted by jean-frederic clere <jf...@gmail.com>.
Filip Hanik - Dev Lists wrote:
> I'd like for us to start using the changelog for trunk, we're losing a
> lot of changes being documented, not everything gets ported to 6.0 etc
> do you guys have any thoughts on this?
+1.
Cheers
Jean-Frederic
>
> Filip
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: dev-help@tomcat.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: tomcat trunk - changelog
Posted by Remy Maucherat <re...@apache.org>.
On Wed, 2008-10-08 at 21:45 -0700, Costin Manolache wrote:
> I never understood the use of the manual changelog - as opposed to svn log
> and good commit messages.
> Could we just use that ?
I don't see how it would be readable. The formatting is inconsistent, it
would likely have no links, etc.
OTOH, it obviously does the job of listing the changes.
Rémy
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: tomcat trunk - changelog
Posted by Costin Manolache <co...@gmail.com>.
On Fri, Oct 10, 2008 at 8:03 AM, Tim Funk <fu...@joedog.org> wrote:
> If we really prefer to be particular about change logs. Then we should
> create a BUGZILLA VERSION called trunk and potentially a new "product"
> called tomcat 7 (or tomcat-unknown). Then any fix first goes into Bugzilla
> with a description of the fix.
>
> Then every commit message would contain the BUGZILLA ID. This allows
> multiple commits to span a single bugzilla entry.
>
> Then it would be trivial to get the distinct set of BUGZILLA ids and
> extract with the summary (and/or) description. Likewise - it probably
> wouldn't be hard to have something listening on the commits and update the
> BUGZILLA entry with a with a URL to the change.
My comment was mostly about minimizing the redundant manual work, if
possible ( and easy enough ).
If people think it's too confusing - sure, we can use the manual file, but
it would be great if the commit message would
include same ( or more ) than the change log, it makes it easier to
browse/understand.
It is possible for the submit to include references to the issue tracker,
and I think there are tools to automatically update it.
But I'm not sure creating a bugzilla before any commit is reducing the
redundant work :-)
Anyways - it was just an idea, I'm +1 on the manual solution if people feel
svn log is too verbose..
Costin
>
>
> --
> Possible example commit message:
>
> bug: 12345
> bug=12345
> <bug>12345</bug>
>
> --
>
> -Tim
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: dev-help@tomcat.apache.org
>
>
Re: tomcat trunk - changelog
Posted by Tim Funk <fu...@joedog.org>.
If we really prefer to be particular about change logs. Then we should
create a BUGZILLA VERSION called trunk and potentially a new "product"
called tomcat 7 (or tomcat-unknown). Then any fix first goes into
Bugzilla with a description of the fix.
Then every commit message would contain the BUGZILLA ID. This allows
multiple commits to span a single bugzilla entry.
Then it would be trivial to get the distinct set of BUGZILLA ids and
extract with the summary (and/or) description. Likewise - it probably
wouldn't be hard to have something listening on the commits and update
the BUGZILLA entry with a with a URL to the change.
--
Possible example commit message:
bug: 12345
bug=12345
<bug>12345</bug>
--
-Tim
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: tomcat trunk - changelog
Posted by Costin Manolache <co...@gmail.com>.
On Thu, Oct 9, 2008 at 11:49 PM, jean-frederic clere <jf...@gmail.com>wrote:
> Costin Manolache wrote:
>
>> On Thu, Oct 9, 2008 at 9:18 AM, Filip Hanik - Dev Lists
>> <de...@hanik.com>wrote:
>>
>> Costin Manolache wrote:
>>>
>>> I never understood the use of the manual changelog - as opposed to svn
>>>> log
>>>> and good commit messages.
>>>> Could we just use that ?
>>>>
>>>> that would be nice if we then could generate the 'changelog' to ship
>>> with
>>> the release.
>>> for an admin that is about to upgrade, it's much nicer to have the
>>> changelog to see what bugs got fixed, what changes were implemented, then
>>> have to scan the SVN repository.
>>> the changelog. the changelog is widely used by admins during upgrade
>>> scenarios
>>>
>>
>>
>> Just include the bug number and links in the commit message. Whatever you
>> put in the CHANGES you can put in the commit log as well.
>>
>
> Well I don't agree because in several case a real fix only appears after
> several commits a changelog entry will be a summary of those.
>
I agree, it's better to split large commits to make them easier to review.
What about: in the last one commit in a series, add a
CHANGELOG: whatever you would put in changelog.
For small ones - don't. Then we can filter out the small ones.
If you don't know when the bug is really fixed - make a dummy submit:
"it looks like previous commit fixed it,
CHANGELOG: ...."
I don't know - it's not a big deal, I'm just used with the source-control
automatically keeping track of the changes :-)
Costin
>
> Cheers
>
> Jean-Frederic
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: dev-help@tomcat.apache.org
>
>
Re: tomcat trunk - changelog
Posted by jean-frederic clere <jf...@gmail.com>.
Costin Manolache wrote:
> On Thu, Oct 9, 2008 at 9:18 AM, Filip Hanik - Dev Lists
> <de...@hanik.com>wrote:
>
>> Costin Manolache wrote:
>>
>>> I never understood the use of the manual changelog - as opposed to svn log
>>> and good commit messages.
>>> Could we just use that ?
>>>
>> that would be nice if we then could generate the 'changelog' to ship with
>> the release.
>> for an admin that is about to upgrade, it's much nicer to have the
>> changelog to see what bugs got fixed, what changes were implemented, then
>> have to scan the SVN repository.
>> the changelog. the changelog is widely used by admins during upgrade
>> scenarios
>
>
> Just include the bug number and links in the commit message. Whatever you
> put in the CHANGES you can put in the commit log as well.
Well I don't agree because in several case a real fix only appears after
several commits a changelog entry will be a summary of those.
Cheers
Jean-Frederic
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: tomcat trunk - changelog
Posted by Costin Manolache <co...@gmail.com>.
On Thu, Oct 9, 2008 at 9:18 AM, Filip Hanik - Dev Lists
<de...@hanik.com>wrote:
> Costin Manolache wrote:
>
>> I never understood the use of the manual changelog - as opposed to svn log
>> and good commit messages.
>> Could we just use that ?
>>
> that would be nice if we then could generate the 'changelog' to ship with
> the release.
> for an admin that is about to upgrade, it's much nicer to have the
> changelog to see what bugs got fixed, what changes were implemented, then
> have to scan the SVN repository.
> the changelog. the changelog is widely used by admins during upgrade
> scenarios
Just include the bug number and links in the commit message. Whatever you
put in the CHANGES you can put in the commit log as well.
I don't know if SVN supports templates - most likely it does.
The formatting seems ok - it's not very different from the manual file - and
shouldn't be very hard to write a script to change the
layout.
I've seen projects that generate the 'changelog' using automated tools,
based on the source control system. The extra benefit
is that better commit messages would make it easier to understand the
changes when browsing the svn.
Example:
jsvn log -l 5
------------------------------------------------------------------------
r699128 | markt | 2008-09-25 16:20:48 -0700 (Thu, 25 Sep 2008) | 1 line
Partial fix for 45878. If we are happy with this approach for the spec JARs,
extend it to the remaining Tomcat JARs.
------------------------------------------------------------------------
r699126 | markt | 2008-09-25 16:00:57 -0700 (Thu, 25 Sep 2008) | 1 line
Update default year
------------------------------------------------------------------------
r698925 | markt | 2008-09-25 04:07:44 -0700 (Thu, 25 Sep 2008) | 1 line
Add NOTICE file to uninstall section.
------------------------------------------------------------------------
r698892 | jfclere | 2008-09-25 02:29:23 -0700 (Thu, 25 Sep 2008) | 2 lines
Use lastest tc-native version.
------------------------------------------------------------------------
r698629 | markt | 2008-09-24 09:21:25 -0700 (Wed, 24 Sep 2008) | 2 lines
Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=45879
Move the NOTICE file to the install dir
------------------------------------------------------------------------
Costin
>
> best
> Filip
>
> Costin
>>
>> On Wed, Oct 8, 2008 at 4:24 PM, Filip Hanik - Dev Lists
>> <de...@hanik.com>wrote:
>>
>>
>>
>>> I'd like for us to start using the changelog for trunk, we're losing a
>>> lot
>>> of changes being documented, not everything gets ported to 6.0 etc
>>> do you guys have any thoughts on this?
>>>
>>> Filip
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
>>> For additional commands, e-mail: dev-help@tomcat.apache.org
>>>
>>>
>>>
>>>
>>
>>
>>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: dev-help@tomcat.apache.org
>
>
Re: tomcat trunk - changelog
Posted by Filip Hanik - Dev Lists <de...@hanik.com>.
Costin Manolache wrote:
> I never understood the use of the manual changelog - as opposed to svn log
> and good commit messages.
> Could we just use that ?
>
that would be nice if we then could generate the 'changelog' to ship
with the release.
for an admin that is about to upgrade, it's much nicer to have the
changelog to see what bugs got fixed, what changes were implemented,
then have to scan the SVN repository.
the changelog. the changelog is widely used by admins during upgrade
scenarios
best
Filip
> Costin
>
> On Wed, Oct 8, 2008 at 4:24 PM, Filip Hanik - Dev Lists
> <de...@hanik.com>wrote:
>
>
>> I'd like for us to start using the changelog for trunk, we're losing a lot
>> of changes being documented, not everything gets ported to 6.0 etc
>> do you guys have any thoughts on this?
>>
>> Filip
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
>> For additional commands, e-mail: dev-help@tomcat.apache.org
>>
>>
>>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: tomcat trunk - changelog
Posted by Costin Manolache <co...@gmail.com>.
I never understood the use of the manual changelog - as opposed to svn log
and good commit messages.
Could we just use that ?
Costin
On Wed, Oct 8, 2008 at 4:24 PM, Filip Hanik - Dev Lists
<de...@hanik.com>wrote:
> I'd like for us to start using the changelog for trunk, we're losing a lot
> of changes being documented, not everything gets ported to 6.0 etc
> do you guys have any thoughts on this?
>
> Filip
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: dev-help@tomcat.apache.org
>
>