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

From: Dan Williams <dan.j.williams@intel.com>
To: Dan Williams <dan.j.williams@intel.com>, <peterz@infradead.org>,
	<torvalds@linux-foundation.org>
Cc: "Bjorn Helgaas" <bhelgaas@google.com>,
	"Ira Weiny" <ira.weiny@intel.com>,
	"Jonathan Cameron" <jonathan.cameron@huawei.com>,
	"Jesse Brandeburg" <jesse.brandeburg@intel.com>,
	"Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>,
	"Lukas Wunner" <lukas@wunner.de>,
	"Jonathan Corbet" <corbet@lwn.net>,
	linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org,
	gregkh@linuxfoundation.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH v2] cleanup: Add usage and style documentation
Date: Tue, 26 Mar 2024 10:53:45 -0700	[thread overview]
Message-ID: <66030ba9d82d6_4a98a2949f@dwillia2-mobl3.amr.corp.intel.com.notmuch> (raw)
In-Reply-To: <171140738438.1574931.15717256954707430472.stgit@dwillia2-xfh.jf.intel.com>

Dan Williams wrote:
[..]
> diff --git a/include/linux/cleanup.h b/include/linux/cleanup.h
> index c2d09bc4f976..8ef2d91c2cbf 100644
> --- a/include/linux/cleanup.h
> +++ b/include/linux/cleanup.h
> @@ -4,6 +4,157 @@
>  
>  #include <linux/compiler.h>
>  
> +/**
> + * DOC: scope-based cleanup helpers
> + *
> + * The "goto error" pattern is notorious for introducing subtle resource
> + * leaks. It is tedious and error prone to add new resource acquisition
> + * constraints into code paths that already have several unwind
> + * conditions. The "cleanup" helpers enable the compiler to help with
> + * this tedium and can aid in maintaining FILO (first in last out)

Missed this FILO => LIFO conversion per Bjorn.