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.

Submitting Patches

From Obsolete Lustre Wiki
Jump to navigationJump to search

When you are ready to have your patch reviewed and committed, please do so using Bugzilla by following the process described below.

Submitting Patches for Review

To have your changes accepted into a main-line Lustre branch, your code must be reviewed and approved. Following these steps will speed up review of your changes and increase the likelihood of success:

1. Read, complete, and return the form found at Contributor Agreement We cannot accept your contributions without this form. See Contribution Policy for more information.

2. Generate a patch with the "-upN" flags set to diff or cvs diff. Please do not send other kinds of patches unless your reviewer requests them.

Would this step be clearer if it said something like this?

Generate a patch file showing the differences between your code and the code in the repository by entering:

$ cvs diff -upN FILENAME (please fix if not correct)

Where N designates the number of lines of context to include. Please do not send other kinds of patches unless your reviewer requests them.

3. Find or file a bug corresponding to your contribution at http://bugzilla.lustre.org/ . For more information about Bugzilla, see the Bugzilla - Bug Writing Guidelines or the Bugzilla User Guide.

If working with an Lustre internal engineer (not a new bug), set the Inspection tag to "?" and take the owner of the bug (Assigned to field) - copy and past into field next to "?" the email address of the engineer who owns the bug. If submitting new bug with patch attached following normal bug submission procedure. Support team will assign bug as appropriate.

  • (Still OK) Enter the email address of the person who should review. If you have not been collaborating with someone and don't know who should review your work, send an email to lustre-rmg-team@sun.com
  • Click on "commit" to submit the attachment update.

4. One or more reviewers will submit comments regarding your patch. Iterate the patch until you receive approval or the bug is closed.

5. Once you have approval, commit the patch (or, if you do not have CVS access, the internal engineer assigned to the bug will direct the bug appropriately or land the change). Include the bug number and reviewer in the commit message, along with a concise description of the change.

Note: This process applies even if you have write access to the CVS tree. If you do not follow these steps, then expect your changes to be backed out of the tree without warning.

Creating a Private Branch in CVS

Our current policy is that anyone may create and maintain a private branch in CVS. We ask, however, that you observe the best practices outlined in this document can a link be provided?. It will save you a lot of effort.

If you have demonstrated a history of good work by submitting several non-trivial and correct patches, you may want to request write access to the CVS tree.