Documentation/core-api/min_heap.rst | 2 +- include/linux/min_heap.h | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-)
The Min Heap API documentation and header file contain a few minor
spelling and grammatical mistakes.
Fix the following:
- Add a missing period at the end of a sentence in min_heap.rst.
- Change "customise" to "customize" in min_heap.h for consistency
with the documentation.
- Change "on to" to "onto" in the description of min_heap_push.
These changes improve the readability of the API and documentation.
Signed-off-by: Min-Hsun Chang <chmh0624@gmail.com>
---
Documentation/core-api/min_heap.rst | 2 +-
include/linux/min_heap.h | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/core-api/min_heap.rst b/Documentation/core-api/min_heap.rst
index 9f57766581df..62439be2cdf6 100644
--- a/Documentation/core-api/min_heap.rst
+++ b/Documentation/core-api/min_heap.rst
@@ -75,7 +75,7 @@ elements in the heap and swapping them. It contains two function pointers:
- **less** is the comparison function used to establish the order of elements.
- **swp** is a function for swapping elements in the heap. If swp is set to
- NULL, the default swap function will be used, which swaps the elements based on their size
+ NULL, the default swap function will be used, which swaps the elements based on their size.
Macro Wrappers
==============
diff --git a/include/linux/min_heap.h b/include/linux/min_heap.h
index 79ddc0adbf2b..cb1cc0c0e8bd 100644
--- a/include/linux/min_heap.h
+++ b/include/linux/min_heap.h
@@ -40,7 +40,7 @@ typedef DEFINE_MIN_HEAP(char, min_heap_char) min_heap_char;
#define __minheap_obj_size(_heap) sizeof((_heap)->data[0])
/**
- * struct min_heap_callbacks - Data/functions to customise the min_heap.
+ * struct min_heap_callbacks - Data/functions to customize the min_heap.
* @less: Partial order function for this heap.
* @swp: Swap elements function.
*/
@@ -373,7 +373,7 @@ void __min_heap_pop_push_inline(min_heap_char *heap, const void *element, size_t
__min_heap_pop_push_inline(container_of(&(_heap)->nr, min_heap_char, nr), _element, \
__minheap_obj_size(_heap), _func, _args)
-/* Push an element on to the heap, O(log2(nr)). */
+/* Push an element onto the heap, O(log2(nr)). */
static __always_inline
bool __min_heap_push_inline(min_heap_char *heap, const void *element, size_t elem_size,
const struct min_heap_callbacks *func, void *args)
--
2.50.1
Min-Hsun Chang <chmh0624@gmail.com> writes: > The Min Heap API documentation and header file contain a few minor > spelling and grammatical mistakes. > > Fix the following: > - Add a missing period at the end of a sentence in min_heap.rst. > - Change "customise" to "customize" in min_heap.h for consistency > with the documentation. > - Change "on to" to "onto" in the description of min_heap_push. > > These changes improve the readability of the API and documentation. > > Signed-off-by: Min-Hsun Chang <chmh0624@gmail.com> > --- > Documentation/core-api/min_heap.rst | 2 +- > include/linux/min_heap.h | 4 ++-- > 2 files changed, 3 insertions(+), 3 deletions(-) > > diff --git a/Documentation/core-api/min_heap.rst b/Documentation/core-api/min_heap.rst > index 9f57766581df..62439be2cdf6 100644 > --- a/Documentation/core-api/min_heap.rst > +++ b/Documentation/core-api/min_heap.rst > @@ -75,7 +75,7 @@ elements in the heap and swapping them. It contains two function pointers: > > - **less** is the comparison function used to establish the order of elements. > - **swp** is a function for swapping elements in the heap. If swp is set to > - NULL, the default swap function will be used, which swaps the elements based on their size > + NULL, the default swap function will be used, which swaps the elements based on their size. > > Macro Wrappers > ============== > diff --git a/include/linux/min_heap.h b/include/linux/min_heap.h > index 79ddc0adbf2b..cb1cc0c0e8bd 100644 > --- a/include/linux/min_heap.h > +++ b/include/linux/min_heap.h > @@ -40,7 +40,7 @@ typedef DEFINE_MIN_HEAP(char, min_heap_char) min_heap_char; > #define __minheap_obj_size(_heap) sizeof((_heap)->data[0]) > > /** > - * struct min_heap_callbacks - Data/functions to customise the min_heap. > + * struct min_heap_callbacks - Data/functions to customize the min_heap. Both British and American spellings are fine in the kernel and do not need to be fixed. Thanks, jon
© 2016 - 2026 Red Hat, Inc.