kernel/module: improve documentation for try_module_get()

Marco Pagani · mcgrof · commit 4515d08a742c · 2023-12-21T10:26:14.000-08:00
The sentence "this call will fail if the module is already being
removed" is potentially confusing and may contradict the rest of the
documentation. If one tries to get a module that has already been
removed using a stale pointer, the kernel will crash.

Signed-off-by: Marco Pagani &lt;marpagan@redhat.com&gt;
Signed-off-by: Luis Chamberlain &lt;mcgrof@kernel.org&gt;
diff --git a/include/linux/module.h b/include/linux/module.h
@@ -668,7 +668,7 @@ extern void __module_get(struct module *module);
  * @module: the module we should check for
  *
  * Only try to get a module reference count if the module is not being removed.
- * This call will fail if the module is already being removed.
+ * This call will fail if the module is in the process of being removed.
  *
  * Care must also be taken to ensure the module exists and is alive prior to
  * usage of this call. This can be gauranteed through two means:

Original file line number	Diff line number	Diff line change
`@@ -668,7 +668,7 @@ extern void __module_get(struct module *module);`
`668`	`668`	`* @module: the module we should check for`
`669`	`669`	`*`
`670`	`670`	`* Only try to get a module reference count if the module is not being removed.`
`671`		`- * This call will fail if the module is already being removed.`
	`671`	`+ * This call will fail if the module is in the process of being removed.`
`672`	`672`	`*`
`673`	`673`	`* Care must also be taken to ensure the module exists and is alive prior to`
`674`	`674`	`* usage of this call. This can be gauranteed through two means:`