On Wed, Aug 5, 2020 at 6:35 PM Alex Elder elder@linaro.org wrote:
On 7/9/20 5:27 AM, Vaibhav Agarwal wrote:
snd_soc_jack APIs are modified in recent kernel versions. This patch updates the codec driver to resolve the compilation errors related to jack framework.
Greg has already accepted this series so I won't review this now. But I still wanted to provide this comment.
It would be helpful in the future to provide a little more information about the nature of the changes to these APIs. As a reviewer I had to go track them down to get a little more context about what you are doing here. So you could say something like:
Audio jacks are now registered at the card level rather than being associated with a CODEC. The new card-based API allows a jack's pins to be supplied when the jack is first registered. See: 970939964c26 ("ASoC: Allow to register jacks at the card level")
In other words, don't just say "the APIs changed," say "here is how the APIs have changed." This kind of introduction can be very helpful and time saving for your reviewers.
Thanks for the feedback Alex. I'll take care of the commit message while sharing similar patches.
-- vaibhav