Commit 196a5085 authored by Geliang Tang's avatar Geliang Tang Committed by Paul Moore
Browse files

audit: update the function comments 



Update the function comments to match the code.

Signed-off-by: default avatarGeliang Tang <geliangtang@gmail.com>
Signed-off-by: default avatarPaul Moore <paul@paul-moore.com>
parent 19128341

kernel/audit.c

+1 −1
Original line number Diff line number Diff line
@@ -1833,7 +1833,7 @@ void audit_log_format(struct audit_buffer *ab, const char *fmt, ...) 
}



/**

 * audit_log_hex - convert a buffer to hex and append it to the audit skb

 * audit_log_n_hex - convert a buffer to hex and append it to the audit skb

 * @ab: the audit_buffer

 * @buf: buffer to convert to hex

 * @len: length of @buf to be converted

kernel/auditsc.c

+9 −9
Original line number Diff line number Diff line
@@ -1462,7 +1462,7 @@ static void audit_log_exit(struct audit_context *context, struct task_struct *ts 
}



/**

 * audit_free - free a per-task audit context

 * __audit_free - free a per-task audit context

 * @tsk: task whose audit context block to free

 *

 * Called from copy_process and do_exit
@@ -1489,7 +1489,7 @@ void __audit_free(struct task_struct *tsk) 
}



/**

 * audit_syscall_entry - fill in an audit record at syscall entry

 * __audit_syscall_entry - fill in an audit record at syscall entry

 * @major: major syscall type (function)

 * @a1: additional syscall register 1

 * @a2: additional syscall register 2
@@ -1543,7 +1543,7 @@ void __audit_syscall_entry(int major, unsigned long a1, unsigned long a2, 
}



/**

 * audit_syscall_exit - deallocate audit context after a system call

 * __audit_syscall_exit - deallocate audit context after a system call

 * @success: success value of the syscall

 * @return_code: return value of the syscall

 *
@@ -1705,7 +1705,7 @@ static struct audit_names *audit_alloc_name(struct audit_context *context, 
}



/**

 * audit_reusename - fill out filename with info from existing entry

 * __audit_reusename - fill out filename with info from existing entry

 * @uptr: userland ptr to pathname

 *

 * Search the audit_names list for the current audit context. If there is an
@@ -1730,7 +1730,7 @@ __audit_reusename(const __user char *uptr) 
}



/**

 * audit_getname - add a name to the list

 * __audit_getname - add a name to the list

 * @name: name to add

 *

 * Add a name to the list of audit names for this context.
@@ -2135,7 +2135,7 @@ void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat) 
}



/**

 * audit_ipc_obj - record audit data for ipc object

 * __audit_ipc_obj - record audit data for ipc object

 * @ipcp: ipc permissions

 *

 */
@@ -2151,7 +2151,7 @@ void __audit_ipc_obj(struct kern_ipc_perm *ipcp) 
}



/**

 * audit_ipc_set_perm - record audit data for new ipc permissions

 * __audit_ipc_set_perm - record audit data for new ipc permissions

 * @qbytes: msgq bytes

 * @uid: msgq user id

 * @gid: msgq group id
@@ -2180,7 +2180,7 @@ void __audit_bprm(struct linux_binprm *bprm) 




/**

 * audit_socketcall - record audit data for sys_socketcall

 * __audit_socketcall - record audit data for sys_socketcall

 * @nargs: number of args, which should not be more than AUDITSC_ARGS.

 * @args: args array

 *
@@ -2211,7 +2211,7 @@ void __audit_fd_pair(int fd1, int fd2) 
}



/**

 * audit_sockaddr - record audit data for sys_bind, sys_connect, sys_sendto

 * __audit_sockaddr - record audit data for sys_bind, sys_connect, sys_sendto

 * @len: data length in user space

 * @a: data address in kernel space

 *