[PATCH v3] futex: Fix a faulty comment.

[PATCH v3] futex: Fix a faulty comment.

[Jangwoong Kim]

From: Jangwoong Kim <6812skiii@gmail.com>

Clarify that "woken" saves the last index of futex awoken.

v2 patch had a typo (awaken -> awoken).

Signed-off-by: Jangwoong Kim <6812skiii@gmail.com>
---
 kernel/futex/waitwake.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/kernel/futex/waitwake.c b/kernel/futex/waitwake.c
index 4ce0923f1ce3..45d634dacfcb 100644
--- a/kernel/futex/waitwake.c
+++ b/kernel/futex/waitwake.c
@@ -454,9 +454,9 @@ static int futex_wait_multiple_setup(struct
futex_vector *vs, int count, int *wo
                __set_current_state(TASK_RUNNING);

                /*
-                * Even if something went wrong, if we find out that a futex
-                * was woken, we don't return error and return this index to
-                * userspace
+                * Even if something went wrong, if we find out that any futex
+                * was woken, we don't return error and return the last index
+                * of futex awoken to userspace
                 */
                *woken = unqueue_multiple(vs, i);
                if (*woken >= 0)
--
2.25.1

Re: [PATCH v3] futex: Fix a faulty comment.

[André Almeida]

Hi Jangwoong,

Thank you for your new version.

No full stop at the end of commit message. I would write as follow:

"futex: Clarify comment at futex_wait_multiple_setup()"

Às 04:03 de 07/12/21, Jangwoong Kim escreveu:
> From: Jangwoong Kim <6812skiii@gmail.com>
> 
> Clarify that "woken" saves the last index of futex awoken.
> 
> v2 patch had a typo (awaken -> awoken).

The changelog is usually place bellow the `---`, so it won't made in the
git history, given that this is only relevant for reviewers.

> 
> Signed-off-by: Jangwoong Kim <6812skiii@gmail.com>
> ---

[Place changelog here]

>  kernel/futex/waitwake.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/kernel/futex/waitwake.c b/kernel/futex/waitwake.c
> index 4ce0923f1ce3..45d634dacfcb 100644
> --- a/kernel/futex/waitwake.c
> +++ b/kernel/futex/waitwake.c
> @@ -454,9 +454,9 @@ static int futex_wait_multiple_setup(struct
> futex_vector *vs, int count, int *wo
>                 __set_current_state(TASK_RUNNING);
> 
>                 /*
> -                * Even if something went wrong, if we find out that a futex
> -                * was woken, we don't return error and return this index to
> -                * userspace
> +                * Even if something went wrong, if we find out that any futex
> +                * was woken, we don't return error and return the last index
> +                * of futex awoken to userspace

I think it's the "index of the last futex awoken", no?

>                  */
>                 *woken = unqueue_multiple(vs, i);
>                 if (*woken >= 0)
> --
> 2.25.1
>