lkml.org 
[lkml]   [2020]   [Sep]   [20]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
SubjectRe: [PATCH] Staging list.h: Modified comment
On Sun, Sep 20, 2020 at 05:31:54PM +0400, Asif Rasheed wrote:
> We (everyone from my Operating System Lecture Section) were confused on whether the list is circular or not (because no one bothered to look at the implementation). Modified the comment on top for clarification.
>
> Signed-off-by: Asif Rasheed <b00073877@aus.edu>

Good point! "Simple" here means "not complex", but given the size of
this file, one could argue that this characterization is long obsolete.

I queued your patch for v5.11, but as usual could not resist the
urge to edit the commit log. Could you please review the version
below to make sure that I did not mess anything up?

Thanx, Paul

------------------------------------------------------------------------

commit 8ac8c191b5f1a42b02462d5b35675f2439097b86
Author: Asif Rasheed <b00073877@aus.edu>
Date: Sun Sep 20 17:31:54 2020 +0400

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>

diff --git a/include/linux/list.h b/include/linux/list.h
index 0d0d17a..796975c 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
\
 
 \ /
  Last update: 2020-09-20 17:18    [W:0.084 / U:1.808 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site