[PATCH 0/9] mtd-www: various fixes, bug reporting info

[PATCH 0/9] mtd-www: various fixes, bug reporting info

[Brian Norris]

This patch series makes several updates to the MTD website. It's based
on top of some recent patches from Matthew Creech that affected similar
portions of the documentation.

The last patch, about bug reporting, is most likely under-informative
at the moment. To write it up, I copied a few portions from other parts
of the MTD website and tried to make them helpful as a "basic bug report"
FAQ. Some of this is in response to Brian Foster's requests, so speak
up if there are other instructions or information that you feel are
missing from this FAQ.

Brian

Brian Norris (9):
  UBIFS FAQ: spelling, grammar
  faq: general: update "pleonasm" description
  faq: general: turn statement into a question
  faq/doc: ubi(fs): move "bug report" questions to FAQ
  doc: nand: update YAFFS URL
  doc: update info on compiling mtd-utils
  faq: ubi(fs): sending bug reports using `mtdinfo'
  faq: ubi(fs): small spelling, URL fixups
  faq: general: add bug reporting FAQ

 doc/nand.xml    |    4 +-
 doc/ubi.xml     |   65 ++++--------------------------------------
 doc/ubifs.xml   |   71 ----------------------------------------------
 faq/general.xml |   84 +++++++++++++++++++++++++++++++++++++++++++++++++-----
 faq/ubi.xml     |   58 ++++++++++++++++++++++++++++++++++++-
 faq/ubifs.xml   |   85 ++++++++++++++++++++++++++++++++++++++++++++++++++----
 mail.xml        |    4 ++-
 7 files changed, 221 insertions(+), 150 deletions(-)

[PATCH 1/9] UBIFS FAQ: spelling, grammar

[Brian Norris]

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
 faq/ubifs.xml |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/faq/ubifs.xml b/faq/ubifs.xml
index bd91733..f70c222 100644
--- a/faq/ubifs.xml
+++ b/faq/ubifs.xml
@@ -77,9 +77,9 @@ some specific aspects of MLC NAND flashes:</p>
 	this is also not a problem because it is exactly what UBI and UBIFS do
 	(see also <a href="ubi.html#L_restrict">this</a> section);</li>
 
-	<li>MLC flashes have rather short eraseblock life-cycle of just few
-	thousand of erase cycles; and this is not a problem, because UBI
-	uses deterministic wear-leveling algorithm
+	<li>MLC flashes have rather short eraseblock life-cycles of just a few
+	thousand erase cycles; this is not a problem because UBI uses a
+	deterministic wear-leveling algorithm
 	(see <a href="ubi.html#L_mlc">this</a> section);</li>
 
 	<li>MLC flashes exhibit bit flips as a result of "program disturb" and
@@ -1229,7 +1229,7 @@ The ways to solve this:
 	<li>Use <code>ubiformat</code> and format the NOR partition before
 	attaching it to UBI. But this will not help in situations when you
 	delete may files, and starts erasing many eraseblocks, so the "MTD/CFI
-	chip lock" becomes very condtended.</li>
+	chip lock" becomes very contended.</li>
 	<li>Use erase-suspend for writing (if your chip supports this).</li>
 </ol>
 </p>
-- 
1.7.0.4

[PATCH 2/9] faq: general: update "pleonasm" description

[Brian Norris]

Not really sure why this was mentioned in the first place, but we
might as well be complete and have a little fun with it...

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
 faq/general.xml |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)

diff --git a/faq/general.xml b/faq/general.xml
index 9cd81ff..2dc64b3 100644
--- a/faq/general.xml
+++ b/faq/general.xml
@@ -30,7 +30,10 @@
 
 <P>
 First off, an MTD is a "Memory Technology Device", so it's just "MTD". An "MTD
-device" is a pleonasm.
+device" is a pleonasm. Of course, at the time of this edit (Thu Aug 4 15:36:10
+PDT 2011) "MTD device" was found at least 520 times in the Linux source tree,
+189 times in the mtd-utils source, and even 119 times in the source for this
+website...
 </P>
 
 <P>
-- 
1.7.0.4

[PATCH 3/9] faq: general: turn statement into a question

[Brian Norris]

This looks like a statement, yet it's in the Frequently Asked Questions.
We can fix that.

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
 faq/general.xml |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/faq/general.xml b/faq/general.xml
index 2dc64b3..0336a32 100644
--- a/faq/general.xml
+++ b/faq/general.xml
@@ -18,7 +18,7 @@
 	<LI><A HREF="general.html#L_mtd_vs_hdd">What are the differences between flash devices and block drives?</A></LI>
 	<LI><A HREF="general.html#L_ext2_mtd">Can I mount ext2 over an MTD device?</A></LI>
 	<LI><A HREF="general.html#L_point">What are the point() and unpoint() functions used for?</A></LI>
-	<LI><A HREF="general.html#L_unlock">I keep getting errors whenever I try to write or erase to my MTD device</A></LI>
+	<LI><A HREF="general.html#L_unlock">Why do I keep getting errors whenever I try to write to or erase my MTD device?</A></LI>
 	<LI><A HREF="general.html#L_compile_mtd">How do I compile the mtd-utils tree?</A></LI>
 </OL>
 
@@ -221,7 +221,7 @@ release the chip again.
 
 
 <A NAME="L_unlock">
-<H2>I keep getting errors whenever I try to write or erase to my MTD device</H2>
+<H2>Why do I keep getting errors whenever I try to write to or erase my MTD device?</H2>
 </A>
 
 <P>
-- 
1.7.0.4

[PATCH 4/9] faq/doc: ubi(fs): move "bug report" questions to FAQ

[Brian Norris]

The "How do I send XXX bug report?" questions belong in the FAQ
for easier access (plus, they're questions anyway). We can then
consolidate/link the bug report information to the "general" FAQ
to give a more unified location for bug reporting info.

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
 doc/ubi.xml   |   54 ------------------------------------------
 doc/ubifs.xml |   71 -------------------------------------------------------
 faq/ubi.xml   |   54 ++++++++++++++++++++++++++++++++++++++++++
 faq/ubifs.xml |   73 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 4 files changed, 126 insertions(+), 126 deletions(-)

diff --git a/doc/ubi.xml b/doc/ubi.xml
index 53c986a..d3f4516 100644
--- a/doc/ubi.xml
+++ b/doc/ubi.xml
@@ -46,7 +46,6 @@
 		</ol>
 	</li>
 	<li><a href="ubi.html#L_ubidoc">More documentation</a></li>
-	<li><a href="ubi.html#L_how_send_bugreport">How do I send a bug report?</a></li>
 </ol>
 
 
@@ -1186,58 +1185,5 @@ commands and the involved data structures),
 <code>drivers/mtd/ubi/kapi.c</code> file contains comments for each kernel API
 function (just above the body of the function).</p>
 
-
-
-<h2><a name="L_how_send_bugreport">How do I send an UBI bug report?</a></h2>
-
-<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>
-
-	<li>enable UBI debugging (<code>CONFIG_MTD_UBI_DEBUG=y</code>
-	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.html#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
-the kernel ring buffer, which may be collected using the <code>dmesg</code>
-utility or using <code>minicom</code> with serial console capturing. Please,
-describe how the problem can be reproduced (if it can be). The bug report
-should be sent to the <a href="../mail.html">MTD mailing list</a>. Please,
-<b>do not</b> send private e-mails to UBI authors, always CC the mailing
-list!</p>
-
-
 <INCLUDE file="../inc/footer.tmpl" />
 </PAGE>
diff --git a/doc/ubifs.xml b/doc/ubifs.xml
index d8770a2..a9a2ab9 100644
--- a/doc/ubifs.xml
+++ b/doc/ubifs.xml
@@ -31,7 +31,6 @@
 	<li><a href="ubifs.html#L_mountopts">Mount options</a></li>
 	<li><a href="ubifs.html#L_spaceacc">Flash space accounting issues</a></li>
 	<li><a href="ubifs.html#L_documentation">Documentation</a></li>
-	<li><a href="ubifs.html#L_how_send_bugreport">How do I send an UBIFS bug report?</a></li>
 	<li><a href="ubifs.html#L_raw_vs_ftl">Raw flash vs. FTL devices</a></li>
 </ol>
 
@@ -1207,76 +1206,6 @@ at the <a href="ubifs.html#L_ml">UBIFS mailing list.</a></p>
 
 
 
-<h2><a name="L_how_send_bugreport">How do I send an UBIFS bug report?</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. See
-	<a href="../faq/ubifs.html#L_how_debug_self_checks">this</a>
-	chapter for more information about how to enable self-checks.</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
-	if needed, see <a href="ubifs.html#L_source">here</a>; no one is
-	interested in digging already fixed problems;</li>
-
-	<li>make sure you have compiled the kernel symbols in
-	(<code>CONFIG_KALLSYMS_ALL=y</code> in <code>.config</code>);</li>
-
-	<li>mark the <b>Enable debugging support</b> check-box in the UBIFS
-	kernel configuration menu (<code>CONFIG_UBIFS_FS_DEBUG=y</code> in
-	<code>.config</code>); this option will make UBIFS print more
-	informative error messages; <b>note</b>, you should enable UBIFS
-	debugging, not UBI debugging - distinguish between UBI and UBIFS please,
-	they are different things;</li>
-
-	<li>include all the messages UBIFS prints, not only those you see at
-	the console, but also those you see when running <code>dmesg</code>; or
-	before running your UBIFS 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.html#L_how_debug_printks">this</a> section contains
-	some more information about how the messages can be collected.</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 UBIi and 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; 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 can be reproduced;</li>
-</ol>
-
-<p>The bugreport should be sent to the
-<a href="../mail.html">MTD mailing list</a>. Please, <b>do not</b> send
-private e-mails to UBIFS authors, always CC the mailing list!</p>
-
-<p>Note, sometimes UBIFS bugs may appear to be UBI bugs. If you suspect
-there are UBI problems, please, also enable UBI debugging. Please, refer the
-<a href="../faq/ubi.html#L_how_debugt">UBI debugging</a> section for more
-information.</p>
-
-
-
 <h2><a name="L_raw_vs_ftl">Raw flash vs. FTL devices</a></h2>
 
 <p>FTL stands for "Flash Translation Layer" and it is software which emulates
diff --git a/faq/ubi.xml b/faq/ubi.xml
index 294403a..2d9ce6e 100644
--- a/faq/ubi.xml
+++ b/faq/ubi.xml
@@ -39,6 +39,7 @@
 	<li><a href="ubi.html#L_dyn_faster">Why a dynamic volume is faster to access than a static volume of the
 same size?</a></li>
 	<li><a href="ubi.html#L_how_debug">How do I debug UBI?</a></li>
+	<li><a href="ubi.html#L_how_send_bugreport">How do I send an UBI bug report?</a></li>
 </ol>
 
 
@@ -840,5 +841,58 @@ option. This will most probably make the ring buffer fit enough messages to
 identify the problem. And because the messages are printed to RAM, this is way
 quicker than the first method.</p>
 
+
+
+<h2><a name="L_how_send_bugreport">How do I send an UBI bug report?</a></h2>
+
+<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="../doc/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>
+
+	<li>enable UBI debugging (<code>CONFIG_MTD_UBI_DEBUG=y</code>
+	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="ubi.html#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
+the kernel ring buffer, which may be collected using the <code>dmesg</code>
+utility or using <code>minicom</code> with serial console capturing. Please,
+describe how the problem can be reproduced (if it can be). The bug report
+should be sent to the <a href="../mail.html">MTD mailing list</a>. Please,
+<b>do not</b> send private e-mails to UBI authors, always CC the mailing
+list!</p>
+
+
 <INCLUDE file="../inc/footer.tmpl" />
 </PAGE>
diff --git a/faq/ubifs.xml b/faq/ubifs.xml
index f70c222..14043f5 100644
--- a/faq/ubifs.xml
+++ b/faq/ubifs.xml
@@ -44,6 +44,7 @@
 	<li><a href="ubifs.html#L_few_lebs">I get: "init_constants_early: too few LEBs (12), min. is 17"</a></li>
 	<li><a href="ubifs.html#L_study_ubifs">I want to study UBIFS - any recommendations?</a></li>
 	<li><a href="ubifs.html#L_how_debug">How do I debug UBIFS?</a></li>
+	<li><a href="ubifs.html#L_how_send_bugreport">How do I send an UBIFS bug report?</a></li>
 </ol>
 
 
@@ -1166,7 +1167,7 @@ messages. UBIFS usually prints error messages before switching to read-only
 mode. The messages may shed some light on what happened. Feel free to ask for
 help from the <a href="../mail.html">MTD mailing list</a>. If you think this is
 an UBIFS bug, please, send a
-<a href="../doc/ubifs.html#L_how_send_bugreport">bug report</a>.</p>
+<a href="ubifs.html#L_how_send_bugreport">bug report</a>.</p>
 
 
 
@@ -1434,5 +1435,75 @@ all checks: "<code>echo 127 > /sys/module/ubifs/parameters/debug_chks</code>".</
 	the real power cut testing.</li>
 </ul>
 
+
+
+<h2><a name="L_how_send_bugreport">How do I send an UBIFS bug report?</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="../doc/general.html#L_mtd_tests">here</a>);</li>
+
+	<li>enable the UBIFS extra self checks and try to reproduce the
+	problem. See
+	<a href="ubifs.html#L_how_debug_self_checks">this</a>
+	chapter for more information about how to enable self-checks.</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
+	if needed, see <a href="../doc/ubifs.html#L_source">here</a>; no one is
+	interested in digging already fixed problems;</li>
+
+	<li>make sure you have compiled the kernel symbols in
+	(<code>CONFIG_KALLSYMS_ALL=y</code> in <code>.config</code>);</li>
+
+	<li>mark the <b>Enable debugging support</b> check-box in the UBIFS
+	kernel configuration menu (<code>CONFIG_UBIFS_FS_DEBUG=y</code> in
+	<code>.config</code>); this option will make UBIFS print more
+	informative error messages; <b>note</b>, you should enable UBIFS
+	debugging, not UBI debugging - distinguish between UBI and UBIFS please,
+	they are different things;</li>
+
+	<li>include all the messages UBIFS prints, not only those you see at
+	the console, but also those you see when running <code>dmesg</code>; or
+	before running your UBIFS 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="ubi.html#L_how_debug_printks">this</a> section contains
+	some more information about how the messages can be collected.</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 UBIi and 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; 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 can be reproduced;</li>
+</ol>
+
+<p>The bugreport should be sent to the
+<a href="../mail.html">MTD mailing list</a>. Please, <b>do not</b> send
+private e-mails to UBIFS authors, always CC the mailing list!</p>
+
+<p>Note, sometimes UBIFS bugs may appear to be UBI bugs. If you suspect
+there are UBI problems, please, also enable UBI debugging. Please, refer the
+<a href="ubi.html#L_how_debug">UBI debugging</a> section for more
+information.</p>
+
 <INCLUDE file="../inc/footer.tmpl" />
 </PAGE>
-- 
1.7.0.4

[PATCH 5/9] doc: nand: update YAFFS URL

[Brian Norris]

The YAFFS website has moved. They're sitll redirecting, but we should
switch.

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
 doc/nand.xml |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/nand.xml b/doc/nand.xml
index 1d55685..281e0e0 100644
--- a/doc/nand.xml
+++ b/doc/nand.xml
@@ -139,7 +139,7 @@ designed for the usage of DiskOnChip devices. JFFS2 supports raw NAND chips and
 SmartMediaCards at the moment. A JFFS2 support for DiskOnChip devices, based on the 
 NAND code, is planned. There are some other Open Source projects for NAND filesystem 
 support, but there's no other working solution than JFFS, YAFFS, and UBIFS at the moment of this writing.
-YAFFS is available from <a href="http://www.aleph1.co.uk/armlinux/projects/yaffs">YAFFS-Homepage</a>.
+YAFFS is available from <a href="http://www.yaffs.net/">YAFFS-Homepage</a>.
 YAFFS is faster than JFFS2 and consumes less RAM, JFFS2 provides on the fly file compression and
 decompression, which is very helpful for small FLASHs.  UBIFS provides compression similar to JFFS2, but
 is usually a better choice for large NAND flash chips (see <a href="ubifs.html">here</a> for more 
@@ -334,7 +334,7 @@ CONFIG_JFFS2_FS_NAND=y</p>
 <h2>References:</h2>
 <h3>Open Source</h3>
 <p>JFFS2, NTFL, and UBIFS are located on this <a href="../index.html">website</a>.<br />
-YAFFS is located at <a href="http://www.aleph1.co.uk/armlinux/projects/yaffs">YAFFS-Homepage</a>.</p>
+YAFFS is located at <a href="http://www.yaffs.net/">YAFFS-Homepage</a>.</p>
 <h3>Hardware</h3>
 <p><a href="http://www.toshiba.com/taec">Toshiba</a></p>
 <p><a href="http://samsungelectronics.com">Samsung</a></p>
-- 
1.7.0.4

[PATCH 6/9] doc: update info on compiling mtd-utils

[Brian Norris]

The recursive build system for mtd-utils was rewritten enough recently
such that the description regarding builing ubi-utils by typing `make'
from its subdirectory is now incorrect. Update the UBI docs to reflect
this.

