Skip to contentSkip to conversation

certs/blacklist: fix kernel doc interface issue

PATCH In review Alex Shi 2 participants 3 messages Nov 6, 2020 – Nov 30, 2020

Subsystems (2)
lore
Share & tools
lore

Alex Shi

author
#0 lore raw

PATCH 1/1 certs/blacklist: fix kernel doc interface issue

certs/blacklist.c:84: warning: Function parameter or member 'hash' not described in 'mark_hash_blacklisted'

---
 certs/blacklist.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
certs/blacklist.c +1 -1
index 6514f9ebc943..02f1016ce6e8 100644
@@ -78,7 +78,7 @@ static void blacklist_describe(const struct key *key, struct seq_file *m)
 
 /**
  * mark_hash_blacklisted - Add a hash to the system blacklist
- * @hash - The hash as a hex string with a type prefix (eg. "tbs:23aa429783")
+ * @hash: - The hash as a hex string with a type prefix (eg. "tbs:23aa429783")
  */
 int mark_hash_blacklisted(const char *hash)
 {
Signature · 1 line
1.8.3.1
maintainer
#1 lore raw
Quoted 4 lines · Alex Shi

/**
* mark_hash_blacklisted - Add a hash to the system blacklist
- * @hash - The hash as a hex string with a type prefix (eg. "tbs:23aa429783")
+ * @hash: - The hash as a hex string with a type prefix (eg. "tbs:23aa429783")

You should remove the dash when making this change. I'll do that for you.

David

author
#2 lore raw
Quoted 8 lines · David Howells
Quoted 4 lines · Alex Shi

/**
* mark_hash_blacklisted - Add a hash to the system blacklist
- * @hash - The hash as a hex string with a type prefix (eg. "tbs:23aa429783")
+ * @hash: - The hash as a hex string with a type prefix (eg. "tbs:23aa429783")

You should remove the dash when making this change. I'll do that for you.

Hi David,

Very appreciate for the fixing and reminder!

Regards
Alex