Re: [PATCH v3] Documentation/core-api: min_heap: remove documented but unimplemented min_heap_empty()

From: Randy Dunlap

Date: Tue Jul 21 2026 - 18:00:19 EST




On 7/21/26 11:43 AM, Jyun-An Chen wrote:
> min_heap_empty()/min_heap_empty_inline() are documented as part of
> the Min Heap API, but no such functions or macros exist in
> include/linux/min_heap.h or lib/min_heap.c. Remove the stale
> description instead of adding unused API surface.
>
> Signed-off-by: Jyun-An Chen <jun930436@xxxxxxxxx>
> Acked-by: Kuan-Wei Chiu <visitorckw@xxxxxxxxx>

Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Thanks.

> ---
> Changes since v2:
> - Fixed subject line.
>
> Documentation/core-api/min_heap.rst | 13 -------------
> 1 file changed, 13 deletions(-)
>
> diff --git a/Documentation/core-api/min_heap.rst b/Documentation/core-api/min_heap.rst
> index 9f57766581df..919dcf1bdec7 100644
> --- a/Documentation/core-api/min_heap.rst
> +++ b/Documentation/core-api/min_heap.rst
> @@ -240,19 +240,6 @@ This macro returns `true` if the heap is full, otherwise `false`.
>
> **Inline Version:** min_heap_full_inline(heap)
>
> -- **min_heap_empty(heap)**: Checks whether the heap is empty.
> - Complexity: **O(1)**.
> -
> -.. code-block:: c
> -
> - bool empty = min_heap_empty(heap);
> -
> -- `heap`: A pointer to the min-heap to check.
> -
> -This macro returns `true` if the heap is empty, otherwise `false`.
> -
> -**Inline Version:** min_heap_empty_inline(heap)
> -
> Example Usage
> =============
>

--
~Randy