All of lore.kernel.org
 help / color / mirror / Atom feed
From: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>,
	Kent Gibson <warthog618@gmail.com>,
	linux-gpio@vger.kernel.org, linux-acpi@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Mika Westerberg <mika.westerberg@linux.intel.com>,
	Linus Walleij <linus.walleij@linaro.org>,
	Bartosz Golaszewski <brgl@bgdev.pl>
Subject: Re: [PATCH v1 1/1] gpiolib: Update the kernel documentation - add Return sections
Date: Fri, 5 Apr 2024 18:40:45 +0300	[thread overview]
Message-ID: <ZhAbfcGkt-Bjj9NY@smile.fi.intel.com> (raw)
In-Reply-To: <47955de8-dfe5-48c0-bc9b-4e930b8f943e@infradead.org>

On Fri, Apr 05, 2024 at 08:33:26AM -0700, Randy Dunlap wrote:
> On 4/5/24 8:27 AM, Andy Shevchenko wrote:
> > On Thu, Apr 04, 2024 at 09:10:09PM -0700, Randy Dunlap wrote:
> >> On 4/4/24 2:27 PM, Andy Shevchenko wrote:
> >>> $ scripts/kernel-doc -v -none -Wall drivers/gpio/gpiolib* 2>&1 | grep -w warning | wc -l
> >>> 67
> >>>
> >>> Fix these by adding Return sections. While at it, make sure all of
> >>> Return sections use the same style.

...

> >> I would use %true, %false, %NULL, %0, and %1 in a few places.
> > 
> > Why? I specifically removed % from all of them, it's not so useful.
> > Do we have, btw, generated HTML with these % as an example to see
> > the difference. Maybe that helps to understand this better?
> 
> The leading '%' just changes the font style of constants.
> I don't know of any HTML that compares them.

I meant to compare the (HTML) render to see the difference, but you already
explained that it adds/modifies <font> tag or so.

-- 
With Best Regards,
Andy Shevchenko



  reply	other threads:[~2024-04-05 15:40 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-04 21:27 [PATCH v1 1/1] gpiolib: Update the kernel documentation - add Return sections Andy Shevchenko
2024-04-05  4:10 ` Randy Dunlap
2024-04-05  7:23   ` Dan Carpenter
2024-04-05 15:27   ` Andy Shevchenko
2024-04-05 15:33     ` Randy Dunlap
2024-04-05 15:40       ` Andy Shevchenko [this message]
2024-04-08 18:21 ` Andy Shevchenko
2024-04-08 21:19   ` Andy Shevchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ZhAbfcGkt-Bjj9NY@smile.fi.intel.com \
    --to=andriy.shevchenko@linux.intel.com \
    --cc=bartosz.golaszewski@linaro.org \
    --cc=brgl@bgdev.pl \
    --cc=linus.walleij@linaro.org \
    --cc=linux-acpi@vger.kernel.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mika.westerberg@linux.intel.com \
    --cc=rdunlap@infradead.org \
    --cc=warthog618@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.