Introduce CHANGELOG.md
diff mbox series

Message ID 20200110091238.845-1-pdurrant@amazon.com
State Superseded
Headers show
Series
  • Introduce CHANGELOG.md
Related show

Commit Message

Paul Durrant Jan. 10, 2020, 9:12 a.m. UTC
As agreed during the 2020-01 community call [1] this patch introduces a
changelog, based on the principles explained at keepachangelog.com [2].
A new MAINTAINERS entry is also added, with myself as (currently sole)
maintainer.

[1] See C.2 at https://cryptpad.fr/pad/#/2/pad/edit/ERZtMYD5j6k0sv-NG6Htl-AJ/
[2] https://keepachangelog.com/en/1.0.0/

Signed-off-by: Paul Durrant <pdurrant@amazon.com>
---
Cc: Andrew Cooper <andrew.cooper3@citrix.com>
Cc: George Dunlap <George.Dunlap@eu.citrix.com>
Cc: Ian Jackson <ian.jackson@eu.citrix.com>
Cc: Jan Beulich <jbeulich@suse.com>
Cc: Julien Grall <julien@xen.org>
Cc: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
Cc: Stefano Stabellini <sstabellini@kernel.org>
Cc: Wei Liu <wl@xen.org>
Cc: Lars Kurth <lars.kurth@citrix.com>

Should there be other maintainers apart from myself (with my RM hat on)?
Perhaps Lars should also be added as a designated reviewer?
---
 CHANGELOG.md | 14 ++++++++++++++
 MAINTAINERS  |  5 +++++
 2 files changed, 19 insertions(+)
 create mode 100644 CHANGELOG.md

Comments

Jan Beulich Jan. 10, 2020, 9:52 a.m. UTC | #1
On 10.01.2020 10:12, Paul Durrant wrote:
> --- /dev/null
> +++ b/CHANGELOG.md
> @@ -0,0 +1,14 @@
> +# Changelog
> +
> +All notable changes to Xen will be documented in this file.

How do we qualify what's "notable" and what's not? IOW I wonder
whether "All" should be dropped, or be replaced by "Some".

Jan
Lars Kurth Jan. 10, 2020, 9:56 a.m. UTC | #2
On 10/01/2020, 09:12, "Paul Durrant" <pdurrant@amazon.com> wrote:

    As agreed during the 2020-01 community call [1] this patch introduces a
    changelog, based on the principles explained at keepachangelog.com [2].
    A new MAINTAINERS entry is also added, with myself as (currently sole)
    maintainer.
    
    [1] See C.2 at https://cryptpad.fr/pad/#/2/pad/edit/ERZtMYD5j6k0sv-NG6Htl-AJ/
    [2] https://keepachangelog.com/en/1.0.0/
    
    Signed-off-by: Paul Durrant <pdurrant@amazon.com>


Thank you Paul
Exactly what I was looking for

Reviewed-by: Lars Kurth <lars.kurth@citrix.com>
Durrant, Paul Jan. 10, 2020, 10:05 a.m. UTC | #3
> -----Original Message-----
> From: Jan Beulich <jbeulich@suse.com>
> Sent: 10 January 2020 09:52
> To: Durrant, Paul <pdurrant@amazon.co.uk>
> Cc: xen-devel@lists.xenproject.org; Andrew Cooper
> <andrew.cooper3@citrix.com>; George Dunlap <George.Dunlap@eu.citrix.com>;
> Ian Jackson <ian.jackson@eu.citrix.com>; Julien Grall <julien@xen.org>;
> Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>; Stefano Stabellini
> <sstabellini@kernel.org>; Wei Liu <wl@xen.org>; Lars Kurth
> <lars.kurth@citrix.com>
> Subject: Re: [PATCH] Introduce CHANGELOG.md
> 
> On 10.01.2020 10:12, Paul Durrant wrote:
> > --- /dev/null
> > +++ b/CHANGELOG.md
> > @@ -0,0 +1,14 @@
> > +# Changelog
> > +
> > +All notable changes to Xen will be documented in this file.
> 
> How do we qualify what's "notable" and what's not? IOW I wonder
> whether "All" should be dropped, or be replaced by "Some".
> 

Agreed that it's debatable. Perhaps just drop the 'All' and say:

'Notable changes to Xen will be documented in this file.'

?

Patch authors ought to update the file if they consider their contribution(s) notable but I'd also hope that maintainers will express an opinion as to whether something should be included/not included. It's not going to be fool-proof but I think it will be better than nothing.

  Paul

> Jan
Andrew Cooper Jan. 10, 2020, 5:54 p.m. UTC | #4
On 10/01/2020 09:12, Paul Durrant wrote:
> As agreed during the 2020-01 community call [1] this patch introduces a
> changelog, based on the principles explained at keepachangelog.com [2].
> A new MAINTAINERS entry is also added, with myself as (currently sole)
> maintainer.
>
> [1] See C.2 at https://cryptpad.fr/pad/#/2/pad/edit/ERZtMYD5j6k0sv-NG6Htl-AJ/
> [2] https://keepachangelog.com/en/1.0.0/
>
> Signed-off-by: Paul Durrant <pdurrant@amazon.com>
> ---
> Cc: Andrew Cooper <andrew.cooper3@citrix.com>
> Cc: George Dunlap <George.Dunlap@eu.citrix.com>
> Cc: Ian Jackson <ian.jackson@eu.citrix.com>
> Cc: Jan Beulich <jbeulich@suse.com>
> Cc: Julien Grall <julien@xen.org>
> Cc: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
> Cc: Stefano Stabellini <sstabellini@kernel.org>
> Cc: Wei Liu <wl@xen.org>
> Cc: Lars Kurth <lars.kurth@citrix.com>
>
> Should there be other maintainers apart from myself (with my RM hat on)?
> Perhaps Lars should also be added as a designated reviewer?

