[PATCH 2/4] conf: domain: Add comment for 'virDomainObjTaint'
Outline what the function does, especially the return value.
Signed-off-by: Peter Krempa <pkrempa(a)redhat.com>
---
src/conf/domain_conf.c | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c
index 84ffd93b7f..39ddfb7db0 100644
--- a/src/conf/domain_conf.c
+++ b/src/conf/domain_conf.c
@@ -1915,8 +1915,17 @@ virDomainBlkioDeviceParseXML(xmlNodePtr root,
}
-bool virDomainObjTaint(virDomainObj *obj,
- virDomainTaintFlags taint)
+/**
+ * virDomainObjTaint:
+ * @obj: domain object
+ * @taint: domain taint flag
+ *
+ * Marks @obj as tainted by @taint. Returns 'false' if @obj already has
+ * been tainted with @taint.
+ */
+bool
+virDomainObjTaint(virDomainObj *obj,
+ virDomainTaintFlags taint)
{
unsigned int flag = (1 << taint);
--
2.39.2