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
  • kernel-doc
Find file BlameHistoryPermalink
  • Tomasz Warniełło's avatar
    scripts: kernel-doc: Drop obsolete comments · 258092a8
    Tomasz Warniełło authored Feb 18, 2022
    
    
    What for? To improve the script maintainability.
    
    1. License
    
    As stated by Jonathan Corbet in the reply to my version 1, the SPDX line
    is enough.
    
    2. The to-do list comment
    
    As suggested by Jonathan Corbet in reply to my version 3, this section
    doesn't need to be transitioned. And so it is removed for clarity.
    
    3. The historical changelog comments
    
    As suggested by Jonathan Corbet in a reply to v3, this section can go.
    I wanted to keep it, but since it doesn't contain copyright notices,
    let's just have it clean and simple.
    
    4. The "format of comments" comment block
    
    As suggested by Jani Nikula in a reply to my first version of this
    transformation, Documentation/doc-guide/kernel-doc.rst can serve as the
    information hub for comment formatting. The section DESCRIPTION already
    points there, so the original comment block can just be removed.
    
    Suggested-by: default avatarJonathan Corbet <corbet@lwn.net>
    Suggested-by: default avatarJani Nikula <jani.nikula@linux.intel.com>
    Signed-off-by: default avatarTomasz Warniełło <tomasz.warniello@gmail.com>
    Tested-by: default avatarRandy Dunlap <rdunlap@infradead.org>
    Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
    Disliked-by: default avatarAkira Yokosawa <akiyks@gmail.com>
    Link: https://lore.kernel.org/r/20220218181628.1411551-11-tomasz.warniello@gmail.com
    
    
    Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
    258092a8
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7