linux-kernel - [tip: core/rcu] doc/RCU/listRCU: Update example function name

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Date:   Tue, 24 Mar 2020 09:16:28 -0000
From:   "tip-bot2 for SeongJae Park" <tip-bot2@...utronix.de>
To:     linux-tip-commits@...r.kernel.org
Cc:     Madhuparna Bhowmik <madhuparnabhowmik04@...il.com>,
        SeongJae Park <sjpark@...zon.de>,
        "Paul E. McKenney" <paulmck@...nel.org>, x86 <x86@...nel.org>,
        LKML <linux-kernel@...r.kernel.org>
Subject: [tip: core/rcu] doc/RCU/listRCU: Update example function name

The following commit has been merged into the core/rcu branch of tip:

Commit-ID:     3282b0469248ab25b3f40b95e9a3d357c9d946d5
Gitweb:        https://git.kernel.org/tip/3282b0469248ab25b3f40b95e9a3d357c9d946d5
Author:        SeongJae Park <sjpark@...zon.de>
AuthorDate:    Mon, 06 Jan 2020 21:07:58 +01:00
Committer:     Paul E. McKenney <paulmck@...nel.org>
CommitterDate: Thu, 27 Feb 2020 07:03:13 -08:00

doc/RCU/listRCU: Update example function name

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.

Reviewed-by: Madhuparna Bhowmik <madhuparnabhowmik04@...il.com>
Signed-off-by: SeongJae Park <sjpark@...zon.de>
Signed-off-by: Paul E. McKenney <paulmck@...nel.org>
---
 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 e768f56..2a643e2 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: