forked from openzfs/zfs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
commitcheck: Multiple OpenZFS ports in commit
Allow commitcheck.sh to handle multiple OpenZFS ports in a single commit. This is useful in the cases when a change upstream has bug fixes and it makes sense to port them with the original patch. Reviewed-by: Brian Behlendorf <[email protected]> Reviewed-by: George Melikov <[email protected]> Reviewed-by: Chris Dunlop <[email protected]> Signed-off-by: Giuseppe Di Natale <[email protected]> Closes openzfs#6780
- Loading branch information
1 parent
8dcaf24
commit 69b229b
Showing
2 changed files
with
51 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -186,23 +186,23 @@ Signed-off-by: Contributor <[email protected]> | |
``` | ||
|
||
#### OpenZFS Patch Ports | ||
If you are porting an OpenZFS patch, the commit message must meet | ||
If you are porting OpenZFS patches, the commit message must meet | ||
the following guidelines: | ||
* The first line must be the summary line from the OpenZFS commit. | ||
It must begin with `OpenZFS dddd - ` where `dddd` is the OpenZFS issue number. | ||
* Provides a `Authored by:` line to attribute the patch to the original author. | ||
* Provides the `Reviewed by:` and `Approved by:` lines from the original | ||
* The first line must be the summary line from the most important OpenZFS commit being ported. | ||
It must begin with `OpenZFS dddd, dddd - ` where `dddd` are OpenZFS issue numbers. | ||
* Provides a `Authored by:` line to attribute each patch for each original author. | ||
* Provides the `Reviewed by:` and `Approved by:` lines from each original | ||
OpenZFS commit. | ||
* Provides a `Ported-by:` line with the developer's name followed by | ||
their email. | ||
* Provides a `OpenZFS-issue:` line which is a link to the original illumos | ||
their email for each OpenZFS commit. | ||
* Provides a `OpenZFS-issue:` line with link for each original illumos | ||
issue. | ||
* Provides a `OpenZFS-commit:` line which links back to the original OpenZFS | ||
commit. | ||
* Provides a `OpenZFS-commit:` line with link for each original OpenZFS commit. | ||
* If necessary, provide some porting notes to describe any deviations from | ||
the original OpenZFS commit. | ||
the original OpenZFS commits. | ||
|
||
An example OpenZFS patch port commit message is provided below. | ||
An example OpenZFS patch port commit message for a single patch is provided | ||
below. | ||
``` | ||
OpenZFS 1234 - Summary from the original OpenZFS commit | ||
|
@@ -218,6 +218,37 @@ OpenZFS-issue: https://www.illumos.org/issues/1234 | |
OpenZFS-commit: https://github.com/openzfs/openzfs/commit/abcd1234 | ||
``` | ||
|
||
If necessary, multiple OpenZFS patches can be combined in a single port. | ||
This is useful when you are porting a new patch and its subsequent bug | ||
fixes. An example commit message is provided below. | ||
``` | ||
OpenZFS 1234, 5678 - Summary of most important OpenZFS commit | ||
1234 Summary from original OpenZFS commit for 1234 | ||
Authored by: Original Author <[email protected]> | ||
Reviewed by: Reviewer Two <[email protected]> | ||
Approved by: Approver One <[email protected]> | ||
Ported-by: ZFS Contributor <[email protected]> | ||
Provide some porting notes here for 1234 if necessary. | ||
OpenZFS-issue: https://www.illumos.org/issues/1234 | ||
OpenZFS-commit: https://github.com/openzfs/openzfs/commit/abcd1234 | ||
5678 Summary from original OpenZFS commit for 5678 | ||
Authored by: Original Author2 <[email protected]> | ||
Reviewed by: Reviewer One <[email protected]> | ||
Approved by: Approver Two <[email protected]> | ||
Ported-by: ZFS Contributor <[email protected]> | ||
Provide some porting notes here for 5678 if necessary. | ||
OpenZFS-issue: https://www.illumos.org/issues/5678 | ||
OpenZFS-commit: https://github.com/openzfs/openzfs/commit/efgh5678 | ||
``` | ||
|
||
#### Coverity Defect Fixes | ||
If you are submitting a fix to a | ||
[Coverity defect](https://scan.coverity.com/projects/zfsonlinux-zfs), | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters