summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_ns_get_fd.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:51:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:51:44 +0000
commit4da5b4b2fba02bd3e78f16828359cef79a757911 (patch)
tree326db4edaddfc20f78fb048509fd646f497e2a65 /doc/man/nvme_ns_get_fd.2
parentAdding upstream version 1.5. (diff)
downloadlibnvme-4da5b4b2fba02bd3e78f16828359cef79a757911.tar.xz
libnvme-4da5b4b2fba02bd3e78f16828359cef79a757911.zip
Adding upstream version 1.7.1.upstream/1.7.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_ns_get_fd.2')
-rw-r--r--doc/man/nvme_ns_get_fd.29
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/man/nvme_ns_get_fd.2 b/doc/man/nvme_ns_get_fd.2
index c58e71e..aac4306 100644
--- a/doc/man/nvme_ns_get_fd.2
+++ b/doc/man/nvme_ns_get_fd.2
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_fd" 9 "nvme_ns_get_fd" "June 2023" "libnvme API manual" LINUX
+.TH "nvme_ns_get_fd" 9 "nvme_ns_get_fd" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_fd \- Get associated file descriptor
.SH SYNOPSIS
@@ -7,5 +7,12 @@ nvme_ns_get_fd \- Get associated file descriptor
.SH ARGUMENTS
.IP "n" 12
Namespace instance
+.SH "DESCRIPTION"
+libnvme will \fBopen\fP the file (if not already opened) and keep
+an internal copy of the file descriptor. Following calls to
+this API retrieve the internal cached copy of the file
+descriptor. The file will remain opened and the fd will
+remain cached until the ns object is deleted or
+\fBnvme_ns_release_fd\fP is called.
.SH "RETURN"
File descriptor associated with \fIn\fP or -1