RE: [EXT] Re: [PATCH v13 1/6] PCI: endpoint: pci-epf-vntb: Clean up kernel_doc warning

From: Frank Li
Date: Wed Oct 19 2022 - 12:28:52 EST




> -----Original Message-----
> From: Bjorn Helgaas <helgaas@xxxxxxxxxx>
> Sent: Wednesday, October 19, 2022 11:26 AM
> To: Frank Li <frank.li@xxxxxxx>
> Cc: imx@xxxxxxxxxxxxxxx; Jon Mason <jdmason@xxxxxxxx>; Dave Jiang
> <dave.jiang@xxxxxxxxx>; Allen Hubbe <allenbh@xxxxxxxxx>; Kishon Vijay
> Abraham I <kishon@xxxxxx>; Lorenzo Pieralisi <lpieralisi@xxxxxxxxxx>;
> Krzysztof Wilczyński <kw@xxxxxxxxx>; Manivannan Sadhasivam
> <mani@xxxxxxxxxx>; Bjorn Helgaas <bhelgaas@xxxxxxxxxx>; open list:NTB
> DRIVER CORE <ntb@xxxxxxxxxxxxxxx>; open list:PCI ENDPOINT SUBSYSTEM
> <linux-pci@xxxxxxxxxxxxxxx>; open list <linux-kernel@xxxxxxxxxxxxxxx>
> Subject: [EXT] Re: [PATCH v13 1/6] PCI: endpoint: pci-epf-vntb: Clean up
> kernel_doc warning
>
> Caution: EXT Email
>
> On Fri, Oct 07, 2022 at 03:13:21PM -0400, Frank Li wrote:
> > From: Frank Li <frank.li@xxxxxxx>
> >
> > Cleanup warning found by scripts/kernel-doc
> > Consolidate term
> > host, host1 to HOST
> > vhost, vHost, Vhost, VHOST2 to VHOST
>
> When you post a series of several patches, it's nice if you include a
> [0/n] cover letter to tie them all together. Regrettably, this is not
> very well covered in the documentation, but here's a pointer:

[Frank Li] Strange, cover letter missed in PCI mail list. Let me repost it.

>
>
> https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.ker
> nel.org%2Fpub%2Fscm%2Flinux%2Fkernel%2Fgit%2Ftorvalds%2Flinux.git%2F
> tree%2FDocumentation%2Fprocess%2F5.Posting.rst%3Fid%3Dv6.0%23n334&
> amp;data=05%7C01%7CFrank.Li%40nxp.com%7C02ecb68ec2024b8ad43208d
> ab1ee9c8d%7C686ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C6380179
> 35642690987%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQ
> IjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&amp;
> sdata=%2BgCDqyYli65%2FVW7eUAC8ZrSAprNVa2QhqcCChsZCF0w%3D&amp
> ;reserved=0
>
> And if you look at the archives, you'll see lots of examples:
>
>
> https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Flore.k
> ernel.org%2Flinux-
> pci%2F&amp;data=05%7C01%7CFrank.Li%40nxp.com%7C02ecb68ec2024b8a
> d43208dab1ee9c8d%7C686ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C
> 638017935642690987%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwM
> DAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7
> C&amp;sdata=FG4SbxNVF66T8ka82DJdB2JmyOeQbyAIstINr%2Bp8UQg%3D&
> amp;reserved=0