[PATCH 0/3] Trivial doc fixes for RCU (v3)

[PATCH 0/3] Trivial doc fixes for RCU (v3)

[Jesper Dangaard Brouer]

Trivial RCU documentation fixes.

It seems that majordomo eate my mail to the netdev list, as stgit
didn't quote the email adresses correctly.  As names which have
characters such as "." in them must be fully surrounded by
double quotes when they appear in email headers.  For this
to work with .gitconfig mail aliases the quotes needs to
be escaped.

So let hope the third time is the last, for these trivial patches.
---

Jesper Dangaard Brouer (3):
      Doc: Fix spelling in RCU/rculist_nulls.txt.
      Doc: Fix wrong API example usage of call_rcu().
      Doc: Fix missing whitespaces in RCU documentation.


 Documentation/RCU/listRCU.txt       |    6 +++---
 Documentation/RCU/rcu.txt           |    2 +-
 Documentation/RCU/rculist_nulls.txt |    4 ++--
 3 files changed, 6 insertions(+), 6 deletions(-)

-- 
Med venlig hilsen / Best regards
  Jesper Brouer
  ComX Networks A/S
  Linux Network developer
  Cand. Scient Datalog / MSc.
  Author of http://adsl-optimizer.dk
  LinkedIn: http://www.linkedin.com/in/brouer

[PATCH 1/3] Doc: Fix missing whitespaces in RCU documentation.

[Jesper Dangaard Brouer]

Trivial fix while reading through the RCU docs.

Reviewed-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>

Signed-off-by: Jesper Dangaard Brouer <hawk@comx.dk>
---

 Documentation/RCU/rcu.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/Documentation/RCU/rcu.txt b/Documentation/RCU/rcu.txt
index 95821a2..7aa2002 100644
--- a/Documentation/RCU/rcu.txt
+++ b/Documentation/RCU/rcu.txt
@@ -81,7 +81,7 @@ o	I hear that RCU needs work in order to support realtime kernels?
 	This work is largely completed.  Realtime-friendly RCU can be
 	enabled via the CONFIG_PREEMPT_RCU kernel configuration parameter.
 	However, work is in progress for enabling priority boosting of
-	preempted RCU read-side critical sections.This is needed if you
+	preempted RCU read-side critical sections.  This is needed if you
 	have CPU-bound realtime threads.
 
 o	Where can I find more information on RCU?

[PATCH 2/3] Doc: Fix wrong API example usage of call_rcu().

[Jesper Dangaard Brouer]

At some point the API of call_rcu() changed from three parameters
to two parameters, correct the documentation.

One confusing thing in RCU/listRCU.txt, which is NOT fixed in this patch,
is that no reason or explaination is given for using call_rcu() instead of
the normal synchronize_rcu() call.

Reviewed-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>

Signed-off-by: Jesper Dangaard Brouer <hawk@comx.dk>
---

 Documentation/RCU/listRCU.txt |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/RCU/listRCU.txt b/Documentation/RCU/listRCU.txt
index 1fd1753..4349c14 100644
--- a/Documentation/RCU/listRCU.txt
+++ b/Documentation/RCU/listRCU.txt
@@ -118,7 +118,7 @@ Following are the RCU equivalents for these two functions:
 		list_for_each_entry(e, list, list) {
 			if (!audit_compare_rule(rule, &e->rule)) {
 				list_del_rcu(&e->list);
-				call_rcu(&e->rcu, audit_free_rule, e);
+				call_rcu(&e->rcu, audit_free_rule);
 				return 0;
 			}
 		}
@@ -206,7 +206,7 @@ RCU ("read-copy update") its name.  The RCU code is as follows:
 				ne->rule.action = newaction;
 				ne->rule.file_count = newfield_count;
 				list_replace_rcu(e, ne);
-				call_rcu(&e->rcu, audit_free_rule, e);
+				call_rcu(&e->rcu, audit_free_rule);
 				return 0;
 			}
 		}