Also, I copied and edited some basic info from the UBI docs to include
in the general description on compiling mtd-utils.

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
 doc/ubi.xml     |   11 ++++++-----
 faq/general.xml |   21 ++++++++++++++++-----
 2 files changed, 22 insertions(+), 10 deletions(-)

diff --git a/doc/ubi.xml b/doc/ubi.xml
index d3f4516..98cb69c 100644
--- a/doc/ubi.xml
+++ b/doc/ubi.xml
@@ -213,15 +213,16 @@ git tree. Please, use this branch unless you are an UBI developer.</p>
 
 <h2><a name="L_usptools">User-space tools</a></h2>
 
-<p>UBI user-space tools are available from the the following git repository:</p>
+<p>UBI user-space tools, as well as other MTD user-space tools, are available
+from the the following git repository:</p>
 
 <code>git://git.infradead.org/mtd-utils.git</code>
 
-<p>Please, clone it and compile. The easiest way to compile UBI tools is to go
-straight to the <code>ubi-utils</code> sub-directory and type
-<code>make</code>. <a href="../faq/general.html#L_compile_mtd">This</a> section
+<p>Please, clone it and compile using <code>make</code> from the root mtd-utils
+directory.  <a href="../faq/general.html#L_compile_mtd">This section</a>
 provides information about how to compile the whole <code>mtd-utils</code>
