2017-12-01 23:45:20

by Vito Caputo

Subject: [PATCH] rbtree.txt: fix typo in cached rbtree section

---
Documentation/rbtree.txt | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/rbtree.txt b/Documentation/rbtree.txt
index c42a21b99046..3a4c23bc90b2 100644
--- a/Documentation/rbtree.txt
+++ b/Documentation/rbtree.txt
@@ -197,9 +197,9 @@ Cached rbtrees
--------------

Computing the leftmost (smallest) node is quite a common task for binary
-search trees, such as for traversals or users relying on a the particular
-order for their own logic. To this end, users can use 'struct rb_root_cached'
-to optimize O(logN) rb_first() calls to a simple pointer fetch avoiding
+search trees, such as for traversals or users relying on a particular order
+for their own logic. To this end, users can use 'struct rb_root_cached' to
+optimize O(logN) rb_first() calls to a simple pointer fetch avoiding
potentially expensive tree iterations. This is done at negligible runtime
overhead for maintanence; albeit larger memory footprint.

--
2.11.0

2017-12-02 12:39:26

by Davidlohr Bueso

Subject: Re: [PATCH] rbtree.txt: fix typo in cached rbtree section

I'm happy to ack your patch but you have to send it correctly.
You are missing a changelog (although it ought to be small due
to the trivial change) as well as you SoB tag. Please consult
Documentation/process/submitting-patches.rst.

You also need to Cc akpm as he routes such areas to Linus.

Thanks,
Davidlohr

On Fri, 01 Dec 2017, Vito Caputo wrote:

>---
> Documentation/rbtree.txt | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
>diff --git a/Documentation/rbtree.txt b/Documentation/rbtree.txt
>index c42a21b99046..3a4c23bc90b2 100644
>--- a/Documentation/rbtree.txt
>+++ b/Documentation/rbtree.txt
>@@ -197,9 +197,9 @@ Cached rbtrees
> --------------
>
> Computing the leftmost (smallest) node is quite a common task for binary
>-search trees, such as for traversals or users relying on a the particular
>-order for their own logic. To this end, users can use 'struct rb_root_cached'
>-to optimize O(logN) rb_first() calls to a simple pointer fetch avoiding
>+search trees, such as for traversals or users relying on a particular order
>+for their own logic. To this end, users can use 'struct rb_root_cached' to
>+optimize O(logN) rb_first() calls to a simple pointer fetch avoiding
> potentially expensive tree iterations. This is done at negligible runtime
> overhead for maintanence; albeit larger memory footprint.
>
>--
>2.11.0
>