[PATCH v2] docs: Mark "gluster" support in QEMU as deprecated

[PATCH v2] docs: Mark "gluster" support in QEMU as deprecated

[Thomas Huth]

According to https://marc.info/?l=fedora-devel-list&m=171934833215726
the GlusterFS development effectively ended. Thus mark it as deprecated
in QEMU, so we can remove it in a future release if the project does
not gain momentum again.

Acked-by: Niels de Vos <ndevos@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 v2: Mark it as deprecated in the QAPI and print a warning once, too

 docs/about/deprecated.rst | 9 +++++++++
 qapi/block-core.json      | 7 ++++++-
 block/gluster.c           | 2 ++
 3 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/docs/about/deprecated.rst b/docs/about/deprecated.rst
index ed31d4b0b2..b231aa3948 100644
--- a/docs/about/deprecated.rst
+++ b/docs/about/deprecated.rst
@@ -395,6 +395,15 @@ Specifying the iSCSI password in plain text on the command line using the
 used instead, to refer to a ``--object secret...`` instance that provides
 a password via a file, or encrypted.
 
+``gluster`` backend (since 9.2)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+According to https://marc.info/?l=fedora-devel-list&m=171934833215726
+the GlusterFS development effectively ended. Unless the development
+gains momentum again, the QEMU project might remove the gluster backend
+in a future release.
+
+
 Character device options
 ''''''''''''''''''''''''
 
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 9f6dd59298..cb7cb1c0ed 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -3187,12 +3187,17 @@
 #
 # @snapshot-access: Since 7.0
 #
+# Features:
+#
+# @deprecated: Member @gluster is deprecated since GlusterFS ceased development
+#
 # Since: 2.9
 ##
 { 'enum': 'BlockdevDriver',
   'data': [ 'blkdebug', 'blklogwrites', 'blkreplay', 'blkverify', 'bochs',
             'cloop', 'compress', 'copy-before-write', 'copy-on-read', 'dmg',
-            'file', 'snapshot-access', 'ftp', 'ftps', 'gluster',
+            'file', 'snapshot-access', 'ftp', 'ftps',
+            {'name': 'gluster', 'features': [ 'deprecated' ] },
             {'name': 'host_cdrom', 'if': 'HAVE_HOST_BLOCK_DEVICE' },
             {'name': 'host_device', 'if': 'HAVE_HOST_BLOCK_DEVICE' },
             'http', 'https',
diff --git a/block/gluster.c b/block/gluster.c
index f8b415f381..f03d05251e 100644
--- a/block/gluster.c
+++ b/block/gluster.c
@@ -809,6 +809,8 @@ static int qemu_gluster_open(BlockDriverState *bs,  QDict *options,
         goto out;
     }
 
+    warn_report_once("'gluster' is deprecated");
+
     filename = qemu_opt_get(opts, GLUSTER_OPT_FILENAME);
 
     s->debug = qemu_opt_get_number(opts, GLUSTER_OPT_DEBUG,
-- 
2.46.0

Re: [PATCH v2] docs: Mark "gluster" support in QEMU as deprecated

[Markus Armbruster]

Thomas Huth <thuth@redhat.com> writes:

> According to https://marc.info/?l=fedora-devel-list&m=171934833215726
> the GlusterFS development effectively ended. Thus mark it as deprecated
> in QEMU, so we can remove it in a future release if the project does
> not gain momentum again.
>
> Acked-by: Niels de Vos <ndevos@redhat.com>
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  v2: Mark it as deprecated in the QAPI and print a warning once, too
>
>  docs/about/deprecated.rst | 9 +++++++++
>  qapi/block-core.json      | 7 ++++++-
>  block/gluster.c           | 2 ++
>  3 files changed, 17 insertions(+), 1 deletion(-)
>
> diff --git a/docs/about/deprecated.rst b/docs/about/deprecated.rst
> index ed31d4b0b2..b231aa3948 100644
> --- a/docs/about/deprecated.rst
> +++ b/docs/about/deprecated.rst
> @@ -395,6 +395,15 @@ Specifying the iSCSI password in plain text on the command line using the
>  used instead, to refer to a ``--object secret...`` instance that provides
>  a password via a file, or encrypted.
>  
> +``gluster`` backend (since 9.2)
> +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> +
> +According to https://marc.info/?l=fedora-devel-list&m=171934833215726
> +the GlusterFS development effectively ended. Unless the development
> +gains momentum again, the QEMU project might remove the gluster backend
> +in a future release.
> +
> +
>  Character device options
>  ''''''''''''''''''''''''
>  
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 9f6dd59298..cb7cb1c0ed 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -3187,12 +3187,17 @@
>  #
>  # @snapshot-access: Since 7.0
>  #
> +# Features:
> +#
> +# @deprecated: Member @gluster is deprecated since GlusterFS ceased development

End the sentence with full stop, and wrap the line.  Suggest:

   # @deprecated: Member @gluster is deprecated because GlusterFS
   #     development ceased.

> +#
>  # Since: 2.9
>  ##
>  { 'enum': 'BlockdevDriver',
>    'data': [ 'blkdebug', 'blklogwrites', 'blkreplay', 'blkverify', 'bochs',
>              'cloop', 'compress', 'copy-before-write', 'copy-on-read', 'dmg',
> -            'file', 'snapshot-access', 'ftp', 'ftps', 'gluster',
> +            'file', 'snapshot-access', 'ftp', 'ftps',
> +            {'name': 'gluster', 'features': [ 'deprecated' ] },
>              {'name': 'host_cdrom', 'if': 'HAVE_HOST_BLOCK_DEVICE' },
>              {'name': 'host_device', 'if': 'HAVE_HOST_BLOCK_DEVICE' },
>              'http', 'https',

I wonder why it's not 'if': 'CONFIG_GLUSTERFS'.  Probably not worth
exploring now.

With the doc comment tidied up:
Acked-by: Markus Armbruster <armbru@redhat.com>

[...]

Re: [PATCH v2] docs: Mark "gluster" support in QEMU as deprecated

[Daniel P. Berrangé]

On Wed, Sep 25, 2024 at 09:15:14AM +0200, Thomas Huth wrote:
> According to https://marc.info/?l=fedora-devel-list&m=171934833215726
> the GlusterFS development effectively ended. Thus mark it as deprecated
> in QEMU, so we can remove it in a future release if the project does
> not gain momentum again.
> 
> Acked-by: Niels de Vos <ndevos@redhat.com>
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  v2: Mark it as deprecated in the QAPI and print a warning once, too
> 
>  docs/about/deprecated.rst | 9 +++++++++
>  qapi/block-core.json      | 7 ++++++-
>  block/gluster.c           | 2 ++
>  3 files changed, 17 insertions(+), 1 deletion(-)
> 
> diff --git a/docs/about/deprecated.rst b/docs/about/deprecated.rst
> index ed31d4b0b2..b231aa3948 100644
> --- a/docs/about/deprecated.rst
> +++ b/docs/about/deprecated.rst
> @@ -395,6 +395,15 @@ Specifying the iSCSI password in plain text on the command line using the
>  used instead, to refer to a ``--object secret...`` instance that provides
>  a password via a file, or encrypted.
>  
> +``gluster`` backend (since 9.2)
> +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> +
> +According to https://marc.info/?l=fedora-devel-list&m=171934833215726
> +the GlusterFS development effectively ended. Unless the development
> +gains momentum again, the QEMU project might remove the gluster backend
> +in a future release.

I'd suggest the second half of the sentance can be simplified:

   ", the QEMU project will remove the gluster backend/"

since marking something as deprecated is a stronger than "might".
We /will/ remove it, unless new informaton comes to light that
makes us re-evaluate the plans.


With 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 :|

Re: [PATCH v2] docs: Mark "gluster" support in QEMU as deprecated

[Markus Armbruster]

Daniel P. Berrangé <berrange@redhat.com> writes:

> On Wed, Sep 25, 2024 at 09:15:14AM +0200, Thomas Huth wrote:
>> According to https://marc.info/?l=fedora-devel-list&m=171934833215726
>> the GlusterFS development effectively ended. Thus mark it as deprecated
>> in QEMU, so we can remove it in a future release if the project does
>> not gain momentum again.
>> 
>> Acked-by: Niels de Vos <ndevos@redhat.com>
>> Signed-off-by: Thomas Huth <thuth@redhat.com>
>> ---
>>  v2: Mark it as deprecated in the QAPI and print a warning once, too
>> 
>>  docs/about/deprecated.rst | 9 +++++++++
>>  qapi/block-core.json      | 7 ++++++-
>>  block/gluster.c           | 2 ++
>>  3 files changed, 17 insertions(+), 1 deletion(-)
>> 
>> diff --git a/docs/about/deprecated.rst b/docs/about/deprecated.rst
>> index ed31d4b0b2..b231aa3948 100644
>> --- a/docs/about/deprecated.rst
>> +++ b/docs/about/deprecated.rst
>> @@ -395,6 +395,15 @@ Specifying the iSCSI password in plain text on the command line using the
>>  used instead, to refer to a ``--object secret...`` instance that provides
>>  a password via a file, or encrypted.
>>  
>> +``gluster`` backend (since 9.2)
>> +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>> +
>> +According to https://marc.info/?l=fedora-devel-list&m=171934833215726
>> +the GlusterFS development effectively ended. Unless the development
>> +gains momentum again, the QEMU project might remove the gluster backend
>> +in a future release.
>
> I'd suggest the second half of the sentance can be simplified:
>
>    ", the QEMU project will remove the gluster backend/"
>
> since marking something as deprecated is a stronger than "might".
> We /will/ remove it, unless new informaton comes to light that
> makes us re-evaluate the plans.

Good point.