From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933103AbdELQl0 (ORCPT ); Fri, 12 May 2017 12:41:26 -0400 Received: from bombadil.infradead.org ([65.50.211.133]:39856 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S933039AbdELQlY (ORCPT ); Fri, 12 May 2017 12:41:24 -0400 Date: Fri, 12 May 2017 09:41:22 -0700 From: Darren Hart To: Mauro Carvalho Chehab Cc: linux-kernel@vger.kernel.org, Linux Doc Mailing List , Mauro Carvalho Chehab , Peter Zijlstra , Ingo Molnar , Thomas Gleixner Subject: Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to generate ReST Message-ID: <20170512164122.GA17235@fury> References: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.8.0 (2017-02-23) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Fri, May 12, 2017 at 10:59:47AM -0300, Mauro Carvalho Chehab wrote: > There are a few issues on some kernel-doc markups that was > causing troubles with kernel-doc output on ReST format. > Fix them. > > No functional changes. > > Signed-off-by: Mauro Carvalho Chehab No objection. One question, rather than prefixing the bulleted list of return codes with a "-" which has no ReST meaning I could find, should we use "*" instead which would be converted to a bullet it formatted documentation? > @@ -1259,9 +1259,9 @@ static int lock_pi_update_atomic(u32 __user *uaddr, u32 uval, u32 newval) > * @set_waiters: force setting the FUTEX_WAITERS bit (1) or not (0) > * > * Return: > - * 0 - ready to wait; > - * 1 - acquired the lock; > - * <0 - error > + * - 0 - ready to wait; > + * - 1 - acquired the lock; > + * - <0 - error > * e.g. * Return: * * 0 - ready to wait * * 1 - acquired the lock * * <0 - error I'm fine with either though, just curious if this would be an improvement, or if we have an established policy (which I didn't find in the docs on docs...). Acked-by: Darren Hart (VMware) -- Darren Hart VMware Open Source Technology Center