Commit d211f177b28ec070c25b3d0b960aa55f352f731f

Authored by Eric W. Biederman
1 parent 6f285b19d0

audit: Update kdoc for audit_send_reply and audit_list_rules_send

The kbuild test robot reported:
> tree:   git://git.kernel.org/pub/scm/linux/kernel/git/ebiederm/user-namespace.git for-next
> head:   6f285b19d09f72e801525f5eea1bdad22e559bf0
> commit: 6f285b19d09f72e801525f5eea1bdad22e559bf0 [2/2] audit: Send replies in the proper network namespace.
> reproduce: make htmldocs
>
> >> Warning(kernel/audit.c:575): No description found for parameter 'request_skb'
> >> Warning(kernel/audit.c:575): Excess function parameter 'portid' description in 'audit_send_reply'
> >> Warning(kernel/auditfilter.c:1074): No description found for parameter 'request_skb'
> >> Warning(kernel/auditfilter.c:1074): Excess function parameter 'portid' description in 'audit_list_rules_s

Which was caused by my failure to update the kdoc annotations when I
updated the functions.  Fix that small oversight now.

Signed-off-by: "Eric W. Biederman" <ebiederm@xmission.com>

Showing 2 changed files with 2 additions and 2 deletions Side-by-side Diff

... ... @@ -559,7 +559,7 @@
559 559 }
560 560 /**
561 561 * audit_send_reply - send an audit reply message via netlink
562   - * @portid: netlink port to which to send reply
  562 + * @request_skb: skb of request we are replying to (used to target the reply)
563 563 * @seq: sequence number
564 564 * @type: audit message type
565 565 * @done: done (last) flag
kernel/auditfilter.c
... ... @@ -1067,7 +1067,7 @@
1067 1067  
1068 1068 /**
1069 1069 * audit_list_rules_send - list the audit rules
1070   - * @portid: target portid for netlink audit messages
  1070 + * @request_skb: skb of request we are replying to (used to target the reply)
1071 1071 * @seq: netlink audit message sequence (serial) number
1072 1072 */
1073 1073 int audit_list_rules_send(struct sk_buff *request_skb, int seq)