2022-10-25 06:18:08

by Bo Liu

Subject: [PATCH] audit: Fix some kernel-doc warnings

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 <[email protected]>
---
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

2022-10-25 16:26:55

by Randy Dunlap

Subject: Re: [PATCH] audit: Fix some kernel-doc warnings

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 <[email protected]>

Acked-by: Randy Dunlap <[email protected]>

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

2022-10-26 00:16:09

by Paul Moore

Subject: Re: [PATCH] audit: Fix some kernel-doc warnings

On Tue, Oct 25, 2022 at 2:04 AM Bo Liu <[email protected]> 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 <[email protected]>
> ---
> 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