From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-5.7 required=5.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI,SPF_HELO_NONE,SPF_NONE autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id BAD777D2EF for ; Thu, 20 Jun 2019 20:02:35 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726841AbfFTUCf (ORCPT ); Thu, 20 Jun 2019 16:02:35 -0400 Received: from ms.lwn.net ([45.79.88.28]:47508 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725914AbfFTUCf (ORCPT ); Thu, 20 Jun 2019 16:02:35 -0400 Received: from lwn.net (localhost [127.0.0.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 8ED33536; Thu, 20 Jun 2019 20:02:34 +0000 (UTC) Date: Thu, 20 Jun 2019 14:02:33 -0600 From: Jonathan Corbet To: Mauro Carvalho Chehab Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Thomas Gleixner Subject: Re: [PATCH 4/6] time: hrtimer: use a bullet for the returns bullet list Message-ID: <20190620140233.3d7202ee@lwn.net> In-Reply-To: References: Organization: LWN.net MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Tue, 18 Jun 2019 15:51:20 -0300 Mauro Carvalho Chehab wrote: > That gets rid of this warning: > > ./kernel/time/hrtimer.c:1119: WARNING: Block quote ends without a blank line; unexpected unindent. > > and displays nicely both at the source code and at the produced > documentation. > > Signed-off-by: Mauro Carvalho Chehab > --- > kernel/time/hrtimer.c | 7 ++++--- > 1 file changed, 4 insertions(+), 3 deletions(-) > > diff --git a/kernel/time/hrtimer.c b/kernel/time/hrtimer.c > index edb230aba3d1..49f78453892f 100644 > --- a/kernel/time/hrtimer.c > +++ b/kernel/time/hrtimer.c > @@ -1114,9 +1114,10 @@ EXPORT_SYMBOL_GPL(hrtimer_start_range_ns); > * @timer: hrtimer to stop > * > * Returns: > - * 0 when the timer was not active > - * 1 when the timer was active > - * -1 when the timer is currently executing the callback function and > + * > + * • 0 when the timer was not active > + * • 1 when the timer was active > + * • -1 when the timer is currently executing the callback function and > * cannot be stopped So I have taken some grief for letting non-ASCII stuff into the docs before; I can only imagine that those who object would be even more unhappy to see it in a C source file. I'm all for fixing the warning, but I think we shouldn't start introducing exotic characters at this point... Thanks, jon > */ > int hrtimer_try_to_cancel(struct hrtimer *timer)