Input: synaptics-rmi4: use correct function name in kernel-doc

Message ID 20230113063841.17191-1-rdunlap@infradead.org
State New
Headers
Series Input: synaptics-rmi4: use correct function name in kernel-doc |

Commit Message

Randy Dunlap Jan. 13, 2023, 6:38 a.m. UTC
  Use the correct function name in kernel-doc notation to prevent a warning:

drivers/input/rmi4/rmi_bus.c:300: warning: expecting prototype for rmi_register_function_handler(). Prototype was for __rmi_register_function_handler() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: linux-input@vger.kernel.org
---
 drivers/input/rmi4/rmi_bus.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Mattijs Korpershoek Jan. 24, 2023, 9:38 a.m. UTC | #1
On Thu, Jan 12, 2023 at 22:38, Randy Dunlap <rdunlap@infradead.org> wrote:

> Use the correct function name in kernel-doc notation to prevent a warning:
>
> drivers/input/rmi4/rmi_bus.c:300: warning: expecting prototype for rmi_register_function_handler(). Prototype was for __rmi_register_function_handler() instead
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
> Cc: linux-input@vger.kernel.org

Reviewed-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>

> ---
>  drivers/input/rmi4/rmi_bus.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/drivers/input/rmi4/rmi_bus.c b/drivers/input/rmi4/rmi_bus.c
> --- a/drivers/input/rmi4/rmi_bus.c
> +++ b/drivers/input/rmi4/rmi_bus.c
> @@ -285,7 +285,7 @@ void rmi_unregister_function(struct rmi_
>  }
>  
>  /**
> - * rmi_register_function_handler - register a handler for an RMI function
> + * __rmi_register_function_handler - register a handler for an RMI function
>   * @handler: RMI handler that should be registered.
>   * @owner: pointer to module that implements the handler
>   * @mod_name: name of the module implementing the handler
  

Patch

diff -- a/drivers/input/rmi4/rmi_bus.c b/drivers/input/rmi4/rmi_bus.c
--- a/drivers/input/rmi4/rmi_bus.c
+++ b/drivers/input/rmi4/rmi_bus.c
@@ -285,7 +285,7 @@  void rmi_unregister_function(struct rmi_
 }
 
 /**
- * rmi_register_function_handler - register a handler for an RMI function
+ * __rmi_register_function_handler - register a handler for an RMI function
  * @handler: RMI handler that should be registered.
  * @owner: pointer to module that implements the handler
  * @mod_name: name of the module implementing the handler