[PATCH] i2c: i2c-smbus: fix i2c_handle_smbus_host_notify documentation

[PATCH] i2c: i2c-smbus: fix i2c_handle_smbus_host_notify documentation

[Jean Delvare]

The parameter description is from a previous implementation, update
it to describe the actual implementation.

Signed-off-by: Jean Delvare <jdelvare@suse.de>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: Wolfram Sang <wsa@the-dreams.de>
---
 drivers/i2c/i2c-smbus.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- a/drivers/i2c/i2c-smbus.c
+++ b/drivers/i2c/i2c-smbus.c
@@ -302,8 +302,8 @@ EXPORT_SYMBOL_GPL(i2c_setup_smbus_host_n
  * i2c_handle_smbus_host_notify - Forward a Host Notify event to the correct
  * I2C client.
  * @host_notify: the struct host_notify attached to the relevant adapter
- * @data: the Host Notify data which contains the payload and address of the
- * client
+ * @addr: the I2C address of the notifying device
+ * @data: the payload of the notification
  * Context: can't sleep
  *
  * Helper function to be called from an I2C bus driver's interrupt

-- 
Jean Delvare
SUSE L3 Support

Re: [PATCH] i2c: i2c-smbus: fix i2c_handle_smbus_host_notify documentation

[Benjamin Tissoires]

On Jul 16 2016 or thereabouts, Jean Delvare wrote:
> The parameter description is from a previous implementation, update
> it to describe the actual implementation.
> 
> Signed-off-by: Jean Delvare <jdelvare@suse.de>
> Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
> Cc: Wolfram Sang <wsa@the-dreams.de>
> ---

Good catch, thanks for fixing it.

Reviewed-by: Benjamin Tissoires <benjamin.tissoires@redhat.com>

Cheers,
Benjamin

>  drivers/i2c/i2c-smbus.c |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> --- a/drivers/i2c/i2c-smbus.c
> +++ b/drivers/i2c/i2c-smbus.c
> @@ -302,8 +302,8 @@ EXPORT_SYMBOL_GPL(i2c_setup_smbus_host_n
>   * i2c_handle_smbus_host_notify - Forward a Host Notify event to the correct
>   * I2C client.
>   * @host_notify: the struct host_notify attached to the relevant adapter
> - * @data: the Host Notify data which contains the payload and address of the
> - * client
> + * @addr: the I2C address of the notifying device
> + * @data: the payload of the notification
>   * Context: can't sleep
>   *
>   * Helper function to be called from an I2C bus driver's interrupt
> 
> -- 
> Jean Delvare
> SUSE L3 Support
> 

Re: [PATCH] i2c: i2c-smbus: fix i2c_handle_smbus_host_notify documentation

[Wolfram Sang]

[-- Attachment #1: Type: text/plain, Size: 365 bytes --]

On Sat, Jul 16, 2016 at 03:45:23PM +0200, Jean Delvare wrote:
> The parameter description is from a previous implementation, update
> it to describe the actual implementation.
> 
> Signed-off-by: Jean Delvare <jdelvare@suse.de>
> Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
> Cc: Wolfram Sang <wsa@the-dreams.de>

Applied to for-next, thanks!


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 819 bytes --]