[tip: core/rcu] list.h: Update comment to explicitly note circular lists

[tip-bot2 for Asif Rasheed]

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

Commit-ID:     1eafe075bf9cb4db575be4ddf1b1c8256758714a
Gitweb:        https://git.kernel.org/tip/1eafe075bf9cb4db575be4ddf1b1c8256758714a
Author:        Asif Rasheed <b00073877@xxxxxxx>
AuthorDate:    Sun, 20 Sep 2020 17:31:54 +04:00
Committer:     Paul E. McKenney <paulmck@xxxxxxxxxx>
CommitterDate: Thu, 19 Nov 2020 19:37:16 -08:00

list.h: Update comment to explicitly note circular lists

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@xxxxxxx>
Signed-off-by: Paul E. McKenney <paulmck@xxxxxxxxxx>
---
 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