diff mbox

[PATCHv2,1/2] i2c: cadence: Fix the Documentation

Message ID 56D6A2BE.7060503@xilinx.com
State Superseded
Headers show

Commit Message

Michal Simek March 2, 2016, 8:22 a.m. UTC 
On 1.3.2016 10:21, Shubhrajyoti Datta wrote:
> The runtime adaptation patch missed the documentation update.
> This fixes the same.
> 
> Signed-off-by: Shubhrajyoti Datta <shubhraj@xilinx.com>
> ---
> v2 changes:
> fix the dev param description
> 
>  drivers/i2c/busses/i2c-cadence.c |   12 +++++++-----
>  1 files changed, 7 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/i2c/busses/i2c-cadence.c b/drivers/i2c/busses/i2c-cadence.c
> index 6b08d16..f9f485d 100644
> --- a/drivers/i2c/busses/i2c-cadence.c
> +++ b/drivers/i2c/busses/i2c-cadence.c
> @@ -124,6 +124,8 @@
>  
>  /**
>   * struct cdns_i2c - I2C device private data structure
> + *
> + * @dev:		Pointer to device structure
>   * @membase:		Base address of the I2C device
>   * @adap:		I2C adapter instance
>   * @p_msg:		Message pointer
> @@ -815,8 +817,8 @@ static int cdns_i2c_clk_notifier_cb(struct notifier_block *nb, unsigned long
>  }
>  
>  /**
> - * cdns_i2c_suspend - Suspend method for the driver
> - * @_dev:	Address of the platform_device structure
> + * cdns_i2c_runtime_suspend -  Runtime suspend method for the driver
> + * @dev:	Address of the platform_device structure
>   *
>   * Put the driver into low power mode.
>   *
> @@ -833,10 +835,10 @@ static int __maybe_unused cdns_i2c_runtime_suspend(struct device *dev)
>  }
>  
>  /**
> - * cdns_i2c_resume - Resume from suspend
> - * @_dev:	Address of the platform_device structure
> + * cdns_i2c_runtime_resume - Runtime resume
> + * @dev:	Address of the platform_device structure
>   *
> - * Resume operation after suspend.
> + * Runtime resume callback.
>   *
>   * Return: 0 on success and error value on error
>   */
> 

Can you also please include this fix there too?


When it is added feel free to add my
Tested-by: Michal Simek <michal.simek@xilinx.com>

Thanks,
Michal

--
To unsubscribe from this list: send the line "unsubscribe linux-i2c" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Wolfram Sang March 2, 2016, 9:01 a.m. UTC | #1 
> Tested-by: Michal Simek <michal.simek@xilinx.com>

Tested-by for a documentation patch?
Michal Simek March 2, 2016, 9:05 a.m. UTC | #2 
On 2.3.2016 10:01, Wolfram Sang wrote:
> 
>> Tested-by: Michal Simek <michal.simek@xilinx.com>
> 
> Tested-by for a documentation patch?

yep. I was running kernel-doc which check it fully.
That's why I have added tested-by.

Thanks,
Michal


--
To unsubscribe from this list: send the line "unsubscribe linux-i2c" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/drivers/i2c/busses/i2c-cadence.c
b/drivers/i2c/busses/i2c-cadence.c
index f9f485d2d917..90bbd9f9dd8f 100644
--- a/drivers/i2c/busses/i2c-cadence.c
+++ b/drivers/i2c/busses/i2c-cadence.c
@@ -173,7 +173,7 @@  struct cdns_platform_data {
                                             clk_rate_change_nb)

 /**
- * cdns_i2c_clear_bus_hold() - Clear bus hold bit
+ * cdns_i2c_clear_bus_hold - Clear bus hold bit
  * @id:        Pointer to driver data struct
  *
  * Helper to clear the controller's bus hold bit.