@@ -283,7 +283,7 @@ flag under the spinlock as follows:
 				list_del_rcu(&e->list);
 				e->deleted = 1;
 				spin_unlock(&e->lock);
-				call_rcu(&e->rcu, audit_free_rule, e);
+				call_rcu(&e->rcu, audit_free_rule);
 				return 0;
 			}
 		}

[PATCH 3/3] Doc: Fix spelling in RCU/rculist_nulls.txt.

[Jesper Dangaard Brouer]

Trival spelling fixes in RCU/rculist_nulls.txt.

Signed-off-by: Jesper Dangaard Brouer <hawk@comx.dk>
---

 Documentation/RCU/rculist_nulls.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/RCU/rculist_nulls.txt b/Documentation/RCU/rculist_nulls.txt
index 239f542..ba075b2 100644
--- a/Documentation/RCU/rculist_nulls.txt
+++ b/Documentation/RCU/rculist_nulls.txt
@@ -21,7 +21,7 @@ if (obj) {
   /*
    * Because a writer could delete object, and a writer could
    * reuse these object before the RCU grace period, we
-   * must check key after geting the reference on object
+   * must check key after getting the reference on object
    */
   if (obj->key != key) { // not the object we expected
      put_ref(obj);
@@ -117,7 +117,7 @@ a race (some writer did a delete and/or a move of an object
 to another chain) checking the final 'nulls' value if
 the lookup met the end of chain. If final 'nulls' value
 is not the slot number, then we must restart the lookup at
-the begining. If the object was moved to same chain,
+the beginning. If the object was moved to same chain,
 then the reader doesnt care : It might eventually
 scan the list again without harm.
 

Re: [PATCH 3/3] Doc: Fix spelling in RCU/rculist_nulls.txt.

[Jarek Poplawski]

Jesper Dangaard Brouer wrote, On 03/30/2009 11:03 AM:

> Trival spelling fixes in RCU/rculist_nulls.txt.
> 
> Signed-off-by: Jesper Dangaard Brouer <hawk@comx.dk>
> ---
> 
>  Documentation/RCU/rculist_nulls.txt |    4 ++--
>  1 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/RCU/rculist_nulls.txt b/Documentation/RCU/rculist_nulls.txt
> index 239f542..ba075b2 100644
> --- a/Documentation/RCU/rculist_nulls.txt
> +++ b/Documentation/RCU/rculist_nulls.txt
> @@ -21,7 +21,7 @@ if (obj) {
>    /*
>     * Because a writer could delete object, and a writer could
>     * reuse these object before the RCU grace period, we
> -   * must check key after geting the reference on object
> +   * must check key after getting the reference on object
>     */
>    if (obj->key != key) { // not the object we expected
>       put_ref(obj);
> @@ -117,7 +117,7 @@ a race (some writer did a delete and/or a move of an object
>  to another chain) checking the final 'nulls' value if
>  the lookup met the end of chain. If final 'nulls' value
>  is not the slot number, then we must restart the lookup at
> -the begining. If the object was moved to same chain,
> +the beginning. If the object was moved to same chain,


"by way":)
 +the beginning. If the object was moved to the same chain,

Jarek P.

>  then the reader doesnt care : It might eventually
>  scan the list again without harm.
>  
> 
> --
> To unsubscribe from this list: send the line "unsubscribe netdev" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> 

Re: [PATCH 3/3] Doc: Fix spelling in RCU/rculist_nulls.txt.

[Jesper Dangaard Brouer]

On Mon, 30 Mar 2009, Jarek Poplawski wrote:

> Jesper Dangaard Brouer wrote, On 03/30/2009 11:03 AM:
>
>> Trival spelling fixes in RCU/rculist_nulls.txt.
>>
>>  the lookup met the end of chain. If final 'nulls' value
>>  is not the slot number, then we must restart the lookup at
>> -the begining. If the object was moved to same chain,
>> +the beginning. If the object was moved to same chain,
>
>
> "by way":)
> +the beginning. If the object was moved to the same chain,

*LOL* this was suppose to be a simple trivial insignificant fix, but you 
are right there is _also_ missing a "the" in the sentence ;-).

Cheers,
   Jesper Brouer

--
-------------------------------------------------------------------
MSc. Master of Computer Science
Dept. of Computer Science, University of Copenhagen
Author of http://www.adsl-optimizer.dk
-------------------------------------------------------------------

Re: [PATCH 3/3] Doc: Fix spelling in RCU/rculist_nulls.txt.

[Eric Dumazet]

Jesper Dangaard Brouer a écrit :
> On Mon, 30 Mar 2009, Jarek Poplawski wrote:
> 
>> Jesper Dangaard Brouer wrote, On 03/30/2009 11:03 AM:
>>
>>> Trival spelling fixes in RCU/rculist_nulls.txt.
>>>
>>>  the lookup met the end of chain. If final 'nulls' value
>>>  is not the slot number, then we must restart the lookup at
>>> -the begining. If the object was moved to same chain,
>>> +the beginning. If the object was moved to same chain,
>>
>>
>> "by way":)
>> +the beginning. If the object was moved to the same chain,
> 
> *LOL* this was suppose to be a simple trivial insignificant fix, but you
> are right there is _also_ missing a "the" in the sentence ;-).
> 


RCU is complex, and english too, at last for me ...

I am very surprised you found so few errors in this file, that mixes these two parts :)

[PATCH v2 3/3] Doc: Fix spelling in RCU/rculist_nulls.txt.

[Jesper Dangaard Brouer]

Trival spelling fixes in RCU/rculist_nulls.txt.

Reviewed-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
Reviewed-by: Jarek Poplawski <jarkao2@gmail.com>
Signed-off-by: Jesper Dangaard Brouer <hawk@comx.dk>
---

  Documentation/RCU/rculist_nulls.txt |    4 ++--
  1 files changed, 2 insertions(+), 2 deletions(-)


diff --git a/Documentation/RCU/rculist_nulls.txt b/Documentation/RCU/rculist_nulls.txt
index 239f542..6389dec 100644
--- a/Documentation/RCU/rculist_nulls.txt
+++ b/Documentation/RCU/rculist_nulls.txt
@@ -21,7 +21,7 @@ if (obj) {
    /*
     * Because a writer could delete object, and a writer could
     * reuse these object before the RCU grace period, we
-   * must check key after geting the reference on object
+   * must check key after getting the reference on object
     */
    if (obj->key != key) { // not the object we expected
       put_ref(obj);
@@ -117,7 +117,7 @@ a race (some writer did a delete and/or a move of an object
  to another chain) checking the final 'nulls' value if
  the lookup met the end of chain. If final 'nulls' value
  is not the slot number, then we must restart the lookup at
-the begining. If the object was moved to same chain,
+the beginning. If the object was moved to the same chain,
  then the reader doesnt care : It might eventually
  scan the list again without harm.

Re: [PATCH v2 3/3] Doc: Fix spelling in RCU/rculist_nulls.txt.

[Jarek Poplawski]

On Mon, Mar 30, 2009 at 10:11:47PM +0200, Jesper Dangaard Brouer wrote:
>
> Trival spelling fixes in RCU/rculist_nulls.txt.
>
> Reviewed-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
> Reviewed-by: Jarek Poplawski <jarkao2@gmail.com>

Hmm... still "reviewing", and maybe it's only me, but can't apply...
(v1 works OK.)

Jarek P.

> Signed-off-by: Jesper Dangaard Brouer <hawk@comx.dk>
> ---
>
>  Documentation/RCU/rculist_nulls.txt |    4 ++--
>  1 files changed, 2 insertions(+), 2 deletions(-)
>
>
> diff --git a/Documentation/RCU/rculist_nulls.txt b/Documentation/RCU/rculist_nulls.txt
> index 239f542..6389dec 100644
> --- a/Documentation/RCU/rculist_nulls.txt
> +++ b/Documentation/RCU/rculist_nulls.txt
> @@ -21,7 +21,7 @@ if (obj) {
>    /*
>     * Because a writer could delete object, and a writer could
>     * reuse these object before the RCU grace period, we
> -   * must check key after geting the reference on object
> +   * must check key after getting the reference on object
>     */
>    if (obj->key != key) { // not the object we expected
>       put_ref(obj);
> @@ -117,7 +117,7 @@ a race (some writer did a delete and/or a move of an object
>  to another chain) checking the final 'nulls' value if
>  the lookup met the end of chain. If final 'nulls' value
>  is not the slot number, then we must restart the lookup at
> -the begining. If the object was moved to same chain,
> +the beginning. If the object was moved to the same chain,
>  then the reader doesnt care : It might eventually
>  scan the list again without harm.
>

Re: [PATCH v2 3/3] Doc: Fix spelling in RCU/rculist_nulls.txt.

[Jesper Dangaard Brouer]

On Tue, 31 Mar 2009, Jarek Poplawski wrote:

> On Mon, Mar 30, 2009 at 10:11:47PM +0200, Jesper Dangaard Brouer wrote:
>>
>> Trival spelling fixes in RCU/rculist_nulls.txt.
>>
>> Reviewed-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
>> Reviewed-by: Jarek Poplawski <jarkao2@gmail.com>
>
> Hmm... still "reviewing", and maybe it's only me, but can't apply...
> (v1 works OK.)

Sorry, it because my email program "pine" insists on line wrapping.  I 
have tried to adjust the preferences ("newmail-window-width" and 
"composer-wrap-column") but it still insists... grrr

It looks like that patchwork corrected the line wrappings 
(http://patchwork.ozlabs.org/patch/25337/) but if I download the patch via 
patchwork, it also fails because a space has been added in front of all 
lines, hmmm...

Okay, I'll try to repost using another email program (as reply to this 
message so patchwork will pick it up).  It amazing how much time we use on 
these nitpicks ;-)

Hilsen
   Jesper Brouer

--
-------------------------------------------------------------------
MSc. Master of Computer Science
Dept. of Computer Science, University of Copenhagen
Author of http://www.adsl-optimizer.dk
-------------------------------------------------------------------

Re: [PATCH v2 3/3] Doc: Fix spelling in RCU/rculist_nulls.txt.

[Jesper Dangaard Brouer]

Doc: Fix spelling in RCU/rculist_nulls.txt.

Trival spelling fixes in RCU/rculist_nulls.txt.

Reviewed-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>

Signed-off-by: Jesper Dangaard Brouer <hawk@comx.dk>
---

 Documentation/RCU/rculist_nulls.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)


diff --git a/Documentation/RCU/rculist_nulls.txt b/Documentation/RCU/rculist_nulls.txt
index 239f542..6389dec 100644
--- a/Documentation/RCU/rculist_nulls.txt
+++ b/Documentation/RCU/rculist_nulls.txt
@@ -21,7 +21,7 @@ if (obj) {
   /*
    * Because a writer could delete object, and a writer could
    * reuse these object before the RCU grace period, we
-   * must check key after geting the reference on object
+   * must check key after getting the reference on object
    */
   if (obj->key != key) { // not the object we expected
      put_ref(obj);
@@ -117,7 +117,7 @@ a race (some writer did a delete and/or a move of an object
 to another chain) checking the final 'nulls' value if
 the lookup met the end of chain. If final 'nulls' value
 is not the slot number, then we must restart the lookup at
-the begining. If the object was moved to same chain,
+the beginning. If the object was moved to the same chain,
 then the reader doesnt care : It might eventually
 scan the list again without harm.
 

Re: [PATCH v2 3/3] Doc: Fix spelling in RCU/rculist_nulls.txt.

[Jarek Poplawski]

On Tue, Mar 31, 2009 at 09:36:48PM +0200, Jesper Dangaard Brouer wrote:
> Doc: Fix spelling in RCU/rculist_nulls.txt.
> 
> Trival spelling fixes in RCU/rculist_nulls.txt.
> 
> Reviewed-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
> 
> Signed-off-by: Jesper Dangaard Brouer <hawk@comx.dk>
> ---

Tested-by: Jarek Poplawski <jarkao2@gmail.com;->

> 
>  Documentation/RCU/rculist_nulls.txt |    4 ++--
>  1 files changed, 2 insertions(+), 2 deletions(-)
> 
> 
> diff --git a/Documentation/RCU/rculist_nulls.txt b/Documentation/RCU/rculist_nulls.txt
> index 239f542..6389dec 100644
> --- a/Documentation/RCU/rculist_nulls.txt
> +++ b/Documentation/RCU/rculist_nulls.txt
> @@ -21,7 +21,7 @@ if (obj) {
>    /*
>     * Because a writer could delete object, and a writer could
>     * reuse these object before the RCU grace period, we
> -   * must check key after geting the reference on object
> +   * must check key after getting the reference on object
>     */
>    if (obj->key != key) { // not the object we expected
>       put_ref(obj);
> @@ -117,7 +117,7 @@ a race (some writer did a delete and/or a move of an object
>  to another chain) checking the final 'nulls' value if
>  the lookup met the end of chain. If final 'nulls' value
>  is not the slot number, then we must restart the lookup at
> -the begining. If the object was moved to same chain,
> +the beginning. If the object was moved to the same chain,
>  then the reader doesnt care : It might eventually
>  scan the list again without harm.
>  
> 
> 

Re: [PATCH 0/3] Trivial doc fixes for RCU (v3)

[David Miller]

From: Jesper Dangaard Brouer <hawk@comx.dk>
Date: Mon, 30 Mar 2009 11:02:51 +0200

> Trivial RCU documentation fixes.
> 
> It seems that majordomo eate my mail to the netdev list, as stgit
> didn't quote the email adresses correctly.  As names which have
> characters such as "." in them must be fully surrounded by
> double quotes when they appear in email headers.  For this
> to work with .gitconfig mail aliases the quotes needs to
> be escaped.
> 
> So let hope the third time is the last, for these trivial patches.

I'll toss these into a GIT tree and ask Linus to pull them.

Re: [PATCH 3/3] Doc: Fix spelling in RCU/rculist_nulls.txt.

[Paul E. McKenney]

On Sun, Mar 29, 2009 at 11:52:57PM +0200, Jesper Dangaard Brouer wrote:
> Trival spelling fixes in RCU/rculist_nulls.txt.

Good eyes!

Reviewed-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>

> Signed-off-by: Jesper Dangaard Brouer <hawk@comx.dk>
> ---
> 
>  Documentation/RCU/rculist_nulls.txt |    4 ++--
>  1 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/RCU/rculist_nulls.txt b/Documentation/RCU/rculist_nulls.txt
> index 239f542..ba075b2 100644
> --- a/Documentation/RCU/rculist_nulls.txt
> +++ b/Documentation/RCU/rculist_nulls.txt
> @@ -21,7 +21,7 @@ if (obj) {
>    /*
>     * Because a writer could delete object, and a writer could
>     * reuse these object before the RCU grace period, we
> -   * must check key after geting the reference on object
> +   * must check key after getting the reference on object
>     */
>    if (obj->key != key) { // not the object we expected
>       put_ref(obj);
> @@ -117,7 +117,7 @@ a race (some writer did a delete and/or a move of an object
>  to another chain) checking the final 'nulls' value if
>  the lookup met the end of chain. If final 'nulls' value
>  is not the slot number, then we must restart the lookup at
> -the begining. If the object was moved to same chain,
> +the beginning. If the object was moved to same chain,
>  then the reader doesnt care : It might eventually
>  scan the list again without harm.
> 
>