-repository tree.</p>
+repository tree. You should find the UBI tools under the <code>ubi-utils</code>
+sub-directory.</p>
 
 <p>The repository contains the following UBI tools:</p>
 <ul>
diff --git a/faq/general.xml b/faq/general.xml
index 0336a32..a4e82f3 100644
--- a/faq/general.xml
+++ b/faq/general.xml
@@ -256,11 +256,22 @@ unlock them.
 <H2>How do I compile the mtd-utils tree?</H2>
 </A>
 
-<p>You have to install libraries the tools depend on. Please, find
-the information about <code>mkfs.jffs2</code> dependencies
-<a href="../faq/jffs2.html#L_mkfs_jffs2_comp">here</a> and the
-the information about <code>mkfs.ubifs</code> dependencies
-<a href="../faq/ubifs.html#L_mkfs_ubifs_comp">here</a>.</p>
+<P>
+The MTD and UBI user-space tools are available from the the following git
+repository:
+</P>
+
+<CODE>git://git.infradead.org/mtd-utils.git</CODE>
+
+<P>
+To compile, first you have to install libraries the tools depend on. You can
+find the information about <CODE>mkfs.jffs2</CODE> dependencies
+<A HREF="jffs2.html#L_mkfs_jffs2_comp">here</A> and the the information about
+<CODE>mkfs.ubifs</CODE> dependencies
+<A HREF="ubifs.html#L_mkfs_ubifs_comp">here</A>. Once you have these satisfied,
+you should be able to simply type <CODE>make</CODE> from the root mtd-utils
+directory.
+</P>
 
 
 <INCLUDE file="../inc/footer.tmpl" />
-- 
1.7.0.4

[PATCH 7/9] faq: ubi(fs): sending bug reports using `mtdinfo'

[Brian Norris]

The `mtdinfo' utility (with the `-a' flag) is much more informative
than `cat /proc/mtd', so encourage users to use it if possible when
sending bug reports.

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
 faq/ubi.xml   |    4 ++--
 faq/ubifs.xml |    4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/faq/ubi.xml b/faq/ubi.xml
index 2d9ce6e..e9e6625 100644
--- a/faq/ubi.xml
+++ b/faq/ubi.xml
@@ -874,8 +874,8 @@ quicker than the first method.</p>
 	<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>describe your flash device, attach the "<code>mtdinfo -a</code>"
+	output (or the less useful "<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
diff --git a/faq/ubifs.xml b/faq/ubifs.xml
index 14043f5..2969bad 100644
--- a/faq/ubifs.xml
+++ b/faq/ubifs.xml
@@ -1485,8 +1485,8 @@ all checks: "<code>echo 127 > /sys/module/ubifs/parameters/debug_chks</code>".</
 	<li>provide UBIi and 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>describe your flash device, attach the "<code>mtdinfo -a</code>"
+	output (or the less useful "<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 UBIFS by
-- 
1.7.0.4

[PATCH 8/9] faq: ubi(fs): small spelling, URL fixups

[Brian Norris]

We used `<a name=[URL]>' instead of `<a href=[URL]>' by accident.

Also, the file "faq/ubi.html" is located within the "faq" directory, so
use a simpler relative link (i.e., don't use `../faq').

Change "we have never find" to "we have never found".

Change "refer this tread" to "refer to this thread".

Change "UBIi" to "UBI", "you your" to "your".

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
 faq/ubi.xml   |    4 ++--
 faq/ubifs.xml |    6 +++---
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/faq/ubi.xml b/faq/ubi.xml
index e9e6625..03a3061 100644
--- a/faq/ubi.xml
+++ b/faq/ubi.xml
@@ -375,7 +375,7 @@ describes how UBI-aware flasher program has to work.</p>
 
 <p><b>Important!</b>: even if you do not care about erasecounters, do not use
 <code>nandwrite</code> for flashing UBI images containing UBIFS file-system to
-NAND flashes, read <a href="../faq/ubifs.html#L_why_ubiformat">here</a> for
+NAND flashes, read <a href="ubifs.html#L_why_ubiformat">here</a> for
 more information.</p>
 
 
@@ -567,7 +567,7 @@ any image, and check if you still have these errors.</p>
 <p>If you do not have errors when you mount empty flash, it is probably indeed
 related to how you flash the UBI/UBIFS images. One typical problem is related
 to ECC calculation algorithm - read
-<a name="ubifs.html#L_why_ubiformat">here</a> for more information. Make sure
+<a href="ubifs.html#L_why_ubiformat">here</a> for more information. Make sure
 that you use <a href="../doc/ubifs.html#L_usptools">ubiformat</a>, or make sure
 either that your flashing program skips <code>0xFF</code> properly (see
 <a href="../doc/ubi.html#L_flasher_algo">here</a>) or that your UBIFS image
