[mtd-www] Add UBI stress testing section

Message ID 20181002104912.15641-1-malu@gomspace.com
State Accepted
Headers show
Series
  • [mtd-www] Add UBI stress testing section
Related show

Commit Message

Martin Lund Oct. 2, 2018, 10:49 a.m.
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.
---
 doc/ubi.xml | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

David Oberhollenzer Oct. 2, 2018, 4:27 p.m. | #1
Applied to mtd-www.git master.

Thanks,

David

Patch

diff --git a/doc/ubi.xml b/doc/ubi.xml
index 299b0f1..f20e1aa 100644
--- 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>