[dm-devel] [PATCH] dm snapshot: improve documentation

[Mikulas Patocka]

Regarding bug 1286898 - the documentation doesn't specify the requirement 
that the origin target must be suspended, so we should add this paragraph 
to the file snapshot.txt.


From: Mikulas Patocka <mpatocka at redhat.com>

Add a node to snapshot.txt that the origin target must be suspended when
loading or unloading the snapshot target.

Signed-off-by: Mikulas Patocka <mpatocka at redhat.com>

---
 Documentation/device-mapper/snapshot.txt |    4 ++++
 1 file changed, 4 insertions(+)

Index: linux-4.4-rc3/Documentation/device-mapper/snapshot.txt
===================================================================
--- linux-4.4-rc3.orig/Documentation/device-mapper/snapshot.txt	2015-12-02 18:26:34.000000000 +0100
+++ linux-4.4-rc3/Documentation/device-mapper/snapshot.txt	2015-12-02 18:29:10.000000000 +0100
@@ -49,6 +49,10 @@ The difference between persistent and tr
 snapshots less metadata must be saved on disk - they can be kept in
 memory by the kernel.
 
+When loading or unloading the snapshot target, the corresponding
+snapshot-origin or snapshot-merge target must be suspended. A failure to
+suspend the origin target could result in data corruption.
+
 
 * snapshot-merge <origin> <COW device> <persistent> <chunksize>