linux-kernel - Re: [PATCH v2] cleanup: Add usage and style documentation

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]

Message-ID: <20240326165623.000002fa@Huawei.com>
Date: Tue, 26 Mar 2024 16:56:23 +0000
From: Jonathan Cameron <Jonathan.Cameron@...wei.com>
To: Dan Williams <dan.j.williams@...el.com>
CC: <peterz@...radead.org>, <torvalds@...ux-foundation.org>, Bjorn Helgaas
	<bhelgaas@...gle.com>, Ira Weiny <ira.weiny@...el.com>, Jesse Brandeburg
	<jesse.brandeburg@...el.com>, Ilpo Järvinen
	<ilpo.jarvinen@...ux.intel.com>, Lukas Wunner <lukas@...ner.de>, "Jonathan
 Corbet" <corbet@....net>, <linux-pci@...r.kernel.org>,
	<linux-kernel@...r.kernel.org>, <gregkh@...uxfoundation.org>,
	<linux-doc@...r.kernel.org>
Subject: Re: [PATCH v2] cleanup: Add usage and style documentation

On Mon, 25 Mar 2024 15:57:42 -0700
Dan Williams <dan.j.williams@...el.com> wrote:

> When proposing that PCI grow some new cleanup helpers for pci_dev_put()
> and pci_dev_{lock,unlock} [1], Bjorn had some fundamental questions
> about expectations and best practices. Upon reviewing an updated
> changelog with those details he recommended adding them to documentation
> in the header file itself.
> 
> Add that documentation and link it into the rendering for
> Documentation/core-api/.
> 
> Link: http://lore.kernel.org/r/20240104183218.GA1820872@bhelgaas [1]
> Cc: Bjorn Helgaas <bhelgaas@...gle.com>
> Cc: Ira Weiny <ira.weiny@...el.com>
> Cc: Jonathan Cameron <jonathan.cameron@...wei.com>
> Cc: Jesse Brandeburg <jesse.brandeburg@...el.com>
> Cc: Ilpo Järvinen <ilpo.jarvinen@...ux.intel.com>
> Cc: Lukas Wunner <lukas@...ner.de>
> Cc: Peter Zijlstra <peterz@...radead.org>
> Cc: Jonathan Corbet <corbet@....net>
> Signed-off-by: Dan Williams <dan.j.williams@...el.com>

Other than the formatting improvement Jon suggested, this looks good to me
and corresponds to my understanding of how this stuff should be used.

FWIW

Reviewed-by: Jonathan Cameron <Jonathan.Cameron@...wei.com>