diff mbox series

[v1,2/2] doc: handlers: add diskformat handler description

Message ID 20210802144326.28642-3-roland.gaudig-oss@weidmueller.com
State Changes Requested
Headers show
Series [v1,1/2] handlers: add diskformat handler | expand

Commit Message

Roland Gaudig Aug. 2, 2021, 2:43 p.m. UTC 
From: Roland Gaudig <roland.gaudig@weidmueller.com>

Add documentation for the diskformat handler.

Signed-off-by: Roland Gaudig <roland.gaudig@weidmueller.com>
---

 doc/source/handlers.rst | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
diff mbox series

Patch

diff --git a/doc/source/handlers.rst b/doc/source/handlers.rst
index 81f61df..747e8ae 100644
--- a/doc/source/handlers.rst
+++ b/doc/source/handlers.rst
@@ -861,6 +861,28 @@  MBR Example:
 	   }
 	}
 
+Diskformat Handler
+------------------
+
+This handler checks if the device already has a file system of the specified
+type. (Available only if CONFIG_DISKFORMAT is set.)
+If the file system does not yet exist, it will be created.
+In case an existing file system shall be overwitten, this can be achieved
+by setting the property ``force`` to ``true``.
+
+::
+
+	partitions: (
+	{
+		type = "diskformat";
+		device = "/dev/loop0p1";
+
+		properties: {
+			fstype = "vfat";
+			force = "true";
+		}
+	})
+
 Unique UUID Handler
 -------------------