kernel/module: improve documentation for try_module_get()

JIRA: https://issues.redhat.com/browse/RHEL-28063

commit 4515d08a742c76612b65d2f47a87d12860519842
Author: Marco Pagani <marpagan@redhat.com>
Date:   Thu Dec 21 17:58:47 2023 +0100

    kernel/module: improve documentation for try_module_get()

    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 <marpagan@redhat.com>
    Signed-off-by: Luis Chamberlain <mcgrof@kernel.org>

Signed-off-by: Donald Dutile <ddutile@redhat.com>
This commit is contained in:
Donald Dutile 2024-05-09 01:54:12 -04:00
parent e6f4187276
commit 363d196a6a
1 changed files with 1 additions and 1 deletions

View File

@ -671,7 +671,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: