[PATCH -next] Smack: fix doc warning

[PATCH -next] Smack: fix doc warning

[ChenXiaoSong]

Fix gcc W=1 warning:

security/smack/smack_access.c:342: warning: Function parameter or member 'ad' not described in 'smack_log'
security/smack/smack_access.c:403: warning: Function parameter or member 'skp' not described in 'smk_insert_entry'
security/smack/smack_access.c:487: warning: Function parameter or member 'level' not described in 'smk_netlbl_mls'
security/smack/smack_access.c:487: warning: Function parameter or member 'len' not described in 'smk_netlbl_mls'

Signed-off-by: ChenXiaoSong <chenxiaosong2@huawei.com>
---
 security/smack/smack_access.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/security/smack/smack_access.c b/security/smack/smack_access.c
index efe2406a3960..1f391f6a3d47 100644
--- a/security/smack/smack_access.c
+++ b/security/smack/smack_access.c
@@ -332,7 +332,7 @@ static void smack_log_callback(struct audit_buffer *ab, void *a)
  *  @object_label  : smack label of the object being accessed
  *  @request: requested permissions
  *  @result: result from smk_access
- *  @a:  auxiliary audit data
+ *  @ad:  auxiliary audit data
  *
  * Audit the granting or denial of permissions in accordance
  * with the policy.
@@ -396,6 +396,7 @@ struct hlist_head smack_known_hash[SMACK_HASH_SLOTS];
 
 /**
  * smk_insert_entry - insert a smack label into a hash map,
+ * @skp: smack label
  *
  * this function must be called under smack_known_lock
  */
@@ -476,8 +477,10 @@ char *smk_parse_smack(const char *string, int len)
 
 /**
  * smk_netlbl_mls - convert a catset to netlabel mls categories
+ * @level: MLS sensitivity level
  * @catset: the Smack categories
  * @sap: where to put the netlabel categories
+ * @len: number of bytes for the levels in a CIPSO IP option
  *
  * Allocates and fills attr.mls
  * Returns 0 on success, error code on failure.
-- 
2.25.4

Re: [PATCH -next] Smack: fix doc warning

[Casey Schaufler]

On 6/6/2021 8:52 PM, ChenXiaoSong wrote:
> Fix gcc W=1 warning:
>
> security/smack/smack_access.c:342: warning: Function parameter or member 'ad' not described in 'smack_log'
> security/smack/smack_access.c:403: warning: Function parameter or member 'skp' not described in 'smk_insert_entry'
> security/smack/smack_access.c:487: warning: Function parameter or member 'level' not described in 'smk_netlbl_mls'
> security/smack/smack_access.c:487: warning: Function parameter or member 'len' not described in 'smk_netlbl_mls'
>
> Signed-off-by: ChenXiaoSong <chenxiaosong2@huawei.com>

Added to smack-next. Thank you.

> ---
>  security/smack/smack_access.c | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/security/smack/smack_access.c b/security/smack/smack_access.c
> index efe2406a3960..1f391f6a3d47 100644
> --- a/security/smack/smack_access.c
> +++ b/security/smack/smack_access.c
> @@ -332,7 +332,7 @@ static void smack_log_callback(struct audit_buffer *ab, void *a)
>   *  @object_label  : smack label of the object being accessed
>   *  @request: requested permissions
>   *  @result: result from smk_access
> - *  @a:  auxiliary audit data
> + *  @ad:  auxiliary audit data
>   *
>   * Audit the granting or denial of permissions in accordance
>   * with the policy.
> @@ -396,6 +396,7 @@ struct hlist_head smack_known_hash[SMACK_HASH_SLOTS];
>  
>  /**
>   * smk_insert_entry - insert a smack label into a hash map,
> + * @skp: smack label
>   *
>   * this function must be called under smack_known_lock
>   */
> @@ -476,8 +477,10 @@ char *smk_parse_smack(const char *string, int len)
>  
>  /**
>   * smk_netlbl_mls - convert a catset to netlabel mls categories
> + * @level: MLS sensitivity level
>   * @catset: the Smack categories
>   * @sap: where to put the netlabel categories
> + * @len: number of bytes for the levels in a CIPSO IP option
>   *
>   * Allocates and fills attr.mls
>   * Returns 0 on success, error code on failure.