[PATCH iproute2] man: devlink-region(8): document the 'new' subcommand
From: Baruch Siach <baruch@tkos.co.il>
Date: 2022-09-02 05:03:17
Subsystem:
the rest · Maintainer:
Linus Torvalds
Some driver provide no region snapshot unless created first with the 'new' operation. Add documentation and example. Signed-off-by: Baruch Siach <baruch@tkos.co.il> --- man/man8/devlink-region.8 | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+)
diff --git a/man/man8/devlink-region.8 b/man/man8/devlink-region.8
index e6617c189c34..b70679613341 100644
--- a/man/man8/devlink-region.8
+++ b/man/man8/devlink-region.8@@ -22,6 +22,14 @@ devlink-region \- devlink address region access .BR "devlink region show" .RI "[ " DEV/REGION " ]" +.ti -8 +.BR "devlink region new" +.RI "" DEV/REGION "" +.BR "[ " +.BR "snapshot" +.RI "" SNAPSHOT_ID "" +.BR "]" + .ti -8 .BR "devlink region del" .RI "" DEV/REGION ""
@@ -56,6 +64,17 @@ devlink-region \- devlink address region access .I "DEV/REGION" - specifies the devlink device and address-region to query. +.SS devlink region new - Create a snapshot specified by address-region name and snapshot ID + +.PP +.I "DEV/REGION" +- specifies the devlink device and address-region to snapshot + +.PP +snapshot +.I "SNAPSHOT_ID" +- optionally specifies the snapshot ID to assign. If not specified, devlink will assign a unique ID to the snapshot. + .SS devlink region del - Delete a snapshot specified by address-region name and snapshot ID .PP
@@ -106,6 +125,11 @@ devlink region show List available address regions and snapshot. .RE .PP +devlink region new pci/0000:00:05.0/cr-space +.RS 4 +Create a new snapshot from cr-space address region from device pci/0000:00:05.0. +.RE +.PP devlink region del pci/0000:00:05.0/cr-space snapshot 1 .RS 4 Delete snapshot id 1 from cr-space address region from device pci/0000:00:05.0.
--
2.35.1