summaryrefslogtreecommitdiffstats
path: root/doc/man/nvmf_get_discovery_log.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:53:09 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:53:09 +0000
commit3945f3269b3e2763faa1ab22d225ca4dd1856b82 (patch)
tree7e96ec768baa3807ce3a1076a74037a287f4caa8 /doc/man/nvmf_get_discovery_log.2
parentInitial commit. (diff)
downloadlibnvme-3945f3269b3e2763faa1ab22d225ca4dd1856b82.tar.xz
libnvme-3945f3269b3e2763faa1ab22d225ca4dd1856b82.zip
Adding upstream version 1.0.upstream/1.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvmf_get_discovery_log.2')
-rw-r--r--doc/man/nvmf_get_discovery_log.217
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/man/nvmf_get_discovery_log.2 b/doc/man/nvmf_get_discovery_log.2
new file mode 100644
index 0000000..aee9c17
--- /dev/null
+++ b/doc/man/nvmf_get_discovery_log.2
@@ -0,0 +1,17 @@
+.TH "nvmf_get_discovery_log" 9 "nvmf_get_discovery_log" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvmf_get_discovery_log \- Return the discovery log page
+.SH SYNOPSIS
+.B "int" nvmf_get_discovery_log
+.BI "(nvme_ctrl_t c " ","
+.BI "struct nvmf_discovery_log **logp " ","
+.BI "int max_retries " ");"
+.SH ARGUMENTS
+.IP "c" 12
+Discover controller to use
+.IP "logp" 12
+Pointer to the log page to be returned
+.IP "max_retries" 12
+maximum number of log page entries to be returned
+.SH "RETURN"
+0 on success; on failure -1 is returned and errno is set