patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

.gitlint: de-duplicate defaults with zephyr_commit_rules.py

Browse source 
We don't need to have two different sets of Zephyr-specific default
values overriding one another, it's confusing.

Note this commit makes NO functional change, the effective defaults stay
the same. It does however make it easier to change defaults in the
future.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
This commit is contained in:
Marc Herbert 2023-09-20 19:45:22 +00:00 committed by Carles Cufí
parent b0303f5bd3
commit 8e7c7c62b1
2 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
.gitlint
View file

@ -1,4 +1,5 @@
# All these sections are optional, edit this file as you like. # All these sections are optional, edit this file as you like.
# Zephyr-specific defaults are located in scripts/gitlint/zephyr_commit_rules.py
[general] [general]
ignore=title-trailing-punctuation, T3, title-max-length, T1, body-hard-tab, B3, B1 ignore=title-trailing-punctuation, T3, title-max-length, T1, body-hard-tab, B3, B1
# verbosity should be a value between 1 and 3, the commandline -v flags take precedence over this # verbosity should be a value between 1 and 3, the commandline -v flags take precedence over this
@ -16,13 +17,13 @@ debug = false
extra-path=scripts/gitlint extra-path=scripts/gitlint
[title-max-length-no-revert] [title-max-length-no-revert]
line-length=75 # line-length=75
[body-min-line-count] [body-min-line-count]
min-line-count=1 # min-line-count=1
[body-max-line-count] [body-max-line-count]
max-line-count=200 # max-line-count=200
[title-starts-with-subsystem] [title-starts-with-subsystem]
regex = ^(?!subsys:)(([^:]+):)(\s([^:]+):)*\s(.+)$ regex = ^(?!subsys:)(([^:]+):)(\s([^:]+):)*\s(.+)$
@ -42,7 +43,7 @@ words=wip
[max-line-length-with-exceptions] [max-line-length-with-exceptions]
# B1 = body-max-line-length # B1 = body-max-line-length
line-length=75 # line-length=75
[body-min-length] [body-min-length]
min-length=3 min-length=3

12
scripts/gitlint/zephyr_commit_rules.py
View file

@ -24,8 +24,8 @@ class BodyMinLineCount(CommitRule):
# A rule MUST have an *unique* id, we recommend starting with UC (for User-defined Commit-rule). # A rule MUST have an *unique* id, we recommend starting with UC (for User-defined Commit-rule).
id = "UC6" id = "UC6"
# A rule MAY have an option_spec if its behavior should be configurable. # A rule MAY have an options_spec if its behavior should be configurable.
options_spec = [IntOption('min-line-count', 2, "Minimum body line count excluding Signed-off-by")] options_spec = [IntOption('min-line-count', 1, "Minimum body line count excluding Signed-off-by")]
def validate(self, commit): def validate(self, commit):
filtered = [x for x in commit.message.body if not x.lower().startswith("signed-off-by") and x != ''] filtered = [x for x in commit.message.body if not x.lower().startswith("signed-off-by") and x != '']
@ -42,8 +42,8 @@ class BodyMaxLineCount(CommitRule):
# A rule MUST have an *unique* id, we recommend starting with UC (for User-defined Commit-rule). # A rule MUST have an *unique* id, we recommend starting with UC (for User-defined Commit-rule).
id = "UC1" id = "UC1"
# A rule MAY have an option_spec if its behavior should be configurable. # A rule MAY have an options_spec if its behavior should be configurable.
options_spec = [IntOption('max-line-count', 3, "Maximum body line count")] options_spec = [IntOption('max-line-count', 200, "Maximum body line count")]
def validate(self, commit): def validate(self, commit):
line_count = len(commit.message.body) line_count = len(commit.message.body)
@ -78,7 +78,7 @@ class TitleMaxLengthRevert(LineRule):
name = "title-max-length-no-revert" name = "title-max-length-no-revert"
id = "UC5" id = "UC5"
target = CommitMessageTitle target = CommitMessageTitle
options_spec = [IntOption('line-length', 72, "Max line length")] options_spec = [IntOption('line-length', 75, "Max line length")]
violation_message = "Commit title exceeds max length ({0}>{1})" violation_message = "Commit title exceeds max length ({0}>{1})"
def validate(self, line, _commit): def validate(self, line, _commit):
@ -103,7 +103,7 @@ class MaxLineLengthExceptions(LineRule):
name = "max-line-length-with-exceptions" name = "max-line-length-with-exceptions"
id = "UC4" id = "UC4"
target = CommitMessageBody target = CommitMessageBody
options_spec = [IntOption('line-length', 80, "Max line length")] options_spec = [IntOption('line-length', 75, "Max line length")]
violation_message = "Commit message body line exceeds max length ({0}>{1})" violation_message = "Commit message body line exceeds max length ({0}>{1})"
def validate(self, line, _commit): def validate(self, line, _commit):