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
You need to sign in or sign up before continuing.
  • linux
  • scripts
  • kernel-doc
Find file BlameHistoryPermalink
  • Aditya Srivastava's avatar
    scripts: kernel-doc: improve parsing for kernel-doc comments syntax · f9bbc12c
    Aditya Srivastava authored Apr 15, 2021
    
    
    Currently kernel-doc does not identify some cases of probable kernel
    doc comments, for e.g. pointer used as declaration type for identifier,
    space separated identifier, etc.
    
    Some example of these cases in files can be:
    i)" *  journal_t * jbd2_journal_init_dev() - creates and initialises a journal structure"
    in fs/jbd2/journal.c
    
    ii) "*      dget, dget_dlock -      get a reference to a dentry" in
    include/linux/dcache.h
    
    iii) "  * DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t"
    in include/linux/seqlock.h
    
    Also improve identification for non-kerneldoc comments. For e.g.,
    
    i) " *	The following functions allow us to read data using a swap map"
    in kernel/power/swap.c does follow the kernel-doc like syntax, but the
    content inside does not adheres to the expected format.
    
    Improve parsing by adding support for these probable attempts to write
    kernel-doc comment.
    
    Suggested-by: default avatarJonathan Corbet <corbet@lwn.net>
    Link: https://lore.kernel.org/lkml/87mtujktl2.fsf@meer.lwn.net
    
    
    Signed-off-by: default avatarAditya Srivastava <yashsri421@gmail.com>
    Link: https://lore.kernel.org/r/20210414192529.9080-1-yashsri421@gmail.com
    
    
    [ jc: fixed some line-length issues ]
    Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
    f9bbc12c
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7