[PATCH v3 5/9] maple_tree: Update the documentation of maple tree

Peng Zhang posted 9 patches 2 years, 4 months ago
There is a newer version of this series
[PATCH v3 5/9] maple_tree: Update the documentation of maple tree
Posted by Peng Zhang 2 years, 4 months ago
Introduce the new interface mtree_dup() in the documentation.

Signed-off-by: Peng Zhang <zhangpeng.00@bytedance.com>
---
 Documentation/core-api/maple_tree.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/core-api/maple_tree.rst b/Documentation/core-api/maple_tree.rst
index 45defcf15da7..3d8a1edf6d04 100644
--- a/Documentation/core-api/maple_tree.rst
+++ b/Documentation/core-api/maple_tree.rst
@@ -81,6 +81,9 @@ section.
 Sometimes it is necessary to ensure the next call to store to a maple tree does
 not allocate memory, please see :ref:`maple-tree-advanced-api` for this use case.
 
+You can use mtree_dup() to duplicate an identical tree. It is a more efficient
+way than inserting all elements one by one into a new tree.
+
 Finally, you can remove all entries from a maple tree by calling
 mtree_destroy().  If the maple tree entries are pointers, you may wish to free
 the entries first.
@@ -112,6 +115,7 @@ Takes ma_lock internally:
  * mtree_insert()
  * mtree_insert_range()
  * mtree_erase()
+ * mtree_dup()
  * mtree_destroy()
  * mt_set_in_rcu()
  * mt_clear_in_rcu()
-- 
2.20.1
Re: [PATCH v3 5/9] maple_tree: Update the documentation of maple tree
Posted by Liam R. Howlett 2 years, 4 months ago
* Peng Zhang <zhangpeng.00@bytedance.com> [230924 23:58]:
> Introduce the new interface mtree_dup() in the documentation.
> 
> Signed-off-by: Peng Zhang <zhangpeng.00@bytedance.com>
> ---
>  Documentation/core-api/maple_tree.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/Documentation/core-api/maple_tree.rst b/Documentation/core-api/maple_tree.rst
> index 45defcf15da7..3d8a1edf6d04 100644
> --- a/Documentation/core-api/maple_tree.rst
> +++ b/Documentation/core-api/maple_tree.rst
> @@ -81,6 +81,9 @@ section.
>  Sometimes it is necessary to ensure the next call to store to a maple tree does
>  not allocate memory, please see :ref:`maple-tree-advanced-api` for this use case.
>  
> +You can use mtree_dup() to duplicate an identical tree. It is a more efficient

"You can use mtree_dup() to create an identical tree."  duplicate an
identical tree seems redundant.

> +way than inserting all elements one by one into a new tree.
> +
>  Finally, you can remove all entries from a maple tree by calling
>  mtree_destroy().  If the maple tree entries are pointers, you may wish to free
>  the entries first.
> @@ -112,6 +115,7 @@ Takes ma_lock internally:
>   * mtree_insert()
>   * mtree_insert_range()
>   * mtree_erase()
> + * mtree_dup()
>   * mtree_destroy()
>   * mt_set_in_rcu()
>   * mt_clear_in_rcu()
> -- 
> 2.20.1
>
Re: [PATCH v3 5/9] maple_tree: Update the documentation of maple tree
Posted by Peng Zhang 2 years, 4 months ago

在 2023/10/4 02:46, Liam R. Howlett 写道:
> * Peng Zhang <zhangpeng.00@bytedance.com> [230924 23:58]:
>> Introduce the new interface mtree_dup() in the documentation.
>>
>> Signed-off-by: Peng Zhang <zhangpeng.00@bytedance.com>
>> ---
>>   Documentation/core-api/maple_tree.rst | 4 ++++
>>   1 file changed, 4 insertions(+)
>>
>> diff --git a/Documentation/core-api/maple_tree.rst b/Documentation/core-api/maple_tree.rst
>> index 45defcf15da7..3d8a1edf6d04 100644
>> --- a/Documentation/core-api/maple_tree.rst
>> +++ b/Documentation/core-api/maple_tree.rst
>> @@ -81,6 +81,9 @@ section.
>>   Sometimes it is necessary to ensure the next call to store to a maple tree does
>>   not allocate memory, please see :ref:`maple-tree-advanced-api` for this use case.
>>   
>> +You can use mtree_dup() to duplicate an identical tree. It is a more efficient
> 
> "You can use mtree_dup() to create an identical tree."  duplicate an
> identical tree seems redundant.
Okay, I will modify this sentence. Thank you.
> 
>> +way than inserting all elements one by one into a new tree.
>> +
>>   Finally, you can remove all entries from a maple tree by calling
>>   mtree_destroy().  If the maple tree entries are pointers, you may wish to free
>>   the entries first.
>> @@ -112,6 +115,7 @@ Takes ma_lock internally:
>>    * mtree_insert()
>>    * mtree_insert_range()
>>    * mtree_erase()
>> + * mtree_dup()
>>    * mtree_destroy()
>>    * mt_set_in_rcu()
>>    * mt_clear_in_rcu()
>> -- 
>> 2.20.1
>>
>