summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-zns-zrwa-flush-zone.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-zns-zrwa-flush-zone.1 (renamed from Documentation/nvme-lnvm-factory.1)63
1 files changed, 19 insertions, 44 deletions
diff --git a/Documentation/nvme-lnvm-factory.1 b/Documentation/nvme-zns-zrwa-flush-zone.1
index c95396c..fb88210 100644
--- a/Documentation/nvme-lnvm-factory.1
+++ b/Documentation/nvme-zns-zrwa-flush-zone.1
@@ -1,13 +1,13 @@
'\" t
-.\" Title: nvme-lnvm-factory
+.\" Title: nvme-zns-zrwa-flush-zone
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 11/11/2021
+.\" Date: 12/13/2021
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-LNVM\-FACTORY" "1" "11/11/2021" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-ZRWA\-FLU" "1" "12/13/2021" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -28,38 +28,34 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-nvme-lnvm-factory \- Factory reset a LightNVM device
+nvme-zns-zrwa-flush-zone \- Flush LBAs associated with a ZRWA to a zone
.SH "SYNOPSIS"
.sp
.nf
-\fInvme lnvm\-factory\fR [\-\-device\-name=<DEVICE> | \-d <DEVICE>]
- [\-\-erase\-only\-marked | \-e]
- [\-\-clear\-host\-side\-blks | \-s]
- [\-\-clear\-bb\-blks | \-b]
+\fInvme zns zrwa\-flush\-zone\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
+ [\-\-lba=<LBA> | \-l <LBA>]
+ [\-\-timeout=<timeout> | \-t <timeout> ]
.fi
.SH "DESCRIPTION"
.sp
-Instantiate a target on top of a LightNVM enabled device\&. This exposes the physical for the user to use\&.
+For the NVMe device given, issues the Zone Management Send command with the "flush Zone" action\&. This will flush the zone that is opened as zone random write area\&.
+.sp
+The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
.SH "OPTIONS"
.PP
-\-\-device\-name=<DEVICE>, \-d <DEVICE>
-.RS 4
-Device name to factory initialize
-.RE
-.PP
-\-\-erase\-only\-marked, \-e
+\-n <NUM>, \-\-namespace\-id=<NUM>
.RS 4
-Erases only blocks that are marked in the bad block list
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
.RE
.PP
-\-\-clear\-host\-side\-blks, \-s
+\-l <lba>, \-\-lba=<lba>
.RS 4
-Remove host\-side bad block marks\&. This clear the media manager registration
+The LBA to flush up to\&.
.RE
.PP
-\-\-clear\-bb\-blks, \-b
+\-t <timeout>, \-\-timeout=<timeout>
.RS 4
-Removes the grown bad block marks\&. Allowing them to be rediscovered\&.
+Override default timeout value\&. In milliseconds\&.
.RE
.SH "EXAMPLES"
.sp
@@ -71,39 +67,18 @@ Removes the grown bad block marks\&. Allowing them to be rediscovered\&.
.sp -1
.IP \(bu 2.3
.\}
-Factory reset of device nvme0n1
-.RE
+flush the first zwra of first zone for zrwacg(15) on namespace 1:
.sp
.if n \{\
.RS 4
.\}
.nf
-# nvme lnvm\-factory \-d nvme0n1
+# nvme zns zrwa\-flush\-zone /dev/nvme0 \-n 1 \-l 15
.fi
.if n \{\
.RE
.\}
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Complete factory reset of device nvme0n1
.RE
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-# nvme lnvm\-factory \-d nvme0n1 \-s \-b
-.fi
-.if n \{\
-.RE
-.\}
.SH "NVME"
.sp
-Part of the nvme\-user suite
+Part of nvme\-cli