util: Document limitation of virFileCanonicalizePath

On most platforms virFileCanonicalizePath is implemented using
realpath(), which only works on existing paths.

Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>

diff --git a/src/util/virfile.c b/src/util/virfile.c
index 7cab3d0cd6732fae7c680bfe623f451be3963a54..242aa7ff88ff8e3f37e146ca924dec8a9385bdd5 100644 (file)
--- a/src/util/virfile.c
+++ b/src/util/virfile.c
@@ -3408,7 +3408,8 @@ virFileSanitizePath(const char *path)
 /**
  * virFileCanonicalizePath:
  *
- * Returns the canonical representation of @path.
+ * Returns the canonical representation of @path. This function is only
+ * guaranteed to work when @path exists. It may return NULL otherwise.
  *
  * The returned string must be freed after use.
  */