module: fix up documentation for add_taint() and add_taint_module()

When add_taint_module() was added, the documentation for it was copied
directly from add_taint().  But that documentation was a bit wrong
(wrong variable name, and misleading boolean reference.)  Fix up both
functions to have the correct documentation for how to use the
lockdep_ok parameter to these functions.

Reported-by: Petr Pavlu <petr.pavlu@suse.com>
Reviewed-by: Bradley Morgan <brads@mainlining.org>
Reviewed-by: Aaron Tomlin <atomlin@atomlin.com>
Acked-by: Danilo Krummrich <dakr@kernel.org>
Link: https://patch.msgid.link/20260914-bind_taint-v4-2-eadf8a090903@linuxfoundation.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Greg Kroah-Hartman 2026-09-14 16:30:32 +02:00
parent 10dde2bd66
commit de2dbaabbc
2 changed files with 6 additions and 4 deletions

View File

@ -197,8 +197,9 @@ static inline int strong_try_module_get(struct module *mod)
* @flag: one of the TAINT_* constants.
* @lockdep_ok: whether lock debugging is still OK.
*
* If something bad has gone wrong, you'll want @lockdebug_ok = false, but for
* some noteworthy-but-not-corrupting cases, it can be set to true.
* If something bad has gone wrong, you'll want
* @lockdep_ok = LOCKDEP_NOW_UNRELIABLE, but for some
* noteworthy-but-not-corrupting cases, it can be set to LOCKDEP_STILL_OK.
*/
void add_taint_module(struct module *mod, unsigned flag,
enum lockdep_ok lockdep_ok)

View File

@ -948,8 +948,9 @@ unsigned long get_taint(void)
* @flag: one of the TAINT_* constants.
* @lockdep_ok: whether lock debugging is still OK.
*
* If something bad has gone wrong, you'll want @lockdebug_ok = false, but for
* some notewortht-but-not-corrupting cases, it can be set to true.
* If something bad has gone wrong, you'll want
* @lockdep_ok = LOCKDEP_NOW_UNRELIABLE, but for some
* noteworthy-but-not-corrupting cases, it can be set to LOCKDEP_STILL_OK.
*/
void add_taint(unsigned flag, enum lockdep_ok lockdep_ok)
{