summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_status_to_string.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_mi_status_to_string.2')
-rw-r--r--doc/man/nvme_mi_status_to_string.217
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..ba26ae5
--- /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" "January 2023" "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