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_format_nvm.2 | |
| parent | Adding upstream version 1.1. (diff) | |
| download | libnvme-0e778f1627598830463288f078b8314fe32d9d07.tar.xz libnvme-0e778f1627598830463288f078b8314fe32d9d07.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_format_nvm.2')
| -rw-r--r-- | doc/man/nvme_mi_admin_format_nvm.2 | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_format_nvm.2 b/doc/man/nvme_mi_admin_format_nvm.2 new file mode 100644 index 0000000..95550ee --- /dev/null +++ b/doc/man/nvme_mi_admin_format_nvm.2 @@ -0,0 +1,18 @@ +.TH "nvme_mi_admin_format_nvm" 9 "nvme_mi_admin_format_nvm" "October 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_format_nvm \- Format NVMe namespace +.SH SYNOPSIS +.B "int" nvme_mi_admin_format_nvm +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "struct nvme_format_nvm_args *args " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to send command to +.IP "args" 12 +Format NVM command arguments +.SH "DESCRIPTION" +Perform a low-level format to set the LBA data & metadata size. May destroy +data & metadata on the specified namespaces +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |