[PATCH] virxml: Fix virXMLPropTristateBoolAllowDefault() documentation

Michal Privoznik via Devel posted 1 patch 1 week ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/77f96eed62f7138267ad1ecf43844a43dab95be8.1774515864.git.mprivozn@redhat.com
src/util/virxml.c | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
[PATCH] virxml: Fix virXMLPropTristateBoolAllowDefault() documentation
Posted by Michal Privoznik via Devel 1 week ago
From: Michal Privoznik <mprivozn@redhat.com>

The documentation to virXMLPropTristateBoolAllowDefault() refers
to itself while it meant to refer to virXMLPropTristateBool().

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
---
 src/util/virxml.c | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/util/virxml.c b/src/util/virxml.c
index 274f072598..beb5301378 100644
--- a/src/util/virxml.c
+++ b/src/util/virxml.c
@@ -525,13 +525,13 @@ virXMLPropTristateBool(xmlNodePtr node,
 }
 
 
-/* Same as virXMLPropTristateBoolAllowDefault, but will accept the
- * value 'default' and convert it to VIR_TRISTATE_BOOL_ABSENT instead
- * of rejecting it with an error. Should only be used for backwards
- * compatibility reasons, and specifically to parse XML files where a
- * property having value VIR_TRISTATE_BOOL_ABSENT has historically
- * resulted in it being formatted with value 'default' instead of
- * being omitted entirely */
+/* Same as virXMLPropTristateBool, but will accept the value 'default'
+ * and convert it to VIR_TRISTATE_BOOL_ABSENT instead of rejecting it
+ * with an error. Should only be used for backwards compatibility
+ * reasons, and specifically to parse XML files where a property
+ * having value VIR_TRISTATE_BOOL_ABSENT has historically resulted in
+ * it being formatted with value 'default' instead of being omitted
+ * entirely. */
 int
 virXMLPropTristateBoolAllowDefault(xmlNodePtr node,
                                    const char *name,
-- 
2.52.0
Re: [PATCH] virxml: Fix virXMLPropTristateBoolAllowDefault() documentation
Posted by Ján Tomko via Devel 1 week ago
On a Thursday in 2026, Michal Privoznik via Devel wrote:
>From: Michal Privoznik <mprivozn@redhat.com>
>
>The documentation to virXMLPropTristateBoolAllowDefault() refers
>to itself while it meant to refer to virXMLPropTristateBool().
>
>Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
>---
> src/util/virxml.c | 14 +++++++-------
> 1 file changed, 7 insertions(+), 7 deletions(-)
>

Reviewed-by: Ján Tomko <jtomko@redhat.com>

Jano