Re: [PATCH v3 1/3] usb typec: mt6360: Add support for mt6360 Type-C driver

[Heikki Krogerus]

On Thu, Aug 27, 2020 at 10:51:43PM +0800, ChiYuan Huang wrote:
> Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx> 於 2020年8月27日 週四 下午10:00寫道：
> >
> > On Thu, Aug 27, 2020 at 07:18:55PM +0800, cy_huang wrote:
> > > From: ChiYuan Huang <cy_huang@xxxxxxxxxxx>
> > >
> > > Mediatek MT6360 is a multi-functional IC that includes USB Type-C.
> > > It works with Type-C Port Controller Manager to provide USB PD
> > > and USB Type-C functionalities.
> > >
> > > v1 to v2
> > > 1. Add fix to Prevent the race condition from interrupt and tcpci port
> > > unregister during module remove.
> > >
> > > v2 to v3
> > > 1. Change comment style for the head of source code.
> > > 2. No need to print error for platform_get_irq_byname.
> > > 3. Fix tcpci_register_port check from IS_ERR_OR_NULL to IS_ERR.
> > > 4. Rename driver/Kconfig/Makefile form mt6360 to mt636x.
> > > 5. Rename DT binding documents from mt6360 to mt636x.
> >
> > You don't place additional changelog here...
> >
> > > Signed-off-by: ChiYuan Huang <cy_huang@xxxxxxxxxxx>
> > > ---
> >
> > You put it here, after that '---' marker:
> > https://www.kernel.org/doc/html/latest/process/submitting-patches.html#the-canonical-patch-format
> >
> HI Hekki:
>      after reading the document, I have a little bit confused how to
> use diffstat for the changelog.
>       Is there any example that make me know to write a clear
> description for the changelog?

Picking the latest patch from linux-usb ml. with version history:
https://lore.kernel.org/linux-usb/1598083553-31896-11-git-send-email-chunfeng.yun@xxxxxxxxxxxx/

See how the last tag line "Signed-off-by: Chunfeng Yun..." is followed
by marker "---", which then is followed by the version history (the
version history is then also ended with the marker "---", a step that
I don't think is mandatory, but commonly used and often recommended).

That way that patch version history does not contaminate the actual
commit message.


thanks,

-- 
heikki