diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-11-05 18:17:17 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-11-05 18:17:17 +0000 |
| commit | 0e75b5495117b9888b7a557fab1db40145a9a705 (patch) | |
| tree | e294b5156b7a85197e4b3192b6fba291a26dd5c6 /doc/man/nvmf_get_discovery_log.2 | |
| parent | Adding upstream version 1.1. (diff) | |
| download | libnvme-0e75b5495117b9888b7a557fab1db40145a9a705.tar.xz libnvme-0e75b5495117b9888b7a557fab1db40145a9a705.zip | |
Adding upstream version 1.2.upstream/1.2
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.2 | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/doc/man/nvmf_get_discovery_log.2 b/doc/man/nvmf_get_discovery_log.2 index 87a3c7c..715fe10 100644 --- a/doc/man/nvmf_get_discovery_log.2 +++ b/doc/man/nvmf_get_discovery_log.2 @@ -1,4 +1,4 @@ -.TH "nvmf_get_discovery_log" 9 "nvmf_get_discovery_log" "August 2022" "libnvme API manual" LINUX +.TH "nvmf_get_discovery_log" 9 "nvmf_get_discovery_log" "October 2022" "libnvme API manual" LINUX .SH NAME nvmf_get_discovery_log \- Return the discovery log page .SH SYNOPSIS @@ -8,10 +8,15 @@ nvmf_get_discovery_log \- Return the discovery log page .BI "int max_retries " ");" .SH ARGUMENTS .IP "c" 12 -Discover controller to use +Discovery 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 +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 |