UBI/UBIFS: update bugreport sending sections

Signed-off-by: Artem Bityutskiy <Artem.Bityutskiy@nokia.com>

diff --git a/doc/ubi.xml b/doc/ubi.xml
index 49b3de8d1f0cd9a258c1ff1edcb7ed8e3c62ef91..06d8cbdbd0382edfe47566284da66d8b229ff906 100644 (file)
--- a/doc/ubi.xml
+++ b/doc/ubi.xml
@@ -1186,6 +1186,12 @@ function (just above the body of the function).</p>
 
 <p>Before sending a bug report:</p>
 <ul>
+       <li>make sure you use up-to-date UBI; pull the latest UBI patches
+       from corresponding UBIFS back-port trees if needed, see
+       <a href="ubifs.html#L_source">here</a> (we do not maintain separate UBI
+       back-ports trees, and UBIFS trees also contain all UBI updates); no one
+       is interested in digging already fixed problems;</li>
+
        <li>make sure you have compiled kernel symbols in
        (<code>CONFIG_KALLSYMS_ALL=y</code> in <code>.config</code>);</li>
 
@@ -1193,6 +1199,29 @@ function (just above the body of the function).</p>
        in <code>.config</code>); please, mark only the "<b>UBI debugging</b>"
        check-box and do not mark other debugging sub-options like "UBI
        debugging messages" unless you know what you are doing.</li>
+
+       <li>include all the messages UBI prints, not only those you see at
+       the console, but also those you see when running <code>dmesg</code>; or
+       before running your UBI test, which reproduces the error, just
+       invoke <code>dmesg -n8</code> command to make all kernel messages
+       to go to the console; another possibility is to boot the kernel
+       with <code>ignore_loglevel</code> option, in which makes the kernel
+       print all messages to the console unconditionally;
+       <a href="../faq/ubi.xml#L_how_debug">this</a> section contains some
+       more information about how the messages can be collected.</li>
+
+       <li>provide UBI configuration from you your <code>.config</code>
+       file, or just attach whole file;</li>
+
+       <li>describe your flash device, attach the
+       "<code>cat /proc/mtd</code>" output;</li>
+
+       <li>specify which kernel version you are using; if your kernel is not
+       the latest one, please, explicitly tell whether you updated UBI by
+       pulling one of the back-port trees or not; if you did not, you will
+       probably be asked to do this, depending on the problem;</li>
+
+       <li>describe how the problem can be reproduced;</li>
 </ul>
 
 <p>Please, attach all the bug-related messages including the UBI messages from

diff --git a/doc/ubifs.xml b/doc/ubifs.xml
index a6ddd6e8fdd861e2f55bf4e8f89527a31302c3e1..94ccfa5300b211b4266df0e762daf1f0c250fdcd 100644 (file)
--- a/doc/ubifs.xml
+++ b/doc/ubifs.xml
@@ -1210,6 +1210,23 @@ at the <a href="ubifs.html#L_ml">UBIFS mailing list.</a></p>
 
 <h2><a name="L_how_send_bugreport">How to send an UBIFS bugreport?</a></h2>
 
+<p>Before sending a bug report, please, try to do the following:</p>
+<ol>
+       <li>run the MTD tests to validate your flash (see
+       <a href="general.html#L_mtd_tests">here</a>);</li>
+
+       <li>enable the UBIFS extra self checks and try to reproduce the
+       problem; to enable the extra self-checks, you have to first mark the
+       <b>Enable debugging</b> check-box in the UBIFS kernel configuration
+       menu (<code>CONFIG_UBIFS_FS_DEBUG=y</code> in <code>.config</code>);
+       then mark the "Enable extra checks" check-box
+       (<code>CONFIG_UBIFS_FS_DEBUG_CHKS=y</code>); do not touch the
+       "Default message level" (<code>CONFIG_UBIFS_FS_DEBUG_MSG_LVL</code>)
+       option unless you know what you are doing. For more information about
+       how to play with UBIFS debugging option, read the
+       <code>Documentation/filesystems/ubifs.txt</code> file.</li>
+</ol>
+
 <p>When sending a bug report, please:</p>
 <ol>
        <li>make sure you use up-to-date UBIFS; pull the latest UBIFS patches
@@ -1221,7 +1238,8 @@ at the <a href="ubifs.html#L_ml">UBIFS mailing list.</a></p>
 
        <li>mark the <b>Enable debugging</b> check-box in the UBIFS kernel
        configuration menu (<code>CONFIG_UBIFS_FS_DEBUG=y</code> in
-       <code>.config</code>); please, do not enable other UBIFS debugging
+       <code>.config</code>); this option will make UBIFS print more
+       informative error messages; please, do not enable other UBIFS debugging
        sub-options like extra debugging messages unless you know what you are
        doing; <b>note</b>, you should enable UBIFS debugging, not UBI
        debugging - distinguish between UBI and UBIFS please, they are
@@ -1233,14 +1251,30 @@ at the <a href="ubifs.html#L_ml">UBIFS mailing list.</a></p>
        invoke <code>dmesg -n8</code> command to make all kernel messages
        to go to the console; another possibility is to boot the kernel
        with <code>ignore_loglevel</code> option, in which makes the kernel
-       print all messages to the console unconditionally;</li>
+       print all messages to the console unconditionally;
+       <a href="../faq/ubi.xml#L_how_debug">this</a> section contains some
+       more information about how the messages can be collected (it is for
+       UBI, but the part about collecting the messages is not
+       UBI-specific).</li>
+
+       <li>explicitly tell about whether you did any checking as described in
+       the previous list of "actions before sending a bug-report" (running MTD
+       tests, enabling UBIFS extra self-checks; and tell the results; if you
+       saw any errors/warnings, describe them and include all corresponding
+       prints from tests / UBIFS / etc;</li>
+
+       <li>provide UBIFS configuration from you your <code>.config</code>
+       file, or just attach whole file;</li>
 
        <li>describe your flash device, attach the
        "<code>cat /proc/mtd</code>" output;</li>
 
-       <li>specify which kernel version you are using;</li>
+       <li>specify which kernel version you are using; if your kernel is not
+       the latest one, please, explicitly tell whether you updated UBIFS by
+       pulling one of the back-port trees or not; if you did not, you will
+       probably be asked to do this, depending on the problem;</li>
 
-       <li>describe how the problem cab be reproduced;</li>
+       <li>describe how the problem can be reproduced;</li>
 </ol>
 
 <p>The bugreport should be sent to the