diff --git a/faq/ubifs.xml b/faq/ubifs.xml
index 2969bad..f5f5fae 100644
--- a/faq/ubifs.xml
+++ b/faq/ubifs.xml
@@ -717,8 +717,8 @@ provably want the file-system doing inode updates every time they are read.</p>
 
 <p>Not, it does not, which means you cannot export UBIFS file-system via NFS.
 We did make an attempt to support NFS, but the support was not exactly correct
-so it was dropped, and we have never find time to come back to that. Please,
-refer <a href="http://marc.info/?l=linux-next&amp;m=121852228611051&amp;w=2">this tread</a>
+so it was dropped, and we have never found time to come back to that. Please,
+refer to <a href="http://marc.info/?l=linux-next&amp;m=121852228611051&amp;w=2">this thread</a>
 for some more details. The original patch can also be found there.</p>
 
 
@@ -1482,7 +1482,7 @@ all checks: "<code>echo 127 > /sys/module/ubifs/parameters/debug_chks</code>".</
 	saw any errors/warnings, describe them and include all corresponding
 	prints from tests / UBIFS / etc;</li>
 
-	<li>provide UBIi and UBIFS configuration from you your
+	<li>provide UBI and UBIFS configuration from your
 	<code>.config</code> file, or just attach whole file;</li>
 
 	<li>describe your flash device, attach the "<code>mtdinfo -a</code>"
-- 
1.7.0.4

[PATCH 9/9] faq: general: add bug reporting FAQ

[Brian Norris]

It's surprising to note that we do not have a general "how to send a bug
report" FAQ. This patch provides a starting point and (most importantly)
directs UBI/UBIFS users to the appropriate bug reporting information.

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
 faq/general.xml |   54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 mail.xml        |    4 +++-
 2 files changed, 57 insertions(+), 1 deletions(-)

diff --git a/faq/general.xml b/faq/general.xml
index a4e82f3..92469ab 100644
--- a/faq/general.xml
+++ b/faq/general.xml
@@ -20,6 +20,7 @@
 	<LI><A HREF="general.html#L_point">What are the point() and unpoint() functions used for?</A></LI>
 	<LI><A HREF="general.html#L_unlock">Why do I keep getting errors whenever I try to write to or erase my MTD device?</A></LI>
 	<LI><A HREF="general.html#L_compile_mtd">How do I compile the mtd-utils tree?</A></LI>
+	<LI><A HREF="general.html#L_bug_report">How do I report bugs?</A></LI>
 </OL>
 
 
@@ -274,5 +275,58 @@ directory.
 </P>
 
 
+
+<A NAME="L_bug_report">
+<H2>How do I report bugs?</H2>
+</A>
+
+<P>
+First, you need to figure out what you're reporting a bug against. This website
+(and its accompanying <A HREF="../mail.html">mailing list</A>) supports several
+related aspects of Linux, from the MTD kernel subsystem to its user-space
+utilities, including the generic MTD and NAND interface layers, several MTD
+hardware drivers, the UBI volume management system, several flash filesystems
+(e.g., JFFS2, UBIFS), and the user-space MTD utils. People on the mailing list
+will often support the YAFFS/YAFFS2 filesystems; however, YAFFS has its own
+dedicated <A HREF="http://www.yaffs.net/">website</A> and
+<A HREF="http://stoneboat.aleph1.co.uk/cgi-bin/mailman/listinfo/yaffs">mailing
+list</A>, and its code is kept out of tree.
+</P>
+
+<P>
+Now, bug reports for any of the above areas are more than welcome on the
+<A HREF="../mail.html">MTD mailing list</A>, provided you include sufficient
+information for reproducing and debugging your problem. This means:
+</P>
+
+<UL>
+	<LI>include all kernel 'oopses', stack traces, debug messages, or
+	relevant logs along with a clear description of the problem you're
+	having, what system(s) are affected, and anything else you think might
+	help understand your issue;</LI>
+
+	<LI>include information about flash parameters found from
+	"<CODE>mtdinfo -a</CODE>" (or the less useful info from
+	"<CODE>cat /proc/mtd</CODE>");</LI>
+
+	<LI>specify which kernel version you are using;</LI>
+
+	<LI>specify which mtd-utils version you are using, if applicable. In
+	past releases of mtd-utils, different tools had different versions, so
+	be sure to check the relevant tool (e.g., use "<CODE>nanddump
+	--version</CODE>); newer releases give the same version to most/all the
+	tools.</LI>
+</UL>
+
+<P>
+You may also want to read one of the other related FAQs:
+</P>
+
+<UL>
+	<LI><A HREF="ubifs.html#L_how_send_bugreport">How do I send an UBIFS bug report?</A></LI>
+	<LI><A HREF="ubi.html#L_how_send_bugreport">How do I send an UBI bug report?</A></LI>
+</UL>
+
+
 <INCLUDE file="../inc/footer.tmpl" />
 </PAGE>
diff --git a/mail.xml b/mail.xml
index d79ac51..e3734f1 100644
--- a/mail.xml
+++ b/mail.xml
@@ -18,7 +18,9 @@
 	    <ul>
 		<li>my <a href="http://www.infradead.org/~dwmw2/email.html">notes on etiquette</a>.</li> 
 		<li>the section about <a href="source.html#kernelversions">kernel versions</a></li>
-		<li>the <a href="faq/general.html">MTD-FAQ</a></li>
+		<li>the <a href="faq/general.html">MTD-FAQ</a>, especially the
+			<a href="faq/general.html#L_bug_report">bug reporting
+			FAQ</a>, if applicable</li>
 		<li>the available <a href="doc/general.html">documentation</a></li>
 		<li>the mailing list archives at <a href="http://lists.infradead.org/pipermail/linux-mtd/">
 			http://lists.infradead.org/pipermail/linux-mtd/</a></li>
