From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Wed, 1 May 2019 18:35:34 +0000 (-0400)
Subject: Document lttng_directory_handle_init_from_dirfd
X-Git-Tag: v2.12.0-rc1~579
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=15d59b1d535b95f021671f441534097b4cd72031;p=lttng-tools.git

Document lttng_directory_handle_init_from_dirfd

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/src/common/compat/directory-handle.h b/src/common/compat/directory-handle.h
index dad4299ca..121918094 100644
--- a/src/common/compat/directory-handle.h
+++ b/src/common/compat/directory-handle.h
@@ -51,6 +51,16 @@ LTTNG_HIDDEN
 int lttng_directory_handle_init(struct lttng_directory_handle *handle,
 		const char *path);
 
+/*
+ * Initialize a new directory handle from an existing directory fd.
+ *
+ * The new directory handle assumes the ownership of the directory fd.
+ * Note that this method should only be used in very specific cases, such as
+ * re-creating a directory handle from a dirfd passed over a unix socket.
+ *
+ * An initialized directory handle must be finalized using
+ * lttng_directory_handle_fini().
+ */
 LTTNG_HIDDEN
 int lttng_directory_handle_init_from_dirfd(
 		struct lttng_directory_handle *handle, int dirfd);