Ultimately, the committers are last line of judgement on "whether this
change should be in the changelog".  Practically, that includes "The
Rest", but there was an objection to that on the call IIRC.

> ---
>  CHANGELOG.md | 14 ++++++++++++++
>  MAINTAINERS  |  5 +++++
>  2 files changed, 19 insertions(+)
>  create mode 100644 CHANGELOG.md
>
> diff --git a/CHANGELOG.md b/CHANGELOG.md
> new file mode 100644
> index 0000000000..ec5e174aa0
> --- /dev/null
> +++ b/CHANGELOG.md
> @@ -0,0 +1,14 @@
> +# Changelog
> +
> +All notable changes to Xen will be documented in this file.
> +
> +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
> +
> +## [Unreleased](https://xenbits.xen.org/gitweb/?p=xen.git;a=shortlog)

Has anyone looked over staging to find other noteworthy things?

~Andrew


> +
> +### Added
> + - This file and MAINTAINERS entry.
> +
> +## [4.13.0](https://xenbits.xen.org/gitweb/?p=xen.git;a=shortlog;h=RELEASE-4.13.0) - 2019-12-17
> +
> +> Pointer to release from which CHANGELOG tracking starts
> diff --git a/MAINTAINERS b/MAINTAINERS
> index d5bd83073c..68c691361a 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -198,6 +198,11 @@ F:	xen/include/asm-arm/
>  F:	xen/include/public/arch-arm/
>  F:	xen/include/public/arch-arm.h
>  
> +Change Log
> +M:	Paul Durrant <pdurrant@amazon.com>
> +S:	Maintained
> +F:	CHANGELOG.md
> +
>  Continuous Integration (CI)
>  M:	Doug Goldstein <cardoe@cardoe.com>
>  W:	https://gitlab.com/xen-project/xen
Lars Kurth Jan. 10, 2020, 8:18 p.m. UTC | #5
> On 10 Jan 2020, at 17:54, Andrew Cooper <andrew.cooper3@citrix.com> wrote:
> 
> On 10/01/2020 09:12, Paul Durrant wrote:
>> As agreed during the 2020-01 community call [1] this patch introduces a
>> changelog, based on the principles explained at keepachangelog.com [2].
>> A new MAINTAINERS entry is also added, with myself as (currently sole)
>> maintainer.
>> 
>> [1] See C.2 at https://cryptpad.fr/pad/#/2/pad/edit/ERZtMYD5j6k0sv-NG6Htl-AJ/
>> [2] https://keepachangelog.com/en/1.0.0/
>> 
>> Signed-off-by: Paul Durrant <pdurrant@amazon.com>
>> ---
>> Cc: Andrew Cooper <andrew.cooper3@citrix.com>
>> Cc: George Dunlap <George.Dunlap@eu.citrix.com>
>> Cc: Ian Jackson <ian.jackson@eu.citrix.com>
>> Cc: Jan Beulich <jbeulich@suse.com>
>> Cc: Julien Grall <julien@xen.org>
>> Cc: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
>> Cc: Stefano Stabellini <sstabellini@kernel.org>
>> Cc: Wei Liu <wl@xen.org>
>> Cc: Lars Kurth <lars.kurth@citrix.com>
>> 
>> Should there be other maintainers apart from myself (with my RM hat on)?
>> Perhaps Lars should also be added as a designated reviewer?
> 
> Ultimately, the committers are last line of judgement on "whether this
> change should be in the changelog".  Practically, that includes "The
> Rest", but there was an objection to that on the call IIRC.

Am happy to be added

Lars

Patch
diff mbox series

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000000..ec5e174aa0
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,14 @@ 
+# Changelog
+
+All notable changes to Xen will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+
+## [Unreleased](https://xenbits.xen.org/gitweb/?p=xen.git;a=shortlog)
+
+### Added
+ - This file and MAINTAINERS entry.
+
+## [4.13.0](https://xenbits.xen.org/gitweb/?p=xen.git;a=shortlog;h=RELEASE-4.13.0) - 2019-12-17
+
+> Pointer to release from which CHANGELOG tracking starts
diff --git a/MAINTAINERS b/MAINTAINERS
index d5bd83073c..68c691361a 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -198,6 +198,11 @@  F:	xen/include/asm-arm/
 F:	xen/include/public/arch-arm/
 F:	xen/include/public/arch-arm.h
 
+Change Log
+M:	Paul Durrant <pdurrant@amazon.com>
+S:	Maintained
+F:	CHANGELOG.md
+
 Continuous Integration (CI)
 M:	Doug Goldstein <cardoe@cardoe.com>
 W:	https://gitlab.com/xen-project/xen