LSM: fix documentation for the audit_* hooks
authorDenis Efremov <efremov@ispras.ru>
Tue, 26 Feb 2019 20:49:08 +0000 (23:49 +0300)
committerJames Morris <james.morris@microsoft.com>
Tue, 26 Mar 2019 23:46:21 +0000 (16:46 -0700)
This patch updates the documentation for the audit_* hooks
to use the same arguments names as in the hook's declarations.

Signed-off-by: Denis Efremov <efremov@ispras.ru>
Acked-by: Kees Cook <keescook@chromium.org>
Acked-by: Casey Schaufler <casey@schaufler-ca.com>
Signed-off-by: James Morris <james.morris@microsoft.com>
include/linux/lsm_hooks.h

index 1a4e4dd..2f0990f 100644 (file)
  *     -EINVAL in case of an invalid rule.
  *
  * @audit_rule_known:
- *     Specifies whether given @rule contains any fields related to
+ *     Specifies whether given @krule 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:
  *     @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.
+ *     @lrule points to the audit rule that will be checked against.
  *     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