summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_format_nvm.2
blob: bf53c5cbd2b03cbedaa4a83233eb53f12c663de2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
.TH "nvme_format_nvm" 9 "nvme_format_nvm" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_format_nvm \- Format nvme namespace(s)
.SH SYNOPSIS
.B "int" nvme_format_nvm
.BI "(struct nvme_format_nvm_args *args "  ");"
.SH ARGUMENTS
.IP "args" 12
\fIstruct nvme_format_nvme_args\fP argument structure
.SH "DESCRIPTION"
The Format NVM command low level formats the NVM media. This command is used
by the host to change the LBA data size and/or metadata size. A low level
format may destroy all data and metadata associated with all namespaces or
only the specific namespace associated with the command
.SH "RETURN"
The nvme command status if a response was received (see
\fIenum nvme_status_field\fP) or -1 with errno set otherwise.