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 0/8] regulator: kerneldoc section fixes
Date: Tue, 27 Aug 2024 17:46:12 +0300	[thread overview]
Message-ID: <Zs3mtN-vPnVtppY-@smile.fi.intel.com> (raw)
In-Reply-To: <20240827095550.675018-1-wenst@chromium.org>

On Tue, Aug 27, 2024 at 05:55:40PM +0800, Chen-Yu Tsai wrote:
> Hi,
> 
> Here are a bunch of kerneldoc fixes for the regulator core. This sort of
> came as a request from Andy to not move code that already had warnings

You can add Reported-by: or Suggested-by to the cover letter.

> without fixing said warnings. So here I'm fixing them first.
> 
> The bulk of the fixes are in the regulator core and OF code, but I also
> fixed up a few bits in common code that were missing "Return" sections.
> These are purely kerneldoc fixes and don't touch any actual code. I left
> the devres code and helpers alone for now.

Thanks for doing this!

I briefly looked at them, the main two remarks are:
1) definite vs. indefinite article;
2) same and consistent term for negative error codes (or numbers if you
prefer).

Otherwise LGTM!

-- 
With Best Regards,
Andy Shevchenko




      parent reply	other threads:[~2024-08-27 14:47 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
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 ` Andy Shevchenko [this message]

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=Zs3mtN-vPnVtppY-@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).