-- 
1.7.0.4

Re: [PATCH 0/9] mtd-www: various fixes, bug reporting info

[Artem Bityutskiy]

On Mon, 2011-08-08 at 12:37 -0700, Brian Norris wrote:
> This patch series makes several updates to the MTD website. It's based
> on top of some recent patches from Matthew Creech that affected similar
> portions of the documentation.
> 
> The last patch, about bug reporting, is most likely under-informative
> at the moment. To write it up, I copied a few portions from other parts
> of the MTD website and tried to make them helpful as a "basic bug report"
> FAQ. Some of this is in response to Brian Foster's requests, so speak
> up if there are other instructions or information that you feel are
> missing from this FAQ.

Hi,

FYI, I am having vacation and cannot take care of MTD now, next week I
should come back and start looking at the MTD stuff. Apologies and
thanks for nice patches.

-- 
Best Regards,
Artem Bityutskiy (Битюцкий Артём)

Re: [PATCH 9/9] faq: general: add bug reporting FAQ

[Brian Foster]

On Monday 08 August 2011 21:37:19 Brian Norris wrote:
> It's surprising to note that we do not have a general "how to send a bug
> report" FAQ. This patch provides a starting point and (most importantly)
> directs UBI/UBIFS users to the appropriate bug reporting information.
> 
> Signed-off-by: Brian Norris <computersforpeace@gmail.com>
> ---
>  faq/general.xml |   54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  mail.xml        |    4 +++-
>  2 files changed, 57 insertions(+), 1 deletions(-)
> 
> diff --git a/faq/general.xml b/faq/general.xml
>[ ... ]
> +<H2>How do I report bugs?</H2>
> +</A>
> +
> +<P>
> +First, you need to figure out what you're reporting a bug against. This website
> +(and its accompanying <A HREF="../mail.html">mailing list</A>) supports several
> +related aspects of Linux, from the MTD kernel subsystem to its user-space
> +utilities, including the generic MTD and NAND interface layers, several MTD
> +hardware drivers, the UBI volume management system, several flash filesystems
> +(e.g., JFFS2, UBIFS), and the user-space MTD utils. People on the mailing list
> +will often support the YAFFS/YAFFS2 filesystems; however, YAFFS has its own
> +dedicated <A HREF="http://www.yaffs.net/">website</A> and
> +<A HREF="http://stoneboat.aleph1.co.uk/cgi-bin/mailman/listinfo/yaffs">mailing
> +list</A>, and its code is kept out of tree.

 A pedantic point that perhaps doesn't matter, but....
 Not quite sure what is meant by “kept out of tree”?
 Two interpertations I can think of:  YAFFS(2) is not
 in the UBI(FS) trees;  and/or  YAFFS(2) is not in the
 Linux kernel tree (albeit it is in the Android tree).

> +</P>
> +
> +<P>
> +Now, bug reports for any of the above areas are more than welcome on the

 “Any”?  Including YAFFS(2)?

 _Assuming_ YAFFS(2) wasn't meant to be included
 in the “any”, then I suggest moving the above
 YAFFS(2) remarks  — which are useful —  to later,
 perhaps after the other-FAQs list (below)?
 This resolves the pedantic confusion over “any”,
 and also takes what is basically an aside out of
 the main flow of text / information.

> +<A HREF="../mail.html">MTD mailing list</A>, provided you include sufficient
> +information for reproducing and debugging your problem. This means:
> +</P>
> +
> +<UL>
> +	<LI>include all kernel 'oopses', stack traces, debug messages, or
> +	relevant logs along with a clear description of the problem you're
> +	having, what system(s) are affected, and anything else you think might
> +	help understand your issue;</LI>
> +
> +	<LI>include information about flash parameters found from
> +	"<CODE>mtdinfo -a</CODE>" (or the less useful info from
> +	"<CODE>cat /proc/mtd</CODE>");</LI>

 I always suggest using ‘&nbsp;’ for spaces in
 inline  <code>⋯</code>  to prevent (what can be)
 horribly confusing inappropriate linebreaks.

 Thanks for addressing the how-to-report-bugs issue.
cheers!
	-blf-

>[ ... ]

-- 
Brian FOSTER
Principal MTS, Software
Maxim Integrated Products (Microcontroller BU), formerly Innova Card
Web    : http://www.maxim-ic.com/

[PATCH v2 7/9] faq: ubi(fs): sending bug reports using `mtdinfo'

[Brian Norris]

The `mtdinfo' utility (with the `-a' flag) is much more informative
than `cat /proc/mtd', so encourage users to use it if possible when
sending bug reports.

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
v2: use &nbsp; within <code> tags to prevent linebreaks

 faq/ubi.xml   |    4 ++--
 faq/ubifs.xml |    4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/faq/ubi.xml b/faq/ubi.xml
index 2d9ce6e..9458e77 100644
--- a/faq/ubi.xml
+++ b/faq/ubi.xml
@@ -874,8 +874,8 @@ quicker than the first method.</p>
 	<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>describe your flash device, attach the "<code>mtdinfo&amp;nbsp;-a</code>"
+	output (or the less useful "<code>cat&amp;nbsp;/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
diff --git a/faq/ubifs.xml b/faq/ubifs.xml
index 14043f5..dbfac0e 100644
--- a/faq/ubifs.xml
+++ b/faq/ubifs.xml
@@ -1485,8 +1485,8 @@ all checks: "<code>echo 127 > /sys/module/ubifs/parameters/debug_chks</code>".</
 	<li>provide UBIi and 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>describe your flash device, attach the "<code>mtdinfo&amp;nbsp;-a</code>"
+	output (or the less useful "<code>cat&amp;nbsp;/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 UBIFS by
-- 
1.7.0.4

[PATCH v2 8/9] faq: ubi(fs): small spelling, URL fixups

[Brian Norris]

We used `<a name=[URL]>' instead of `<a href=[URL]>' by accident.

