2022-03-17 05:08:15

by Yang Li

Subject: [PATCH -next] certs: Fix some kernel-doc comments

Remove some warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.

certs/system_keyring.c:46: warning: expecting prototype for
restrict_link_to_builtin_trusted(). Prototype was for
restrict_link_by_builtin_trusted() instead
certs/system_keyring.c:80: warning: This comment starts with '/**', but
isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
certs/system_keyring.c | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/certs/system_keyring.c b/certs/system_keyring.c
index 05b66ce9d1c9..f0eb8c680cac 100644
--- a/certs/system_keyring.c
+++ b/certs/system_keyring.c
@@ -34,7 +34,7 @@ extern __initconst const unsigned long system_certificate_list_size;
extern __initconst const unsigned long module_cert_size;

/**
- * restrict_link_to_builtin_trusted - Restrict keyring addition by built in CA
+ * restrict_link_by_builtin_trusted - Restrict keyring addition by built in CA
*
* Restrict the addition of keys into a keyring based on the key-to-be-added
* being vouched for by a key in the built in system keyring.
@@ -77,8 +77,9 @@ int restrict_link_by_builtin_and_secondary_trusted(
}

/**
- * Allocate a struct key_restriction for the "builtin and secondary trust"
- * keyring. Only for use in system_trusted_keyring_init().
+ * get_builtin_and_secondary_restriction - Allocate a struct key_restriction
+ * for the "builtin and secondary trust" keyring. Only for use in
+ * system_trusted_keyring_init().
*/
static __init struct key_restriction *get_builtin_and_secondary_restriction(void)
{
--
2.20.1.7.g153144c

2022-03-31 22:35:17

by David Howells

Subject: Re: [PATCH -next] certs: Fix some kernel-doc comments

Yang Li <[email protected]> wrote:

> /**
> - * Allocate a struct key_restriction for the "builtin and secondary trust"
> - * keyring. Only for use in system_trusted_keyring_init().
> + * get_builtin_and_secondary_restriction - Allocate a struct key_restriction
> + * for the "builtin and secondary trust" keyring. Only for use in
> + * system_trusted_keyring_init().
> */
> static __init struct key_restriction *get_builtin_and_secondary_restriction(void)

Better to just turn the "/**" into "/*" for this one. It's not a function
that should necessarily appear in API docs.

David