Skip to content
Snippets Groups Projects
Select Git revision
  • ebff7f929b2a72fa614f5e95fd34c56c82ac9c36
  • vme-testing default
  • ci-test
  • master
  • remoteproc
  • am625-sk-ov5640
  • pcal6534-upstreaming
  • lps22df-upstreaming
  • msc-upstreaming
  • imx8mp
  • iio/noa1305
  • vme-next
  • vme-next-4.14-rc4
  • v4.14-rc4
  • v4.14-rc3
  • v4.14-rc2
  • v4.14-rc1
  • v4.13
  • vme-next-4.13-rc7
  • v4.13-rc7
  • v4.13-rc6
  • v4.13-rc5
  • v4.13-rc4
  • v4.13-rc3
  • v4.13-rc2
  • v4.13-rc1
  • v4.12
  • v4.12-rc7
  • v4.12-rc6
  • v4.12-rc5
  • v4.12-rc4
  • v4.12-rc3
32 results

kernel-doc

  • Daniel Vetter's avatar
    ebff7f92
    scripts/kernel-doc: Remove duplicated DOC: start handling · ebff7f92
    Daniel Vetter authored
    
    Further up in the state machinery we switch from STATE_NAME to
    STATE_DOCBLOCK when we match /$doc_block/. Which means this block of
    code here is entirely unreachable, unless there are multiple DOC:
    sections within a single kernel-doc comment.
    
    Getting a list of all the files with more than one DOC: section using
    
    $ git grep -c " * DOC:" | grep -v ":1$"
    
    and then doing a full audit of them reveals there are no such comment
    blocks in the kernel.
    
    Supporting multiple DOC: sections in a single kernel-doc comment does
    not seem like a recommended way of doing things anyway, so nuke the code
    for simplicity.
    
    Cc: Jani Nikula <jani.nikula@intel.com>
    Cc: linux-doc@vger.kernel.org
    Cc: Jonathan Corbet <corbet@lwn.net>
    Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
    [Jani: amended the commit message]
    Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>
    ebff7f92
    History
    scripts/kernel-doc: Remove duplicated DOC: start handling
    Daniel Vetter authored
    
    Further up in the state machinery we switch from STATE_NAME to
    STATE_DOCBLOCK when we match /$doc_block/. Which means this block of
    code here is entirely unreachable, unless there are multiple DOC:
    sections within a single kernel-doc comment.
    
    Getting a list of all the files with more than one DOC: section using
    
    $ git grep -c " * DOC:" | grep -v ":1$"
    
    and then doing a full audit of them reveals there are no such comment
    blocks in the kernel.
    
    Supporting multiple DOC: sections in a single kernel-doc comment does
    not seem like a recommended way of doing things anyway, so nuke the code
    for simplicity.
    
    Cc: Jani Nikula <jani.nikula@intel.com>
    Cc: linux-doc@vger.kernel.org
    Cc: Jonathan Corbet <corbet@lwn.net>
    Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
    [Jani: amended the commit message]
    Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>