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

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

[Yu-Chun Lin]

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>
---
 Documentation/core-api/min_heap.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/core-api/min_heap.rst b/Documentation/core-api/min_heap.rst
index 683bc6d09f00..9f57766581df 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 */
     }
-- 
2.43.0

Re: [PATCH] Documentation/core-api: min_heap: update for variable types change

[Kuan-Wei Chiu]

On Sat, Feb 15, 2025 at 11:54:21PM +0800, Yu-Chun Lin wrote:
> 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>

LGTM. Thanks for the patch.

Acked-by: Kuan-Wei Chiu <visitorckw@gmail.com>

This reminds me that I have a patch to change 'int' to 'size_t' for
indexes in min_heap.h, but it hasn't been merged yet. I'll find it and
resend it.

Regards,
Kuan-Wei

Re: [PATCH] Documentation/core-api: min_heap: update for variable types change

[Jonathan Corbet]

Yu-Chun Lin <eleanor15x@gmail.com> writes:

> 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>
> ---
>  Documentation/core-api/min_heap.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/core-api/min_heap.rst b/Documentation/core-api/min_heap.rst
> index 683bc6d09f00..9f57766581df 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 */

Applied, thanks.

jon