WARNING: This is the _old_ Lustre wiki, and it is in the process of being retired. The information found here is all likely to be out of date. Please search the new wiki for more up to date information.

Reporting Bugs: Difference between revisions

From Obsolete Lustre Wiki
Jump to navigationJump to search
No edit summary
 
No edit summary
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Lustre® Bugzilla User Guide
<small>''(Updated: Dec 2009)''</small>
__TOC__
[https://bugzilla.lustre.org Bugzilla] for Lustre™ is an issue tracker as well as a bug tracker. It is a one-stop repository for:
* Bugs
* Enhancement requests
* Patch submission
* Patch review and dependency tracking


== Overview ==
A bug-tracking system is less-error prone and superior to email in dozens of ways. For this reason we ask that all the above issues be handled exclusively through Bugzilla.


Despite the name, the Bugzilla for Lustre is really an issue tracker, not just a bug tracker. It's a one-stop repository for:
All of the important links described below are accessible from the Bugzilla main page or the toolbar at the bottom of each Bugzilla page.


** bugs,
== Opening an Account ==
** enhancement requests,
To use Bugzilla, you will need to open an account. On the Main page, click on "Open a new Bugzilla account". After you enter a valid email address, an email will be sent to you confirming the creation of your account.
** patch submission
  ** patch review, and dependency tracking.


Email is a low-power and error-prone tool for these tasks, and a real bug tracking system is better in dozens of ways. For this reason we ask that all of the above issues be handled exclusively through Bugzilla.
== Searching for Bugs ==


All of the important links on this page are accessible from the front page or the toolbar at the bottom of each Bugzilla page, so you don't need to bookmark them.
You can search for bugs in Bugzilla in two ways:
Searching for Bugs


There are two ways to search for bugs in Bugzilla: the quick way and the detailed way.
* Enter the bug number or search on a keyword.
* Search on a specific field or specify detailed or complex criteria. For more information about advanced searches see the [https://bugzilla.lustre.org/docs/html/using.html ''Bugzilla User's Guide'']


Use the quick way if you already know the bug number or just want to search for a keyword. Use the detailed way if you want to search on a specific field or with detailed or complex criteria.
== Filing a Bug ==
 
To file a bug, complete these steps:
If you want to use the detailed query, but don't really know what all of those things mean, you can read this longer guide.


== Filing a Bug ==
1. Before opening a new bug report, do a quick search to avoid filing a duplicate bug.


Before visiting the bug reporting form, please take a moment to do a quick search to avoid filing duplicate bugs.
2. To enter a new bug report, click on "New" or "Enter a new bug report".  


Please fill in as many fields as you can. If your version of Lustre isn't listed, please make a note of that in the bug summary so that we can correct that oversight. Please choose the correct component.
3. In the bug report form, fill in as many fields as you can. If your version of Lustre isn't listed, include it in a note in the bug summary so that we can add it to the list. Please choose the correct component.


Most importantly, please write a good summary and comment. A descriptive summary will dramatically improve your chances of success, and a good comment will prevent it from being immediately closed as INVALID. At the minimum:
4. Include a descriptive summary. At a minimum, include the following:


    * Describe the problem that you're solving, the feature that you're adding, or the enhancement that you're requesting.
* Describe the problem that you're solving, the feature that you're adding, or the enhancement that you're requesting.
    * If it's a bug, describe precisely the behaviour that you're seeing and the behaviour that you think is correct.
* If you are reporting a bug, describe precisely the behavior that you're seeing and the behavior that you think is correct.
    * Provide as minimal a test case as possible. For example, if 'tar' is crashing, try to narrow it down to a specific syscall, and then do another test with just that one operation. If you tried to narrow it down without success, tell us what you tried.
* Provide a minimal a test case. For example, if 'tar' is crashing, try to narrow the issue down to a specific ''syscall''. If you have tried to narrow it down without success, tell us what you tried.
    * If you have a patch, please read this page for information about how to create your patch, attach it to the bug, and have it reviewed. Please don't just paste it into a comment.
* If you are submitting a patch, see [[Submitting Patches]] for a detailed procedure.


== Including Diagnostics Information in a Bug Report==
A Lustre diagnostics tool is available for downloading at: http://downloads.lustre.org/public/tools/lustre-diagnostics/.
You can run this tool to capture diagnostics output to include in the reported bug. To run this tool, enter one of these commands:
* lustre-diagnostics -t <bugzilla bug #>
* lustre-diagnostics.
Output is sent directly to the terminal. Use normal file redirection to send the output to a file, and then manually attach the file to the bug you are submitting.
== Priority Bugs ==
== Priority Bugs ==
If you have a contract with Cluster File Systems for support of your Lustre project, you will see a group membership tick box. Use that to indicate that the bug is important for your project.
If you have a support contract for Lustre with Oracle, you will see a group membership tick box. Use this box to indicate that the bug is important for your project.
 
== Developers ==


For bug management see the Lustre project Wiki
'''''Note:''''' S1 (Critical) bugs can be filed only for corruption events or by customers with support contracts who are experiencing a production outage event.

Latest revision as of 11:34, 5 January 2011

(Updated: Dec 2009)

Bugzilla for Lustre™ is an issue tracker as well as a bug tracker. It is a one-stop repository for:

  • Bugs
  • Enhancement requests
  • Patch submission
  • Patch review and dependency tracking

A bug-tracking system is less-error prone and superior to email in dozens of ways. For this reason we ask that all the above issues be handled exclusively through Bugzilla.

All of the important links described below are accessible from the Bugzilla main page or the toolbar at the bottom of each Bugzilla page.

Opening an Account

To use Bugzilla, you will need to open an account. On the Main page, click on "Open a new Bugzilla account". After you enter a valid email address, an email will be sent to you confirming the creation of your account.

Searching for Bugs

You can search for bugs in Bugzilla in two ways:

  • Enter the bug number or search on a keyword.
  • Search on a specific field or specify detailed or complex criteria. For more information about advanced searches see the Bugzilla User's Guide

Filing a Bug

To file a bug, complete these steps:

1. Before opening a new bug report, do a quick search to avoid filing a duplicate bug.

2. To enter a new bug report, click on "New" or "Enter a new bug report".

3. In the bug report form, fill in as many fields as you can. If your version of Lustre isn't listed, include it in a note in the bug summary so that we can add it to the list. Please choose the correct component.

4. Include a descriptive summary. At a minimum, include the following:

  • Describe the problem that you're solving, the feature that you're adding, or the enhancement that you're requesting.
  • If you are reporting a bug, describe precisely the behavior that you're seeing and the behavior that you think is correct.
  • Provide a minimal a test case. For example, if 'tar' is crashing, try to narrow the issue down to a specific syscall. If you have tried to narrow it down without success, tell us what you tried.
  • If you are submitting a patch, see Submitting Patches for a detailed procedure.

Including Diagnostics Information in a Bug Report

A Lustre diagnostics tool is available for downloading at: http://downloads.lustre.org/public/tools/lustre-diagnostics/. You can run this tool to capture diagnostics output to include in the reported bug. To run this tool, enter one of these commands:

  • lustre-diagnostics -t <bugzilla bug #>
  • lustre-diagnostics.

Output is sent directly to the terminal. Use normal file redirection to send the output to a file, and then manually attach the file to the bug you are submitting.

Priority Bugs

If you have a support contract for Lustre with Oracle, you will see a group membership tick box. Use this box to indicate that the bug is important for your project.

Note: S1 (Critical) bugs can be filed only for corruption events or by customers with support contracts who are experiencing a production outage event.