linux/Documentation/core-api/cleanup.rst

.. SPDX-License-Identifier: GPL-2.0

===========================
Scope-based Cleanup Helpers
===========================

.. kernel-doc:: include/linux/cleanup.h
   :doc: scope-based cleanup helpers
cleanup: Add usage and style documentation 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/. Signed-off-by: Dan Williams <dan.j.williams@intel.com> Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org> Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> Reviewed-by: Kevin Tian <kevin.tian@intel.com> Link: https://lore.kernel.org/r/171175585714.2192972.12661675876300167762.stgit@dwillia2-xfh.jf.intel.com 2024-03-29 16:48:48 -07:00			`.. SPDX-License-Identifier: GPL-2.0`

			`===========================`
			`Scope-based Cleanup Helpers`
			`===========================`

			`.. kernel-doc:: include/linux/cleanup.h`
			`:doc: scope-based cleanup helpers`