Re: [libvirt] [PATCH] news: Make changes understandable for users
On Mon, Mar 27, 2017 at 22:25:39 +0200, Martin Kletzander wrote:
When reading release notes, patch summary is not always the best
description of what users can expect in new version. I propose
changing it slightly so that it describes what exactly happens and
when.
However, we do not have to add every single code change to the news
file, that would be ridiculous and unreadable for users. If the patch
subject needs changes like this one, I'm rather tempted to say that
such changes should not be in the news file at all. So that would be
the other way how to fix this.
I agree, I think we should change the "Bug fixes" part to list only
important/critical bug fixes. It's not going to be perfect since a bug
importance is a subjective thing, but we could at least make developers
think about it :-)
Signed-off-by: Martin Kletzander <mkletzan(a)redhat.com>
---
docs/news.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/news.xml b/docs/news.xml
index eb0f2426be25..494c6489b9c5 100644
--- a/docs/news.xml
+++ b/docs/news.xml
@@ -706,7 +706,7 @@
</change>
<change>
<summary>
- logical: Need to overwrite/clear more than just first 512 bytes
+ Overwrite (clear) 2 KB instead of just 512 bytes when initializing logical
device
</summary>
</change>
<change>
ACK
Jirka