Skip to contentSkip to conversation

Trivial doc fixes for RCU (v3)

PATCH In review Jesper Dangaard Brouer 5 participants 13 messages Mar 30, 2009 – Apr 2, 2009

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

cover Trivial doc fixes for RCU (v3)

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(-)
Signature · 7 lines
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
#1 lore raw

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

Trivial fix while reading through the RCU docs.

---

 Documentation/RCU/rcu.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
Documentation/RCU/rcu.txt +1 -1
index 95821a2..7aa2002 100644
@@ -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?
#2 lore raw

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

In reply to 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.

---

 Documentation/RCU/listRCU.txt |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)
Documentation/RCU/listRCU.txt +3 -3
index 1fd1753..4349c14 100644
@@ -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;
 			}
 		}
#3 lore raw

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

In reply to Jesper Dangaard Brouer

Trival spelling fixes in RCU/rculist_nulls.txt.

---

 Documentation/RCU/rculist_nulls.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
Documentation/RCU/rculist_nulls.txt +2 -2
index 239f542..ba075b2 100644
@@ -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.
 
#4 lore raw

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

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

Quoted 22 lines

Trival spelling fixes in RCU/rculist_nulls.txt.

---

 Documentation/RCU/rculist_nulls.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
Documentation/RCU/rculist_nulls.txt +1 -1
index 239f542..ba075b2 100644
@@ -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);

Documentation/RCU/rculist_nulls.txt a race (some writer did a delete and/or a move of an object · line 120

Quoted 5 lines
Documentation/RCU/rculist_nulls.txt +1 -1
@@ -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.

Quoted 9 lines
Documentation/RCU/rculist_nulls.txt +0 -1
 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 [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

#5 lore raw

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

Quoted 4 lines · Jarek Poplawski

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

Quoted 2 lines

Trival spelling fixes in RCU/rculist_nulls.txt.

Quoted 8 lines

Documentation/RCU/rculist_nulls.txt a race (some writer did a delete and/or a move of an object · line 120

Quoted 4 lines

the lookup met the end of chain. If final 'nulls' value is not the slot number, then we must restart the lookup at

Documentation/RCU/rculist_nulls.txt +1 -1
-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
-------------------------------------------------------------------

#6 lore raw

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

Quoted 15 lines · Jesper Dangaard Brouer
Quoted 4 lines · Jarek Poplawski

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

Quoted 2 lines

Trival spelling fixes in RCU/rculist_nulls.txt.

Quoted 8 lines

Documentation/RCU/rculist_nulls.txt a race (some writer did a delete and/or a move of an object · line 120

Quoted 4 lines

the lookup met the end of chain. If final 'nulls' value is not the slot number, then we must restart the lookup at

Documentation/RCU/rculist_nulls.txt +1 -1
-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,

Quoted 3 lines

*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 :)

#7 lore raw

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

In reply to Jesper Dangaard Brouer

Trival spelling fixes in RCU/rculist_nulls.txt.

---

 Documentation/RCU/rculist_nulls.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
Documentation/RCU/rculist_nulls.txt +2 -2
index 239f542..6389dec 100644
@@ -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.
 
#8 lore raw

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

Quoted 5 lines · Jesper Dangaard Brouer

Trival spelling fixes in RCU/rculist_nulls.txt.

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

Jarek P.

Quoted 29 lines

---

 Documentation/RCU/rculist_nulls.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
Documentation/RCU/rculist_nulls.txt +2 -2
index 239f542..6389dec 100644
@@ -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.
 
#9 lore raw

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

Quoted 9 lines · Jarek Poplawski
Quoted 5 lines · Jesper Dangaard Brouer

Trival spelling fixes in RCU/rculist_nulls.txt.

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
-------------------------------------------------------------------

author Reviewed-by Paul E. McKenney
#10 lore raw

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

Doc: Fix spelling in RCU/rculist_nulls.txt.

Trival spelling fixes in RCU/rculist_nulls.txt.

---

 Documentation/RCU/rculist_nulls.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
Documentation/RCU/rculist_nulls.txt +2 -2
index 239f542..6389dec 100644
@@ -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.
 
Tested-by
#11 lore raw

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

Quoted 8 lines · Jesper Dangaard Brouer

Doc: Fix spelling in RCU/rculist_nulls.txt.

Trival spelling fixes in RCU/rculist_nulls.txt.

---

Quoted 29 lines
 Documentation/RCU/rculist_nulls.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
Documentation/RCU/rculist_nulls.txt +2 -2
index 239f542..6389dec 100644
@@ -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.
 
maintainer
#12 lore raw
In reply to Jesper Dangaard Brouer

From: Jesper Dangaard Brouer <[email protected]>
Date: Mon, 30 Mar 2009 11:02:51 +0200

Quoted 10 lines

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.