From 7b574012e9c571f97e0ac9f796c1759082974779 Mon Sep 17 00:00:00 2001 From: Brian Norris Date: Mon, 8 Aug 2011 12:37:14 -0700 Subject: [PATCH] faq/doc: ubi(fs): move "bug report" questions to FAQ 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 Signed-off-by: Artem Bityutskiy --- 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 @@
  • More documentation
    • -
  • How do I send a bug report?
    • @@ -1186,58 +1185,5 @@ commands and the involved data structures), drivers/mtd/ubi/kapi.c file contains comments for each kernel API function (just above the body of the function).

    - - -

    How do I send an UBI bug report?

    - -

    Before sending a bug report:

    -
      -
    • make sure you use up-to-date UBI; pull the latest UBI patches - from corresponding UBIFS back-port trees if needed, see - here (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;
      • - -
    • make sure you have compiled kernel symbols in - (CONFIG_KALLSYMS_ALL=y in .config);
      • - -
    • enable UBI debugging (CONFIG_MTD_UBI_DEBUG=y - in .config); please, mark only the "UBI debugging" - check-box and do not mark other debugging sub-options like "UBI - debugging messages" unless you know what you are doing.
      • - -
    • include all the messages UBI prints, not only those you see at - the console, but also those you see when running dmesg; or - before running your UBI test, which reproduces the error, just - invoke dmesg -n8 command to make all kernel messages - 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.
      • - -
    • provide UBI configuration from you your .config - file, or just attach whole file;
      • - -
    • describe your flash device, attach the - "cat /proc/mtd" output;
      • - -
    • 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;
      • - -
    • describe how the problem can be reproduced;
      • -
    - -

    Please, attach all the bug-related messages including the UBI messages from -the kernel ring buffer, which may be collected using the dmesg -utility or using minicom with serial console capturing. Please, -describe how the problem can be reproduced (if it can be). The bug report -should be sent to the MTD mailing list. Please, -do not send private e-mails to UBI authors, always CC the mailing -list!

    - - 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 @@
  • Mount options
  • Flash space accounting issues
  • Documentation
    • -
  • How do I send an UBIFS bug report?
  • Raw flash vs. FTL devices
    • @@ -1207,76 +1206,6 @@ at the UBIFS mailing list.

    -

    How do I send an UBIFS bug report?

    - -

    Before sending a bug report, please, try to do the following:

    -
      -
    1. run the MTD tests to validate your flash (see - here);
      2. - -
    2. enable the UBIFS extra self checks and try to reproduce the - problem. See - this - chapter for more information about how to enable self-checks.
      3. -
    - -

    When sending a bug report, please:

    -
      -
    1. make sure you use up-to-date UBIFS; pull the latest UBIFS patches - if needed, see here; no one is - interested in digging already fixed problems;
      2. - -
    2. make sure you have compiled the kernel symbols in - (CONFIG_KALLSYMS_ALL=y in .config);
      3. - -
    3. 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; note, you should enable UBIFS - debugging, not UBI debugging - distinguish between UBI and UBIFS please, - they are different things;
      4. - -
    4. include all the messages UBIFS prints, not only those you see at - the console, but also those you see when running dmesg; or - before running your UBIFS test, which reproduces the error, just - invoke dmesg -n8 command to make all kernel messages - 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.
      5. - -
    5. 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;
      6. - -
    6. provide UBIi and UBIFS configuration from you your - .config file, or just attach whole file;
      7. - -
    7. describe your flash device, attach the - "cat /proc/mtd" output;
      8. - -
    8. 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;
      9. - -
    9. describe how the problem can be reproduced;
      10. -
    - -

    The bugreport should be sent to the -MTD mailing list. Please, do not send -private e-mails to UBIFS authors, always CC the mailing list!

    - -

    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 -UBI debugging section for more -information.

    - - -

    Raw flash vs. FTL devices

    FTL stands for "Flash Translation Layer" and it is software which emulates diff --git a/faq/ubi.xml b/faq/ubi.xml index 6ddb23c..314d31b 100644 --- a/faq/ubi.xml +++ b/faq/ubi.xml @@ -39,6 +39,7 @@

  • Why a dynamic volume is faster to access than a static volume of the same size?
  • How do I debug UBI?
    • +
  • How do I send an UBI bug report?
    • @@ -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.

    + + +

    How do I send an UBI bug report?

    + +

    Before sending a bug report:

    +
      +
    • make sure you use up-to-date UBI; pull the latest UBI patches + from corresponding UBIFS back-port trees if needed, see + here (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;
      • + +
    • make sure you have compiled kernel symbols in + (CONFIG_KALLSYMS_ALL=y in .config);
      • + +
    • enable UBI debugging (CONFIG_MTD_UBI_DEBUG=y + in .config); please, mark only the "UBI debugging" + check-box and do not mark other debugging sub-options like "UBI + debugging messages" unless you know what you are doing.
      • + +
    • include all the messages UBI prints, not only those you see at + the console, but also those you see when running dmesg; or + before running your UBI test, which reproduces the error, just + invoke dmesg -n8 command to make all kernel messages + 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.
      • + +
    • provide UBI configuration from you your .config + file, or just attach whole file;
      • + +
    • describe your flash device, attach the + "cat /proc/mtd" output;
      • + +
    • 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;
      • + +
    • describe how the problem can be reproduced;
      • +
    + +

    Please, attach all the bug-related messages including the UBI messages from +the kernel ring buffer, which may be collected using the dmesg +utility or using minicom with serial console capturing. Please, +describe how the problem can be reproduced (if it can be). The bug report +should be sent to the MTD mailing list. Please, +do not send private e-mails to UBI authors, always CC the mailing +list!

    + + diff --git a/faq/ubifs.xml b/faq/ubifs.xml index 8500b03..6b92970 100644 --- a/faq/ubifs.xml +++ b/faq/ubifs.xml @@ -44,6 +44,7 @@
  • I get: "init_constants_early: too few LEBs (12), min. is 17"
  • I want to study UBIFS - any recommendations?
  • How do I debug UBIFS?
    • +
  • How do I send an UBIFS bug report?
    • @@ -1144,7 +1145,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 MTD mailing list. If you think this is an UBIFS bug, please, send a -bug report.

    +bug report.

    @@ -1412,5 +1413,75 @@ all checks: "echo 127 > /sys/module/ubifs/parameters/debug_chks". + + +

    How do I send an UBIFS bug report?

    + +

    Before sending a bug report, please, try to do the following:

    +
      +
    1. run the MTD tests to validate your flash (see + here);
      2. + +
    2. enable the UBIFS extra self checks and try to reproduce the + problem. See + this + chapter for more information about how to enable self-checks.
      3. +
    + +

    When sending a bug report, please:

    +
      +
    1. make sure you use up-to-date UBIFS; pull the latest UBIFS patches + if needed, see here; no one is + interested in digging already fixed problems;
      2. + +
    2. make sure you have compiled the kernel symbols in + (CONFIG_KALLSYMS_ALL=y in .config);
      3. + +
    3. 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; note, you should enable UBIFS + debugging, not UBI debugging - distinguish between UBI and UBIFS please, + they are different things;
      4. + +
    4. include all the messages UBIFS prints, not only those you see at + the console, but also those you see when running dmesg; or + before running your UBIFS test, which reproduces the error, just + invoke dmesg -n8 command to make all kernel messages + 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.
      5. + +
    5. 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;
      6. + +
    6. provide UBIi and UBIFS configuration from you your + .config file, or just attach whole file;
      7. + +
    7. describe your flash device, attach the + "cat /proc/mtd" output;
      8. + +
    8. 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;
      9. + +
    9. describe how the problem can be reproduced;
      10. +
    + +

    The bugreport should be sent to the +MTD mailing list. Please, do not send +private e-mails to UBIFS authors, always CC the mailing list!

    + +

    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 +UBI debugging section for more +information.

    + -- 2.49.0