]> www.infradead.org Git - users/jedix/linux-maple.git/commit
lib min_heap: add brief introduction to Min Heap API
authorKuan-Wei Chiu <visitorckw@gmail.com>
Fri, 29 Nov 2024 18:12:21 +0000 (02:12 +0800)
committerAndrew Morton <akpm@linux-foundation.org>
Mon, 13 Jan 2025 04:20:57 +0000 (20:20 -0800)
commit2ad0546deb0214e385dbf33bb7a5e26c0dda3ad1
tree36de454e3c15185ee8f022ad79535b3c59bed92e
parent93aa1b5c1722b697ecc4eae490fdb55c0f3cfe22
lib min_heap: add brief introduction to Min Heap API

A short description of the Min Heap API is added to the min_heap.h,
explaining its purpose for managing min-heaps and emphasizing the use of
macro wrappers instead of direct function calls.  For more details, users
are directed to the documentation at Documentation/core-api/min_heap.rst.

Link: https://lkml.kernel.org/r/20241129181222.646855-4-visitorckw@gmail.com
Signed-off-by: Kuan-Wei Chiu <visitorckw@gmail.com>
Cc: Ching-Chun (Jim) Huang <jserv@ccns.ncku.edu.tw>
Cc: Geert Uytterhoeven <geert@linux-m68k.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
include/linux/min_heap.h