From 75c386985e02ef0d430d968a5c7093549507efba Mon Sep 17 00:00:00 2001
From: Michal Privoznik <mprivozn@redhat.com>
Date: Mon, 23 Mar 2020 15:49:59 +0100
Subject: [PATCH] news: Document removal of support for .ini style of comments
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

In previous patches virKeyFile was replaced with its GLib
counterpart which created an incompatible change: comments can
now begin only with a number sign (#). While this won't probably
affect anyone, mention it in the release notes.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
---
 docs/news.xml | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/news.xml b/docs/news.xml
index ae4ee444d0..26f50461c3 100644
--- a/docs/news.xml
+++ b/docs/news.xml
@@ -45,6 +45,19 @@
   <release version="v6.2.0" date="unreleased">
     <section title="New features">
     </section>
+    <section title="Removed features">
+      <change>
+        <summary>
+          Removed support for INI style of comments
+        </summary>
+        <description>
+          With switching of our internal code to GLib, parsing of client
+          authentication config files is handed over to GLib which does not
+          support <code>INI</code> style of comments starting with a semicolon
+          (<code>;</code>). Use number sign (<code>#</code>) instead.
+        </description>
+      </change>
+    </section>
     <section title="Improvements">
     </section>
     <section title="Bug fixes">
-- 
GitLab