From: Jyun-An Chen <jun930436@gmail.com>
To: Kuan-Wei Chiu <visitorckw@gmail.com>
Cc: Jyun-An Chen <jun930436@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
Shuah Khan <skhan@linuxfoundation.org>,
linux-kernel@vger.kernel.org (open list:MIN HEAP),
linux-doc@vger.kernel.org (open list:DOCUMENTATION)
Subject: [PATCH v2] Documentation/core-api: min_heap: remove undocumented min_heap_empty()
Date: Tue, 21 Jul 2026 18:01:26 +0000 [thread overview]
Message-ID: <20260721180127.132730-1-jun930436@gmail.com> (raw)
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
next reply other threads:[~2026-07-21 18:02 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-21 18:01 Jyun-An Chen [this message]
2026-07-21 18:24 ` [PATCH v2] Documentation/core-api: min_heap: remove undocumented min_heap_empty() Kuan-Wei Chiu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260721180127.132730-1-jun930436@gmail.com \
--to=jun930436@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=visitorckw@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.