apparmor: Fix some kernel-doc comments
Subsystems (2)
PATCH 1/1 apparmor: Fix some kernel-doc comments
Use colons to separate parameter names from their specific meanings. silencethe warnings:
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'
--- security/apparmor/resource.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
security/apparmor/resource.c +4 -4
@@ -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. *
Signature · 1 line
2.20.1.7.g153144c
Quoted 9 lines · Yang Li
Use colons to separate parameter names from their specific meanings. silencethe warnings:
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 <[email protected]>
Thanks.
Quoted 23 lines
--- security/apparmor/resource.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)security/apparmor/resource.c +4
-4@@ -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. *
Signature · 1 line
~Randy
John Johansen
maintainerQuoted 3 lines · Yang Li
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
Quoted 29 lines
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 <[email protected]>--- security/apparmor/resource.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)security/apparmor/resource.c +4
-4@@ -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. *