Re: [PATCH v3 2/4] Documentation: devres: Add pcim_alloc_irq_vectors()
From: Dejin Zheng
Date: Wed Feb 17 2021 - 05:50:55 EST
On Tue, Feb 16, 2021 at 06:10:52PM +0100, Krzysztof Wilczyński wrote:
> Hi Dejin,
>
> Thank you again for all the work here!
>
> > Add pcim_alloc_irq_vectors(), a device-managed version of
> > pci_alloc_irq_vectors(). introducing this function can simplify
> > the error handling path in many drivers.
>
> The second sentence should most likely start with a capital letter.
>
> Having said that, people might ask - how does it simplify the error
> handling path?
>
> You might have to back this with a line of two to explain how does the
> change achieved that, so that when someone looks at the commit message
> it would be clear what the benefits of the change were.
>
Hi Krzysztof,
The device-managed function is a conventional concept that every developer
knows. So don't worry about this. And I really can't explain its operation
mechanism to you in a sentence or two. If you are really interested, you
can read the relevant code.
I think it is meaningless to add a lot of explanations of general
concepts in the commit comments. Maybe it will be better let us put more
energy and time on the code.
BR,
Dejin
> Reviewed-by: Krzysztof Wilczyński <kw@xxxxxxxxx>
>
> Krzysztof