Commit Patch Message Guidelines - Revision history

Rhi at 08:28, 16 April 2024

2024-04-16T08:28:26Z

← Older revision		Revision as of 08:28, 16 April 2024
Line 1:		Line 1:
	This page has moved to the [https://docs.yoctoproject.org/dev/contributor-guide/submit-changes.html ~~Yocto Documentation Contributors Guide~~]		This page has moved to the Yocto Documentation Contributors Guide:

			* For the Patch Upstream Status documentation see the section ''[https://docs.yoctoproject.org/dev/contributor-guide/recipe-style-guide.html#patch-upstream-status Recipe Style Guide]''
			* See section ''[https://docs.yoctoproject.org/dev/contributor-guide/submit-changes.html Contributing Changes to a Component]'' for everything else

2023-08-30T15:38:23Z

Moved to YP docs

2021-12-13T17:38:24Z

Patch Header Recommendations: Upstream-Status

← Older revision		Revision as of 17:38, 13 December 2021
Line 341:		Line 341:
	- Not accepted by upstream, include reason in patch		- Not accepted by upstream, include reason in patch

	'''Inactive-Upstream [lastcommit: when, lastrelease: when]'''		'''Inactive-Upstream [lastcommit: when (and/or) lastrelease: when]'''
	- The upstream is no longer available. This typically means a defunct project		- The upstream is no longer available. This typically means a defunct project
	where no activity has happened for a long time - measured in years. To make		where no activity has happened for a long time - measured in years. To make
	that ~~judgment~~, it is recommended to look at not only when the last release		that judgement, it is recommended to look at not only when the last release
	happened, but also when the last commit happened, and whether newly made bug		happened, but also when the last commit happened, and whether newly made bug
	reports and merge requests since that time receive no reaction. It is also		reports and merge requests since that time receive no reaction. It is also

2021-12-13T17:34:46Z

Patch Header Recommendations: Upstream-Status

← Older revision		Revision as of 17:34, 13 December 2021
Line 342:		Line 342:

	'''Inactive-Upstream [lastcommit: when, lastrelease: when]'''		'''Inactive-Upstream [lastcommit: when, lastrelease: when]'''
	- The upstream is no longer available. This typically means a defunct project where no activity has happened for a long time - measured in years. To make that judgment, it is recommended to look at not only when the last release happened, but also when the last commit happened, and whether newly made bug reports and merge requests since that time receive no reaction.		- The upstream is no longer available. This typically means a defunct project
			where no activity has happened for a long time - measured in years. To make
			that judgment, it is recommended to look at not only when the last release
			happened, but also when the last commit happened, and whether newly made bug
			reports and merge requests since that time receive no reaction. It is also
			recommended to add any relevant links to the commit message where the inactivity
			can be clearly seen.

	'''Inappropriate [reason]'''		'''Inappropriate [reason]'''

2021-12-13T17:31:24Z

Add a separate status for inactive upstreams

← Older revision		Revision as of 17:31, 13 December 2021
Line 340:		Line 340:
	'''Denied'''		'''Denied'''
	- Not accepted by upstream, include reason in patch		- Not accepted by upstream, include reason in patch

			'''Inactive-Upstream [lastcommit: when, lastrelease: when]'''
			- The upstream is no longer available. This typically means a defunct project where no activity has happened for a long time - measured in years. To make that judgment, it is recommended to look at not only when the last release happened, but also when the last commit happened, and whether newly made bug reports and merge requests since that time receive no reaction.

	'''Inappropriate [reason]'''		'''Inappropriate [reason]'''
Line 354:		Line 357:
	bugfix (add bug URL here)		bugfix (add bug URL here)
	embedded specific		embedded specific
	~~no upstream (the upstream is no longer available -- dead project)~~
	other (give details in comments)		other (give details in comments)

2020-10-08T19:44:04Z

Document use of [YOCTO #12345] type syntax for Bugzilla fixes

@@ Line 399: / Line 399: @@
     CVE: CVE-2015-8370
     Signed-off-by: Joe Developer <joe.developer@example.com>
 == Common Errors in Patch and Commit Messages ==

2020-10-08T19:41:40Z

Patch Headers and Commit Messages

← Older revision		Revision as of 19:41, 8 October 2020
Line 109:		Line 109:

	where 12345 is the number of the bug being referenced. The commit message should be understandable in its own right without needing to look at the bug.		where 12345 is the number of the bug being referenced. The commit message should be understandable in its own right without needing to look at the bug.

			It is useful to include a version number in the [PATCH] prefix of the subject line, e.g. [PATCH v2] so that its known to be a new version of an earlier patch. It can also be useful to include information about what changed in the new version. This should either be in the cover letter of the series (if one is present) or be done under the detailed commit message and after a "---" separator line. This will mean git will discard the revision information when the patch is applied. This is because the history of the patch revisions is not usually useful to the information being stored against the change. If it is useful information, it should be in the commit message instead.

	== New Development ==		== New Development ==

2020-10-08T19:38:20Z

Patch Headers and Commit Messages

← Older revision		Revision as of 19:38, 8 October 2020
Line 104:		Line 104:
	such as "Signed-off-by:".		such as "Signed-off-by:".

			If the bug relates to a bug in the Yocto Project Bugzilla (https://bugzilla.yoctoproject.org/) then a reference to that bugzilla entry should be added to the details in the form:

			[YOCTO #12345]

			where 12345 is the number of the bug being referenced. The commit message should be understandable in its own right without needing to look at the bug.

	== New Development ==		== New Development ==

2018-03-01T16:03:20Z

Add Upstream-Status to the title of this section so that it is easier to find with search engines etc.

← Older revision		Revision as of 16:03, 1 March 2018
Line 296:		Line 296:
	Signed-off-by: Your Name <your.name@openembedded.org>		Signed-off-by: Your Name <your.name@openembedded.org>

	== Patch Header Recommendations ==		== Patch Header Recommendations: Upstream-Status ==

	In order to keep track of patches and ultimately reduce the number of patches		In order to keep track of patches and ultimately reduce the number of patches

2018-01-23T14:34:38Z

Add information about license changes.

@@ Line 183: / Line 183: @@
 It is not acceptable to have an empty or non-existent header, or just a single
 line message. The summary and description is required for all changes.
 == Importing from Elsewhere ==