[PATCH] security: fix documentation for the audit_* hooks

[PATCH] security: fix documentation for the audit_* hooks

[efremov]

From: Denis Efremov <efremov@linux.com>

This patch makes argument names equal in the documentation and
declarations of the audit_* hooks.

Signed-off-by: Denis Efremov <efremov@linux.com>
---
 include/linux/lsm_hooks.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/linux/lsm_hooks.h b/include/linux/lsm_hooks.h
index 596351f7c3d1..9fb67c212298 100644
--- a/include/linux/lsm_hooks.h
+++ b/include/linux/lsm_hooks.h
@@ -1329,7 +1329,7 @@
  * @audit_rule_known:
  *	Specifies whether given @rule contains any fields related to
  *	current LSM.
- *	@rule contains the audit rule of interest.
+ *	@krule contains the audit rule of interest.
  *	Return 1 in case of relation found, 0 otherwise.
  *
  * @audit_rule_match:
@@ -1338,14 +1338,14 @@
  *	@secid contains the security id in question.
  *	@field contains the field which relates to current LSM.
  *	@op contains the operator that will be used for matching.
- *	@rule points to the audit rule that will be checked against.
+ *	@lsmrule points to the audit rule that will be checked against.
  *	@actx points to the audit context associated with the check.
  *	Return 1 if secid matches the rule, 0 if it does not, -ERRNO on failure.
  *
  * @audit_rule_free:
  *	Deallocate the LSM audit rule structure previously allocated by
  *	audit_rule_init.
- *	@rule contains the allocated rule
+ *	@lsmrule contains the allocated rule.
  *
  * @inode_invalidate_secctx:
  *	Notify the security module that it must revalidate the security context
-- 
2.17.2

Re: [PATCH] security: fix documentation for the audit_* hooks

[Kees Cook]

On Tue, Oct 23, 2018 at 4:17 AM,  <efremov@linux.com> wrote:
> From: Denis Efremov <efremov@linux.com>
>
> This patch makes argument names equal in the documentation and
> declarations of the audit_* hooks.
>
> Signed-off-by: Denis Efremov <efremov@linux.com>

Reviewed-by: Kees Cook <keescook@chromium.org>

-Kees

> ---
>  include/linux/lsm_hooks.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/include/linux/lsm_hooks.h b/include/linux/lsm_hooks.h
> index 596351f7c3d1..9fb67c212298 100644
> --- a/include/linux/lsm_hooks.h
> +++ b/include/linux/lsm_hooks.h
> @@ -1329,7 +1329,7 @@
>   * @audit_rule_known:
>   *     Specifies whether given @rule contains any fields related to
>   *     current LSM.
> - *     @rule contains the audit rule of interest.
> + *     @krule contains the audit rule of interest.
>   *     Return 1 in case of relation found, 0 otherwise.
>   *
>   * @audit_rule_match:
> @@ -1338,14 +1338,14 @@
>   *     @secid contains the security id in question.
>   *     @field contains the field which relates to current LSM.
>   *     @op contains the operator that will be used for matching.
> - *     @rule points to the audit rule that will be checked against.
> + *     @lsmrule points to the audit rule that will be checked against.
>   *     @actx points to the audit context associated with the check.
>   *     Return 1 if secid matches the rule, 0 if it does not, -ERRNO on failure.
>   *
>   * @audit_rule_free:
>   *     Deallocate the LSM audit rule structure previously allocated by
>   *     audit_rule_init.
> - *     @rule contains the allocated rule
> + *     @lsmrule contains the allocated rule.
>   *
>   * @inode_invalidate_secctx:
>   *     Notify the security module that it must revalidate the security context
> --
> 2.17.2
>



-- 
Kees Cook