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/nvme_mi_admin_identify_ns.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/nvme_mi_admin_identify_ns.2')
-rw-r--r-- | doc/man/nvme_mi_admin_identify_ns.2 | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_identify_ns.2 b/doc/man/nvme_mi_admin_identify_ns.2 new file mode 100644 index 0000000..233be5b --- /dev/null +++ b/doc/man/nvme_mi_admin_identify_ns.2 @@ -0,0 +1,21 @@ +.TH "nvme_mi_admin_identify_ns" 9 "nvme_mi_admin_identify_ns" "October 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_identify_ns \- Perform an Admin identify command for a namespace +.SH SYNOPSIS +.B "int" nvme_mi_admin_identify_ns +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "__u32 nsid " "," +.BI "struct nvme_id_ns *ns " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to process identify command +.IP "nsid" 12 +namespace ID +.IP "ns" 12 +Namespace identification to populate +.SH "DESCRIPTION" +Perform an Identify (namespace) command, setting the namespace id data +in \fIns\fP. The namespace is expected to active and allocated. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |