Re: [PATCH v4 1/3] driver core: platform: Add an error message to platform_get_irq*()

From: Stephen Boyd
Date: Wed Jul 24 2019 - 14:17:56 EST


Quoting Markus Elfring (2019-07-24 08:00:43)
> > Let's consolidate all these error messages into the API itself,
> > allowing us to get rid of the error messages in each driver.
>
> Such information from the commit descriptions sounds positive.
>
>
> > +++ b/drivers/base/platform.c
> â
> > @@ -163,6 +158,22 @@ int platform_get_irq(struct platform_device *dev, unsigned int num)
> â
> > +/**
> > + * platform_get_irq - get an IRQ for a device
> > + * @dev: platform device
> > + * @num: IRQ number index
> > + */
>
> Do you find the provided description for the programming interface
> really sufficient then?
> Would it be more helpful to indicate the existence of an appropriate error message
> also in this software documentation (besides the C source code)?
>

Sure. I'll add some more documentation in this patch too so that
developers can easily see that they shouldn't print an error message
themselves.