From nobody Sun May 24 20:33:35 2026 Received: from SJ2PR03CU001.outbound.protection.outlook.com (mail-westusazon11012010.outbound.protection.outlook.com [52.101.43.10]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A8859363C72 for ; Thu, 21 May 2026 16:40:53 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=52.101.43.10 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1779381655; cv=fail; b=lb4Hmq/VgFJqI/BuAtqjV/L2DonDFLThfVYP4KGQFvMUci80ALvcSqqf0RhltIRqXVBL+S0zc/Mng/HzUhk0FMxO5TONi4WT7b36pkEhBZ+ekTccf65qnRU+/1HJ7Ulpq5j3quV3vYMofRTRwsyx4FpKzGG/GxG9E8iV7KgWlq8= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1779381655; c=relaxed/simple; bh=5A8oNhI9YB/hy7W/k+P6CwutJOdhyPe8b7TSFY2TIc4=; h=From:To:Cc:Subject:Date:Message-ID:Content-Type:MIME-Version; b=DIGL3+QqfxkqJsK7HWVcYNoo6wKXe13onqaY04HlpmFfJ9TzLkeAui3Wuy3xz1C/yl3UILi9FIhKf8TmljnjTZw+2KK6W1LJaSShvbLXGwg0B+m7vqESRRk9oxEOQzcQoG+2WHYZItV5kYbKc20ZeGjeNrrqBZ/tRzHa0UgPnQg= ARC-Authentication-Results: i=2; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=nvidia.com; spf=fail smtp.mailfrom=nvidia.com; dkim=pass (2048-bit key) header.d=Nvidia.com header.i=@Nvidia.com header.b=suzGrcRC; arc=fail smtp.client-ip=52.101.43.10 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=nvidia.com Authentication-Results: smtp.subspace.kernel.org; spf=fail smtp.mailfrom=nvidia.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=Nvidia.com header.i=@Nvidia.com header.b="suzGrcRC" ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=e8WVzd+8wspMfLcNoc9wV1SZ3iom6ZthNiNwYa1WifasC47xegL9lD++ouE9TMu2Maly2GR1OqZ0cy98uCc7kAyNCSQhEouIhP/V2jWzZrucqk4sNn53snTXbKp7Y/oYqkJWjjNZk+7RPgEKaDtmK1hHDuSoaiq6k3zXCA50MN/QWwGqzmg/yKxie7VGhi/YYBayQJhZSA+piWobks5Kg4Wl4BHLIqbnBLB0Cv0Dcw8jqCtpdXQEHPTz00K6vsdwb3nOl/+v65i5zcslvJrnvcCXN7iUYfU6d4k3ixkNMYQ6dt2WauUrqcvAj5lX4Vlq+AOYCs/ZE5fGeLvhYALhqQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=2zZjeAiiVg4aKM0Z8f+PJnPrlYqImPQVm5S2qhPZ0uI=; b=AvAEuwfva7WJGTJMxoAshgaG3xyyHh6tBmvhsXGDzYg28FqLpbyr+cEn4iPAjhMt/mZrBAZDX/VxLJIXFpMCSh6yPWGseYZj8l84VkTU+M3hjEAKApuZQmZUG5oNj01uTkLjRFtWXDH1YicA4Mtu9NFqarK3hE7WP714I51aRrY2VKV042RCJNeTZNlO+HGbe8wJ/LRZbPYftaVS2YiAshZqYrzIgHyRDDha7ONhv3pEshkwnR2Yuj5qBR5dupY7Sul1kAeHLgfFKEkBAii1CNum/5o+zK9qJdqy6o8q0mX0XlT6bMJ68J4Fi//L4wSWeZn+0ku6cV/ZHAqwqV5ZKQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=nvidia.com; dmarc=pass action=none header.from=nvidia.com; dkim=pass header.d=nvidia.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=2zZjeAiiVg4aKM0Z8f+PJnPrlYqImPQVm5S2qhPZ0uI=; b=suzGrcRCM56YnyrOMqVfgg85PyVfshiXnUrPdRW+WV/ApHngImgHsSO1DmcPUw75aLlsNVlOLPjoF0AsWJ95TFhlUxAFBx42FdNjgHnhsCzLX5ongw3Xkh8jWgMi/OVwX5EHO6ofSEsJi0siKf3nzt+ou2eBTG9iLcl3zOhiXhYoWe7ONa13k3C/gNENHxCWLrQ8yNhLMBfDQqZoUU621UcasHR4JJYSDDrojJwJwZpH3zTykiEe5YW034kfV3Rt3VG5wkewNqvvB2V7yp4Yx1EoS6TmcATDbak0hfPpVGYq0Q6tSR+gA8GZPdDZTS/GGEXTfrSzKi5r7LFLtzg7wA== Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=nvidia.com; Received: from CY8PR12MB8300.namprd12.prod.outlook.com (2603:10b6:930:7d::16) by BN7PPF0D2C72F0D.namprd12.prod.outlook.com (2603:10b6:40f:fc02::6c6) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.9913.11; Thu, 21 May 2026 16:40:43 +0000 Received: from CY8PR12MB8300.namprd12.prod.outlook.com ([fe80::ce75:8187:3ac3:c5de]) by CY8PR12MB8300.namprd12.prod.outlook.com ([fe80::ce75:8187:3ac3:c5de%5]) with mapi id 15.21.0048.016; Thu, 21 May 2026 16:40:43 +0000 From: Yury Norov To: Yury Norov , Rasmus Villemoes , linux-kernel@vger.kernel.org Cc: Yury Norov Subject: [PATCH] bitmap: fix find helper documentation Date: Thu, 21 May 2026 12:40:39 -0400 Message-ID: <20260521164040.253624-1-ynorov@nvidia.com> X-Mailer: git-send-email 2.51.0 Content-Transfer-Encoding: quoted-printable X-ClientProxiedBy: SJ0PR13CA0120.namprd13.prod.outlook.com (2603:10b6:a03:2c5::35) To CY8PR12MB8300.namprd12.prod.outlook.com (2603:10b6:930:7d::16) Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CY8PR12MB8300:EE_|BN7PPF0D2C72F0D:EE_ X-MS-Office365-Filtering-Correlation-Id: 2a2f89bf-28f2-4eaf-bf88-08deb757b338 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0;ARA:13230040|1800799024|366016|10070799003|376014|18002099003|56012099003|11063799006; X-Microsoft-Antispam-Message-Info: 8oAgNx/IW5ybR1f1ZwDysK3upj15GrB+Jl8QCwR6RfMkeclRopZIWyM63rqcmYYAgEOAyrqR48+rYNCHS94aAhzenrdSBv4Dr+nRKcrIqSz9U0q31DTRgGQKSJw9iS93OSmCbjBUMArti6tk8EBnxIeQZIfHpcjs7eUgyCB4d+uWWTT05aRM0lAZkWJ1nB7lt/OMHSQxC4sPp+WVczuobhEDahxeR0HHgInzTlL27I0z7L+5BQINs003EeZGGEBh7jNBAAaAQILxFNMGklBttEh2+84OOcFFn6vtR4eOSW+t9acdqhyD5lDXglrP0TGfVnmTHtk1vBGm2tKiI319yCcqNkvQvMJ2NbVWC2vBoaGjdkXmuSmP/GNcdAUVlwJ5RLdXfaaoqU/q+pGiftnlXbechSk7RKCDobq0WbtTO52x7983kZhh/LrjCPYGrHeHnQm20Rb2ETNzUJm5zhM1w8yReW0zhXLlruwj2W5Wu5nWnfV7Rhr5hPdJGDCTylV16Xh30ONhk5qPuLZ/VRQrrl3zbakQ5h2lv+RLbPQYIosbiD1lQtkdBIhtE9Zv2xZI4BdoayAsrB+f6dGgaQsEbyxdTxevQ/bofTWM9F7AKZ9F2EZgG9PJ0OaOX2YWoCzKHh5o4wtjGf4Bq1LmSxc89lept0YLbj/2VowC8Gjuv2fOjV5WcNuvaZiPj3sA1ia7 X-Forefront-Antispam-Report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:CY8PR12MB8300.namprd12.prod.outlook.com;PTR:;CAT:NONE;SFS:(13230040)(1800799024)(366016)(10070799003)(376014)(18002099003)(56012099003)(11063799006);DIR:OUT;SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?bVQQYnXyZnbvjb4wyM+JP7Mb0ar1S7PPk/hFx/66J7nyMH6+69O+bFT65dXf?= =?us-ascii?Q?dnyRpGQlwwOSdB/9I5xyHX8oJHRhXoCkOwr0eQNV4cOW6MHnFSeFTAJ9EEm3?= =?us-ascii?Q?wszsZlvGFSD6RioQjykuwt4gIMjTyoYaxn38oqahYsdz0pGWzQIa6OLNWE6n?= =?us-ascii?Q?Y+iY49GR5z7vQHerUse+WqJFoU/oDpzui+GysxSK/RAvyDaPKFBa0sOTARXT?= =?us-ascii?Q?0lr/ayhFQuDjLAIOgDNhPw+KM3OvOdb2UWa+0Qxn8lZ/eaw4eCOnJyM8dbmS?= =?us-ascii?Q?lcxdCXYgh7HhyQZi5ydBruMLZp1dvm714p9b1lGN0gxoHF0GpxmOALc8xJN/?= =?us-ascii?Q?Md4vReL8CxSLSnVgjqWzYwYlTnCFOYHklGVp4dtIK2sp/NFUYkz3cL8AsS8S?= =?us-ascii?Q?r9DLk583Ooc67qyeqZUjWopE+D9pKrRZ4NEnT6SLzET6m43YfKkSpjESLU8Z?= =?us-ascii?Q?JKSGpQ8KmF9IfUoBXAYzRuW8eSnGDPqd7pMVZdfy0aG/IxA8MaoHKuRHquBP?= =?us-ascii?Q?fnkdHM/JqcuoNY3YJoAvN12Rn+6Qwv4mut3vpDKcQjcbdQ1jNGCFN19gV0Cn?= =?us-ascii?Q?WlHD6LpDB3N/y5slOz6GYNBPUCNv7TpIvweGimMQJJByEFm+Xdz8JLr8RwKc?= =?us-ascii?Q?0kVVNkkVYA4zI/lSwICSAY0wbCwjkuDSynwFnxnX7a5pG2az75Cfqg76QqMo?= =?us-ascii?Q?v8nfq5DvSt9p+mhKmn5tWW2tFDoEovHIr163GE7mLGifrbeAVkH/twWR2R2n?= =?us-ascii?Q?q1W3dXOU3+9QmE7Pc5BzqUxJl93u5q/hYp/adRObesEB88eR8NGCAjLWYp9Y?= =?us-ascii?Q?yNXsJ+xXf3SpfyB9JlhFNPnCa7lTQV9yhcrZCLZSF1OLcthWnZfZWmplv56N?= =?us-ascii?Q?7dVEHMXPp8WwnbZBR4XQ2xS/v2coBKPBVrZ1wUvAML2rW1dSAtviPsul50fs?= =?us-ascii?Q?Qcab8BJj3bbnS2ZVeOQrJ+rPHG4ZdmvzTQG1IkVnkPx5sRxm/PImS3IdKHfF?= =?us-ascii?Q?xDzrgtNbyJUzCT0VhKVhBd9K5maO7qT7My9lsEOEDVDD37cpSDyiFZPEzq0L?= =?us-ascii?Q?DAUYYbSRXJRgpqc7rru0gLGNjDEuox9aey7lckirQoQwzpsxmFCGalijndJA?= =?us-ascii?Q?NOO3pHuEeuzzeHWJSii8EtsbGuUWB1gL9m46DNWcynsg4y4SeAq1lNCDSffy?= =?us-ascii?Q?f11gR6d30ov7wST6PiJEh7Jbd6NKOokhyCzCxaElIKN4+HbCipzjjEdBHQcY?= =?us-ascii?Q?9d5NW7t+iTYThYcEIrOZlCd5zzwiW9t7fC63/wFJI6+akinGgbb92zo1wF46?= =?us-ascii?Q?8nViL7fELETIRQ1C4eX0qp2ZiSC/TNaVTGVJaR8Sdteq0TkNnYa+Xd7PtONE?= =?us-ascii?Q?iIrc79R/UjBvdSHMq+81hSmIdyj3nCW6LXz5uRXth31YSQbFYkFPxewXdwd6?= =?us-ascii?Q?vSS7RjjXwTfEw/5H5QQ5qHdnqwN4/2q84lv6YbhpI9PaonUGaFz9ukEcpeYL?= =?us-ascii?Q?CBAD9ogWAHxatyEoMqSxsENgrUsJe3jKq5XVt7rX/uQ8MfORTvd71dEZSQuP?= =?us-ascii?Q?55fS++GSpegq5ssNQTXSApChtdZgS1ZvuGQ9uDxZD7PNLiIiMlExDnY+uzcb?= =?us-ascii?Q?TURRqA2jc2ZtPeLFpdmbg3hugIO87lpFfT81b+lG97yuUP8EkYGvS4RyDrGh?= =?us-ascii?Q?HvOUeCr9eG0KYYNtN6RkymsOv97uY/mfi7ZL8uNa+tJKWwjX3JqQ2NpBw8NB?= =?us-ascii?Q?HVnxixtHey8hGVfAXPBbRqVHL0FH1vGKzKj/7JE5xa9+TQo/c5DU?= X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-Network-Message-Id: 2a2f89bf-28f2-4eaf-bf88-08deb757b338 X-MS-Exchange-CrossTenant-AuthSource: CY8PR12MB8300.namprd12.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 21 May 2026 16:40:43.1591 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: ZmXBcmeH7OkTOsWoHvh5Wx9ORXW3HCZL5dRCNCuYhEt/3RSf0revOaiBMGhC0hoSLVy8JwTwtNIgZL2Rdu0Ohw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN7PPF0D2C72F0D Content-Type: text/plain; charset="utf-8" find_nth_and_bit() and find_nth_and_andnot_bit() may return a value greater than @size when the requested bit does not exist, matching find_nth_bit(). Document that correctly. All current users are safe against the '>=3D' vs '=3D=3D' conditions.=20 Also fix the for_each_clear_bitrange_from() parameter descriptions so they describe clear ranges instead of set ranges. Signed-off-by: Yury Norov --- include/linux/find.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/include/linux/find.h b/include/linux/find.h index 6c2be8ca615d..a129f8205fb6 100644 --- a/include/linux/find.h +++ b/include/linux/find.h @@ -249,7 +249,7 @@ unsigned long find_nth_bit(const unsigned long *addr, u= nsigned long size, unsign * @n: The number of set bit, which position is needed, counting from 0 * * Returns the bit number of the N'th set bit. - * If no such, returns @size. + * If no such, returns >=3D @size. */ static __always_inline unsigned long find_nth_and_bit(const unsigned long *addr1, const unsigned = long *addr2, @@ -277,7 +277,7 @@ unsigned long find_nth_and_bit(const unsigned long *add= r1, const unsigned long * * @n: The number of set bit, which position is needed, counting from 0 * * Returns the bit number of the N'th set bit. - * If no such, returns @size. + * If no such, returns >=3D @size. */ static __always_inline unsigned long find_nth_and_andnot_bit(const unsigned long *addr1, @@ -655,8 +655,8 @@ unsigned long find_next_bit_le(const void *addr, unsign= ed =20 /** * for_each_clear_bitrange_from - iterate over all unset bit ranges [b; e) - * @b: bit offset of start of current bitrange (first set bit); must be in= itialized - * @e: bit offset of end of current bitrange (first unset bit) + * @b: bit offset of start of current bitrange (first unset bit); must be = initialized + * @e: bit offset of end of current bitrange (first set bit) * @addr: bitmap address to base the search on * @size: bitmap size in number of bits */ --=20 2.51.0