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_status_to_string.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_status_to_string.2')
-rw-r--r-- | doc/man/nvme_mi_status_to_string.2 | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_status_to_string.2 b/doc/man/nvme_mi_status_to_string.2 new file mode 100644 index 0000000..a65a85f --- /dev/null +++ b/doc/man/nvme_mi_status_to_string.2 @@ -0,0 +1,17 @@ +.TH "nvme_mi_status_to_string" 9 "nvme_mi_status_to_string" "October 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_status_to_string \- return a string representation of the MI status. +.SH SYNOPSIS +.B "const char *" nvme_mi_status_to_string +.BI "(int status " ");" +.SH ARGUMENTS +.IP "status" 12 +MI response status +.SH "DESCRIPTION" +Gives a string description of \fIstatus\fP, as per section 4.1.2 of the NVMe-MI +spec. The status value should be of type NVME_STATUS_MI, and extracted +from the return value using \fBnvme_status_get_value\fP. + +Returned string is const, and should not be \fBfree\fPed. +.SH "RETURN" +A string representing the status value |