diff mbox series

[v3,4/4] block/rbd: add deprecation documenation for filename keyvalue pairs

Message ID fb330b4c21bf6c53cc4ada53f3f33e13e531ee6c.1536701561.git.jcody@redhat.com
State New
Headers show
Series block/rbd: enable filename parsing on open | expand

Commit Message

Jeff Cody Sept. 11, 2018, 9:34 p.m. UTC
Signed-off-by: Jeff Cody <jcody@redhat.com>
---
 qemu-deprecated.texi | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Eric Blake Sept. 11, 2018, 9:56 p.m. UTC | #1
[MAINTAINERS says libvir-list should have been cc'd; not sure why that 
didn't happen]

On 9/11/18 4:34 PM, Jeff Cody wrote:
> Signed-off-by: Jeff Cody <jcody@redhat.com>

In the subject: s/documenation/documentation/

> ---
>   qemu-deprecated.texi | 7 +++++++
>   1 file changed, 7 insertions(+)
> 
> diff --git a/qemu-deprecated.texi b/qemu-deprecated.texi
> index 1b9c007f12..4df8ac442d 100644
> --- a/qemu-deprecated.texi
> +++ b/qemu-deprecated.texi
> @@ -190,6 +190,13 @@ used instead.
>   In order to prevent QEMU from automatically opening an image's backing
>   chain, use ``"backing": null'' instead.
>   
> +@subsubsection "rbd keyvalue pair encoded filenames": "" (since 3.1.0)
> +
> +Options for ``rbd'' should be specified according to its runtime options,
> +like other block drivers.  Legacy parsing of keyvalue pair encoded
> +filenames is useful to open images with the old format for backing files;
> +These image files should be updated to use the current format.

Can we give an example?  Cribbing from patch 3, an example might look 
like changing:

json:{"file.driver":"rbd", "file.filename":"rbd:rbd/name"}

into:

json:{"file.driver":"rbd", "file.pool":"rbd", "file.image":"name"}

I'll let Peter or John comment on whether libvirt's RBD pool handler is 
impacted by this deprecation, but it seems reasonable to me.
Jeff Cody Sept. 11, 2018, 10:16 p.m. UTC | #2
On Tue, Sep 11, 2018 at 04:56:36PM -0500, Eric Blake wrote:
> [MAINTAINERS says libvir-list should have been cc'd; not sure why that
> didn't happen]
> 

Thanks

> On 9/11/18 4:34 PM, Jeff Cody wrote:
> >Signed-off-by: Jeff Cody <jcody@redhat.com>
> 
> In the subject: s/documenation/documentation/
> 
> >---
> >  qemu-deprecated.texi | 7 +++++++
> >  1 file changed, 7 insertions(+)
> >
> >diff --git a/qemu-deprecated.texi b/qemu-deprecated.texi
> >index 1b9c007f12..4df8ac442d 100644
> >--- a/qemu-deprecated.texi
> >+++ b/qemu-deprecated.texi
> >@@ -190,6 +190,13 @@ used instead.
> >  In order to prevent QEMU from automatically opening an image's backing
> >  chain, use ``"backing": null'' instead.
> >+@subsubsection "rbd keyvalue pair encoded filenames": "" (since 3.1.0)
> >+
> >+Options for ``rbd'' should be specified according to its runtime options,
> >+like other block drivers.  Legacy parsing of keyvalue pair encoded
> >+filenames is useful to open images with the old format for backing files;
> >+These image files should be updated to use the current format.
> 
> Can we give an example?  Cribbing from patch 3, an example might look like
> changing:
> 
> json:{"file.driver":"rbd", "file.filename":"rbd:rbd/name"}
> 
> into:
> 
> json:{"file.driver":"rbd", "file.pool":"rbd", "file.image":"name"}
> 

That is a good example, I'll include it.

> I'll let Peter or John comment on whether libvirt's RBD pool handler is
> impacted by this deprecation, but it seems reasonable to me.
> 

Thanks!
diff mbox series

Patch

diff --git a/qemu-deprecated.texi b/qemu-deprecated.texi
index 1b9c007f12..4df8ac442d 100644
--- a/qemu-deprecated.texi
+++ b/qemu-deprecated.texi
@@ -190,6 +190,13 @@  used instead.
 In order to prevent QEMU from automatically opening an image's backing
 chain, use ``"backing": null'' instead.
 
+@subsubsection "rbd keyvalue pair encoded filenames": "" (since 3.1.0)
+
+Options for ``rbd'' should be specified according to its runtime options,
+like other block drivers.  Legacy parsing of keyvalue pair encoded
+filenames is useful to open images with the old format for backing files;
+These image files should be updated to use the current format.
+
 @subsection vio-spapr-device device options
 
 @subsubsection "irq": "" (since 3.0.0)