Introduce CHANGELOG.md
PATCH 1/1 Introduce CHANGELOG.md
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/
---
Cc: Andrew Cooper <[email protected]>
Cc: George Dunlap <[email protected]>
Cc: Ian Jackson <[email protected]>
Cc: Jan Beulich <[email protected]>
Cc: Julien Grall <[email protected]>
Cc: Konrad Rzeszutek Wilk <[email protected]>
Cc: Stefano Stabellini <[email protected]>
Cc: Wei Liu <[email protected]>
Cc: Lars Kurth <[email protected]>
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
CHANGELOG.md new file +14 -0
@@ -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
MAINTAINERS +5 -0
@@ -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 <[email protected]> +S: Maintained +F: CHANGELOG.md + Continuous Integration (CI) M: Doug Goldstein <[email protected]> W: https://gitlab.com/xen-project/xen
Signature · 7 lines
2.17.1 _______________________________________________ Xen-devel mailing list [email protected] https://lists.xenproject.org/mailman/listinfo/xen-devel
CHANGELOG.md line 3
Quoted 6 lines · Paul Durrant
CHANGELOG.md new file +3
-0@@ -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
_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Quoted 13 lines
-----Original Message-----
From: Jan Beulich <[email protected]>
Sent: 10 January 2020 09:52
To: Durrant, Paul <[email protected]>
Cc: [email protected]; Andrew Cooper <[email protected]>; George Dunlap <[email protected]>; Ian Jackson <[email protected]>; Julien Grall <[email protected]>; Konrad Rzeszutek Wilk <[email protected]>; Stefano Stabellini <[email protected]>; Wei Liu <[email protected]>; Lars Kurth <[email protected]>
Subject: Re: [PATCH] Introduce CHANGELOG.mdOn 10.01.2020 10:12, Paul Durrant wrote:
Quoted 10 lines
CHANGELOG.md line 3
Quoted 6 lines
CHANGELOG.md new file +3
-0@@ -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
Quoted 1 line
Jan
_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
On 10/01/2020, 09:12, "Paul Durrant" <[email protected]> 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/
Thank you Paul
Exactly what I was looking for
_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Quoted 20 lines · Paul Durrant
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
MAINTAINERSentry 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 <[email protected]>---
Cc: Andrew Cooper <[email protected]>
Cc: George Dunlap <[email protected]>
Cc: Ian Jackson <[email protected]>
Cc: Jan Beulich <[email protected]>
Cc: Julien Grall <[email protected]>
Cc: Konrad Rzeszutek Wilk <[email protected]>
Cc: Stefano Stabellini <[email protected]>
Cc: Wei Liu <[email protected]>
Cc: Lars Kurth <[email protected]>
Quoted 2 lines
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.
Quoted 12 lines
--- CHANGELOG.md | 14 ++++++++++++++ MAINTAINERS | 5 +++++ 2 files changed, 19 insertions(+) create mode 100644 CHANGELOG.mdCHANGELOG.md new file +0
-0
CHANGELOG.md line 7
Quoted 7 lines
CHANGELOG.md new file +7
-0@@ -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
Quoted 13 lines
CHANGELOG.md new file +7
-0+ +### 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 startsMAINTAINERS +0
-0@@ -198,6 +198,11 @@ F: xen/include/asm-arm/ F: xen/include/public/arch-arm/
MAINTAINERS F: xen/include/asm-arm/ · line 208
Quoted 10 lines
MAINTAINERS +5
-0F: xen/include/public/arch-arm.h +Change Log +M: Paul Durrant <[email protected]> +S: Maintained +F: CHANGELOG.md + Continuous Integration (CI) M: Doug Goldstein <[email protected]> W: https://gitlab.com/xen-project/xen
_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Quoted 25 lines · Andrew Cooper
Quoted 20 lines · Paul Durrant
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
MAINTAINERSentry 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 <[email protected]>---
Cc: Andrew Cooper <[email protected]>
Cc: George Dunlap <[email protected]>
Cc: Ian Jackson <[email protected]>
Cc: Jan Beulich <[email protected]>
Cc: Julien Grall <[email protected]>
Cc: Konrad Rzeszutek Wilk <[email protected]>
Cc: Stefano Stabellini <[email protected]>
Cc: Wei Liu <[email protected]>
Cc: Lars Kurth <[email protected]>
Quoted 6 lines
Quoted 2 lines
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
_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel