summaryrefslogtreecommitdiff
path: root/include/linux/list.h
diff options
context:
space:
mode:
authorAsif Rasheed <b00073877@aus.edu>2020-09-20 16:31:54 +0300
committerPaul E. McKenney <paulmck@kernel.org>2020-11-20 06:37:16 +0300
commit1eafe075bf9cb4db575be4ddf1b1c8256758714a (patch)
treee15fbb232cdf8088eb9e85176f5b0f13e05aa203 /include/linux/list.h
parentdfe564045c653d9e6969ccca57a8a04771d333f7 (diff)
downloadlinux-1eafe075bf9cb4db575be4ddf1b1c8256758714a.tar.xz
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@aus.edu> Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Diffstat (limited to 'include/linux/list.h')
-rw-r--r--include/linux/list.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/linux/list.h b/include/linux/list.h
index a18c87b63376..89bdc92e75c3 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