linux-kernel - [PATCH] dca: Change the format of kerneldoc parameters to fix warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [day] [month] [year] [list]
Date: Sat,  8 Jun 2024 15:42:10 -0300
From: Marilene A Garcia <marilene.agarcia@...il.com>
To: Andrew Morton <akpm@...ux-foundation.org>
Cc: Marilene A Garcia <marilene.agarcia@...il.com>,
	Shuah Khan <skhan@...uxfoundation.org>,
	Javier Carrasco <javier.carrasco.cruz@...il.com>,
	linux-kernel@...r.kernel.org
Subject: [PATCH] dca: Change the format of kerneldoc parameters to fix warnings

According to the kernel documentation, the format of the parameter
descriptions should be "@arg: description".

It also added some missing parameter descriptions and the module
description.

Signed-off-by: Marilene A Garcia <marilene.agarcia@...il.com>
---
Hello,
This subsystem seems unmaintained, and because of that, I was wondering 
if you could review the patch, Andrew.

These changes fix the following compiler warnings.
These warnings happen using GCC compiler the command 'make W=1'.
Thank you.

drivers/dca/dca-core.c:171: warning: Function parameter or struct member 'dev' not described in 'dca_add_requester'
drivers/dca/dca-core.c:226: warning: Function parameter or struct member 'dev' not described in 'dca_remove_requester'
drivers/dca/dca-core.c:258: warning: Function parameter or struct member 'dev' not described in 'dca_common_get_tag'
drivers/dca/dca-core.c:258: warning: Function parameter or struct member 'cpu' not described in 'dca_common_get_tag'
drivers/dca/dca-core.c:283: warning: Function parameter or struct member 'dev' not described in 'dca3_get_tag'
drivers/dca/dca-core.c:283: warning: Function parameter or struct member 'cpu' not described in 'dca3_get_tag'
drivers/dca/dca-core.c:296: warning: Function parameter or struct member 'cpu' not described in 'dca_get_tag'
drivers/dca/dca-core.c:308: warning: Function parameter or struct member 'ops' not described in 'alloc_dca_provider'
drivers/dca/dca-core.c:308: warning: Function parameter or struct member 'priv_size' not described in 'alloc_dca_provider'
drivers/dca/dca-core.c:328: warning: Function parameter or struct member 'dca' not described in 'free_dca_provider'
drivers/dca/dca-core.c:339: warning: Function parameter or struct member 'dca' not described in 'register_dca_provider'
drivers/dca/dca-core.c:339: warning: Function parameter or struct member 'dev' not described in 'register_dca_provider'
drivers/dca/dca-core.c:396: warning: Function parameter or struct member 'dca' not described in 'unregister_dca_provider'
drivers/dca/dca-core.c:396: warning: Function parameter or struct member 'dev' not described in 'unregister_dca_provider'
drivers/dca/dca-core.c:428: warning: Function parameter or struct member 'nb' not described in 'dca_register_notify'
drivers/dca/dca-core.c:437: warning: Function parameter or struct member 'nb' not described in 'dca_unregister_notify'
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/dca/dca.o

 drivers/dca/dca-core.c | 31 +++++++++++++++++--------------
 1 file changed, 17 insertions(+), 14 deletions(-)

diff --git a/drivers/dca/dca-core.c b/drivers/dca/dca-core.c
index ed3dac546dd6..f849386f8424 100644
--- a/drivers/dca/dca-core.c
+++ b/drivers/dca/dca-core.c
@@ -17,6 +17,7 @@
 #define DCA_VERSION "1.12.1"
 
 MODULE_VERSION(DCA_VERSION);
+MODULE_DESCRIPTION("Intel Direct Cache Access Driver");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Intel Corporation");
 
