* [PATCH] Staging list.h: Modified comment
@ 2020-09-20 13:31 Asif Rasheed
2020-09-20 15:18 ` Paul E. McKenney
0 siblings, 1 reply; 3+ messages in thread
From: Asif Rasheed @ 2020-09-20 13:31 UTC (permalink / raw)
To: paulmck; +Cc: linux-kernel, b00073877
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>
---
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 0d0d17a10d25..796975c3c35c 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
--
2.24.3 (Apple Git-128)
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] Staging list.h: Modified comment
2020-09-20 13:31 [PATCH] Staging list.h: Modified comment Asif Rasheed
@ 2020-09-20 15:18 ` Paul E. McKenney
2020-09-20 17:00 ` Asif Rasheed
0 siblings, 1 reply; 3+ messages in thread
From: Paul E. McKenney @ 2020-09-20 15:18 UTC (permalink / raw)
To: Asif Rasheed; +Cc: linux-kernel
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
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] Staging list.h: Modified comment
2020-09-20 15:18 ` Paul E. McKenney
@ 2020-09-20 17:00 ` Asif Rasheed
0 siblings, 0 replies; 3+ messages in thread
From: Asif Rasheed @ 2020-09-20 17:00 UTC (permalink / raw)
To: paulmck; +Cc: linux-kernel
Everything looks good. Thank you!
Regards,
Asif Rasheed
> On 20 Sep 2020, at 7:18 PM, Paul E. McKenney <paulmck@kernel.org> wrote:
>
> 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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-09-20 17:00 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-09-20 13:31 [PATCH] Staging list.h: Modified comment Asif Rasheed
2020-09-20 15:18 ` Paul E. McKenney
2020-09-20 17:00 ` Asif Rasheed
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®