* [PATCH] audit: Fix some kernel-doc warnings
@ 2022-10-25 6:03 Bo Liu
2022-10-25 15:53 ` Randy Dunlap
2022-10-25 23:55 ` Paul Moore
0 siblings, 2 replies; 3+ messages in thread
From: Bo Liu @ 2022-10-25 6:03 UTC (permalink / raw)
To: paul, jmorris, serge; +Cc: linux-security-module, linux-kernel, Bo Liu
The current code provokes some kernel-doc warnings:
security/lsm_audit.c:198: warning: Function parameter or member 'ab' not described in 'dump_common_audit_data'
Signed-off-by: Bo Liu <liubo03@inspur.com>
---
security/lsm_audit.c | 1 +
1 file changed, 1 insertion(+)
diff --git a/security/lsm_audit.c b/security/lsm_audit.c
index 75cc3f8d2a42..ea5d35dce674 100644
--- a/security/lsm_audit.c
+++ b/security/lsm_audit.c
@@ -190,6 +190,7 @@ static inline void print_ipv4_addr(struct audit_buffer *ab, __be32 addr,
/**
* dump_common_audit_data - helper to dump common audit data
+ * @ab : the audit data to fill
* @a : common audit data
*
*/
--
2.27.0
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] audit: Fix some kernel-doc warnings
2022-10-25 6:03 [PATCH] audit: Fix some kernel-doc warnings Bo Liu
@ 2022-10-25 15:53 ` Randy Dunlap
2022-10-25 23:55 ` Paul Moore
1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2022-10-25 15:53 UTC (permalink / raw)
To: Bo Liu, paul, jmorris, serge; +Cc: linux-security-module, linux-kernel
On 10/24/22 23:03, Bo Liu wrote:
> The current code provokes some kernel-doc warnings:
> security/lsm_audit.c:198: warning: Function parameter or member 'ab' not described in 'dump_common_audit_data'
>
> Signed-off-by: Bo Liu <liubo03@inspur.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
> ---
> security/lsm_audit.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/security/lsm_audit.c b/security/lsm_audit.c
> index 75cc3f8d2a42..ea5d35dce674 100644
> --- a/security/lsm_audit.c
> +++ b/security/lsm_audit.c
> @@ -190,6 +190,7 @@ static inline void print_ipv4_addr(struct audit_buffer *ab, __be32 addr,
>
> /**
> * dump_common_audit_data - helper to dump common audit data
> + * @ab : the audit data to fill
> * @a : common audit data
> *
> */
--
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] audit: Fix some kernel-doc warnings
2022-10-25 6:03 [PATCH] audit: Fix some kernel-doc warnings Bo Liu
2022-10-25 15:53 ` Randy Dunlap
@ 2022-10-25 23:55 ` Paul Moore
1 sibling, 0 replies; 3+ messages in thread
From: Paul Moore @ 2022-10-25 23:55 UTC (permalink / raw)
To: Bo Liu; +Cc: jmorris, serge, linux-security-module, linux-kernel
On Tue, Oct 25, 2022 at 2:04 AM Bo Liu <liubo03@inspur.com> wrote:
>
> The current code provokes some kernel-doc warnings:
> security/lsm_audit.c:198: warning: Function parameter or member 'ab' not described in 'dump_common_audit_data'
>
> Signed-off-by: Bo Liu <liubo03@inspur.com>
> ---
> security/lsm_audit.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/security/lsm_audit.c b/security/lsm_audit.c
> index 75cc3f8d2a42..ea5d35dce674 100644
> --- a/security/lsm_audit.c
> +++ b/security/lsm_audit.c
> @@ -190,6 +190,7 @@ static inline void print_ipv4_addr(struct audit_buffer *ab, __be32 addr,
>
> /**
> * dump_common_audit_data - helper to dump common audit data
> + * @ab : the audit data to fill
When we need to comment on audit_buffer structs we usually refer to it
as "the audit buffer" or similar, e.g. kernel/audit*, and in
lsm_audit.c the term "audit data to fill" is typically used by the
common_audit_data struct. Please update this patch to something like
the following:
/**
* ...
* @ab: the audit buffer
* ...
*/
> * @a : common audit data
> *
> */
--
paul-moore.com
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-10-25 23:56 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-10-25 6:03 [PATCH] audit: Fix some kernel-doc warnings Bo Liu
2022-10-25 15:53 ` Randy Dunlap
2022-10-25 23:55 ` Paul Moore
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®