public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: paulmck@kernel.org
To: rcu@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, kernel-team@fb.com,
	mingo@kernel.org, jiangshanlai@gmail.com,
	akpm@linux-foundation.org, mathieu.desnoyers@efficios.com,
	josh@joshtriplett.org, tglx@linutronix.de, peterz@infradead.org,
	rostedt@goodmis.org, dhowells@redhat.com, edumazet@google.com,
	fweisbec@gmail.com, oleg@redhat.com, joel@joelfernandes.org,
	Asif Rasheed <b00073877@aus.edu>,
	"Paul E . McKenney" <paulmck@kernel.org>
Subject: [PATCH tip/core/rcu 04/16] list.h: Update comment to explicitly note circular lists
Date: Thu,  5 Nov 2020 15:09:09 -0800	[thread overview]
Message-ID: <20201105230921.19017-4-paulmck@kernel.org> (raw)
In-Reply-To: <20201105230856.GA18904@paulmck-ThinkPad-P72>

From: Asif Rasheed <b00073877@aus.edu>

The students in the Operating System Lecture Section at the
American University of Sharjah were confused by the header comment
in include/linux/list.h, which says "Simple doubly linked list
implementation".  This comment means "simple" as in "not complex",
but "simple" is often used in this context to mean "not circular".
This commit therefore avoids this ambiguity by explicitly calling out
"circular".

Signed-off-by: Asif Rasheed <b00073877@aus.edu>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
---
 include/linux/list.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/list.h b/include/linux/list.h
index a18c87b..89bdc92 100644
--- a/include/linux/list.h
+++ b/include/linux/list.h
@@ -9,7 +9,7 @@
 #include <linux/kernel.h>
 
 /*
- * Simple doubly linked list implementation.
+ * Circular doubly linked list implementation.
  *
  * Some of the internal functions ("__xxx") are useful when
  * manipulating whole lists rather than single entries, as
-- 
2.9.5


  parent reply	other threads:[~2020-11-05 23:09 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-05 23:08 [PATCH tip/core/rcu 0/16] Miscellaneous fixes for v5.11 Paul E. McKenney
2020-11-05 23:09 ` [PATCH tip/core/rcu 01/16] rcu: Don't invoke try_invoke_on_locked_down_task() with irqs disabled paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 02/16] x86/smpboot: Move rcu_cpu_starting() earlier paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 03/16] rcu: Panic after fixed number of stalls paulmck
2020-11-05 23:09 ` paulmck [this message]
2020-11-05 23:09 ` [PATCH tip/core/rcu 05/16] rcu: Implement rcu_segcblist_is_offloaded() config dependent paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 06/16] rcu: Fix single-CPU check in rcu_blocking_is_gp() paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 07/16] rcu: Clarify nocb kthreads naming in RCU_NOCB_CPU config paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 08/16] rcu/tree: Add a warning if CPU being onlined did not report QS already paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 09/16] rcu/tree: Make struct kernel_param_ops definitions const paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 10/16] rcu,ftrace: Fix ftrace recursion paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 11/16] rcu/tree: nocb: Avoid raising softirq for offloaded ready-to-execute CBs paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 12/16] rcu: Prevent lockdep-RCU splats on lock acquisition/release paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 13/16] rcu: Fix a typo in rcu_blocking_is_gp() header comment paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 14/16] rcu: Do not report strict GPs for outgoing CPUs paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 15/16] rcu/tree: Defer kvfree_rcu() allocation to a clean context paulmck
2020-11-05 23:09 ` [PATCH tip/core/rcu 16/16] srcu: Take early exit on memory-allocation failure paulmck

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201105230921.19017-4-paulmck@kernel.org \
    --to=paulmck@kernel.org \
    --cc=akpm@linux-foundation.org \
    --cc=b00073877@aus.edu \
    --cc=dhowells@redhat.com \
    --cc=edumazet@google.com \
    --cc=fweisbec@gmail.com \
    --cc=jiangshanlai@gmail.com \
    --cc=joel@joelfernandes.org \
    --cc=josh@joshtriplett.org \
    --cc=kernel-team@fb.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mathieu.desnoyers@efficios.com \
    --cc=mingo@kernel.org \
    --cc=oleg@redhat.com \
    --cc=peterz@infradead.org \
    --cc=rcu@vger.kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=tglx@linutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox