Re: [PATCH 04/17] kernel: futex.c: get rid of a docs build warning

[Peter Zijlstra]

On Tue, Mar 17, 2020 at 11:36:33AM -0600, Jonathan Corbet wrote:
> On Tue, 17 Mar 2020 17:58:05 +0100
> Peter Zijlstra <peterz@xxxxxxxxxxxxx> wrote:
> 
> > On Tue, Mar 17, 2020 at 03:54:13PM +0100, Mauro Carvalho Chehab wrote:
> > > Adjust whitespaces and blank lines in order to get rid of this:
> > > 
> > > 	./kernel/futex.c:491: WARNING: Definition list ends without a blank line; unexpected unindent.
> > > 
> > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
> > > ---
> > >  kernel/futex.c | 3 ++-
> > >  1 file changed, 2 insertions(+), 1 deletion(-)
> > > 
> > > diff --git a/kernel/futex.c b/kernel/futex.c
> > > index 67f004133061..dda6ddbc2e7d 100644
> > > --- a/kernel/futex.c
> > > +++ b/kernel/futex.c
> > > @@ -486,7 +486,8 @@ static u64 get_inode_sequence_number(struct inode *inode)
> > >   * The key words are stored in @key on success.
> > >   *
> > >   * For shared mappings (when @fshared), the key is:
> > > - *   ( inode->i_sequence, page->index, offset_within_page )
> > > + * ( inode->i_sequence, page->index, offset_within_page )
> > > + *  
> > 
> > WTH, that's less readable.
> 
> It won't render well in the build either; that should be a literal block.

it renders perfectly in an ASCII text editor, which is by far the most
important interface for all this.