Re: [PATCH 1/2] Documentation: devres: add missing mailbox helpers

[anish kumar]

On Mon, Nov 11, 2024 at 8:58 AM David Lechner <dlechner@xxxxxxxxxxxx> wrote:
>
> On 11/6/24 5:52 PM, anish kumar wrote:
> > mailbox api's were missing from the devres documentation.
> > This patch adds them.
>
> I've been wondering... Is it really that useful to have all
> of the devn_ functions listed in the documentation?
>
> My opinion is no, we can grep the source code for these if
> we want to find them and we should just delete these lists

Agreed.
> instead of spending effort trying to keep them up-to-date.
>
> Or if the consensus is yes it is useful, maybe we should
> add something in checkpatch to avoid missing these like
> we do for MAINTAINERS?

excellent idea, checkpatch can warn if a corresponding devm_*
variant is available and the patch is not utilizing it.
>
> >
> > Signed-off-by: anish kumar <yesanishhere@xxxxxxxxx>
> > ---
> >  Documentation/driver-api/driver-model/devres.rst | 4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > diff --git a/Documentation/driver-api/driver-model/devres.rst b/Documentation/driver-api/driver-model/devres.rst
> > index 5f2ee8d717b1..8350a098f81f 100644
> > --- a/Documentation/driver-api/driver-model/devres.rst
> > +++ b/Documentation/driver-api/driver-model/devres.rst
> > @@ -346,6 +346,10 @@ LED
> >    devm_led_trigger_register()
> >    devm_of_led_get()
> >
> > +MAILBOX
> > +  devm_mbox_controller_register()
> > +  devm_mbox_controller_unregister()
> > +
> >  MDIO
> >    devm_mdiobus_alloc()
> >    devm_mdiobus_alloc_size()
>