From: Richard Weinberger <richard@nod.at>
Date: Wed, 12 Nov 2014 21:11:44 +0000 (+0100)
Subject: mtd-www: UBI: Fastmap: Add a notes section
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=a7aec8d14c472b0d395a3eb7843836e93bcb77bb;p=mtd-www.git

mtd-www: UBI: Fastmap: Add a notes section

Add a notes section to clarify that fastmap is an optional
feature and it can happen that a full scan is still done if fastmap
is enabled.

Signed-off-by: Richard Weinberger <richard@nod.at>
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@linux.intel.com>
---

diff --git a/doc/ubi.xml b/doc/ubi.xml
index 393b27b..4bded98 100644
--- a/doc/ubi.xml
+++ b/doc/ubi.xml
@@ -1269,6 +1269,16 @@ where a full scan takes too long. E.g. On 4GiB NAND chips a full scan takes
 several seconds whereas a fast attach needs less than one second.</p>
 
 
+<h4><a name="L_fastmap_notes">Notes</a></h4>
+
+<p>Enabling fastmap does not guarantee that every attach process can be done
+in a fast way. In some situations a full scan is still needed.
+This can happen in two cases, (i) if a power cut occurred while a fastmap was
+written to the flash or (ii) UBI ran out of PEBs while writing the fastmap.
+The latter case can happen if a massive amount of IO errors happen while writing
+and UBI cannot find an usable PEB.
+</p>
+
 
 <h2><a name="L_ubiblock">R/O block devices on top of UBI volumes</a></h2>