Adding upstream version 1.3.upstream/1.3upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 22 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..fef0824
--- /dev/null
+++ b/doc/man/nvmf_get_discovery_log.2
@@ -0,0 +1,22 @@
+.TH "nvmf_get_discovery_log" 9 "nvmf_get_discovery_log" "January 2023" "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
+Discovery controller to use
+.IP "logp" 12
+Pointer to the log page to be returned
+.IP "max_retries" 12
+Number of retries in case of failure
+.SH "DESCRIPTION"
+The memory allocated for the log page and returned in \fIlogp\fP
+must be freed by the caller using \fBfree\fP.
+.SH "NOTE"
+Consider using \fBnvmf_get_discovery_wargs\fP instead.
+.SH "RETURN"
+0 on success; on failure -1 is returned and errno is set