[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-ID: <685315da-3a6d-6d1e-03cb-1fc07ff68121@canonical.com>
Date: Mon, 10 Jul 2023 01:48:14 -0700
From: John Johansen <john.johansen@...onical.com>
To: Yang Li <yang.lee@...ux.alibaba.com>
Cc: paul@...l-moore.com, jmorris@...ei.org, serge@...lyn.com,
apparmor@...ts.ubuntu.com, linux-security-module@...r.kernel.org,
linux-kernel@...r.kernel.org
Subject: Re: [PATCH -next] apparmor: Fix some kernel-doc comments
On 7/7/23 01:07, Yang Li wrote:
> Use colons to separate parameter names from their specific meanings.
> silencethe warnings:
>
Unfortunately Gaosheng Cui beat you to this fix on 6/24 with
[PATCH -next 08/11] apparmor: Fix kernel-doc warnings in apparmor/resource.c
thankyou for taking the time to help make apparmor better
-
john
> security/apparmor/resource.c:111: warning: Function parameter or member 'label' not described in 'aa_task_setrlimit'
> security/apparmor/resource.c:111: warning: Function parameter or member 'task' not described in 'aa_task_setrlimit'
> security/apparmor/resource.c:111: warning: Function parameter or member 'resource' not described in 'aa_task_setrlimit'
> security/apparmor/resource.c:111: warning: Function parameter or member 'new_rlim' not described in 'aa_task_setrlimit'
>
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
> ---
> security/apparmor/resource.c | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/security/apparmor/resource.c b/security/apparmor/resource.c
> index e85948164896..2bebc5d9e741 100644
> --- a/security/apparmor/resource.c
> +++ b/security/apparmor/resource.c
> @@ -97,10 +97,10 @@ static int profile_setrlimit(struct aa_profile *profile, unsigned int resource,
>
> /**
> * aa_task_setrlimit - test permission to set an rlimit
> - * @label - label confining the task (NOT NULL)
> - * @task - task the resource is being set on
> - * @resource - the resource being set
> - * @new_rlim - the new resource limit (NOT NULL)
> + * @label: label confining the task (NOT NULL)
> + * @task: task the resource is being set on
> + * @resource: the resource being set
> + * @new_rlim: the new resource limit (NOT NULL)
> *
> * Control raising the processes hard limit.
> *
Powered by blists - more mailing lists