@@ -165,7 +166,7 @@ static struct dca_provider *dca_find_provider_by_dev(struct device *dev)
 
 /**
  * dca_add_requester - add a dca client to the list
- * @dev - the device that wants dca service
+ * @dev: the device that wants dca service
  */
 int dca_add_requester(struct device *dev)
 {
@@ -220,7 +221,7 @@ EXPORT_SYMBOL_GPL(dca_add_requester);
 
 /**
  * dca_remove_requester - remove a dca client from the list
- * @dev - the device that wants dca service
+ * @dev: the device that wants dca service
  */
 int dca_remove_requester(struct device *dev)
 {
@@ -251,8 +252,8 @@ EXPORT_SYMBOL_GPL(dca_remove_requester);
 
 /**
  * dca_common_get_tag - return the dca tag (serves both new and old api)
- * @dev - the device that wants dca service
- * @cpu - the cpuid as returned by get_cpu()
+ * @dev: the device that wants dca service
+ * @cpu: the cpuid as returned by get_cpu()
  */
 static u8 dca_common_get_tag(struct device *dev, int cpu)
 {
@@ -276,8 +277,8 @@ static u8 dca_common_get_tag(struct device *dev, int cpu)
 /**
  * dca3_get_tag - return the dca tag to the requester device
  *                for the given cpu (new api)
- * @dev - the device that wants dca service
- * @cpu - the cpuid as returned by get_cpu()
+ * @dev: the device that wants dca service
+ * @cpu: the cpuid as returned by get_cpu()
  */
 u8 dca3_get_tag(struct device *dev, int cpu)
 {
@@ -290,7 +291,7 @@ EXPORT_SYMBOL_GPL(dca3_get_tag);
 
 /**
  * dca_get_tag - return the dca tag for the given cpu (old api)
- * @cpu - the cpuid as returned by get_cpu()
+ * @cpu: the cpuid as returned by get_cpu()
  */
 u8 dca_get_tag(int cpu)
 {
@@ -300,8 +301,8 @@ EXPORT_SYMBOL_GPL(dca_get_tag);
 
 /**
  * alloc_dca_provider - get data struct for describing a dca provider
- * @ops - pointer to struct of dca operation function pointers
- * @priv_size - size of extra mem to be added for provider's needs
+ * @ops: pointer to struct of dca operation function pointers
+ * @priv_size: size of extra mem to be added for provider's needs
  */
 struct dca_provider *alloc_dca_provider(const struct dca_ops *ops,
 					int priv_size)
@@ -321,8 +322,7 @@ EXPORT_SYMBOL_GPL(alloc_dca_provider);
 
 /**
  * free_dca_provider - release the dca provider data struct
- * @ops - pointer to struct of dca operation function pointers
- * @priv_size - size of extra mem to be added for provider's needs
+ * @dca: struct created by alloc_dca_provider()
  */
 void free_dca_provider(struct dca_provider *dca)
 {
@@ -332,8 +332,8 @@ EXPORT_SYMBOL_GPL(free_dca_provider);
 
 /**
  * register_dca_provider - register a dca provider
- * @dca - struct created by alloc_dca_provider()
- * @dev - device providing dca services
+ * @dca: struct created by alloc_dca_provider()
+ * @dev: device providing dca services
  */
 int register_dca_provider(struct dca_provider *dca, struct device *dev)
 {
@@ -390,7 +390,8 @@ EXPORT_SYMBOL_GPL(register_dca_provider);
 
 /**
  * unregister_dca_provider - remove a dca provider
- * @dca - struct created by alloc_dca_provider()
+ * @dca: struct created by alloc_dca_provider()
+ * @dev: device providing dca services
  */
 void unregister_dca_provider(struct dca_provider *dca, struct device *dev)
 {
@@ -423,6 +424,7 @@ EXPORT_SYMBOL_GPL(unregister_dca_provider);
 
 /**
  * dca_register_notify - register a client's notifier callback
+ * @nb: notifier block to register
  */
 void dca_register_notify(struct notifier_block *nb)
 {
@@ -432,6 +434,7 @@ EXPORT_SYMBOL_GPL(dca_register_notify);
 
 /**
  * dca_unregister_notify - remove a client's notifier callback
+ * @nb: notifier block to unregister
  */
 void dca_unregister_notify(struct notifier_block *nb)
 {
-- 
2.34.1