linux-kernel - Re: [PATCH v13 1/6] PCI: endpoint: pci-epf-vntb: Clean up kernel

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 19 Oct 2022 11:25:56 -0500
From:   Bjorn Helgaas <helgaas@...nel.org>
To:     Frank Li <Frank.Li@....com>
Cc:     imx@...ts.linux.dev, Jon Mason <jdmason@...zu.us>,
        Dave Jiang <dave.jiang@...el.com>,
        Allen Hubbe <allenbh@...il.com>,
        Kishon Vijay Abraham I <kishon@...com>,
        Lorenzo Pieralisi <lpieralisi@...nel.org>,
        Krzysztof Wilczyński <kw@...ux.com>,
        Manivannan Sadhasivam <mani@...nel.org>,
        Bjorn Helgaas <bhelgaas@...gle.com>,
        "open list:NTB DRIVER CORE" <ntb@...ts.linux.dev>,
        "open list:PCI ENDPOINT SUBSYSTEM" <linux-pci@...r.kernel.org>,
        open list <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH v13 1/6] PCI: endpoint: pci-epf-vntb: Clean up kernel_doc
 warning

On Fri, Oct 07, 2022 at 03:13:21PM -0400, Frank Li wrote:
> From: Frank Li <frank.li@....com>
> 
> 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:

  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/5.Posting.rst?id=v6.0#n334

And if you look at the archives, you'll see lots of examples:

  https://lore.kernel.org/linux-pci/