From 4cb0ffa46490cadfdc0ad34e97a742960b8fd8fa Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Wed, 1 May 2019 14:35:34 -0400 Subject: [PATCH] Document lttng_directory_handle_init_from_dirfd MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau --- src/common/compat/directory-handle.h | 10 ++++++++++ 1 file changed, 10 insertions(+) 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); -- 2.34.1