Documentation/core-api/min_heap.rst | 13 ------------- 1 file changed, 13 deletions(-)
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@gmail.com>
---
Changes since v1:
- Per Kuan-Wei's review, dropped the min_heap_empty()/min_heap_empty_inline()
implementation (unused API with no in-tree callers) and instead just
removed the stale documentation for it.
- Signed-off-by now uses real name instead of GitHub handle.
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
=============
--
2.43.0
Hi Jyun-An, On Tue, Jul 21, 2026 at 06:01:26PM +0000, 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@gmail.com> One minor nit: the subject line says "remove undocumented", but it actually removes a documented function. With fixing subject line: Acked-by: Kuan-Wei Chiu <visitorckw@gmail.com> Regards, Kuan-Wei > --- > Changes since v1: > - Per Kuan-Wei's review, dropped the min_heap_empty()/min_heap_empty_inline() > implementation (unused API with no in-tree callers) and instead just > removed the stale documentation for it. > - Signed-off-by now uses real name instead of GitHub handle. > > 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 > ============= > > -- > 2.43.0 >
© 2016 - 2026 Red Hat, Inc.