list.h: Update comment to explicitly note circular lists
authorAsif Rasheed <b00073877@aus.edu>
Sun, 20 Sep 2020 13:31:54 +0000 (17:31 +0400)
committerPaul E. McKenney <paulmck@kernel.org>
Fri, 20 Nov 2020 03:37:16 +0000 (19:37 -0800)
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

index a18c87b633768a2931c08c176c9db381594941d9..89bdc92e75c339f93a97e87352da0e1f2f193f46 100644 (file)
@@ -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