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
  • Mauro Carvalho Chehab's avatar
    scripts: kernel-doc: accept blank lines on parameter description · 0d55d48b
    Mauro Carvalho Chehab authored Apr 14, 2020
    
    
    Sphinx is very pedantic with respect to blank lines. Sometimes,
    in order to make it to properly handle something, we need to
    add a blank line. However, currently, any blank line inside a
    kernel-doc comment like:
    
    	/*
    	 * @foo: bar
             *
    	 *       foobar
    	 *
    	 * some description
    
    will be considered as if "foobar" was part of the description.
    
    This patch changes kernel-doc behavior. After it, foobar will
    be considered as part of the parameter text. The description
    will only be considered as such if it starts with:
    
    zero spaces after asterisk:
    
    	*foo
    
    one space after asterisk:
    	* foo
    
    or have a explicit Description section:
    
    	*   Description:
    
    Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
    Link: https://lore.kernel.org/r/c07d2862792d75a2691d69c9eceb7b89a0164cc0.1586881715.git.mchehab+huawei@kernel.org
    
    
    Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
    0d55d48b
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7