From: sashiko-bot@kernel.org
To: "Inochi Amaoto" <inochiama@gmail.com>
Cc: vkoul@kernel.org, olteanv@gmail.com,
linux-phy@lists.infradead.org, neil.armstrong@linaro.org
Subject: Re: [PATCH v3 5/5] doc: phy: Document some bulk helper functions
Date: Wed, 23 Sep 2026 02:46:45 +0000 [thread overview]
Message-ID: <20260923024646.45ADA1F000FF@smtp.kernel.org> (raw)
In-Reply-To: <20260923023304.78428-6-inochiama@gmail.com>
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] docs: phy: linking to unmerged patches in official documentation
--
commit 409a8664a48e7380c1575514d92de3906af9ad4f
Author: Inochi Amaoto <inochiama@gmail.com>
doc: phy: Document some bulk helper functions
Document all newly added bulk helper function, it can be used to manage
a set of PHYs automatically. This is useful when the driver want to
simplify the management of multiple PHYs.
> diff --git a/Documentation/driver-api/phy/phy.rst b/Documentation/driver-api/phy/phy.rst
> index 0865c2e94eece..c5d3d7cc1a74b 100644
> --- a/Documentation/driver-api/phy/phy.rst
> +++ b/Documentation/driver-api/phy/phy.rst
[ ... ]
> @@ -221,3 +245,8 @@ DeviceTree Binding
>
> The documentation for PHY dt binding can be found @
> Documentation/devicetree/bindings/phy/phy-bindings.txt
> +
> +Missing Bulk Helpers
> +====================
> +Currently, Only a few bulk helper functions are added as they have users.
> +Function not upstreamed can be found at https://lore.kernel.org/linux-phy/20260904083709.425893-1-inochiama@gmail.com/
[Severity: Low]
Is it appropriate to include links to out-of-tree, unmerged patches in the
official kernel API documentation?
Should this reference be moved to the commit message or cover letter instead,
and only added to the documentation once the additional helpers are upstreamed
alongside their users?
Additionally, there are minor grammatical issues in this section ("Currently,
Only a few", "Function not upstreamed").
--
Sashiko AI review · https://sashiko.dev/#/patchset/20260923023304.78428-1-inochiama@gmail.com?part=5
--
linux-phy mailing list
linux-phy@lists.infradead.org
https://lists.infradead.org/mailman/listinfo/linux-phy
next prev parent reply other threads:[~2026-09-23 2:46 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-23 2:32 [PATCH v3 0/5] phy: core: Add phy bulk helpers support Inochi Amaoto
2026-09-23 2:32 ` [PATCH v3 1/5] phy: core: Add common helper to add phy phandle device link Inochi Amaoto
2026-09-23 2:33 ` [PATCH v3 2/5] phy: core: Add common helper for get phy phandle by index Inochi Amaoto
2026-09-23 2:33 ` [PATCH v3 3/5] phy: core: Add phy bulk data helper functions Inochi Amaoto
2026-09-23 2:43 ` sashiko-bot
2026-09-23 2:33 ` [PATCH v3 4/5] phy: core: Add managed " Inochi Amaoto
2026-09-23 2:33 ` [PATCH v3 5/5] doc: phy: Document some bulk " Inochi Amaoto
2026-09-23 2:46 ` sashiko-bot [this message]
2026-09-23 2:55 ` Randy Dunlap
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=20260923024646.45ADA1F000FF@smtp.kernel.org \
--to=sashiko-bot@kernel.org \
--cc=inochiama@gmail.com \
--cc=linux-phy@lists.infradead.org \
--cc=neil.armstrong@linaro.org \
--cc=olteanv@gmail.com \
--cc=sashiko-reviews@lists.linux.dev \
--cc=vkoul@kernel.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