From 2dba2525fb35dcfc79aad5bdf6c92e790d69635c Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 29 Apr 2024 06:40:20 +0200 Subject: Adding upstream version 1.3. Signed-off-by: Daniel Baumann --- doc/man/nvme_mi_admin_get_log_sanitize.2 | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 doc/man/nvme_mi_admin_get_log_sanitize.2 (limited to 'doc/man/nvme_mi_admin_get_log_sanitize.2') diff --git a/doc/man/nvme_mi_admin_get_log_sanitize.2 b/doc/man/nvme_mi_admin_get_log_sanitize.2 new file mode 100644 index 0000000..2eb8ca1 --- /dev/null +++ b/doc/man/nvme_mi_admin_get_log_sanitize.2 @@ -0,0 +1,21 @@ +.TH "nvme_mi_admin_get_log_sanitize" 9 "nvme_mi_admin_get_log_sanitize" "January 2023" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_get_log_sanitize \- Retrieve Sanitize Status +.SH SYNOPSIS +.B "int" nvme_mi_admin_get_log_sanitize +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "bool rae " "," +.BI "struct nvme_sanitize_log_page *log " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to query +.IP "rae" 12 +Retain asynchronous events +.IP "log" 12 +User address to store the sanitize log +.SH "DESCRIPTION" +The Sanitize Status log page reports sanitize operation time estimates and +information about the most recent sanitize operation. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. -- cgit v1.2.3