summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_sanitize_nvm_args.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-26 05:25:24 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-26 05:25:24 +0000
commitacf73199fa227b97217238334236af367c8ab2d7 (patch)
treeb6812bd6cbe6b977884ec94def20de59555983d5 /doc/man/nvme_sanitize_nvm_args.2
parentAdding upstream version 1.0. (diff)
downloadlibnvme-acf73199fa227b97217238334236af367c8ab2d7.tar.xz
libnvme-acf73199fa227b97217238334236af367c8ab2d7.zip
Adding upstream version 1.1~rc0.upstream/1.1_rc0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_sanitize_nvm_args.2')
-rw-r--r--doc/man/nvme_sanitize_nvm_args.251
1 files changed, 0 insertions, 51 deletions
diff --git a/doc/man/nvme_sanitize_nvm_args.2 b/doc/man/nvme_sanitize_nvm_args.2
deleted file mode 100644
index 1a414db..0000000
--- a/doc/man/nvme_sanitize_nvm_args.2
+++ /dev/null
@@ -1,51 +0,0 @@
-.TH "libnvme" 9 "struct nvme_sanitize_nvm_args" "April 2022" "API Manual" LINUX
-.SH NAME
-struct nvme_sanitize_nvm_args \- Arguments for the NVMe Sanitize NVM command
-.SH SYNOPSIS
-struct nvme_sanitize_nvm_args {
-.br
-.BI " __u32 *result;"
-.br
-.BI " int args_size;"
-.br
-.BI " int fd;"
-.br
-.BI " __u32 timeout;"
-.br
-.BI " enum nvme_sanitize_sanact sanact;"
-.br
-.BI " __u32 ovrpat;"
-.br
-.BI " bool ause;"
-.br
-.BI " __u8 owpass;"
-.br
-.BI " bool oipbp;"
-.br
-.BI " bool nodas;"
-.br
-.BI "
-};
-.br
-
-.SH Members
-.IP "result" 12
-The command completion result from CQE dword0
-.IP "args_size" 12
-Size of \fIstruct nvme_sanitize_nvm_args\fP
-.IP "fd" 12
-File descriptor of nvme device
-.IP "timeout" 12
-Timeout in ms
-.IP "sanact" 12
-Sanitize action, see \fIenum nvme_sanitize_sanact\fP
-.IP "ovrpat" 12
-Overwrite pattern
-.IP "ause" 12
-Set to allow unrestriced sanitize exit
-.IP "owpass" 12
-Overwrite pass count
-.IP "oipbp" 12
-Set to overwrite invert pattern between passes
-.IP "nodas" 12
-Set to not deallocate blocks after sanitizing