proc: consoles: document console_lock usage
authorJohn Ogness <john.ogness@linutronix.de>
Wed, 16 Nov 2022 16:21:22 +0000 (17:27 +0106)
committerPetr Mladek <pmladek@suse.com>
Fri, 2 Dec 2022 10:25:00 +0000 (11:25 +0100)
commit8b5dd40088f7a3d85e6072f027ec50f309f64876
tree91dc7785c11e00f57197aedd4f0ec46b6d995a45
parentd25a2e748ae159e43d40f4bc0a9e89cc443e325f
proc: consoles: document console_lock usage

The console_lock is held throughout the start/show/stop procedure
to print out device/driver information about all 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-11-john.ogness@linutronix.de
fs/proc/consoles.c