docs: fix broken UUID example

[PATCH] docs: fix broken UUID example

Posted by Daniel P. Berrangé via Devel 3 weeks, 6 days ago

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

The UUID had only 11 characters in the last component, instead of the
required 12.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 docs/formatsecret.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/formatsecret.rst b/docs/formatsecret.rst
index d4e0cb9ddb..bbf2fc22ea 100644
--- a/docs/formatsecret.rst
+++ b/docs/formatsecret.rst
@@ -73,7 +73,7 @@ passphrase to decrypt the volume, :since:`since 2.1.0`. An example follows:
    # cat luks-secret.xml
    <secret ephemeral='no' private='yes'>
       <description>LUKS Sample Secret</description>
-      <uuid>f52a81b2-424e-490c-823d-6bd4235bc57</uuid>
+      <uuid>f52a81b2-424e-490c-823d-6bd4235bc507</uuid>
       <usage type='volume'>
          <volume>/var/lib/libvirt/images/luks-sample.img</volume>
       </usage>
@@ -91,7 +91,7 @@ The volume type secret can be supplied in domain XML for a luks storage volume
 ::
 
    <encryption format='luks'>
-     <secret type='passphrase' uuid='f52a81b2-424e-490c-823d-6bd4235bc57'/>
+     <secret type='passphrase' uuid='f52a81b2-424e-490c-823d-6bd4235bc507'/>
    </encryption>
 
 Usage type "ceph"
-- 
2.52.0

Re: [PATCH] docs: fix broken UUID example

Posted by Arun Menon via Devel 3 weeks, 5 days ago

On Mon, Jan 05, 2026 at 05:36:02PM +0000, Daniel P. Berrangé via Devel wrote:
> From: Daniel P. Berrangé <berrange@redhat.com>
> 
> The UUID had only 11 characters in the last component, instead of the
> required 12.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>  docs/formatsecret.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/formatsecret.rst b/docs/formatsecret.rst
> index d4e0cb9ddb..bbf2fc22ea 100644
> --- a/docs/formatsecret.rst
> +++ b/docs/formatsecret.rst
> @@ -73,7 +73,7 @@ passphrase to decrypt the volume, :since:`since 2.1.0`. An example follows:
>     # cat luks-secret.xml
>     <secret ephemeral='no' private='yes'>
>        <description>LUKS Sample Secret</description>
> -      <uuid>f52a81b2-424e-490c-823d-6bd4235bc57</uuid>
> +      <uuid>f52a81b2-424e-490c-823d-6bd4235bc507</uuid>
>        <usage type='volume'>
>           <volume>/var/lib/libvirt/images/luks-sample.img</volume>
>        </usage>
> @@ -91,7 +91,7 @@ The volume type secret can be supplied in domain XML for a luks storage volume
>  ::
>  
>     <encryption format='luks'>
> -     <secret type='passphrase' uuid='f52a81b2-424e-490c-823d-6bd4235bc57'/>
> +     <secret type='passphrase' uuid='f52a81b2-424e-490c-823d-6bd4235bc507'/>
>     </encryption>
>  
>  Usage type "ceph"
> -- 
> 2.52.0
> 

Reviewed-by: Arun Menon <armenon@redhat.com>

Regards,
Arun

Re: [PATCH] docs: fix broken UUID example

Posted by Daniel P. Berrangé via Devel 3 weeks, 5 days ago

On Tue, Jan 06, 2026 at 02:16:13PM +0530, Arun Menon via Devel wrote:
> On Mon, Jan 05, 2026 at 05:36:02PM +0000, Daniel P. Berrangé via Devel wrote:
> > From: Daniel P. Berrangé <berrange@redhat.com>
> > 
> > The UUID had only 11 characters in the last component, instead of the
> > required 12.
> > 
> > Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> > ---
> >  docs/formatsecret.rst | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/docs/formatsecret.rst b/docs/formatsecret.rst
> > index d4e0cb9ddb..bbf2fc22ea 100644
> > --- a/docs/formatsecret.rst
> > +++ b/docs/formatsecret.rst
> > @@ -73,7 +73,7 @@ passphrase to decrypt the volume, :since:`since 2.1.0`. An example follows:
> >     # cat luks-secret.xml
> >     <secret ephemeral='no' private='yes'>
> >        <description>LUKS Sample Secret</description>
> > -      <uuid>f52a81b2-424e-490c-823d-6bd4235bc57</uuid>
> > +      <uuid>f52a81b2-424e-490c-823d-6bd4235bc507</uuid>

I realized that this uuid is used in many other examples too, and then all
have a trailing '2', so I will change my fix to add the trailing 2 instead
for consistency.

> >        <usage type='volume'>
> >           <volume>/var/lib/libvirt/images/luks-sample.img</volume>
> >        </usage>
> > @@ -91,7 +91,7 @@ The volume type secret can be supplied in domain XML for a luks storage volume
> >  ::
> >  
> >     <encryption format='luks'>
> > -     <secret type='passphrase' uuid='f52a81b2-424e-490c-823d-6bd4235bc57'/>
> > +     <secret type='passphrase' uuid='f52a81b2-424e-490c-823d-6bd4235bc507'/>
> >     </encryption>
> >  
> >  Usage type "ceph"
> > -- 
> > 2.52.0
> > 
> 
> Reviewed-by: Arun Menon <armenon@redhat.com>
> 
> Regards,
> Arun
> 

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