[Libguestfs] [nbdkit PATCH v3 1/2] docs: improve documentation of nbdkit_absolute_path

[Pino Toscano]

Mention what it really does, and where it can only be used.

Signed-off-by: Pino Toscano <ptoscano at redhat.com>
---
 docs/nbdkit-plugin.pod | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/docs/nbdkit-plugin.pod b/docs/nbdkit-plugin.pod
index 65f3190..27a885e 100644
--- a/docs/nbdkit-plugin.pod
+++ b/docs/nbdkit-plugin.pod
@@ -273,7 +273,12 @@ descriptor.
  char *nbdkit_absolute_path (const char *filename);
 
 The utility function C<nbdkit_absolute_path> converts any path to an
-absolute path.
+absolute path: if it is relative, then all this function does is
+prepending the current working directory to the path, with no extra
+checks.
+
+Note that this function works I<only> when used in the C<.config>, and
+C<.config_complete> callbacks.
 
 If conversion was not possible, this calls C<nbdkit_error> and returns
 C<NULL>.  Note that this function does not check that the file exists.
-- 
2.14.3