* [PATCH 0/7] Fix trivial nits in RCU docs
@ 2019-12-31 15:15 sj38.park
2019-12-31 15:15 ` [PATCH 1/7] doc/RCU/Design: Remove remaining HTML tags in ReST files sj38.park
` (6 more replies)
0 siblings, 7 replies; 10+ messages in thread
From: sj38.park @ 2019-12-31 15:15 UTC (permalink / raw)
To: paulmck; +Cc: corbet, rcu, linux-doc, linux-kernel, SeongJae Park
From: SeongJae Park <sjpark@amazon.de>
This patchset fixes trivial nits in the RCU documentations.
SeongJae Park (7):
doc/RCU/Design: Remove remaining HTML tags in ReST files
doc/RCU/listRCU: Fix typos in a example code snippets
doc/RCU/listRCU: Update example function name
doc/RCU/rcu: Use ':ref:' for links to other docs
doc/RCU/rcu: Use absolute paths for non-rst files
doc/RCU/rcu: Use https instead of http if possible
rcu: Fix typos in beginning comments
.../Tree-RCU-Memory-Ordering.rst | 8 ++++----
Documentation/RCU/listRCU.rst | 10 +++++-----
Documentation/RCU/rcu.rst | 18 +++++++++---------
kernel/rcu/srcutree.c | 2 +-
kernel/rcu/tree.c | 4 ++--
5 files changed, 21 insertions(+), 21 deletions(-)
--
2.17.1
^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH 1/7] doc/RCU/Design: Remove remaining HTML tags in ReST files
2019-12-31 15:15 [PATCH 0/7] Fix trivial nits in RCU docs sj38.park
@ 2019-12-31 15:15 ` sj38.park
2019-12-31 15:15 ` [PATCH 2/7] doc/RCU/listRCU: Fix typos in a example code snippets sj38.park
` (5 subsequent siblings)
6 siblings, 0 replies; 10+ messages in thread
From: sj38.park @ 2019-12-31 15:15 UTC (permalink / raw)
To: paulmck; +Cc: corbet, rcu, linux-doc, linux-kernel, SeongJae Park
From: SeongJae Park <sjpark@amazon.de>
Commit ccc9971e2147 ("docs: rcu: convert some articles from html to
ReST") has converted a few of html RCU docs into ReST files, but a few
of html tags which not supported on rst is remaining. This commit
converts those to ReST appropriate alternatives.
Signed-off-by: SeongJae Park <sjpark@amazon.de>
---
.../Design/Memory-Ordering/Tree-RCU-Memory-Ordering.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/RCU/Design/Memory-Ordering/Tree-RCU-Memory-Ordering.rst b/Documentation/RCU/Design/Memory-Ordering/Tree-RCU-Memory-Ordering.rst
index 1a8b129cfc04..83ae3b79a643 100644
--- a/Documentation/RCU/Design/Memory-Ordering/Tree-RCU-Memory-Ordering.rst
+++ b/Documentation/RCU/Design/Memory-Ordering/Tree-RCU-Memory-Ordering.rst
@@ -4,7 +4,7 @@ A Tour Through TREE_RCU's Grace-Period Memory Ordering
August 8, 2017
-This article was contributed by Paul E. McKenney
+This article was contributed by Paul E. McKenney
Introduction
============
@@ -48,7 +48,7 @@ Tree RCU Grace Period Memory Ordering Building Blocks
The workhorse for RCU's grace-period memory ordering is the
critical section for the ``rcu_node`` structure's
-``->lock``. These critical sections use helper functions for lock
+``->lock``. These critical sections use helper functions for lock
acquisition, including ``raw_spin_lock_rcu_node()``,
``raw_spin_lock_irq_rcu_node()``, and ``raw_spin_lock_irqsave_rcu_node()``.
Their lock-release counterparts are ``raw_spin_unlock_rcu_node()``,
@@ -102,9 +102,9 @@ lock-acquisition and lock-release functions::
23 r3 = READ_ONCE(x);
24 }
25
- 26 WARN_ON(r1 == 0 && r2 == 0 && r3 == 0);
+ 26 WARN_ON(r1 == 0 && r2 == 0 && r3 == 0);
-The ``WARN_ON()`` is evaluated at “the end of time”,
+The ``WARN_ON()`` is evaluated at "the end of time",
after all changes have propagated throughout the system.
Without the ``smp_mb__after_unlock_lock()`` provided by the
acquisition functions, this ``WARN_ON()`` could trigger, for example
--
2.17.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH 2/7] doc/RCU/listRCU: Fix typos in a example code snippets
2019-12-31 15:15 [PATCH 0/7] Fix trivial nits in RCU docs sj38.park
2019-12-31 15:15 ` [PATCH 1/7] doc/RCU/Design: Remove remaining HTML tags in ReST files sj38.park
@ 2019-12-31 15:15 ` sj38.park
2019-12-31 15:15 ` [PATCH 3/7] doc/RCU/listRCU: Update example function name sj38.park
` (4 subsequent siblings)
6 siblings, 0 replies; 10+ messages in thread
From: sj38.park @ 2019-12-31 15:15 UTC (permalink / raw)
To: paulmck
Cc: corbet, rcu, linux-doc, linux-kernel, SeongJae Park, SeongJae Park
From: SeongJae Park <sjpark@amazon.de>
Signed-off-by: SeongJae Park <sj38.park@amazon.de>
---
Documentation/RCU/listRCU.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/RCU/listRCU.rst b/Documentation/RCU/listRCU.rst
index 55d2b30db481..e768f56e8fa3 100644
--- a/Documentation/RCU/listRCU.rst
+++ b/Documentation/RCU/listRCU.rst
@@ -226,7 +226,7 @@ need to be filled in)::
list_for_each_entry(e, list, list) {
if (!audit_compare_rule(rule, &e->rule)) {
e->rule.action = newaction;
- e->rule.file_count = newfield_count;
+ e->rule.field_count = newfield_count;
write_unlock(&auditsc_lock);
return 0;
}
@@ -255,7 +255,7 @@ RCU (*read-copy update*) its name. The RCU code is as follows::
return -ENOMEM;
audit_copy_rule(&ne->rule, &e->rule);
ne->rule.action = newaction;
- ne->rule.file_count = newfield_count;
+ ne->rule.field_count = newfield_count;
list_replace_rcu(&e->list, &ne->list);
call_rcu(&e->rcu, audit_free_rule);
return 0;
--
2.17.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH 3/7] doc/RCU/listRCU: Update example function name
2019-12-31 15:15 [PATCH 0/7] Fix trivial nits in RCU docs sj38.park
2019-12-31 15:15 ` [PATCH 1/7] doc/RCU/Design: Remove remaining HTML tags in ReST files sj38.park
2019-12-31 15:15 ` [PATCH 2/7] doc/RCU/listRCU: Fix typos in a example code snippets sj38.park
@ 2019-12-31 15:15 ` sj38.park
2019-12-31 15:15 ` [PATCH 4/7] doc/RCU/rcu: Use ':ref:' for links to other docs sj38.park
` (3 subsequent siblings)
6 siblings, 0 replies; 10+ messages in thread
From: sj38.park @ 2019-12-31 15:15 UTC (permalink / raw)
To: paulmck; +Cc: corbet, rcu, linux-doc, linux-kernel, SeongJae Park
From: SeongJae Park <sjpark@amazon.de>
listRCU.rst document gives an example with 'ipc_lock()', but the
function has dropped off by commit 82061c57ce93 ("ipc: drop
ipc_lock()"). Because the main logic of 'ipc_lock()' has melded in
'shm_lock()' by the commit, this commit updates the document to use
'shm_lock()' instead.
Signed-off-by: SeongJae Park <sjpark@amazon.de>
---
Documentation/RCU/listRCU.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/RCU/listRCU.rst b/Documentation/RCU/listRCU.rst
index e768f56e8fa3..2a643e293fb4 100644
--- a/Documentation/RCU/listRCU.rst
+++ b/Documentation/RCU/listRCU.rst
@@ -286,11 +286,11 @@ time the external state changes before Linux becomes aware of the change,
additional RCU-induced staleness is generally not a problem.
However, there are many examples where stale data cannot be tolerated.
-One example in the Linux kernel is the System V IPC (see the ipc_lock()
-function in ipc/util.c). This code checks a *deleted* flag under a
+One example in the Linux kernel is the System V IPC (see the shm_lock()
+function in ipc/shm.c). This code checks a *deleted* flag under a
per-entry spinlock, and, if the *deleted* flag is set, pretends that the
entry does not exist. For this to be helpful, the search function must
-return holding the per-entry lock, as ipc_lock() does in fact do.
+return holding the per-entry spinlock, as shm_lock() does in fact do.
.. _quick_quiz:
--
2.17.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH 4/7] doc/RCU/rcu: Use ':ref:' for links to other docs
2019-12-31 15:15 [PATCH 0/7] Fix trivial nits in RCU docs sj38.park
` (2 preceding siblings ...)
2019-12-31 15:15 ` [PATCH 3/7] doc/RCU/listRCU: Update example function name sj38.park
@ 2019-12-31 15:15 ` sj38.park
2019-12-31 15:15 ` [PATCH 5/7] doc/RCU/rcu: Use absolute paths for non-rst files sj38.park
` (2 subsequent siblings)
6 siblings, 0 replies; 10+ messages in thread
From: sj38.park @ 2019-12-31 15:15 UTC (permalink / raw)
To: paulmck; +Cc: corbet, rcu, linux-doc, linux-kernel, SeongJae Park
From: SeongJae Park <sjpark@amazon.de>
Signed-off-by: SeongJae Park <sjpark@amazon.de>
---
Documentation/RCU/rcu.rst | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/RCU/rcu.rst b/Documentation/RCU/rcu.rst
index 8dfb437dacc3..a1dd71d01862 100644
--- a/Documentation/RCU/rcu.rst
+++ b/Documentation/RCU/rcu.rst
@@ -11,8 +11,8 @@ must be long enough that any readers accessing the item being deleted have
since dropped their references. For example, an RCU-protected deletion
from a linked list would first remove the item from the list, wait for
a grace period to elapse, then free the element. See the
-Documentation/RCU/listRCU.rst file for more information on using RCU with
-linked lists.
+:ref:`Documentation/RCU/listRCU.rst <list_rcu_doc>` for more information on
+using RCU with linked lists.
Frequently Asked Questions
--------------------------
@@ -50,7 +50,7 @@ Frequently Asked Questions
- If I am running on a uniprocessor kernel, which can only do one
thing at a time, why should I wait for a grace period?
- See the Documentation/RCU/UP.rst file for more information.
+ See :ref:`Documentation/RCU/UP.rst <up_doc>` for more information.
- How can I see where RCU is currently used in the Linux kernel?
@@ -68,9 +68,9 @@ Frequently Asked Questions
- Why the name "RCU"?
- "RCU" stands for "read-copy update". The file Documentation/RCU/listRCU.rst
- has more information on where this name came from, search for
- "read-copy update" to find it.
+ "RCU" stands for "read-copy update".
+ :ref:`Documentation/RCU/listRCU.rst <list_rcu_doc>` has more information on where
+ this name came from, search for "read-copy update" to find it.
- I hear that RCU is patented? What is with that?
--
2.17.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH 5/7] doc/RCU/rcu: Use absolute paths for non-rst files
2019-12-31 15:15 [PATCH 0/7] Fix trivial nits in RCU docs sj38.park
` (3 preceding siblings ...)
2019-12-31 15:15 ` [PATCH 4/7] doc/RCU/rcu: Use ':ref:' for links to other docs sj38.park
@ 2019-12-31 15:15 ` sj38.park
2019-12-31 15:15 ` [PATCH 6/7] doc/RCU/rcu: Use https instead of http if possible sj38.park
2019-12-31 15:15 ` [PATCH 7/7] rcu: Fix typos in beginning comments sj38.park
6 siblings, 0 replies; 10+ messages in thread
From: sj38.park @ 2019-12-31 15:15 UTC (permalink / raw)
To: paulmck; +Cc: corbet, rcu, linux-doc, linux-kernel, SeongJae Park
From: SeongJae Park <sjpark@amazon.de>
Signed-off-by: SeongJae Park <sjpark@amazon.de>
---
Documentation/RCU/rcu.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/RCU/rcu.rst b/Documentation/RCU/rcu.rst
index a1dd71d01862..2a830c51477e 100644
--- a/Documentation/RCU/rcu.rst
+++ b/Documentation/RCU/rcu.rst
@@ -75,7 +75,7 @@ Frequently Asked Questions
- I hear that RCU is patented? What is with that?
Yes, it is. There are several known patents related to RCU,
- search for the string "Patent" in RTFP.txt to find them.
+ search for the string "Patent" in Documentation/RCU/RTFP.txt to find them.
Of these, one was allowed to lapse by the assignee, and the
others have been contributed to the Linux kernel under GPL.
There are now also LGPL implementations of user-level RCU
@@ -88,5 +88,5 @@ Frequently Asked Questions
- Where can I find more information on RCU?
- See the RTFP.txt file in this directory.
+ See the Documentation/RCU/RTFP.txt file.
Or point your browser at (http://www.rdrop.com/users/paulmck/RCU/).
--
2.17.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH 6/7] doc/RCU/rcu: Use https instead of http if possible
2019-12-31 15:15 [PATCH 0/7] Fix trivial nits in RCU docs sj38.park
` (4 preceding siblings ...)
2019-12-31 15:15 ` [PATCH 5/7] doc/RCU/rcu: Use absolute paths for non-rst files sj38.park
@ 2019-12-31 15:15 ` sj38.park
2020-01-06 18:35 ` Paul E. McKenney
2019-12-31 15:15 ` [PATCH 7/7] rcu: Fix typos in beginning comments sj38.park
6 siblings, 1 reply; 10+ messages in thread
From: sj38.park @ 2019-12-31 15:15 UTC (permalink / raw)
To: paulmck; +Cc: corbet, rcu, linux-doc, linux-kernel, SeongJae Park
From: SeongJae Park <sjpark@amazon.de>
Signed-off-by: SeongJae Park <sjpark@amazon.de>
---
Documentation/RCU/rcu.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/RCU/rcu.rst b/Documentation/RCU/rcu.rst
index 2a830c51477e..0e03c6ef3147 100644
--- a/Documentation/RCU/rcu.rst
+++ b/Documentation/RCU/rcu.rst
@@ -79,7 +79,7 @@ Frequently Asked Questions
Of these, one was allowed to lapse by the assignee, and the
others have been contributed to the Linux kernel under GPL.
There are now also LGPL implementations of user-level RCU
- available (http://liburcu.org/).
+ available (https://liburcu.org/).
- I hear that RCU needs work in order to support realtime kernels?
--
2.17.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH 7/7] rcu: Fix typos in beginning comments
2019-12-31 15:15 [PATCH 0/7] Fix trivial nits in RCU docs sj38.park
` (5 preceding siblings ...)
2019-12-31 15:15 ` [PATCH 6/7] doc/RCU/rcu: Use https instead of http if possible sj38.park
@ 2019-12-31 15:15 ` sj38.park
6 siblings, 0 replies; 10+ messages in thread
From: sj38.park @ 2019-12-31 15:15 UTC (permalink / raw)
To: paulmck; +Cc: corbet, rcu, linux-doc, linux-kernel, SeongJae Park
From: SeongJae Park <sjpark@amazon.de>
Signed-off-by: SeongJae Park <sjpark@amazon.de>
---
kernel/rcu/srcutree.c | 2 +-
kernel/rcu/tree.c | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/kernel/rcu/srcutree.c b/kernel/rcu/srcutree.c
index 119a37319e67..a0892a9e2bf7 100644
--- a/kernel/rcu/srcutree.c
+++ b/kernel/rcu/srcutree.c
@@ -5,7 +5,7 @@
* Copyright (C) IBM Corporation, 2006
* Copyright (C) Fujitsu, 2012
*
- * Author: Paul McKenney <paulmck@linux.ibm.com>
+ * Authors: Paul McKenney <paulmck@linux.ibm.com>
* Lai Jiangshan <laijs@cn.fujitsu.com>
*
* For detailed explanation of Read-Copy Update mechanism see -
diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
index 48fba2257748..ab7cbe71f57b 100644
--- a/kernel/rcu/tree.c
+++ b/kernel/rcu/tree.c
@@ -1,12 +1,12 @@
// SPDX-License-Identifier: GPL-2.0+
/*
- * Read-Copy Update mechanism for mutual exclusion
+ * Read-Copy Update mechanism for mutual exclusion (tree-based version)
*
* Copyright IBM Corporation, 2008
*
* Authors: Dipankar Sarma <dipankar@in.ibm.com>
* Manfred Spraul <manfred@colorfullife.com>
- * Paul E. McKenney <paulmck@linux.ibm.com> Hierarchical version
+ * Paul E. McKenney <paulmck@linux.ibm.com>
*
* Based on the original work by Paul McKenney <paulmck@linux.ibm.com>
* and inputs from Rusty Russell, Andrea Arcangeli and Andi Kleen.
--
2.17.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: [PATCH 6/7] doc/RCU/rcu: Use https instead of http if possible
2019-12-31 15:15 ` [PATCH 6/7] doc/RCU/rcu: Use https instead of http if possible sj38.park
@ 2020-01-06 18:35 ` Paul E. McKenney
2020-01-06 19:02 ` SeongJae Park
0 siblings, 1 reply; 10+ messages in thread
From: Paul E. McKenney @ 2020-01-06 18:35 UTC (permalink / raw)
To: madhuparnabhowmik04
Cc: sj38.park, joel, frextrite, corbet, rcu, linux-doc, linux-kernel,
SeongJae Park
On Mon, Jan 06, 2020 at 06:59:51PM +0530, madhuparnabhowmik04@gmail.com wrote:
> From: sj38.park@gmail.com
>
> From: SeongJae Park <sjpark@amazon.de>
>
> Signed-off-by: SeongJae Park <sjpark@amazon.de>
>
> Hi SeongJae,
>
> The patch looks fine, but I am not sure if this change is required.
> What do you think Paul?
Thank you, Madhuparna! This change might not be absolutely required,
but it is a good change.
SeongJae, could you please include Madhuparna's pair of Reviewed-by
tags and also make your email address consistent in your next posting?
You currently have both sj38.park@gmail.com and sjpark@amazon.de.
Either is fine. ;-)
Thanx, Paul
> Thanks,
> Madhuparna
>
> ---
> Documentation/RCU/rcu.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/RCU/rcu.rst b/Documentation/RCU/rcu.rst
> index 2a830c51477e..0e03c6ef3147 100644
> --- a/Documentation/RCU/rcu.rst
> +++ b/Documentation/RCU/rcu.rst
> @@ -79,7 +79,7 @@ Frequently Asked Questions
> Of these, one was allowed to lapse by the assignee, and the
> others have been contributed to the Linux kernel under GPL.
> There are now also LGPL implementations of user-level RCU
> - available (http://liburcu.org/).
> + available (https://liburcu.org/).
>
> - I hear that RCU needs work in order to support realtime kernels?
>
> --
> 2.17.1
>
>
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: Re: [PATCH 6/7] doc/RCU/rcu: Use https instead of http if possible
2020-01-06 18:35 ` Paul E. McKenney
@ 2020-01-06 19:02 ` SeongJae Park
0 siblings, 0 replies; 10+ messages in thread
From: SeongJae Park @ 2020-01-06 19:02 UTC (permalink / raw)
To: Paul E. McKenney
Cc: madhuparnabhowmik04, sj38.park, joel, frextrite, corbet, rcu,
linux-doc, linux-kernel, SeongJae Park
On Mon, 6 Jan 2020 10:35:43 -0800 "Paul E. McKenney" <paulmck@kernel.org> wrote:
> On Mon, Jan 06, 2020 at 06:59:51PM +0530, madhuparnabhowmik04@gmail.com wrote:
> > From: sj38.park@gmail.com
> >
> > From: SeongJae Park <sjpark@amazon.de>
> >
> > Signed-off-by: SeongJae Park <sjpark@amazon.de>
> >
> > Hi SeongJae,
> >
> > The patch looks fine, but I am not sure if this change is required.
> > What do you think Paul?
>
> Thank you, Madhuparna! This change might not be absolutely required,
> but it is a good change.
Sorry for late reply, Madhuparna. I made this patch because I seen a commit
converting http urls to https url for a document. However, I couldn't find the
commit again. Maybe my confusion. So, please drop this if you have any doubt,
Paul.
>
> SeongJae, could you please include Madhuparna's pair of Reviewed-by
> tags and also make your email address consistent in your next posting?
> You currently have both sj38.park@gmail.com and sjpark@amazon.de.
> Either is fine. ;-)
Yes, of course, and sorry for the mistake. I will use sjpark@amazon.de for
this patchset. Will send the second version soon.
Thanks,
SeongJae Park
>
> Thanx, Paul
>
> > Thanks,
> > Madhuparna
> >
> > ---
> > Documentation/RCU/rcu.rst | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/RCU/rcu.rst b/Documentation/RCU/rcu.rst
> > index 2a830c51477e..0e03c6ef3147 100644
> > --- a/Documentation/RCU/rcu.rst
> > +++ b/Documentation/RCU/rcu.rst
> > @@ -79,7 +79,7 @@ Frequently Asked Questions
> > Of these, one was allowed to lapse by the assignee, and the
> > others have been contributed to the Linux kernel under GPL.
> > There are now also LGPL implementations of user-level RCU
> > - available (http://liburcu.org/).
> > + available (https://liburcu.org/).
> >
> > - I hear that RCU needs work in order to support realtime kernels?
> >
> > --
> > 2.17.1
> >
> >
^ permalink raw reply [flat|nested] 10+ messages in thread
end of thread, other threads:[~2020-01-06 19:02 UTC | newest]
Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-12-31 15:15 [PATCH 0/7] Fix trivial nits in RCU docs sj38.park
2019-12-31 15:15 ` [PATCH 1/7] doc/RCU/Design: Remove remaining HTML tags in ReST files sj38.park
2019-12-31 15:15 ` [PATCH 2/7] doc/RCU/listRCU: Fix typos in a example code snippets sj38.park
2019-12-31 15:15 ` [PATCH 3/7] doc/RCU/listRCU: Update example function name sj38.park
2019-12-31 15:15 ` [PATCH 4/7] doc/RCU/rcu: Use ':ref:' for links to other docs sj38.park
2019-12-31 15:15 ` [PATCH 5/7] doc/RCU/rcu: Use absolute paths for non-rst files sj38.park
2019-12-31 15:15 ` [PATCH 6/7] doc/RCU/rcu: Use https instead of http if possible sj38.park
2020-01-06 18:35 ` Paul E. McKenney
2020-01-06 19:02 ` SeongJae Park
2019-12-31 15:15 ` [PATCH 7/7] rcu: Fix typos in beginning comments sj38.park
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).