Add UBI stress testing section

Not many are aware of the UBI stress testing tools available in
mtd-utils so lets mention them. Also, lets give a short example on how
to run the tests.

Signed-off-by: David Oberhollenzer <david.oberhollenzer@sigma-star.at>

diff --git a/doc/ubi.xml b/doc/ubi.xml
index 299b0f15d7b662051f559780f089961619364674..f20e1aaac33db07cd7523f7d27f995f1fd2f8843 100644 (file)
--- a/doc/ubi.xml
+++ b/doc/ubi.xml
@@ -49,6 +49,7 @@
        </li>
        <li><a href="ubi.html#L_fastmap">Fastmap</a></li>
        <li><a href="ubi.html#L_ubiblock">R/O block devices on top of UBI volumes</a></li>
+       <li><a href="ubi.html#L_ubitest">UBI stress testing</a></li>
        <li><a href="ubi.html#L_ubidoc">More documentation</a></li>
 </ol>
 
@@ -1349,6 +1350,20 @@ $ ubiblock --remove /dev/ubi0_0
 </pre>
 
 
+<h2><a name="L_ubitest">UBI stress testing</a></h2>
+
+<p>If enabled, mtd-utils include user-space tools that can be used to stress
+test the UBI stack. This is useful if you want to test the stability and
+correctness of your particular UBI stack implementation.</p>
+
+<p>Example, running various UBI tests:</p>
+
+<pre>
+$ flash_erase /dev/mtd3 0 0
+$ ubiattach --mtdn 3
+$ /usr/libexec/mtd-utils/runubitests.sh /dev/ubi0
+</pre>
+
 
 <h2><a name="L_ubidoc">More documentation</a></h2>