lkml.org 
[lkml]   [2020]   [Nov]   [5]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: [PATCH v3 56/56] scrpits: kernel-doc: validate kernel-doc markup with the actual names
    On Thu, 5 Nov 2020 15:00:17 +0000
    Matthew Wilcox <willy@infradead.org> wrote:

    > I wonder if we could change kernel-doc to be (optionally) less verbose.
    > If we allowed people to write:
    >
    > /**
    > * Add a value to a refcount.
    > * @i: The value to add to the refcount
    > * @r: The refcount
    > */
    >
    > and had the kernel-doc script pick up the name of the following function
    > automatically, would that be an improvement we could all agree on?

    Given the number of issues Mauro just fixed where the comments had become
    separated from the functions they documented, this seems potentially
    hazardous... It seems especially likely to fail with the "change foo() to
    __foo() and add a new foo() down below" pattern that is fairly common.

    jon

    \
     
     \ /
      Last update: 2020-11-05 16:16    [W:9.281 / U:0.332 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site