Also, the file "faq/ubi.html" is located within the "faq" directory, so
use a simpler relative link (i.e., don't use `../faq').

Change "we have never find" to "we have never found".

Change "refer this tread" to "refer to this thread".

Change "UBIi" to "UBI", "you your" to "your".

Change "refer the" to "refer to the".

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
v2: add "refer the" => "refer to the" fix

 faq/ubi.xml   |    4 ++--
 faq/ubifs.xml |    8 ++++----
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/faq/ubi.xml b/faq/ubi.xml
index 9458e77..1ee4327 100644
--- a/faq/ubi.xml
+++ b/faq/ubi.xml
@@ -375,7 +375,7 @@ describes how UBI-aware flasher program has to work.</p>
 
 <p><b>Important!</b>: even if you do not care about erasecounters, do not use
 <code>nandwrite</code> for flashing UBI images containing UBIFS file-system to
-NAND flashes, read <a href="../faq/ubifs.html#L_why_ubiformat">here</a> for
+NAND flashes, read <a href="ubifs.html#L_why_ubiformat">here</a> for
 more information.</p>
 
 
@@ -567,7 +567,7 @@ any image, and check if you still have these errors.</p>
 <p>If you do not have errors when you mount empty flash, it is probably indeed
 related to how you flash the UBI/UBIFS images. One typical problem is related
 to ECC calculation algorithm - read
-<a name="ubifs.html#L_why_ubiformat">here</a> for more information. Make sure
+<a href="ubifs.html#L_why_ubiformat">here</a> for more information. Make sure
 that you use <a href="../doc/ubifs.html#L_usptools">ubiformat</a>, or make sure
 either that your flashing program skips <code>0xFF</code> properly (see
 <a href="../doc/ubi.html#L_flasher_algo">here</a>) or that your UBIFS image
diff --git a/faq/ubifs.xml b/faq/ubifs.xml
index dbfac0e..b6b0b14 100644
--- a/faq/ubifs.xml
+++ b/faq/ubifs.xml
@@ -717,8 +717,8 @@ provably want the file-system doing inode updates every time they are read.</p>
 
 <p>Not, it does not, which means you cannot export UBIFS file-system via NFS.
 We did make an attempt to support NFS, but the support was not exactly correct
-so it was dropped, and we have never find time to come back to that. Please,
-refer <a href="http://marc.info/?l=linux-next&amp;m=121852228611051&amp;w=2">this tread</a>
+so it was dropped, and we have never found time to come back to that. Please,
+refer to <a href="http://marc.info/?l=linux-next&amp;m=121852228611051&amp;w=2">this thread</a>
 for some more details. The original patch can also be found there.</p>
 
 
@@ -1482,7 +1482,7 @@ all checks: "<code>echo 127 > /sys/module/ubifs/parameters/debug_chks</code>".</
 	saw any errors/warnings, describe them and include all corresponding
 	prints from tests / UBIFS / etc;</li>
 
-	<li>provide UBIi and UBIFS configuration from you your
+	<li>provide UBI and UBIFS configuration from your
 	<code>.config</code> file, or just attach whole file;</li>
 
 	<li>describe your flash device, attach the "<code>mtdinfo&amp;nbsp;-a</code>"
@@ -1501,7 +1501,7 @@ all checks: "<code>echo 127 > /sys/module/ubifs/parameters/debug_chks</code>".</
 private e-mails to UBIFS authors, always CC the mailing list!</p>
 
 <p>Note, sometimes UBIFS bugs may appear to be UBI bugs. If you suspect
-there are UBI problems, please, also enable UBI debugging. Please, refer the
+there are UBI problems, please, also enable UBI debugging. Please, refer to the
 <a href="ubi.html#L_how_debug">UBI debugging</a> section for more
 information.</p>
 
-- 
1.7.0.4

[PATCH v2 9/9] faq: general: add bug reporting FAQ

[Brian Norris]

It's surprising to note that we do not have a general "how to send a bug
report" FAQ. This patch provides a starting point and (most importantly)
directs UBI/UBIFS users to the appropriate bug reporting information.

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
v2: handle some of Brian Foster's suggestions regarding clarity, other
    additions to FAQ entry

 faq/general.xml |   64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 mail.xml        |    4 ++-
 2 files changed, 67 insertions(+), 1 deletions(-)

diff --git a/faq/general.xml b/faq/general.xml
index a4e82f3..6b8e95f 100644
--- a/faq/general.xml
+++ b/faq/general.xml
@@ -20,6 +20,7 @@
 	<LI><A HREF="general.html#L_point">What are the point() and unpoint() functions used for?</A></LI>
 	<LI><A HREF="general.html#L_unlock">Why do I keep getting errors whenever I try to write to or erase my MTD device?</A></LI>
 	<LI><A HREF="general.html#L_compile_mtd">How do I compile the mtd-utils tree?</A></LI>
+	<LI><A HREF="general.html#L_bug_report">How do I report bugs?</A></LI>
 </OL>
 
 
@@ -274,5 +275,68 @@ directory.
 </P>
 
 
