The Linux Kernel Mailing List
 help / color / mirror / Atom feed
From: Kuan-Wei Chiu <visitorckw@gmail.com>
To: Jyun-An Chen <jun930436@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>,
	Shuah Khan <skhan@linuxfoundation.org>,
	"open list:MIN HEAP" <linux-kernel@vger.kernel.org>,
	"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>
Subject: Re: [PATCH v3] Documentation/core-api: min_heap: remove documented but unimplemented min_heap_empty()
Date: Wed, 22 Jul 2026 12:19:16 +0800	[thread overview]
Message-ID: <amBExAcfF6ORsy11@google.com> (raw)
In-Reply-To: <20260721184334.143152-1-jun930436@gmail.com>

On Tue, Jul 21, 2026 at 06:43:34PM +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.

I think we can drop the last clause "instead of adding unused API
surface". It reads like unnecessary AI generated text.

Regards,
Kuan-Wei

> 
> Signed-off-by: Jyun-An Chen <jun930436@gmail.com>
> Acked-by: Kuan-Wei Chiu <visitorckw@gmail.com>
> ---
> 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
>  =============
>  
> -- 
> 2.43.0
> 

      parent reply	other threads:[~2026-07-22  4:19 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-21 18:43 [PATCH v3] Documentation/core-api: min_heap: remove documented but unimplemented min_heap_empty() Jyun-An Chen
2026-07-21 20:12 ` Randy Dunlap
2026-07-22  4:19 ` Kuan-Wei Chiu [this message]

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=amBExAcfF6ORsy11@google.com \
    --to=visitorckw@gmail.com \
    --cc=corbet@lwn.net \
    --cc=jun930436@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=skhan@linuxfoundation.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox