From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mms3.broadcom.com ([216.31.210.19]) by canuck.infradead.org with esmtp (Exim 4.76 #1 (Red Hat Linux)) id 1QquQk-0003cb-3E for linux-mtd@lists.infradead.org; Tue, 09 Aug 2011 22:05:47 +0000 From: "Brian Norris" To: "Artem Bityutskiy" Subject: [PATCH v2 9/9] faq: general: add bug reporting FAQ Date: Tue, 9 Aug 2011 15:05:31 -0700 Message-ID: <1312927531-16853-1-git-send-email-computersforpeace@gmail.com> In-Reply-To: <1312832239-21759-10-git-send-email-computersforpeace@gmail.com> References: <1312832239-21759-10-git-send-email-computersforpeace@gmail.com> MIME-Version: 1.0 Content-Type: text/plain Content-Transfer-Encoding: 7bit Cc: brian.foster@maxim-ic.com, Brian Norris , linux-mtd@lists.infradead.org List-Id: Linux MTD discussion mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , 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 --- 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 @@
  • What are the point() and unpoint() functions used for?
  • Why do I keep getting errors whenever I try to write to or erase my MTD device?
  • How do I compile the mtd-utils tree?
    • +
  • How do I report bugs?
    • @@ -274,5 +275,68 @@ directory.

    + + +

    How do I report bugs?

    +     + +

    +First, you need to figure out what you're reporting a bug against. This website +(and its accompanying mailing list) 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. +

    + +

    +Now, bug reports for any of the above areas are more than welcome on the +MTD mailing list, provided you include sufficient +information for reproducing and debugging your problem. This means: +

    + +
      +
    • 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;
      • + +
    • include information about flash parameters found from + "mtdinfo&nbsp;-a" (or the less useful info from + "cat&nbsp;/proc/mtd");
      • + +
    • specify which kernel version you are using;
      • + +
    • 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 + "nanddump&nbsp;--version" when reporting bugs involving + the nanddump tool); newer releases give the same version to + most/all the tools.
      • +
    + +

    +Please, do not send private e-mails to MTD maintainers; always CC the +mailing list! +

    + +

    +You may also want to read one of the other related FAQs: +

    + + + +

    +The MTD community may help support the YAFFS/YAFFS2 filesystems; however, YAFFS +has its own dedicated website and +mailing +list, 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. +

    + diff --git a/mail.xml b/mail.xml index d79ac51..e3734f1 100644 --- a/mail.xml +++ b/mail.xml @@ -18,7 +18,9 @@