Re: [PATCH v2] maple_tree: document that "last" in mtree_insert_range() is inclusive

[Liam R. Howlett]

On 26/05/12 05:56PM, Steven Rostedt wrote:
> From: Steven Rostedt <rostedt@xxxxxxxxxxx>
> 
> The kernel doc of mtree_insert_range() does not state if the address
> represented by the "last" parameter is inclusive or exclusive. This can
> lead to bugs by code that assumes it is exclusive. Explicitly state that
> the parameter is inclusive.
> 
> Signed-off-by: Steven Rostedt <rostedt@xxxxxxxxxxx>

Thanks, this looks good.

Reviewed-by: "Liam R. Howlett" <liam@xxxxxxxxxxxxx>

> ---
> Changes since v1: https://patch.msgid.link/20260506105218.2d027cc0@fedora
> 
> - Use "(inclusive)" instead of adding '[' ']' around "end". (Alice Ryhl)
> 
> - Add "from [first, last]" in the short description. (Liam Howlett)
> 
>  lib/maple_tree.c | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
> 
> diff --git a/lib/maple_tree.c b/lib/maple_tree.c
> index d18d7ed9ab67..7f6c9b729a1a 100644
> --- a/lib/maple_tree.c
> +++ b/lib/maple_tree.c
> @@ -5727,13 +5727,16 @@ int mtree_store(struct maple_tree *mt, unsigned long index, void *entry,
>  EXPORT_SYMBOL(mtree_store);
>  
>  /**
> - * mtree_insert_range() - Insert an entry at a given range if there is no value.
> + * mtree_insert_range() - Insert an entry from [first, last] at a given range
> + *                        if there is no value.
>   * @mt: The maple tree
>   * @first: The start of the range
> - * @last: The end of the range
> + * @last: The end of the range (inclusive)
>   * @entry: The entry to store
>   * @gfp: The GFP_FLAGS to use for allocations.
>   *
> + * Note that @last is inclusive. That is, @last = @first + length - 1;
> + *
>   * Return: 0 on success, -EEXISTS if the range is occupied, -EINVAL on invalid
>   * request, -ENOMEM if memory could not be allocated.
>   */
> -- 
> 2.53.0
> 
> 
> -- 
> maple-tree mailing list
> maple-tree@xxxxxxxxxxxxxxxxxxx
> https://lists.infradead.org/mailman/listinfo/maple-tree