linux-arm-kernel.lists.infradead.org archive mirror
 help / color / mirror / Atom feed
From: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
To: Chen-Yu Tsai <wenst@chromium.org>
Cc: Mark Brown <broonie@kernel.org>,
	Liam Girdwood <lgirdwood@gmail.com>,
	linux-kernel@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH 6/8] regulator: fixed: Fix incorrectly formatted kerneldoc "Return" section
Date: Tue, 27 Aug 2024 17:43:02 +0300	[thread overview]
Message-ID: <Zs3l9lPoDm4E3cEO@smile.fi.intel.com> (raw)
In-Reply-To: <20240827095550.675018-7-wenst@chromium.org>

On Tue, Aug 27, 2024 at 05:55:46PM +0800, Chen-Yu Tsai wrote:
> kernel-doc complains about missing "Return" section for kerneldoc of
> of_get_fixed_voltage_config(). The kerneldoc has a description
> about the return values, just not in the format kernel-doc wants.
> 
> Convert it to use the proper "Return:" section header. The existing
> description have been reworded and moved around to fit the grammar and
> formatting.

...

> + * Return: pointer to populated &struct fixed_voltage_config or %NULL if

Seems to me this should be "pointer to the"

> + *	   memory alloc fails.

-- 
With Best Regards,
Andy Shevchenko




  reply	other threads:[~2024-08-27 14:44 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-27  9:55 [PATCH 0/8] regulator: kerneldoc section fixes Chen-Yu Tsai
2024-08-27  9:55 ` [PATCH 1/8] regulator: core: Fix short description for _regulator_check_status_enabled() Chen-Yu Tsai
2024-08-27  9:55 ` [PATCH 2/8] regulator: core: Fix regulator_is_supported_voltage() kerneldoc return value Chen-Yu Tsai
2024-08-27 14:35   ` Andy Shevchenko
2024-08-28  7:59     ` Chen-Yu Tsai
2024-08-27  9:55 ` [PATCH 3/8] regulator: core: Fix incorrectly formatted kerneldoc "Return" sections Chen-Yu Tsai
2024-08-27 14:41   ` Andy Shevchenko
2024-08-28  8:01     ` Chen-Yu Tsai
2024-08-28 20:29       ` Mark Brown
2024-08-27  9:55 ` [PATCH 4/8] regulator: core: Add missing kerneldoc Return sections Chen-Yu Tsai
2024-08-27  9:55 ` [PATCH 5/8] regulator: of: Fix incorrectly formatted kerneldoc "Return" sections Chen-Yu Tsai
2024-08-27  9:55 ` [PATCH 6/8] regulator: fixed: Fix incorrectly formatted kerneldoc "Return" section Chen-Yu Tsai
2024-08-27 14:43   ` Andy Shevchenko [this message]
2024-08-27  9:55 ` [PATCH 7/8] regulator: fixed-helper: Add missing "Return" kerneldoc section Chen-Yu Tsai
2024-08-27 14:43   ` Andy Shevchenko
2024-08-27  9:55 ` [PATCH 8/8] regulator: irq_helpers: " Chen-Yu Tsai
2024-08-27 14:44   ` Andy Shevchenko
2024-08-28  7:50     ` Chen-Yu Tsai
2024-08-28 13:53       ` Andy Shevchenko
2024-08-28  5:55   ` Matti Vaittinen
2024-08-28  7:53     ` Chen-Yu Tsai
2024-08-28 12:03       ` Matti Vaittinen
2024-08-27 14:46 ` [PATCH 0/8] regulator: kerneldoc section fixes 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=Zs3l9lPoDm4E3cEO@smile.fi.intel.com \
    --to=andriy.shevchenko@linux.intel.com \
    --cc=broonie@kernel.org \
    --cc=lgirdwood@gmail.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=wenst@chromium.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).