cleanup: Add usage and style documentation
authorDan Williams <dan.j.williams@intel.com>
Fri, 29 Mar 2024 23:48:48 +0000 (16:48 -0700)
committerPeter Zijlstra <peterz@infradead.org>
Mon, 5 Aug 2024 14:54:41 +0000 (16:54 +0200)
commitd5934e76316e84eced836b6b2bafae1837d1cd58
treea7562439e0d70b6160e0fce0efd85bc7a8a6733b
parent7886a61ebc1f3998df5950299cbe17272bf32c59
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
Documentation/core-api/cleanup.rst [new file with mode: 0644]
Documentation/core-api/index.rst
include/linux/cleanup.h