Commit ffb5d9cf authored by Lee Jones's avatar Lee Jones Committed by Greg Kroah-Hartman
Browse files

tty: tty_audit: Demote non-conformant kernel-doc headers 



Fixes the following W=1 kernel build warning(s):

 drivers/tty/tty_audit.c:91: warning: Function parameter or member 'buf' not described in 'tty_audit_buf_push'
 drivers/tty/tty_audit.c:129: warning: Function parameter or member 'sig' not described in 'tty_audit_fork'
 drivers/tty/tty_audit.c:137: warning: Function parameter or member 'tty' not described in 'tty_audit_tiocsti'
 drivers/tty/tty_audit.c:137: warning: Function parameter or member 'ch' not described in 'tty_audit_tiocsti'
 drivers/tty/tty_audit.c:202: warning: Function parameter or member 'tty' not described in 'tty_audit_add_data'
 drivers/tty/tty_audit.c:202: warning: Function parameter or member 'data' not described in 'tty_audit_add_data'
 drivers/tty/tty_audit.c:202: warning: Function parameter or member 'size' not described in 'tty_audit_add_data'

Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jiri Slaby <jirislaby@kernel.org>
Cc: Miloslav Trmac <mitr@redhat.com>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20201104193549.4026187-16-lee.jones@linaro.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 32ed2480

drivers/tty/tty_audit.c

+6 −6
Original line number Diff line number Diff line
@@ -81,7 +81,7 @@ static void tty_audit_log(const char *description, dev_t dev, 
	}

}



/**

/*

 *	tty_audit_buf_push	-	Push buffered data out

 *

 *	Generate an audit message from the contents of @buf, which is owned by
@@ -120,7 +120,7 @@ void tty_audit_exit(void) 
	tty_audit_buf_free(buf);

}



/**

/*

 *	tty_audit_fork	-	Copy TTY audit state for a new task

 *

 *	Set up TTY audit state in @sig from current.  @sig needs no locking.
@@ -130,7 +130,7 @@ void tty_audit_fork(struct signal_struct *sig) 
	sig->audit_tty = current->signal->audit_tty;

}



/**

/*

 *	tty_audit_tiocsti	-	Log TIOCSTI

 */

void tty_audit_tiocsti(struct tty_struct *tty, char ch)
@@ -145,7 +145,7 @@ void tty_audit_tiocsti(struct tty_struct *tty, char ch) 
		tty_audit_log("ioctl=TIOCSTI", dev, &ch, 1);

}



/**

/*

 *	tty_audit_push	-	Flush current's pending audit data

 *

 *	Returns 0 if success, -EPERM if tty audit is disabled
@@ -166,7 +166,7 @@ int tty_audit_push(void) 
	return 0;

}



/**

/*

 *	tty_audit_buf_get	-	Get an audit buffer.

 *

 *	Get an audit buffer, allocate it if necessary.  Return %NULL
@@ -193,7 +193,7 @@ static struct tty_audit_buf *tty_audit_buf_get(void) 
	return tty_audit_buf_ref();

}



/**

/*

 *	tty_audit_add_data	-	Add data for TTY auditing.

 *

 *	Audit @data of @size from @tty, if necessary.