diff mbox

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

Message ID 1456813959-20398-1-git-send-email-shubhraj@xilinx.com
State Superseded
Headers show

Commit Message

Shubhrajyoti Datta March 1, 2016, 6:32 a.m. UTC
The runtime adaptation patch missed the documentation update.
This fixes the same.
No functional change.

Signed-off-by: Shubhrajyoti Datta <shubhraj@xilinx.com>
---
 drivers/i2c/busses/i2c-cadence.c |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

Comments

Michal Simek March 1, 2016, 7:33 a.m. UTC | #1
On 1.3.2016 07:32, Shubhrajyoti Datta wrote:
> The runtime adaptation patch missed the documentation update.
> This fixes the same.
> No functional change.
> 
> Signed-off-by: Shubhrajyoti Datta <shubhraj@xilinx.com>
> ---
>  drivers/i2c/busses/i2c-cadence.c |    4 ++--
>  1 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/i2c/busses/i2c-cadence.c b/drivers/i2c/busses/i2c-cadence.c
> index 6b08d16..a761520 100644
> --- a/drivers/i2c/busses/i2c-cadence.c
> +++ b/drivers/i2c/busses/i2c-cadence.c
> @@ -815,7 +815,7 @@ static int cdns_i2c_clk_notifier_cb(struct notifier_block *nb, unsigned long
>  }
>  
>  /**
> - * cdns_i2c_suspend - Suspend method for the driver
> + * cdns_i2c_runtime_suspend -  Runtime suspend method for the driver
>   * @_dev:	Address of the platform_device structure

you should fix this parameter too.

>   *
>   * Put the driver into low power mode.
> @@ -833,7 +833,7 @@ static int __maybe_unused cdns_i2c_runtime_suspend(struct device *dev)
>  }
>  
>  /**
> - * cdns_i2c_resume - Resume from suspend
> + * cdns_i2c_runtime_resume - Runtime resume
>   * @_dev:	Address of the platform_device structure

and here too.

>   *
>   * Resume operation after suspend.
> 

There is also undocumented dev. Please fix it too.
drivers/i2c/busses/i2c-cadence.c:126: info: Scanning doc for struct cdns_i2c
drivers/i2c/busses/i2c-cadence.c:164: warning: No description found for
parameter 'dev'

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
Shubhrajyoti Datta March 1, 2016, 9:23 a.m. UTC | #2
On Tue, Mar 1, 2016 at 1:03 PM, Michal Simek <michal.simek@xilinx.com> wrote:
> On 1.3.2016 07:32, Shubhrajyoti Datta wrote:
>> The runtime adaptation patch missed the documentation update.
>> This fixes the same.
>> No functional change.
>>
>> Signed-off-by: Shubhrajyoti Datta <shubhraj@xilinx.com>
>> ---
>>  drivers/i2c/busses/i2c-cadence.c |    4 ++--
>>  1 files changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/drivers/i2c/busses/i2c-cadence.c b/drivers/i2c/busses/i2c-cadence.c
>> index 6b08d16..a761520 100644
>> --- a/drivers/i2c/busses/i2c-cadence.c
>> +++ b/drivers/i2c/busses/i2c-cadence.c
>> @@ -815,7 +815,7 @@ static int cdns_i2c_clk_notifier_cb(struct notifier_block *nb, unsigned long
>>  }
>>
>>  /**
>> - * cdns_i2c_suspend - Suspend method for the driver
>> + * cdns_i2c_runtime_suspend -  Runtime suspend method for the driver
>>   * @_dev:    Address of the platform_device structure
>
> you should fix this parameter too.
yes
>
>>   *
>>   * Put the driver into low power mode.
>> @@ -833,7 +833,7 @@ static int __maybe_unused cdns_i2c_runtime_suspend(struct device *dev)
>>  }
>>
>>  /**
>> - * cdns_i2c_resume - Resume from suspend
>> + * cdns_i2c_runtime_resume - Runtime resume
>>   * @_dev:    Address of the platform_device structure
>
> and here too.
ok
>
>>   *
>>   * Resume operation after suspend.
>>
>
> There is also undocumented dev. Please fix it too.
> drivers/i2c/busses/i2c-cadence.c:126: info: Scanning doc for struct cdns_i2c
> drivers/i2c/busses/i2c-cadence.c:164: warning: No description found for
> parameter 'dev'
Sent a v2 fixing all the comments.


Thanks for the review

>
> 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
--
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 6b08d16..a761520 100644
--- a/drivers/i2c/busses/i2c-cadence.c
+++ b/drivers/i2c/busses/i2c-cadence.c
@@ -815,7 +815,7 @@  static int cdns_i2c_clk_notifier_cb(struct notifier_block *nb, unsigned long
 }
 
 /**
- * cdns_i2c_suspend - Suspend method for the driver
+ * 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,7 +833,7 @@  static int __maybe_unused cdns_i2c_runtime_suspend(struct device *dev)
 }
 
 /**
- * cdns_i2c_resume - Resume from suspend
+ * cdns_i2c_runtime_resume - Runtime resume
  * @_dev:	Address of the platform_device structure
  *
  * Resume operation after suspend.