Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Register
  • Sign in
  • L linux
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • Deployments
    • Deployments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • Kirill Smelkov
  • linux
  • Repository
  • linux
  • scripts
  • checkpatch.pl
Find file BlameHistoryPermalink
  • Kai Wasserbäch's avatar
    checkpatch: warn when unknown tags are used for links · 76f381bb
    Kai Wasserbäch authored Jan 20, 2023
    Patch series "checkpatch.pl: warn about discouraged tags and missing Link:
    tags", v4.
    
    The first two changes make checkpatch.pl check for a few mistakes wrt to
    links to bug reports Linus recently complained about a few times. 
    Avoiding those is also important for my regression tracking efforts a lot,
    as the automated tracking performed by regzbot relies on the proper usage
    of the Link: tag.
    
    The third patch fixes a few small oddities noticed in existing code during
    review of the two changes.
    
    
    This patch (of 3):
    
    Issue a warning when encountering URLs behind unknown tags, as Linus
    recently stated ```please stop making up random tags that make no sense. 
    Just use "Link:"```[1].  That statement was triggered by an use of
    'BugLink', but that's not the only tag people invented:
    
    $ git log -100000 --no-merges --format=email -P \
       --grep='^\w+:[ 	]*http' | grep -Poh '^\w+:[ 	]*http' | \
      sort | uniq -c | sort -rn | head -n 20
     103958 Link: http
        418 BugLink: http
        372 Patchwork: http
        280 Closes: http
        224 Bug: http
        123 References: http
         84 Bugzilla: http
         61 URL: http
         42 v1: http
         38 Datasheet: http
         20 v2: http
          9 Ref: http
          9 Fixes: http
          9 Buglink: http
          8 v3: http
          8 Reference: http
          7 See: http
          6 1: http
          5 link: http
          3 Link:http
    
    Some of these non-standard tags make it harder for external tools that
    rely on use of proper tags.  One of those tools is the regression tracking
    bot 'regzbot', which looks out for "Link:" tags pointing to reports of
    tracked regressions.
    
    The initial idea was to use a disallow list to raise an error when
    encountering known unwanted tags like BugLink:; during review it was
    requested to use a list of allowed tags instead[2].
    
    Link: https://lkml.kernel.org/r/cover.1674217480.git.linux@leemhuis.info
    Link: https://lore.kernel.org/all/CAHk-=wgs38ZrfPvy=nOwVkVzjpM3VFU1zobP37Fwd_h9iAD5JQ@mail.gmail.com/ [1]
    Link: https://lore.kernel.org/all/15f7df96d49082fb7799dda6e187b33c84f38831.camel@perches.com/ [2]
    Link: https://lkml.kernel.org/r/3b036087d80b8c0e07a46a1dbaaf4ad0d018f8d5.1674217480.git.linux@leemhuis.info
    
    
    Signed-off-by: default avatarKai Wasserbäch <kai@dev.carbon-project.org>
    Co-developed-by: default avatarThorsten Leemhuis <linux@leemhuis.info>
    Signed-off-by: default avatarThorsten Leemhuis <linux@leemhuis.info>
    Cc: Andy Whitcroft <apw@canonical.com>
    Cc: Dwaipayan Ray <dwaipayanray1@gmail.com>
    Cc: Joe Perches <joe@perches.com>
    Cc: Lukas Bulwahn <lukas.bulwahn@gmail.com>
    Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
    76f381bb
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7