[PATCH] news: Document removal of support for .ini style of comments

Michal Privoznik posted 1 patch 2 weeks ago
Test syntax-check failed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/8fbe4a1dd401d0c0408fcf92b28766923c1e1338.1584976211.git.mprivozn@redhat.com
docs/news.xml | 13 +++++++++++++
1 file changed, 13 insertions(+)

[PATCH] news: Document removal of support for .ini style of comments

Posted by Michal Privoznik 2 weeks ago
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>
---
 docs/news.xml | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/news.xml b/docs/news.xml
index ae4ee444d0..3de0a4945f 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 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">
-- 
2.24.1

Re: [PATCH] news: Document removal of support for .ini style of comments

Posted by Daniel P. Berrangé 2 weeks ago
On Mon, Mar 23, 2020 at 04:10:11PM +0100, Michal Privoznik wrote:
> 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>
> ---
>  docs/news.xml | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
> 
> diff --git a/docs/news.xml b/docs/news.xml
> index ae4ee444d0..3de0a4945f 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 config files

s/parsing of config/parsing of client authentication config/

since only that one config file uses this format

> +          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">
> -- 
> 2.24.1
> 

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|