Submitting Patches - Revision history

Sbarthel at 17:29, 20 January 2011

2011-01-20T17:29:00Z

← Older revision		Revision as of 10:29, 20 January 2011
Line 7:		Line 7:
	When you are ready to have your patch reviewed, follow the process described below for submitting it using Bugzilla.		When you are ready to have your patch reviewed, follow the process described below for submitting it using Bugzilla.

	'''''Note:''''' It is sometimes desirable to solicit reviews of a patch on the [mailto:lustre-devel@lists.lustre.org lustre-devel] mailing list to expose the patch to a wider audience. However, this will ''NOT'' put the patch on track to being accepted into the ~~Lustre™~~ repository.		'''''Note:''''' It is sometimes desirable to solicit reviews of a patch on the [mailto:lustre-devel@lists.lustre.org lustre-devel] mailing list to expose the patch to a wider audience. However, this will ''NOT'' put the patch on track to being accepted into the Lustre repository.

	=== Submitting Patches for Review ===		=== Submitting Patches for Review ===

Docadmin at 01:35, 4 November 2010

2010-11-04T01:35:34Z

← Older revision		Revision as of 18:35, 3 November 2010
Line 13:		Line 13:
	To have your changes accepted into a mainline Lustre branch, your code must follow the Lustre [[Coding Guidelines]], and be reviewed and approved by senior Lustre engineers. Following these steps will speed up review of your changes and increase the likelihood of success:		To have your changes accepted into a mainline Lustre branch, your code must follow the Lustre [[Coding Guidelines]], and be reviewed and approved by senior Lustre engineers. 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 [[Media:~~Sun_Contributor_Agreement_1_5~~.pdf\|Contributor Agreement]]. We cannot accept your contributions without this form. See [[Contribution_Policy\|Contribution Policy]] for more information.		1. Read, complete, and return the form found at [[Media:Oracle_Contributor_Agreement_Nov_2010.pdf\|Contributor Agreement]]. We cannot accept your contributions without this form. See [[Contribution_Policy\|Contribution Policy]] for more information.

	2. Testing the patch is required before it can be submitted. The patch must include any new tests specific to the bug/feature. See [[Testing Lustre Code]] for specific details.		2. Testing the patch is required before it can be submitted. The patch must include any new tests specific to the bug/feature. See [[Testing Lustre Code]] for specific details.

Nirant.puntambekar at 15:08, 18 October 2010

2010-10-18T15:08:46Z

