Skip to content

Provide commit message format for Coverity defects #6771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 23, 2017
Merged

Provide commit message format for Coverity defects #6771

merged 1 commit into from
Oct 23, 2017
+45 −11

Conversation

@dinatale2
Copy link
Contributor

Description

Provide details about the commit message format for Coverity defect
fixes submitted. Will make changes to the commit message checker in the future.

Motivation and Context

Document Coverity defect fix commit message expectations.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Performance enhancement (non-breaking change which improves efficiency)
  • Code cleanup (non-breaking change which makes code smaller or more readable)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (a change to man pages or other documentation)

Checklist:

  • My code follows the ZFS on Linux code style requirements.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • All commit messages are properly formatted and contain Signed-off-by.
  • Change has been approved by a ZFS on Linux member.

@dinatale2 dinatale2 added Type: Documentation Indicates a requested change to the documentation Status: Work in Progress Not yet ready for general review labels Oct 20, 2017
behlendorf
behlendorf requested changes Oct 20, 2017
View reviewed changes
.github/CONTRIBUTING.md Outdated
```

#### Coverity Defect Fixes
If you are submitting a fix to a Coverity defect, the commit message must
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should link to the Coverity results, https://scan.coverity.com/projects/zfsonlinux-zfs

.github/CONTRIBUTING.md Outdated
* The first line must be in the format of `Fix coverity defects: CID dddd, dddd...`
where `dddd` represents each CID fixed by the commit.
* The body of the commit message must be a list of Coverity defects and how
each defect was corrected. Each defect must start in with a line in the format
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about.

  • The body of the commit message should list each Coverity defect and how it was corrected.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want me to leave the description of the format? Or should we just let the example fill in that part?

@dinatale2 dinatale2 force-pushed the coverity-commit-contrib branch 2 times, most recently from f34870a to a6121cf Compare October 20, 2017 21:06
@dinatale2 dinatale2 removed the Status: Work in Progress Not yet ready for general review label Oct 21, 2017
gmelikov
gmelikov approved these changes Oct 21, 2017
View reviewed changes
Copy link
Member

@gmelikov gmelikov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@dinatale2
Provide commit message format for Coverity defects
597606e 
Provide details about the commit message format for Coverity defect
fixes submitted.

Signed-off-by: Giuseppe Di Natale <dinatale2@llnl.gov>
@dinatale2 dinatale2 force-pushed the coverity-commit-contrib branch from a6121cf to 597606e Compare October 22, 2017 18:46
@codecov
Copy link

codecov bot commented Oct 22, 2017

Codecov Report

Merging #6771 into master will increase coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6771      +/-   ##
==========================================
+ Coverage   74.45%   74.52%   +0.07%     
==========================================
  Files         297      297              
  Lines       94371    94371              
==========================================
+ Hits        70266    70334      +68     
+ Misses      24105    24037      -68
Flag Coverage Δ
#kernel 74.36% <ø> (+0.06%) ⬆️
#user 66.78% <ø> (+0.09%) ⬆️
Impacted Files Coverage Δ
module/zfs/zio_checksum.c 98.31% <0%> (-0.57%) ⬇️
module/zfs/ddt.c 96.02% <0%> (-0.55%) ⬇️
module/zfs/zfs_dir.c 76.32% <0%> (-0.51%) ⬇️
module/zfs/spa.c 82.87% <0%> (-0.43%) ⬇️
module/icp/api/kcf_cipher.c 15.35% <0%> (-0.42%) ⬇️
module/zfs/zap.c 67.17% <0%> (-0.35%) ⬇️
module/zfs/zio.c 93.47% <0%> (-0.34%) ⬇️
module/icp/algs/modes/ccm.c 83.97% <0%> (-0.33%) ⬇️
module/zfs/arc.c 88.57% <0%> (-0.26%) ⬇️
module/zfs/dsl_scan.c 81.2% <0%> (-0.26%) ⬇️
... and 35 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1cfdb0e...597606e. Read the comment docs.

@dinatale2
Copy link
Contributor Author

Small correction to the example commit message. Forgot the CID in the commit message subject line.

@behlendorf behlendorf merged commit 70c8a79 into openzfs:master Oct 23, 2017
@dinatale2 dinatale2 deleted the coverity-commit-contrib branch October 23, 2017 17:42
Nasf-Fan pushed a commit to Nasf-Fan/zfs that referenced this pull request Nov 4, 2017
@dinatale2 @Nasf-Fan
Provide commit message format for Coverity defects
a1bdd14 
Provide details about the commit message format for Coverity defect
fixes submitted.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Giuseppe Di Natale <dinatale2@llnl.gov>
Closes openzfs#6771
Nasf-Fan pushed a commit to Nasf-Fan/zfs that referenced this pull request Nov 6, 2017
@dinatale2 @Nasf-Fan
Provide commit message format for Coverity defects
a569aa4 
Provide details about the commit message format for Coverity defect
fixes submitted.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Giuseppe Di Natale <dinatale2@llnl.gov>
Closes openzfs#6771
Nasf-Fan pushed a commit to Nasf-Fan/zfs that referenced this pull request Jan 29, 2018
@dinatale2 @Nasf-Fan
Provide commit message format for Coverity defects
94df7bb 
Provide details about the commit message format for Coverity defect
fixes submitted.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Giuseppe Di Natale <dinatale2@llnl.gov>
Closes openzfs#6771
Nasf-Fan pushed a commit to Nasf-Fan/zfs that referenced this pull request Feb 13, 2018
@dinatale2 @Nasf-Fan
Provide commit message format for Coverity defects
6052f4d 
Provide details about the commit message format for Coverity defect
fixes submitted.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Giuseppe Di Natale <dinatale2@llnl.gov>
Closes openzfs#6771
FransUrbo pushed a commit to FransUrbo/zfs that referenced this pull request Apr 28, 2019
@dinatale2 @FransUrbo
Provide commit message format for Coverity defects
8c5f76d 
Provide details about the commit message format for Coverity defect
fixes submitted.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: George Melikov <mail@gmelikov.ru>
Signed-off-by: Giuseppe Di Natale <dinatale2@llnl.gov>
Closes openzfs#6771
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@behlendorf behlendorf behlendorf approved these changes

+1 more reviewer

@gmelikov gmelikov gmelikov approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Type: Documentation Indicates a requested change to the documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dinatale2 @behlendorf @gmelikov