docs: Correct dbus graphics' accepted p2p values

[PATCH] docs: Correct dbus graphics' accepted p2p values

Martin Kletzander posted 1 patch 11 months ago

Download mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/36ecef5e137094cf0172dc005f934c65f3929d73.1741695410.git.mkletzan@redhat.com

docs/formatdomain.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

Expand all Fold all

[PATCH] docs: Correct dbus graphics' accepted p2p values

Posted by Martin Kletzander 11 months ago

The attribute is used (and formatted) as virTristateBool() and even in
schema defined as virYesNo, so the values are supposed to be `yes` and
`no`.

Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
---
 docs/formatdomain.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 4d03768c5f4e..3bbf94e192c9 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -6740,7 +6740,7 @@ interaction with the admin.
 
         <graphics type='dbus'/>
 
-      ``p2p`` (accepts ``on`` or ``off``) enables peer-to-peer connections,
+      ``p2p`` (accepts ``yes`` or ``no``) enables peer-to-peer connections,
       established through virDomainOpenGraphics() APIs.
 
       ``address`` (accepts a `D-Bus address
-- 
2.48.1

Re: [PATCH] docs: Correct dbus graphics' accepted p2p values

Posted by Michal Prívozník 11 months ago

On 3/11/25 13:16, Martin Kletzander wrote:
> The attribute is used (and formatted) as virTristateBool() and even in
> schema defined as virYesNo, so the values are supposed to be `yes` and
> `no`.
> 
> Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
> ---
>  docs/formatdomain.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
> index 4d03768c5f4e..3bbf94e192c9 100644
> --- a/docs/formatdomain.rst
> +++ b/docs/formatdomain.rst
> @@ -6740,7 +6740,7 @@ interaction with the admin.
>  
>          <graphics type='dbus'/>
>  
> -      ``p2p`` (accepts ``on`` or ``off``) enables peer-to-peer connections,
> +      ``p2p`` (accepts ``yes`` or ``no``) enables peer-to-peer connections,
>        established through virDomainOpenGraphics() APIs.
>  
>        ``address`` (accepts a `D-Bus address

Reviewed-by: Michal Privoznik <mprivozn@redhat.com>

Michal