[PATCH v1 05/14] extcon: Amend kernel documentation of struct extcon_dev

Andy Shevchenko posted 14 patches 3 years ago
There is a newer version of this series
[PATCH v1 05/14] extcon: Amend kernel documentation of struct extcon_dev
Posted by Andy Shevchenko 3 years ago
First of all, the @lock description is missing. Add it.
Second, correct the terminator value for the mutual exclusive
cabling.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 drivers/extcon/extcon.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/extcon/extcon.h b/drivers/extcon/extcon.h
index 93b5e0306966..15616446140d 100644
--- a/drivers/extcon/extcon.h
+++ b/drivers/extcon/extcon.h
@@ -13,8 +13,8 @@
  *			are disabled.
  * @mutually_exclusive:	Array of mutually exclusive set of cables that cannot
  *			be attached simultaneously. The array should be
- *			ending with NULL or be NULL (no mutually exclusive
- *			cables). For example, if it is { 0x7, 0x30, 0}, then,
+ *			ending with 0 or be NULL (no mutually exclusive cables).
+ *			For example, if it is {0x7, 0x30, 0}, then,
  *			{0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot
  *			be attached simulataneously. {0x7, 0} is equivalent to
  *			{0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there
@@ -27,7 +27,7 @@
  * @nh:			Notifier for the state change events from this extcon
  * @entry:		To support list of extcon devices so that users can
  *			search for extcon devices based on the extcon name.
- * @lock:
+ * @lock:		Protects device state and serialises device registration
  * @max_supported:	Internal value to store the number of cables.
  * @extcon_dev_type:	Device_type struct to provide attribute_groups
  *			customized for each extcon device.
-- 
2.40.0.1.gaa8946217a0b
Re: [PATCH v1 05/14] extcon: Amend kernel documentation of struct extcon_dev
Posted by Chanwoo Choi 3 years ago
On 23. 3. 22. 23:39, Andy Shevchenko wrote:
> First of all, the @lock description is missing. Add it.
> Second, correct the terminator value for the mutual exclusive
> cabling.
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---
>  drivers/extcon/extcon.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/extcon/extcon.h b/drivers/extcon/extcon.h
> index 93b5e0306966..15616446140d 100644
> --- a/drivers/extcon/extcon.h
> +++ b/drivers/extcon/extcon.h
> @@ -13,8 +13,8 @@
>   *			are disabled.
>   * @mutually_exclusive:	Array of mutually exclusive set of cables that cannot
>   *			be attached simultaneously. The array should be
> - *			ending with NULL or be NULL (no mutually exclusive
> - *			cables). For example, if it is { 0x7, 0x30, 0}, then,
> + *			ending with 0 or be NULL (no mutually exclusive cables).
> + *			For example, if it is {0x7, 0x30, 0}, then,
>   *			{0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot
>   *			be attached simulataneously. {0x7, 0} is equivalent to
>   *			{0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there
> @@ -27,7 +27,7 @@
>   * @nh:			Notifier for the state change events from this extcon
>   * @entry:		To support list of extcon devices so that users can
>   *			search for extcon devices based on the extcon name.
> - * @lock:
> + * @lock:		Protects device state and serialises device registration
>   * @max_supported:	Internal value to store the number of cables.
>   * @extcon_dev_type:	Device_type struct to provide attribute_groups
>   *			customized for each extcon device.


Applied it.

-- 
Best Regards,
Samsung Electronics
Chanwoo Choi