← Older revision		Revision as of 08:08, 18 October 2010
Line 58:		Line 58:
	6. Request patch landing permission by setting the "landing_''release'' ?" flag for your patch.		6. Request patch landing permission by setting the "landing_''release'' ?" flag for your patch.

	7. Once you have landing approval (as given by the branch maintainer in the form of a "landing_''release'' +" flag on the patch, mail the patch to [mailto:lustre-gate-20@sun.com lustre-gate-20] for Lustre 2.0, or [mailto:lustre-gate-18@sun.com lustre-gate-18] for Lustre 1.8. Include the bug number and reviewer in the commit message along with a concise description of the change, as stated above.		7. Once you have landing approval (as given by the branch maintainer in the form of a "landing_''release'' +" flag on the patch, mail the patch to [mailto:lustre-gate-2x@sun.com lustre-gate-2x] for Lustre 2.x, or [mailto:lustre-gate-18@sun.com lustre-gate-18] for Lustre 1.8. Include the bug number and reviewer in the commit message along with a concise description of the change, as stated above.

Adilger: /* Submitting Patches for Review */

2010-08-04T18:12:55Z

Submitting Patches for Review

← Older revision		Revision as of 11:12, 4 August 2010
Line 11:		Line 11:
	=== Submitting Patches for Review ===		=== Submitting Patches for Review ===

	To have your changes accepted into a mainline Lustre branch, your code must be reviewed and approved by senior Lustre engineers. Following these steps will speed up review of your changes and increase the likelihood of success:		To have your changes accepted into a mainline Lustre branch, your code must follow the Lustre [[Coding Guidelines]], and be reviewed and approved by senior Lustre engineers. 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 [[Media:Sun_Contributor_Agreement_1_5.pdf\|Contributor Agreement]]. We cannot accept your contributions without this form. See [[Contribution_Policy\|Contribution Policy]] for more information.		1. Read, complete, and return the form found at [[Media:Sun_Contributor_Agreement_1_5.pdf\|Contributor Agreement]]. We cannot accept your contributions without this form. See [[Contribution_Policy\|Contribution Policy]] for more information.

Adilger: /* Submitting Patches for Review */ add format-patch example

2010-07-16T22:15:45Z

Submitting Patches for Review: add format-patch example

← Older revision		Revision as of 15:15, 16 July 2010
Line 19:		Line 19:
	3. Generate a patch with ''diff -upN'', ''git diff'', or ''git format-patch''. Please do not send other kinds of patches unless your reviewer requests them.		3. Generate a patch with ''diff -upN'', ''git diff'', or ''git format-patch''. Please do not send other kinds of patches unless your reviewer requests them.

	The command for generating a patch is:<pre>		The easiest command for generating a patch is:
			<pre>
	[lustre]$ git diff {basebranch} > {patchname}.diff		[lustre]$ git diff {basebranch} > {patchname}.diff
	</pre>		</pre>
	where ''{basebranch}'' is the branch you are patching against (''b1_6'', ''b1_8'', or ''master''). Note this patch will include committed and uncommitted changes on your branch. If you ~~have nicely squashed your~~ commit ~~history~~, ~~feel free~~ to use ''git format-patch''. If you are unfamiliar with this process, use ''git diff''.		where ''{basebranch}'' is the branch you are patching against (''b1_6'', ''b1_8'', or ''master''). Note this patch will include committed and uncommitted changes on your branch. If you well-defined patches with proper commit comments as described below, it is also possible to use ''git format-patch'':
			<pre>
			[lustre]$ git format-patch {since}
			e.g.
			[lustre]$ git format-patch -2 # format the last 2 commits
			</pre>

			If you are unfamiliar with this process, use ''git diff''.

	If sending changes with ''git format-patch'' we ask that you follow ~~the~~ standard commit message format when making your commits, so that the patch can more easily be identified in the future. If you are doing a rebase, you will get a chance to modify/combine your commit messages. Commit messages for final patches should look like this:		If sending changes with ''git format-patch'' we ask that you follow our standard commit message format when making your commits, so that the patch can more easily be identified in the future. If you are doing a rebase, you will get a chance to modify/combine your commit messages. Commit messages for final patches should look like this:
	<pre>		<pre>
	b=<bugno> <~~Single~~ line summary of change>		b=<bugno> <One-line summary of change>

	<~~In depth~~ description>		<Full description of change>

	i=<inspector1>		i=<inspector1>
Line 34:		Line 42:
	</pre>		</pre>

	If you are not using git format-patch, then simply adding the above lines at the start of the submission email is enough.		If you are not using git format-patch, then simply adding the above lines at the start of the submission email is enough. If you are making a commit prior to submitting the patch for inspection, simply omit the ''i=<inspector>'' lines, and then use ''git commit --amend'' to change the commit comment after inspection is complete.

	4. Find or file a bug corresponding to your contribution in [http://bugzilla.lustre.org/ Bugzilla]. For more information about Bugzilla, see the [[Developers Guide to Bugzilla for Lustre\|Developers Guide to Bugzilla]], the [https://bugzilla.lustre.org/page.cgi?id=bug-writing.html Bugzilla - Bug Writing Guidelines], or the [https://bugzilla.lustre.org/docs/html/using.html Bugzilla User Guide].		4. Find or file a bug corresponding to your contribution in [http://bugzilla.lustre.org/ Bugzilla]. For more information about Bugzilla, see the [[Developers Guide to Bugzilla for Lustre\|Developers Guide to Bugzilla]], the [https://bugzilla.lustre.org/page.cgi?id=bug-writing.html Bugzilla - Bug Writing Guidelines], or the [https://bugzilla.lustre.org/docs/html/using.html Bugzilla User Guide].

Adilger: /* Submitting Patches for Review */ move testing flags setting

2010-07-16T22:09:05Z

Submitting Patches for Review: move testing flags setting

← Older revision		Revision as of 15:09, 16 July 2010
Line 15:		Line 15:
	1. Read, complete, and return the form found at [[Media:Sun_Contributor_Agreement_1_5.pdf\|Contributor Agreement]]. We cannot accept your contributions without this form. See [[Contribution_Policy\|Contribution Policy]] for more information.		1. Read, complete, and return the form found at [[Media:Sun_Contributor_Agreement_1_5.pdf\|Contributor Agreement]]. We cannot accept your contributions without this form. See [[Contribution_Policy\|Contribution Policy]] for more information.

	2. Testing the patch is required before it can be submitted. The patch must include any new tests specific to the bug/feature. See [[Testing Lustre Code]] for specific details. ~~If you have completed testing of the patch, set the "acc-sm_passed_''release''" flag to "+" for the branch(es) that passed testing in step 4 below.~~		2. Testing the patch is required before it can be submitted. The patch must include any new tests specific to the bug/feature. See [[Testing Lustre Code]] for specific details.

	3. Generate a patch with ''diff -upN'', ''git diff'', or ''git format-patch''. Please do not send other kinds of patches unless your reviewer requests them.		3. Generate a patch with ''diff -upN'', ''git diff'', or ''git format-patch''. Please do not send other kinds of patches unless your reviewer requests them.
Line 42:		Line 42:
	** If submitting a new bug with a patch attached, follow normal bug submission procedures. The support team will assign the bug and inspections as appropriate.		** If submitting a new bug with a patch attached, follow normal bug submission procedures. The support team will assign the bug and inspections as appropriate.
	** If working with an Lustre internal engineer, under "Flags" set the ''inspection'' flag to "?" and copy the email address of the engineer into the adjacent ''Requestee:'' field.		** If working with an Lustre internal engineer, under "Flags" set the ''inspection'' flag to "?" and copy the email address of the engineer into the adjacent ''Requestee:'' field.
			** If you have completed testing of the patch, set the "acc-sm_passed_''release'' +" flag for the branch(es) that passed testing. If you have not actually run the acceptance-small.sh test script to completion (unless advised otherwise) you should describe the testing performed to date, and can optionally set the "more-testing_''release'' +" flag.
	** If you have not been collaborating with someone on the Lustre team and don't know who should review your work, assign the inspection to ''lustre-rmg-team@sun.com''		** If you have not been collaborating with someone on the Lustre team and don't know who should review your work, assign the inspection to ''lustre-rmg-team@sun.com''
	* Click on "commit" to submit the attachment and inspection request.		* Click on "commit" to submit the attachment and inspection request.

	5. One or more reviewers will submit comments regarding your patch. Iterate the patch until you receive inspection approval or the bug is closed.		5. One or more reviewers will submit comments regarding your patch. Iterate the patch until you receive inspection approval, have passed all requested testing, or the bug is closed.

	6. Once you have approval, mail the patch to [mailto:lustre-gate-20@sun.com lustre-gate-20] for Lustre 2.0, or [mailto:lustre-gate-18@sun.com lustre-gate-18] for Lustre 1.8. Include the bug number and reviewer in the commit message, along with a concise description of the change, as stated above.		6. Request patch landing permission by setting the "landing_''release'' ?" flag for your patch.

			7. Once you have landing approval (as given by the branch maintainer in the form of a "landing_''release'' +" flag on the patch, mail the patch to [mailto:lustre-gate-20@sun.com lustre-gate-20] for Lustre 2.0, or [mailto:lustre-gate-18@sun.com lustre-gate-18] for Lustre 1.8. Include the bug number and reviewer in the commit message along with a concise description of the change, as stated above.

Adilger: /* Submitting Patches for Review */ fix up links for gates, remove 16-gate

2010-06-05T02:21:38Z

Submitting Patches for Review: fix up links for gates, remove 16-gate

← Older revision		Revision as of 19:21, 4 June 2010
Line 47:		Line 47:
	5. One or more reviewers will submit comments regarding your patch. Iterate the patch until you receive inspection approval or the bug is closed.		5. One or more reviewers will submit comments regarding your patch. Iterate the patch until you receive inspection approval or the bug is closed.

	6. Once you have approval, mail the patch to [mailto:lustre-gate-20@sun.com lustre-gate-20]~~, [mailto:lustre-gate-20@sun~~.~~com lustre-gate-16]~~, or [mailto:lustre-gate-16@sun.com lustre-gate-18] (for Lustre ~~2.0, 1.6, or~~ 1.8 ~~respectively)~~. Include the bug number and reviewer in the commit message, along with a concise description of the change, as stated above.		6. Once you have approval, mail the patch to [mailto:lustre-gate-20@sun.com lustre-gate-20] for Lustre 2.0, or [mailto:lustre-gate-18@sun.com lustre-gate-18] for Lustre 1.8. Include the bug number and reviewer in the commit message, along with a concise description of the change, as stated above.

Sbarthel at 19:03, 22 February 2010

2010-02-22T19:03:27Z

← Older revision		Revision as of 12:03, 22 February 2010
Line 1:		Line 1:
			<small>''(Updated: Dec 2009)''</small>

	'''''NOTICE:''''' A transition from CVS to Git took place on Monday, December 14. For more information about the transition, see the [[Git Transition Notice]]. For details about how to migrate to Git, see [[Migrating to Git]].		'''''NOTICE:''''' A transition from CVS to Git took place on Monday, December 14. For more information about the transition, see the [[Git Transition Notice]]. For details about how to migrate to Git, see [[Migrating to Git]].

Docadmin: /* Submitting Patches for Review */

2009-12-23T02:00:29Z

Submitting Patches for Review

← Older revision		Revision as of 19:00, 22 December 2009
Line 11:		Line 11:
	To have your changes accepted into a mainline Lustre branch, your code must be reviewed and approved by senior Lustre engineers. Following these steps will speed up review of your changes and increase the likelihood of success:		To have your changes accepted into a mainline Lustre branch, your code must be reviewed and approved by senior Lustre engineers. 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 [~~http~~:~~//wiki.lustre.org/images/c/cd/~~Sun_Contributor_Agreement_1_5.pdf Contributor Agreement]. We cannot accept your contributions without this form. See [[Contribution_Policy\|Contribution Policy]] for more information.		1. Read, complete, and return the form found at [[Media:Sun_Contributor_Agreement_1_5.pdf\|Contributor Agreement]]. We cannot accept your contributions without this form. See [[Contribution_Policy\|Contribution Policy]] for more information.

	2. Testing the patch is required before it can be submitted. The patch must include any new tests specific to the bug/feature. See [[Testing Lustre Code]] for specific details. If you have completed testing of the patch, set the "acc-sm_passed_''release''" flag to "+" for the branch(es) that passed testing in step 4 below.		2. Testing the patch is required before it can be submitted. The patch must include any new tests specific to the bug/feature. See [[Testing Lustre Code]] for specific details. If you have completed testing of the patch, set the "acc-sm_passed_''release''" flag to "+" for the branch(es) that passed testing in step 4 below.
Line 34:		Line 34:
	If you are not using git format-patch, then simply adding the above lines at the start of the submission email is enough.		If you are not using git format-patch, then simply adding the above lines at the start of the submission email is enough.

	4. Find or file a bug corresponding to your contribution in [http://bugzilla.lustre.org/ Bugzilla]. For more information about Bugzilla, see the [[~~Developers_Guide_to_Bugzilla_for_Lustre~~\|Developers Guide to Bugzilla]], the [https://bugzilla.lustre.org/page.cgi?id=bug-writing.html Bugzilla - Bug Writing Guidelines], or the [https://bugzilla.lustre.org/docs/html/using.html Bugzilla User Guide].		4. Find or file a bug corresponding to your contribution in [http://bugzilla.lustre.org/ Bugzilla]. For more information about Bugzilla, see the [[Developers Guide to Bugzilla for Lustre\|Developers Guide to Bugzilla]], the [https://bugzilla.lustre.org/page.cgi?id=bug-writing.html Bugzilla - Bug Writing Guidelines], or the [https://bugzilla.lustre.org/docs/html/using.html Bugzilla User Guide].

	* Provide the patch as an Attachment (click on "Add an Attachment")		* Provide the patch as an Attachment (click on "Add an Attachment")

Docadmin at 20:22, 16 December 2009

2009-12-16T20:22:35Z

← Older revision		Revision as of 13:22, 16 December 2009
Line 5:		Line 5:
	When you are ready to have your patch reviewed, follow the process described below for submitting it using Bugzilla.		When you are ready to have your patch reviewed, follow the process described below for submitting it using Bugzilla.

	'''''Note:''''' It is sometimes desirable to solicit reviews of a patch on the [mailto:lustre-devel@lists.lustre.org lustre-devel] mailing list to expose the patch to a wider audience. However, this will ''NOT'' put the patch on track to being accepted into the ~~Lustre~~ repository.		'''''Note:''''' It is sometimes desirable to solicit reviews of a patch on the [mailto:lustre-devel@lists.lustre.org lustre-devel] mailing list to expose the patch to a wider audience. However, this will ''NOT'' put the patch on track to being accepted into the Lustre™ repository.

	=== Submitting Patches for Review ===		=== Submitting Patches for Review ===