lkml.org 
[lkml]   [2023]   [Mar]   [24]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Date
    Subject[PATCH v2 2/2] checkpatch: allow Closes tags with links
    As a follow-up of the previous patch modifying the documentation to
    allow using the "Closes:" tag, checkpatch.pl is updated accordingly.

    checkpatch.pl now mentions the "Closes:" tag between brackets to express
    the fact it should be used only if it makes sense.

    While at it, checkpatch.pl will not complain if the "Closes" tag is used
    with a "long" line, similar to what is done with the "Link" tag.

    Fixes: 76f381bb77a0 ("checkpatch: warn when unknown tags are used for links")
    Fixes: d7f1d71e5ef6 ("checkpatch: warn when Reported-by: is not followed by Link:")
    Closes: https://github.com/multipath-tcp/mptcp_net-next/issues/373
    Signed-off-by: Matthieu Baerts <matthieu.baerts@tessares.net>
    ---
    scripts/checkpatch.pl | 16 ++++++++--------
    1 file changed, 8 insertions(+), 8 deletions(-)

    diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
    index bd44d12965c9..d6376e0b68cc 100755
    --- a/scripts/checkpatch.pl
    +++ b/scripts/checkpatch.pl
    @@ -3158,14 +3158,14 @@ sub process {
    }
    }

    -# check if Reported-by: is followed by a Link:
    +# check if Reported-by: is followed by a Link: (or Closes:) tag
    if ($sign_off =~ /^reported(?:|-and-tested)-by:$/i) {
    if (!defined $lines[$linenr]) {
    WARN("BAD_REPORTED_BY_LINK",
    - "Reported-by: should be immediately followed by Link: to the report\n" . $herecurr . $rawlines[$linenr] . "\n");
    - } elsif ($rawlines[$linenr] !~ m{^link:\s*https?://}i) {
    + "Reported-by: should be immediately followed by Link: (or Closes:) to the report\n" . $herecurr . $rawlines[$linenr] . "\n");
    + } elsif ($rawlines[$linenr] !~ m{^(link|closes):\s*https?://}i) {
    WARN("BAD_REPORTED_BY_LINK",
    - "Reported-by: should be immediately followed by Link: with a URL to the report\n" . $herecurr . $rawlines[$linenr] . "\n");
    + "Reported-by: should be immediately followed by Link: (or Closes:) with a URL to the report\n" . $herecurr . $rawlines[$linenr] . "\n");
    }
    }
    }
    @@ -3250,8 +3250,8 @@ sub process {
    # file delta changes
    $line =~ /^\s*(?:[\w\.\-\+]*\/)++[\w\.\-\+]+:/ ||
    # filename then :
    - $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i ||
    - # A Fixes: or Link: line or signature tag line
    + $line =~ /^\s*(?:Fixes:|Link:|Closes:|$signature_tags)/i ||
    + # A Fixes:, Link:, Closes: or signature tag line
    $commit_log_possible_stack_dump)) {
    WARN("COMMIT_LOG_LONG_LINE",
    "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
    @@ -3266,13 +3266,13 @@ sub process {

    # Check for odd tags before a URI/URL
    if ($in_commit_log &&
    - $line =~ /^\s*(\w+):\s*http/ && $1 ne 'Link') {
    + $line =~ /^\s*(\w+):\s*http/ && $1 ne 'Link' && $1 ne 'Closes') {
    if ($1 =~ /^v(?:ersion)?\d+/i) {
    WARN("COMMIT_LOG_VERSIONING",
    "Patch version information should be after the --- line\n" . $herecurr);
    } else {
    WARN("COMMIT_LOG_USE_LINK",
    - "Unknown link reference '$1:', use 'Link:' instead\n" . $herecurr);
    + "Unknown link reference '$1:', use 'Link:' (or 'Closes:') instead\n" . $herecurr);
    }
    }

    --
    2.39.2

    \
     
     \ /
      Last update: 2023-03-27 01:17    [W:4.574 / U:0.280 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site