]> xenbits.xensource.com Git - libvirt.git/commitdiff
util: xml: Adjust documentation of virXMLPropString
authorPeter Krempa <pkrempa@redhat.com>
Fri, 16 Sep 2022 07:14:42 +0000 (09:14 +0200)
committerPeter Krempa <pkrempa@redhat.com>
Mon, 3 Oct 2022 12:43:17 +0000 (14:43 +0200)
All callers treat NULL as if the string is not present in the XML.
Adjust the description so that it's implied that it's not an error and
thus also no error reporting is expected.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
src/util/virxml.c

index f92cd32dfa6d8977b4c2980a009266c8c80bf15c..7122d42ef1962fcfc63038e1b2f7ba6b8a77a8d6 100644 (file)
@@ -443,7 +443,8 @@ virXMLCheckIllegalChars(const char *nodeName,
  *
  * Convenience function to return copy of an attribute value of a XML node.
  *
- * Returns the property (attribute) value as string or NULL in case of failure.
+ * Returns the property (attribute) value as string or NULL if the attribute
+ * is not present (no error is reported).
  * The caller is responsible for freeing the returned buffer.
  */
 char *