+
+<A NAME="L_bug_report">
+<H2>How do I report bugs?</H2>
+</A>
+
+<P>
+First, you need to figure out what you're reporting a bug against. This website
+(and its accompanying <A HREF="../mail.html">mailing list</A>) supports several
+related aspects of Linux, from the MTD kernel subsystem to its user-space
+utilities, including the generic MTD and NAND interface layers, several MTD
+hardware drivers, the UBI volume management system, several flash filesystems
+(e.g., JFFS2, UBIFS), and the user-space MTD utils.
+</P>
+
+<P>
+Now, bug reports for any of the above areas are more than welcome on the
+<A HREF="../mail.html">MTD mailing list</A>, provided you include sufficient
+information for reproducing and debugging your problem. This means:
+</P>
+
+<UL>
+	<LI>include all kernel 'oopses', stack traces, debug messages, or
+	relevant logs along with a clear description of the problem you're
+	having, what system(s) are affected, and anything else you think might
+	help people understand your issue;</LI>
+
+	<LI>include information about flash parameters found from
+	"<CODE>mtdinfo&amp;nbsp;-a</CODE>" (or the less useful info from
+	"<CODE>cat&amp;nbsp;/proc/mtd</CODE>");</LI>
+
+	<LI>specify which kernel version you are using;</LI>
+
+	<LI>specify which mtd-utils version you are using, if applicable. In
+	past releases of mtd-utils, different tools had different versions, so
+	be sure to check the relevant tool (e.g., use
+	"<CODE>nanddump&amp;nbsp;--version</CODE>" when reporting bugs involving
+	the <CODE>nanddump</CODE> tool); newer releases give the same version to
+	most/all the tools.</LI>
+</UL>
+
+<P>
+Please, <b>do not</b> send private e-mails to MTD maintainers; always CC the
+mailing list!
+</P>
+
+<P>
+You may also want to read one of the other related FAQs:
+</P>
+
+<UL>
+	<LI><A HREF="ubifs.html#L_how_send_bugreport">How do I send an UBIFS bug report?</A></LI>
+	<LI><A HREF="ubi.html#L_how_send_bugreport">How do I send an UBI bug report?</A></LI>
+</UL>
+
+<P>
+The MTD community may help support the YAFFS/YAFFS2 filesystems; however, YAFFS
+has its own dedicated <A HREF="http://www.yaffs.net/">website</A> and
+<A HREF="http://stoneboat.aleph1.co.uk/cgi-bin/mailman/listinfo/yaffs">mailing
+list</A>, and its code is not kept in the mainstream Linux kernel tree. Thus,
+any support you receive here will be limited, and you should contact YAFFS
+maintainers with real YAFFS bug reports.
+</P>
+
 <INCLUDE file="../inc/footer.tmpl" />
 </PAGE>
diff --git a/mail.xml b/mail.xml
index d79ac51..e3734f1 100644
--- a/mail.xml
+++ b/mail.xml
@@ -18,7 +18,9 @@
 	    <ul>
 		<li>my <a href="http://www.infradead.org/~dwmw2/email.html">notes on etiquette</a>.</li> 
 		<li>the section about <a href="source.html#kernelversions">kernel versions</a></li>
-		<li>the <a href="faq/general.html">MTD-FAQ</a></li>
+		<li>the <a href="faq/general.html">MTD-FAQ</a>, especially the
+			<a href="faq/general.html#L_bug_report">bug reporting
+			FAQ</a>, if applicable</li>
 		<li>the available <a href="doc/general.html">documentation</a></li>
 		<li>the mailing list archives at <a href="http://lists.infradead.org/pipermail/linux-mtd/">
 			http://lists.infradead.org/pipermail/linux-mtd/</a></li>
-- 
1.7.0.4

Re: [PATCH v2 9/9] faq: general: add bug reporting FAQ

[Brian Foster]

On Wednesday 10 August 2011 00:05:31 Brian Norris wrote:
> It's surprising to note that we do not have a general "how to send a bug
> report" FAQ. This patch provides a starting point and (most importantly)
> directs UBI/UBIFS users to the appropriate bug reporting information.
> 
> Signed-off-by: Brian Norris <computersforpeace@gmail.com>
> ---
> v2: handle some of Brian Foster's suggestions regarding clarity, other
>     additions to FAQ entry
> 
>  faq/general.xml |   64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  mail.xml        |    4 ++-
>  2 files changed, 67 insertions(+), 1 deletions(-)
> 
> diff --git a/faq/general.xml b/faq/general.xml
>[...] 
> +	<LI>include information about flash parameters found from
> +	"<CODE>mtdinfo&amp;nbsp;-a</CODE>" (or the less useful info from
> +	"<CODE>cat&amp;nbsp;/proc/mtd</CODE>");</LI>

 ‘&amp;nbsp;’?  I assume that's because this appears to be
 XML which, I also assume, is translated(?) into (X)HTML ?
 (Just checking that that is intended/intentional.)
cheers!
	-blf-
-- 
Brian FOSTER
Principal MTS, Software
Maxim Integrated Products (Microcontroller BU), formerly Innova Card
Web    : http://www.maxim-ic.com/

Re: [PATCH 9/9] faq: general: add bug reporting FAQ

[Brian Norris]

[-- Attachment #1: Type: text/plain, Size: 524 bytes --]

On Wednesday, August 10, 2011, Brian Foster <brian.foster@maxim-ic.com>
wrote:
> On Wednesday 10 August 2011 00:05:31 Brian Norris wrote:
>> +     "<CODE>cat&amp;nbsp;/proc/mtd</CODE>");</LI>
>
>  ‘&amp;nbsp;’?  I assume that's because this appears to be
>  XML which, I also assume, is translated(?) into (X)HTML ?
>  (Just checking that that is intended/intentional.)

Yeah, it's intentional. There's a Python script that converts the XML to
XHTML in the mtd-www.git repository, and this is necessary.

Brian

[-- Attachment #2: Type: text/html, Size: 668 bytes --]

Re: [PATCH 0/9] mtd-www: various fixes, bug reporting info

[Artem Bityutskiy]

On Mon, 2011-08-08 at 12:37 -0700, Brian Norris wrote:
> This patch series makes several updates to the MTD website. It's based
> on top of some recent patches from Matthew Creech that affected similar
> portions of the documentation.
> 
> The last patch, about bug reporting, is most likely under-informative
> at the moment. To write it up, I copied a few portions from other parts
> of the MTD website and tried to make them helpful as a "basic bug report"
> FAQ. Some of this is in response to Brian Foster's requests, so speak
> up if there are other instructions or information that you feel are
> missing from this FAQ.

Pushed to the mtd-www git tree, thanks!

-- 
Best Regards,
Artem Bityutskiy