From: Artem Bityutskiy
Date: Wed, 9 Mar 2011 14:10:16 +0000 (+0200)
Subject: UBIFS FAQ: update bug-report sending instructions
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=e84c4fabce616adae6140bfbecab2265580df9d3;p=mtd-www.git
UBIFS FAQ: update bug-report sending instructions
Signed-off-by: Artem Bityutskiy
---
diff --git a/doc/ubifs.xml b/doc/ubifs.xml
index 06c3a49..95dcba0 100644
--- a/doc/ubifs.xml
+++ b/doc/ubifs.xml
@@ -1220,15 +1220,9 @@ at the UBIFS mailing list.
here);
enable the UBIFS extra self checks and try to reproduce the
- problem; to enable the extra self-checks, you have to first mark the
- Enable debugging check-box in the UBIFS kernel configuration
- menu (CONFIG_UBIFS_FS_DEBUG=y
in .config
);
- then mark the "Enable extra checks" check-box
- (CONFIG_UBIFS_FS_DEBUG_CHKS=y
); do not touch the
- "Default message level" (CONFIG_UBIFS_FS_DEBUG_MSG_LVL
)
- option unless you know what you are doing. For more information about
- how to play with UBIFS debugging option, read the
- Documentation/filesystems/ubifs.txt
file.
+ problem. See
+ this
+ chapter for more information about how to enable self-checks.
When sending a bug report, please:
@@ -1240,14 +1234,12 @@ at the UBIFS mailing list.
make sure you have compiled the kernel symbols in
(CONFIG_KALLSYMS_ALL=y
in .config
);
- mark the Enable debugging check-box in the UBIFS kernel
- configuration menu (CONFIG_UBIFS_FS_DEBUG=y
in
+ mark the Enable debugging support check-box in the UBIFS
+ kernel configuration menu (CONFIG_UBIFS_FS_DEBUG=y
in
.config
); 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; note, you should enable UBIFS debugging, not UBI
- debugging - distinguish between UBI and UBIFS please, they are
- different things;
+ informative error messages; note, you should enable UBIFS
+ debugging, not UBI debugging - distinguish between UBI and UBIFS please,
+ they are different things;
include all the messages UBIFS prints, not only those you see at
the console, but also those you see when running dmesg
; or
@@ -1256,10 +1248,8 @@ at the UBIFS mailing list.
to go to the console; another possibility is to boot the kernel
with ignore_loglevel
option, in which makes the kernel
print all messages to the console unconditionally;
- this 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).
+ this section contains
+ some more information about how the messages can be collected.
explicitly tell about whether you did any checking as described in
the previous list of "actions before sending a bug-report" (running MTD
@@ -1267,8 +1257,8 @@ at the UBIFS mailing list.
saw any errors/warnings, describe them and include all corresponding
prints from tests / UBIFS / etc;
- provide UBIFS configuration from you your .config
- file, or just attach whole file;
+ provide UBIi and UBIFS configuration from you your
+ .config
file, or just attach whole file;
describe your flash device, attach the
"cat /proc/mtd
" output;
diff --git a/faq/ubifs.xml b/faq/ubifs.xml
index 5a0cb7c..f1e063c 100644
--- a/faq/ubifs.xml
+++ b/faq/ubifs.xml
@@ -1298,7 +1298,7 @@ large enough. This section explains
how to make the ring buffer larger.
-Extra self-checks
+
UBIFS contains various internal self-check functions which are often
very useful for debugging or testing. However, the self-checks are very