diff mbox series

[1/2] yama: document function parameter

Message ID 20240315125418.273104-2-cgzones@googlemail.com (mailing list archive)
State Under Review
Delegated to: Paul Moore
Headers show
Series [1/2] yama: document function parameter | expand

Commit Message

Christian Göttsche March 15, 2024, 12:54 p.m. UTC
Document the unused function parameter of yama_relation_cleanup() to
please kernel doc warnings.

Signed-off-by: Christian Göttsche <cgzones@googlemail.com>
---
 security/yama/yama_lsm.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Paul Moore March 26, 2024, 7:18 p.m. UTC | #1
On Fri, Mar 15, 2024 at 8:54 AM Christian Göttsche
<cgzones@googlemail.com> wrote:
>
> Document the unused function parameter of yama_relation_cleanup() to
> please kernel doc warnings.
>
> Signed-off-by: Christian Göttsche <cgzones@googlemail.com>
> ---
>  security/yama/yama_lsm.c | 1 +
>  1 file changed, 1 insertion(+)

One small comment below, but otherwise looks okay to me.

Reviewed-by:

> diff --git a/security/yama/yama_lsm.c b/security/yama/yama_lsm.c
> index 49dc52b454ef..f8e4acd41b72 100644
> --- a/security/yama/yama_lsm.c
> +++ b/security/yama/yama_lsm.c
> @@ -111,6 +111,7 @@ static void report_access(const char *access, struct task_struct *target,
>
>  /**
>   * yama_relation_cleanup - remove invalid entries from the relation list
> + * @work: unused
>   *
>   */
>  static void yama_relation_cleanup(struct work_struct *work)

Should we also take this opportunity to mark the parameter as '__always_unused'?
Paul Moore March 26, 2024, 7:18 p.m. UTC | #2
On Tue, Mar 26, 2024 at 3:18 PM Paul Moore <paul@paul-moore.com> wrote:
>
> On Fri, Mar 15, 2024 at 8:54 AM Christian Göttsche
> <cgzones@googlemail.com> wrote:
> >
> > Document the unused function parameter of yama_relation_cleanup() to
> > please kernel doc warnings.
> >
> > Signed-off-by: Christian Göttsche <cgzones@googlemail.com>
> > ---
> >  security/yama/yama_lsm.c | 1 +
> >  1 file changed, 1 insertion(+)
>
> One small comment below, but otherwise looks okay to me.
>
> Reviewed-by:

Bah, let's try that again ...

Reviewed-by: Paul Moore <paul@paul-moore.com>

> > diff --git a/security/yama/yama_lsm.c b/security/yama/yama_lsm.c
> > index 49dc52b454ef..f8e4acd41b72 100644
> > --- a/security/yama/yama_lsm.c
> > +++ b/security/yama/yama_lsm.c
> > @@ -111,6 +111,7 @@ static void report_access(const char *access, struct task_struct *target,
> >
> >  /**
> >   * yama_relation_cleanup - remove invalid entries from the relation list
> > + * @work: unused
> >   *
> >   */
> >  static void yama_relation_cleanup(struct work_struct *work)
>
> Should we also take this opportunity to mark the parameter as '__always_unused'?
Kees Cook March 28, 2024, 10:06 p.m. UTC | #3
On Fri, Mar 15, 2024 at 01:54:10PM +0100, Christian Göttsche wrote:
> Document the unused function parameter of yama_relation_cleanup() to
> please kernel doc warnings.
> 
> Signed-off-by: Christian Göttsche <cgzones@googlemail.com>

Reviewed-by: Kees Cook <keescook@chromium.org>
diff mbox series

Patch

diff --git a/security/yama/yama_lsm.c b/security/yama/yama_lsm.c
index 49dc52b454ef..f8e4acd41b72 100644
--- a/security/yama/yama_lsm.c
+++ b/security/yama/yama_lsm.c
@@ -111,6 +111,7 @@  static void report_access(const char *access, struct task_struct *target,
 
 /**
  * yama_relation_cleanup - remove invalid entries from the relation list
+ * @work: unused
  *
  */
 static void yama_relation_cleanup(struct work_struct *work)