Re: [PATCH v2 2/3] usb: xhci: Remove unwanted header inclusion

[Greg Kroah-Hartman <gregkh@linuxfoundation.org>]

On Mon, Mar 21, 2022 at 02:47:08PM +0530, Sandeep Maheswaram (Temp) wrote:
> Hi Greg,
> 
> On 3/18/2022 5:31 PM, Greg Kroah-Hartman wrote:
> > On Tue, Mar 01, 2022 at 03:58:26PM +0530, Sandeep Maheswaram wrote:
> > > Remove the header file and forward declare struct usb_hcd.
> > Why?
> 
> This was done to address below comment in previous version
> 
> https://patchwork.kernel.org/project/linux-arm-msm/patch/1644949454-814-2-git-send-email-quic_c_sanm@quicinc.com/#24739885

Then EXPLAIN THAT in the changelog text.  Don't make us guess.

Please read the kernel documentation for how to write a good changelog
text.  This single sentance does not follow the guidelines at all.

> 
> 
> > 
> > > Signed-off-by: Sandeep Maheswaram <quic_c_sanm@quicinc.com>
> > > ---
> > >   include/linux/usb/xhci-plat.h | 3 ++-
> > >   1 file changed, 2 insertions(+), 1 deletion(-)
> > > 
> > > diff --git a/include/linux/usb/xhci-plat.h b/include/linux/usb/xhci-plat.h
> > > index 906e907..576e400 100644
> > > --- a/include/linux/usb/xhci-plat.h
> > > +++ b/include/linux/usb/xhci-plat.h
> > > @@ -9,7 +9,8 @@
> > >   #define _XHCI_PLAT_H
> > >   #include <linux/types.h>
> > > -#include <linux/usb/hcd.h>
> > > +
> > > +struct usb_hcd;
> > >   struct xhci_plat_priv {
> > >   	const char *firmware_name;
> > > -- 
> > > 2.7.4
> > > 
> > Where did this come from?  Is this fixing a build breakage from a
> > previous patch?  If not, why is this needed?
> > 
> > confused,
> > 
> > greg k-h
> 
> There wasn't any build breakage.
> 
> This was done to address below comment in previous version
> 
> https://patchwork.kernel.org/project/linux-arm-msm/patch/1644949454-814-2-git-send-email-quic_c_sanm@quicinc.com/#24739885

Again, how were we supposed to know any of this?

Please read the documentation again for how to do this properly.

thanks,

greg k-h