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)
commit1eafe075bf9cb4db575be4ddf1b1c8256758714a
treee15fbb232cdf8088eb9e85176f5b0f13e05aa203
parentdfe564045c653d9e6969ccca57a8a04771d333f7
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>
include/linux/list.h