diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-11-05 18:17:21 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-11-05 18:17:32 +0000 |
commit | b0dc2feab3271dbcb42df6e6d8a37138a90c44a1 (patch) | |
tree | ae02f159c125f183b2adae47fdf0e64357bf76a8 /doc/man/nvmf_get_discovery_wargs.2 | |
parent | Releasing debian version 1.1-2. (diff) | |
download | libnvme-b0dc2feab3271dbcb42df6e6d8a37138a90c44a1.tar.xz libnvme-b0dc2feab3271dbcb42df6e6d8a37138a90c44a1.zip |
Merging upstream version 1.2.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvmf_get_discovery_wargs.2')
-rw-r--r-- | doc/man/nvmf_get_discovery_wargs.2 | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/man/nvmf_get_discovery_wargs.2 b/doc/man/nvmf_get_discovery_wargs.2 new file mode 100644 index 0000000..b07c2f9 --- /dev/null +++ b/doc/man/nvmf_get_discovery_wargs.2 @@ -0,0 +1,20 @@ +.TH "nvmf_get_discovery_wargs" 9 "nvmf_get_discovery_wargs" "October 2022" "libnvme API manual" LINUX +.SH NAME +nvmf_get_discovery_wargs \- Get the discovery log page with args +.SH SYNOPSIS +.B "struct nvmf_discovery_log *" nvmf_get_discovery_wargs +.BI "(struct nvme_get_discovery_args *args " ");" +.SH ARGUMENTS +.IP "args" 12 +Argument structure +.SH "DESCRIPTION" +This function is similar to \fBnvmf_get_discovery_log\fP, but +takes an extensible \fIargs\fP parameter. \fIargs\fP provides more +options than \fBnvmf_get_discovery_log\fP. + +This function performs a get discovery log page (DLP) command +and returns the DLP. The memory allocated for the returned +DLP must be freed by the caller using \fBfree\fP. +.SH "RETURN" +Pointer to the discovery log page (to be freed). NULL +on failure and errno is set. |