Received-SPF: pass (google.com: domain of linux-kernel+bounces-119634-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Date: Tue, 26 Mar 2024 10:53:45 -0700
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 =?iso-8859-1?Q?J=E4rvinen?=
	<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
Message-ID: <66030ba9d82d6_4a98a2949f@dwillia2-mobl3.amr.corp.intel.com.notmuch>
References: <171097196970.1011049.9726486429680041876.stgit@dwillia2-xfh.jf.intel.com>
 <171140738438.1574931.15717256954707430472.stgit@dwillia2-xfh.jf.intel.com>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <171140738438.1574931.15717256954707430472.stgit@dwillia2-xfh.jf.intel.com>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?7EHY23VJnRPvh7sFKJypKo61TjvgsFcqHi839cIT++fnIwulkCgjgS9tSgMB?=
 =?us-ascii?Q?HQ/s5iar6mVTr22r0DgJmPLC838g9e+ZVRKwvKJ+8fQaNlOavcmwcMgGc6Dt?=
 =?us-ascii?Q?/EzstukQ8XAAW8cqSoeKvSe+Q96oCK3obX09Mdc22T3aO7Qli38JPOud0/ws?=
 =?us-ascii?Q?+h1bBpXBugh6Vr8qB0wNr1QeLf/kiEx83OdRODzAA1U4n62bBni4mOA7xosY?=
 =?us-ascii?Q?1iJmgBqXaxjUn4IO+3VPqNa5ms6nm2QL3M28SGWpYuWW7Oa+JSa42wfi4L8H?=
 =?us-ascii?Q?kmpcF0fPjqVUinfDelxDney7weh5QmYkC9HRush6NfQnicb5BgS3uYXxMjY2?=
 =?us-ascii?Q?oxlVG9tgn/gzXx7Ey/hFIM5Eq5XB3ybYHtYIysPZt6X10vRHHvvTtOQ2Zx94?=
 =?us-ascii?Q?OeVPXJiKP3DIv4C4dsu8UNpH1VEVxA8Ha7VRoiUz6OAr0EUuSUqwL5onC9gh?=
 =?us-ascii?Q?uktFZ76h9oXITE0p5XlYpGNUhtInBuRGDaLN6LUBQ221N7Usjq6DZ4CC1pLw?=
 =?us-ascii?Q?X6WO9Unayi8yeZhS4+5OdsCo8Lm9KUy/koKLdktmZTfZmGwf22aaNvLFgwr5?=
 =?us-ascii?Q?6s3I9zLZ0y8sxE1EdS/546N9nHKWX+HPdg7+YbCPfoWureobIZFzn1rANPRl?=
 =?us-ascii?Q?/wHCvd48Ud92MEGomBg/9HqYVR9mO3AZkspk39yE3Opo5qCw93EHu6HYig1U?=
 =?us-ascii?Q?XfP9pBBrmIQhOahVu7yxOUiktEkWkBAKPuhRhQd49wTuvYlc2REie+KlU2NS?=
 =?us-ascii?Q?tbBXDq3NMGDGmcYsJXqR2kYR2ximzYDQQZV/zeBJT4/AvVOxVHZbyKAM34Ed?=
 =?us-ascii?Q?ZLgHepTLJjHQLom8VW2YgzM3UYfhAzPuVKn6cvOMRwBlBHZUbr1Uixwe5hRL?=
 =?us-ascii?Q?khw5xPezOhzeyW5KAmYX2uZjdl1KxsYZezdGudt5gfQFc75pSThymXe6okDF?=
 =?us-ascii?Q?5GJuxoDIShG7nckp3XSi2rJh/bUlUj2ODV6n7AVSOKsZ/E8JrwaeJb/64oHn?=
 =?us-ascii?Q?+8ku0w4x3fI6nLw/eg/8kvXx1X1bnSOY1wQ+og/3PBHTivDEV8DW49OmbCQC?=
 =?us-ascii?Q?Q3C14heQ1RVM9UF8l2mHK/VhGK2oNXqfJgwuh6rnHFNXWHFfAR/6Z6cXFBi7?=
 =?us-ascii?Q?Ls0ByB+MavZKvyOQrCyTwxwQT7KlkUVcbqwTBRdNGqcJ7AzhnrSurIYMnQHq?=
 =?us-ascii?Q?2G/z3K8U8T2i589bd89rVjnWItkCFLted+u34z1s+UKPDidWYxGmqYQmYIy4?=
 =?us-ascii?Q?FLd/6UEzDGrlsg5i309qBm+XZRg88+RLLpmD52l0oHZGVh7QnbZFQ1PhW6Pp?=
 =?us-ascii?Q?NBGwjBP8YK0omvuhy25GwgKFVFkK6TbAAVYU1EIexGx+nosq4YWuTIlLgch1?=
 =?us-ascii?Q?O7nqqVQSzmchYyomkTmYDyUIBdt8pMrW8FCCHoEy/4S6AgrwaYAVsZaCKuqu?=
 =?us-ascii?Q?A7/a+RSQ+b7D0mGaaW73Cfb4AZTttaXMDeRIS649RtJG21wlH23l1zflW5rt?=
 =?us-ascii?Q?F8ctEsJRRE6lkOyA6ApEDVC/9xx2Zao5CJ7FMmWGCk88yQtqlcM+AMk34rSN?=
 =?us-ascii?Q?ks6HA9NalQUFnAvRt8gW0ZuWQhA9eBD0D+WvEx1w/0p1ZDb03wkeUmuvGr2/?=
 =?us-ascii?Q?dA=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 1a7076ba-8bbf-4227-1cf8-08dc4dbdb0fe
X-MS-Exchange-CrossTenant-AuthSource: PH8PR11MB8107.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 26 Mar 2024 17:53:49.5438
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: s34+3/CgxkOLzzYnOqZjIwzsktF/8/j00SHI/KIpWdhSnqgcyUQwuQ2bySUwCPnc8WGKB+8Il8QON4kwRqmRdzv5ixHbpdxbQwJKs2kwk3o=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH8PR11MB7992
X-OriginatorOrg: 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.