diff mbox series

doc: add missing doc for rawcopy handler

Message ID 20211103092009.1793493-1-sbabic@denx.de
State Accepted
Headers show
Series doc: add missing doc for rawcopy handler | expand

Commit Message

Stefano Babic Nov. 3, 2021, 9:20 a.m. UTC 
Signed-off-by: Stefano Babic <sbabic@denx.de>
---
 doc/source/handlers.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
diff mbox series

Patch

diff --git a/doc/source/handlers.rst b/doc/source/handlers.rst
index 6a08ad73..723c1106 100644
--- a/doc/source/handlers.rst
+++ b/doc/source/handlers.rst
@@ -760,6 +760,27 @@  Properties ``size`` and ``offset`` are optional, all the other properties are ma
     |             |          | If not set, default value 0 will be used.          |
     +-------------+----------+----------------------------------------------------+
 
+
+Rawcopy handler
+---------------
+
+The rawcopy handler copies one source to a destination. It can be used to copy configuration data,
+or parts that should be taken by the current installation. It requires just one property (`copyfrom`), while
+device contains the destination path. The handler performs a byte copy, and it does not matter which is
+the source - it can be a file or a partition.
+
+
+::
+
+        scripts : (
+                {
+                device = "/dev/mmcblk2p1";
+                type = "rawcopy";
+                properties : {
+                        copyfrom = "/dev/mmcblk2p2";
+                }
+        }
+
 Disk partitioner
 ----------------