From: Yu-Chun Lin <eleanor15x@gmail.com>
Date: Sat, 15 Feb 2025 15:54:21 +0000 (+0800)
Subject: Documentation/core-api: min_heap: update for variable types change
X-Git-Tag: v6.15-rc1~223^2~35
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=364469e533b8d0b4ad6b2ae11fc78c1e54d6afae;p=thirdparty%2Fkernel%2Flinux.git

Documentation/core-api: min_heap: update for variable types change

Update the documentation to reflect the change in variable types of
'nr' and 'size' from 'int' to 'size_t', ensuring consistency with
commit dec6c0aac4fc ("lib min_heap: Switch to size_t").

Signed-off-by: Yu-Chun Lin <eleanor15x@gmail.com>
Acked-by: Kuan-Wei Chiu <visitorckw@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250215155421.2010336-1-eleanor15x@gmail.com
---

diff --git a/Documentation/core-api/min_heap.rst b/Documentation/core-api/min_heap.rst
index 683bc6d09f00d..9f57766581dfb 100644
--- a/Documentation/core-api/min_heap.rst
+++ b/Documentation/core-api/min_heap.rst
@@ -47,8 +47,8 @@ Example:
 
     #define MIN_HEAP_PREALLOCATED(_type, _name, _nr)
     struct _name {
-        int nr;         /* Number of elements in the heap */
-        int size;       /* Maximum number of elements that can be held */
+        size_t nr;         /* Number of elements in the heap */
+        size_t size;       /* Maximum number of elements that can be held */
         _type *data;    /* Pointer to the heap data */
         _type preallocated[_nr];  /* Static preallocated array */
     }