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 Reported-by: is not followed by Link: · d7f1d71e
    Kai Wasserbäch authored Jan 20, 2023
    
    
    Encourage patch authors to link to reports by issuing a warning, if a
    Reported-by: is not accompanied by a link to the report.  Those links are
    often extremely useful for any code archaeologist that wants to know more
    about the backstory of a change than the commit message provides.  That
    includes maintainers higher up in the patch-flow hierarchy, which is why
    Linus asks developers to add such links [1, 2, 3].  To quote [1]:
    
    > Again, the commit has a link to the patch *submission*, which is
    > almost entirely useless. There's no link to the actual problem the
    > patch fixes.
    >
    > [...]
    >
    > Put another way: I can see that
    >
    > Reported-by: default avatarZhangfei Gao <zhangfei.gao@foxmail.com>
    >
    > in the commit, but I don't have a clue what the actual report was, and
    > there really isn't enough information in the commit itself, except for
    > a fairly handwavy "Device drivers might, for instance, still need to
    > flush operations.."
    >
    > I don't want to know what device drivers _might_ do. I would want to
    > have an actual pointer to what they do and where.
    
    Another reason why these links are wanted: the ongoing regression tracking
    efforts can only scale with them, as they allow the regression tracking
    bot 'regzbot' to automatically connect tracked reports with patches that
    are posted or committed to fix tracked regressions.
    
    Link: https://lore.kernel.org/all/CAHk-=wjMmSZzMJ3Xnskdg4+GGz=5p5p+GSYyFBTh0f-DgvdBWg@mail.gmail.com/ [1]
    Link: https://lore.kernel.org/all/CAHk-=wgs38ZrfPvy=nOwVkVzjpM3VFU1zobP37Fwd_h9iAD5JQ@mail.gmail.com/ [2]
    Link: https://lore.kernel.org/all/CAHk-=wjxzafG-=J8oT30s7upn4RhBs6TX-uVFZ5rME+L5_DoJA@mail.gmail.com/ [3]
    Link: https://lkml.kernel.org/r/bb5dfd55ea2026303ab2296f4a6df3da7dd64006.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>
    d7f1d71e
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7