[PATCH 2/2] apparmor: fix typo in kernel doc

[PATCH 2/2] apparmor: fix typo in kernel doc

[Christian Göttsche]

Fix the typo in the function documentation to please kernel doc
warnings.

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

diff --git a/security/apparmor/lsm.c b/security/apparmor/lsm.c
index cef8c466af80..d0485fb0ed63 100644
--- a/security/apparmor/lsm.c
+++ b/security/apparmor/lsm.c
@@ -1124,7 +1124,7 @@ static int apparmor_socket_create(int family, int type, int protocol, int kern)
  * @sock: socket that is being setup
  * @family: family of socket being created
  * @type: type of the socket
- * @ptotocol: protocol of the socket
+ * @protocol: protocol of the socket
  * @kern: socket is a special kernel socket
  *
  * Note:
-- 
2.43.0

[PATCH 1/2] yama: document function parameter

[Christian Göttsche]

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(+)

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)
-- 
2.43.0

Re: [PATCH 1/2] yama: document function parameter

[Paul Moore]

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.com

Re: [PATCH 1/2] yama: document function parameter

[Paul Moore]

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'?

-- 
paul-moore.com

Re: [PATCH 1/2] yama: document function parameter

[Kees Cook]

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>

-- 
Kees Cook

Re: [PATCH 2/2] apparmor: fix typo in kernel doc

[Kees Cook]

On Fri, Mar 15, 2024 at 01:54:09PM +0100, Christian Göttsche wrote:
> Fix the typo in the function documentation to please kernel doc
> warnings.
> 
> Signed-off-by: Christian Göttsche <cgzones@googlemail.com>

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

-- 
Kees Cook

Re: [PATCH 2/2] apparmor: fix typo in kernel doc

[John Johansen]

On 3/15/24 05:54, Christian Göttsche wrote:
> Fix the typo in the function documentation to please kernel doc
> warnings.
> 
> Signed-off-by: Christian Göttsche <cgzones@googlemail.com>

Acked-by: John Johansen <john.johansen@canonical.com>

I have pulled this into my tree

> ---
>   security/apparmor/lsm.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/security/apparmor/lsm.c b/security/apparmor/lsm.c
> index cef8c466af80..d0485fb0ed63 100644
> --- a/security/apparmor/lsm.c
> +++ b/security/apparmor/lsm.c
> @@ -1124,7 +1124,7 @@ static int apparmor_socket_create(int family, int type, int protocol, int kern)
>    * @sock: socket that is being setup
>    * @family: family of socket being created
>    * @type: type of the socket
> - * @ptotocol: protocol of the socket
> + * @protocol: protocol of the socket
>    * @kern: socket is a special kernel socket
>    *
>    * Note:

Re: [PATCH 1/2] yama: document function parameter

[Paul Moore]

On Thu, Mar 28, 2024 at 6:06 PM Kees Cook <keescook@chromium.org> wrote:
> 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>

I ran across this in patchwork just now and don't see it upstream yet,
you're picking this up right Kees?

-- 
paul-moore.com

Re: (subset) [PATCH 1/2] yama: document function parameter

[Kees Cook]

On Fri, 15 Mar 2024 13:54:10 +0100, Christian Göttsche wrote:
> Document the unused function parameter of yama_relation_cleanup() to
> please kernel doc warnings.
> 
> 

Applied to for-next/hardening, thanks!

[1/2] yama: document function parameter
      https://git.kernel.org/kees/c/f7d3b1ffc654

Take care,

-- 
Kees Cook