You are viewing a plain text version of this content. The canonical link for it is here.
Posted to log4j-dev@logging.apache.org by Mikael Ståldal <mi...@magine.com> on 2017/02/02 20:45:44 UTC

Re: Use of the manual change log

It is a bit confusing that "update" in changes.xml translates to "Changes"
in release notes. Why is it so?

On Jan 28, 2017 1:16 AM, "Remko Popma" <re...@gmail.com> wrote:

> When you say change, you mean update? (I thought there were only 4
> categories: add, fix, update and delete.)
>
>  I don't mind using the update category for improvements in the future,
> just that the difference between new feature and improvement is sometimes
> not clear-cut.
>
> Sent from my iPhone
>
> On Jan 28, 2017, at 3:58, Apache <ra...@dslextreme.com> wrote:
>
> I wouldn’t call making GelfLayout independent of Jackson a new feature
> since it wouldn’t affect the external behavior other than the dependencies.
> I would have marked it as a change. I would have done the same with all the
> “Avoid allocating temporary objects” issues. The way I look at it, is if it
> is something that is really new, such as an additional parameter or new
> external or internal component, then it belongs as a new feature. If it
> fixes a reported bug then it is a fix. Pretty much everything else is a
> change.
>
> Ralph
>
> On Jan 27, 2017, at 11:20 AM, Matt Sicker <bo...@gmail.com> wrote:
>
> I was looking over the changelog for 2.8 and noticed some things in the
> "Fixed Bugs" section that sound like they'd be more appropriate in the "New
> features" section such as:
>
> * Added Builder classes (e.g., GelfLayout)
> * Make GelfLayout independent of Jackson (that is totally a new feature!)
> * Added CleanableThreadContextMap (not only is it a new feature, it's a
> new log4j-api class!)
> * Any new options added to plugins (e.g., disableAnsi in PatternLayout)
> * Configurable JVM shutdown hook timeout
> * Garbage-free changes (unless you consider garbage objects to be a bug
> now?)
>
> Also, this isn't such a big deal, but when we do more than two dependency
> version upgrades within a single release, it might be clearer to combine
> them into a single ticket (e.g., Jackson makes a bit more releases than we
> do, so we usually end up with multiple Jackson upgrade tickets in the
> changelog which isn't very helpful to a user).
>
> --
> Matt Sicker <bo...@gmail.com>
>
>
>

Re: Use of the manual change log

Posted by Mikael Ståldal <mi...@magine.com>.
I added a comment at the top of changes.xml to clarify this.

On Fri, Feb 10, 2017 at 4:13 AM, Matt Sicker <bo...@gmail.com> wrote:

> That changes because that's how the template is configured: <
> https://github.com/apache/logging-log4j2/blob/master/
> src/changes/announcement.vm#L94>. It could be changed to whatever. The
> template should be a bit simpler to figure out now that it's been macro'd a
> bit.
>
> On 2 February 2017 at 14:45, Mikael Ståldal <mi...@magine.com>
> wrote:
>
>> It is a bit confusing that "update" in changes.xml translates to
>> "Changes" in release notes. Why is it so?
>>
>> On Jan 28, 2017 1:16 AM, "Remko Popma" <re...@gmail.com> wrote:
>>
>>> When you say change, you mean update? (I thought there were only 4
>>> categories: add, fix, update and delete.)
>>>
>>>  I don't mind using the update category for improvements in the future,
>>> just that the difference between new feature and improvement is
>>> sometimes not clear-cut.
>>>
>>> Sent from my iPhone
>>>
>>> On Jan 28, 2017, at 3:58, Apache <ra...@dslextreme.com> wrote:
>>>
>>> I wouldn’t call making GelfLayout independent of Jackson a new feature
>>> since it wouldn’t affect the external behavior other than the dependencies.
>>> I would have marked it as a change. I would have done the same with all the
>>> “Avoid allocating temporary objects” issues. The way I look at it, is if it
>>> is something that is really new, such as an additional parameter or new
>>> external or internal component, then it belongs as a new feature. If it
>>> fixes a reported bug then it is a fix. Pretty much everything else is a
>>> change.
>>>
>>> Ralph
>>>
>>> On Jan 27, 2017, at 11:20 AM, Matt Sicker <bo...@gmail.com> wrote:
>>>
>>> I was looking over the changelog for 2.8 and noticed some things in the
>>> "Fixed Bugs" section that sound like they'd be more appropriate in the "New
>>> features" section such as:
>>>
>>> * Added Builder classes (e.g., GelfLayout)
>>> * Make GelfLayout independent of Jackson (that is totally a new feature!)
>>> * Added CleanableThreadContextMap (not only is it a new feature, it's a
>>> new log4j-api class!)
>>> * Any new options added to plugins (e.g., disableAnsi in PatternLayout)
>>> * Configurable JVM shutdown hook timeout
>>> * Garbage-free changes (unless you consider garbage objects to be a bug
>>> now?)
>>>
>>> Also, this isn't such a big deal, but when we do more than two
>>> dependency version upgrades within a single release, it might be clearer to
>>> combine them into a single ticket (e.g., Jackson makes a bit more releases
>>> than we do, so we usually end up with multiple Jackson upgrade tickets in
>>> the changelog which isn't very helpful to a user).
>>>
>>> --
>>> Matt Sicker <bo...@gmail.com>
>>>
>>>
>>>
>
>
> --
> Matt Sicker <bo...@gmail.com>
>



-- 
[image: MagineTV]

*Mikael Ståldal*
Senior software developer

*Magine TV*
mikael.staldal@magine.com
Grev Turegatan 3  | 114 46 Stockholm, Sweden  |   www.magine.com

Privileged and/or Confidential Information may be contained in this
message. If you are not the addressee indicated in this message
(or responsible for delivery of the message to such a person), you may not
copy or deliver this message to anyone. In such case,
you should destroy this message and kindly notify the sender by reply
email.

Re: Use of the manual change log

Posted by Matt Sicker <bo...@gmail.com>.
That changes because that's how the template is configured: <
https://github.com/apache/logging-log4j2/blob/master/src/changes/announcement.vm#L94>.
It could be changed to whatever. The template should be a bit simpler to
figure out now that it's been macro'd a bit.

On 2 February 2017 at 14:45, Mikael Ståldal <mi...@magine.com>
wrote:

> It is a bit confusing that "update" in changes.xml translates to "Changes"
> in release notes. Why is it so?
>
> On Jan 28, 2017 1:16 AM, "Remko Popma" <re...@gmail.com> wrote:
>
>> When you say change, you mean update? (I thought there were only 4
>> categories: add, fix, update and delete.)
>>
>>  I don't mind using the update category for improvements in the future,
>> just that the difference between new feature and improvement is
>> sometimes not clear-cut.
>>
>> Sent from my iPhone
>>
>> On Jan 28, 2017, at 3:58, Apache <ra...@dslextreme.com> wrote:
>>
>> I wouldn’t call making GelfLayout independent of Jackson a new feature
>> since it wouldn’t affect the external behavior other than the dependencies.
>> I would have marked it as a change. I would have done the same with all the
>> “Avoid allocating temporary objects” issues. The way I look at it, is if it
>> is something that is really new, such as an additional parameter or new
>> external or internal component, then it belongs as a new feature. If it
>> fixes a reported bug then it is a fix. Pretty much everything else is a
>> change.
>>
>> Ralph
>>
>> On Jan 27, 2017, at 11:20 AM, Matt Sicker <bo...@gmail.com> wrote:
>>
>> I was looking over the changelog for 2.8 and noticed some things in the
>> "Fixed Bugs" section that sound like they'd be more appropriate in the "New
>> features" section such as:
>>
>> * Added Builder classes (e.g., GelfLayout)
>> * Make GelfLayout independent of Jackson (that is totally a new feature!)
>> * Added CleanableThreadContextMap (not only is it a new feature, it's a
>> new log4j-api class!)
>> * Any new options added to plugins (e.g., disableAnsi in PatternLayout)
>> * Configurable JVM shutdown hook timeout
>> * Garbage-free changes (unless you consider garbage objects to be a bug
>> now?)
>>
>> Also, this isn't such a big deal, but when we do more than two dependency
>> version upgrades within a single release, it might be clearer to combine
>> them into a single ticket (e.g., Jackson makes a bit more releases than we
>> do, so we usually end up with multiple Jackson upgrade tickets in the
>> changelog which isn't very helpful to a user).
>>
>> --
>> Matt Sicker <bo...@gmail.com>
>>
>>
>>


-- 
Matt Sicker <bo...@gmail.com>