lkml.org 
[lkml]   [2018]   [May]   [9]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings
    On Mon, May 07, 2018 at 06:35:49AM -0300, Mauro Carvalho Chehab wrote:
    > The flow diagram should be inside a code-block to avoid those
    > warnings:
    > ./include/linux/wait.h:110: WARNING: Block quote ends without a blank line; unexpected unindent.
    > ./include/linux/wait.h:113: WARNING: Unexpected indentation.
    > ./include/linux/wait.h:115: WARNING: Block quote ends without a blank line; unexpected unindent.
    >
    > This is easily done by using "::" instead of just ":".

    And I'll voice my objection once again. This makes a regular comment
    worse. This rst stuff is utter shit for making normal text files less
    readable in your favourite text editor.

    If this gets merged, I'll simply remove that spurious ':' the next time
    I'm near that comment.

    > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
    > ---
    > include/linux/wait.h | 2 +-
    > 1 file changed, 1 insertion(+), 1 deletion(-)
    >
    > diff --git a/include/linux/wait.h b/include/linux/wait.h
    > index d9f131ecf708..d907ed761a7f 100644
    > --- a/include/linux/wait.h
    > +++ b/include/linux/wait.h
    > @@ -101,7 +101,7 @@ init_waitqueue_func_entry(struct wait_queue_entry *wq_entry, wait_queue_func_t f
    > * lead to sporadic and non-obvious failure.
    > *
    > * Use either while holding wait_queue_head::lock or when used for wakeups
    > - * with an extra smp_mb() like:
    > + * with an extra smp_mb() like::
    > *
    > * CPU0 - waker CPU1 - waiter
    > *
    > --
    > 2.17.0
    >

    \
     
     \ /
      Last update: 2018-05-09 10:43    [W:4.185 / U:0.060 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site