Adding upstream version 1.0.upstream/1.0

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

1 files changed, 26 insertions, 0 deletions

diff --git a/doc/man/nvme_identify_ns_descs.2 b/doc/man/nvme_identify_ns_descs.2
new file mode 100644
index 0000000..def86ee
--- /dev/null
+++ b/doc/man/nvme_identify_ns_descs.2
@@ -0,0 +1,26 @@
+.TH "nvme_identify_ns_descs" 9 "nvme_identify_ns_descs" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_identify_ns_descs \- Retrieves namespace descriptor list
+.SH SYNOPSIS
+.B "int" nvme_identify_ns_descs
+.BI "(int fd "  ","
+.BI "__u32 nsid "  ","
+.BI "struct nvme_ns_id_desc *descs "  ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "nsid" 12
+The namespace id to retrieve destriptors
+.IP "descs" 12
+User space destination address to transfer the data
+.SH "DESCRIPTION"
+A list of Namespace Identification Descriptor structures is returned to the
+host for the namespace specified in the Namespace Identifier (NSID) field if
+it is an active NSID.
+
+The data returned is in the form of an arrray of 'struct nvme_ns_id_desc'.
+
+See \fIstruct nvme_ns_id_desc\fP for the definition of the returned structure.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.