summaryrefslogtreecommitdiffstats
path: root/kernel/module.c
diff options
context:
space:
mode:
authorSergey Shtylyov <s.shtylyov@omprussia.ru>2020-11-04 23:34:59 +0300
committerJessica Yu <jeyu@kernel.org>2020-11-09 13:46:58 +0100
commit24389b610be31536328c655ae0a2cb0ef94be2c8 (patch)
tree57f7eb1b2064b23f82a52294bea72b0ac8692748 /kernel/module.c
parent076aa52e402185e1e347bf5c62c61c6388fce4c7 (diff)
downloadlinux-24389b610be31536328c655ae0a2cb0ef94be2c8.tar.bz2
module: fix up 'kernel-doc' comments
Some 'kernel-doc' function comments do not fully comply with the specified format due to: - missing () after the function name; - "RETURNS:"/"Returns:" instead of "Return:" when documenting the function's result. - empty line before describing the function's arguments. Signed-off-by: Sergey Shtylyov <s.shtylyov@omprussia.ru> Signed-off-by: Jessica Yu <jeyu@kernel.org>
Diffstat (limited to 'kernel/module.c')
-rw-r--r--kernel/module.c10
1 files changed, 4 insertions, 6 deletions
diff --git a/kernel/module.c b/kernel/module.c
index 948d4bbbceb5..98b9e2ba8c3d 100644
--- a/kernel/module.c
+++ b/kernel/module.c
@@ -727,13 +727,12 @@ bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
}
/**
- * is_module_percpu_address - test whether address is from module static percpu
+ * is_module_percpu_address() - test whether address is from module static percpu
* @addr: address to test
*
* Test whether @addr belongs to module static percpu area.
*
- * RETURNS:
- * %true if @addr is from module static percpu area
+ * Return: %true if @addr is from module static percpu area
*/
bool is_module_percpu_address(unsigned long addr)
{
@@ -957,11 +956,10 @@ static int try_stop_module(struct module *mod, int flags, int *forced)
}
/**
- * module_refcount - return the refcount or -1 if unloading
- *
+ * module_refcount() - return the refcount or -1 if unloading
* @mod: the module we're checking
*
- * Returns:
+ * Return:
* -1 if the module is in the process of unloading
* otherwise the number of references in the kernel to the module
*/