tty: tty_io: document console_lock usage
authorJohn Ogness <john.ogness@linutronix.de>
Wed, 16 Nov 2022 16:21:21 +0000 (17:27 +0106)
committerPetr Mladek <pmladek@suse.com>
Fri, 2 Dec 2022 10:25:00 +0000 (11:25 +0100)
commitd25a2e748ae159e43d40f4bc0a9e89cc443e325f
treec04c03454c3c78eea0a2240123552acb437ddc1f
parent0fb413ea64603a71e19b4b15a6c5b704e3897d06
tty: tty_io: document console_lock usage

show_cons_active() uses the console_lock to gather information
on registered consoles. Since the console_lock is being used for
multiple reasons, explicitly document these reasons. This will
be useful when the console_lock is split into fine-grained
locking.

Signed-off-by: John Ogness <john.ogness@linutronix.de>
Reviewed-by: Petr Mladek <pmladek@suse.com>
Signed-off-by: Petr Mladek <pmladek@suse.com>
Link: https://lore.kernel.org/r/20221116162152.193147-10-john.ogness@linutronix.de
drivers/tty/tty_io.c