diff mbox series

[09/10] mfd: atmel-smc: Add missing colon(s) for 'conf' arguments

Message ID 20200625064619.2775707-10-lee.jones@linaro.org
State New
Headers show
Series [01/10] mfd: wm8350-core: Supply description wm8350_reg_{un}lock args | expand

Commit Message

Lee Jones June 25, 2020, 6:46 a.m. UTC 
Kerneldoc valication gets confused if syntax isn't "@.*: ".

Adding the missing colons squashes the following W=1 warnings:

drivers/mfd/atmel-smc.c:247: warning: Function parameter or member 'conf' not described in 'atmel_smc_cs_conf_apply'
drivers/mfd/atmel-smc.c:268: warning: Function parameter or member 'conf' not described in 'atmel_hsmc_cs_conf_apply'

Cc: <stable@vger.kernel.org>
Cc: Nicolas Ferre <nicolas.ferre@microchip.com>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
Cc: Ludovic Desroches <ludovic.desroches@microchip.com>
Cc: Boris Brezillon <boris.brezillon@free-electrons.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/mfd/atmel-smc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

-- 
2.25.1

Comments

Greg Kroah-Hartman June 25, 2020, 6:55 a.m. UTC | #1 
On Thu, Jun 25, 2020 at 07:46:18AM +0100, Lee Jones wrote:
> Kerneldoc valication gets confused if syntax isn't "@.*: ".

> 

> Adding the missing colons squashes the following W=1 warnings:

> 

> drivers/mfd/atmel-smc.c:247: warning: Function parameter or member 'conf' not described in 'atmel_smc_cs_conf_apply'

> drivers/mfd/atmel-smc.c:268: warning: Function parameter or member 'conf' not described in 'atmel_hsmc_cs_conf_apply'


Why is this a stable patch?
Alexandre Belloni June 26, 2020, 8:56 p.m. UTC | #2 
On 25/06/2020 07:46:18+0100, Lee Jones wrote:
> Kerneldoc valication gets confused if syntax isn't "@.*: ".

> 

> Adding the missing colons squashes the following W=1 warnings:

> 

> drivers/mfd/atmel-smc.c:247: warning: Function parameter or member 'conf' not described in 'atmel_smc_cs_conf_apply'

> drivers/mfd/atmel-smc.c:268: warning: Function parameter or member 'conf' not described in 'atmel_hsmc_cs_conf_apply'

> 

Reviewed-by: Alexandre Belloni <alexandre.belloni@bootlin.com>


> Cc: <stable@vger.kernel.org>

> Cc: Nicolas Ferre <nicolas.ferre@microchip.com>

> Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>

> Cc: Ludovic Desroches <ludovic.desroches@microchip.com>

> Cc: Boris Brezillon <boris.brezillon@free-electrons.com>

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>  drivers/mfd/atmel-smc.c | 4 ++--

>  1 file changed, 2 insertions(+), 2 deletions(-)

> 

> diff --git a/drivers/mfd/atmel-smc.c b/drivers/mfd/atmel-smc.c

> index 17bbe9d1fa740..4aac96d213369 100644

> --- a/drivers/mfd/atmel-smc.c

> +++ b/drivers/mfd/atmel-smc.c

> @@ -237,7 +237,7 @@ EXPORT_SYMBOL_GPL(atmel_smc_cs_conf_set_cycle);

>   * atmel_smc_cs_conf_apply - apply an SMC CS conf

>   * @regmap: the SMC regmap

>   * @cs: the CS id

> - * @conf the SMC CS conf to apply

> + * @conf: the SMC CS conf to apply

>   *

>   * Applies an SMC CS configuration.

>   * Only valid on at91sam9/avr32 SoCs.

> @@ -257,7 +257,7 @@ EXPORT_SYMBOL_GPL(atmel_smc_cs_conf_apply);

>   * @regmap: the HSMC regmap

>   * @cs: the CS id

>   * @layout: the layout of registers

> - * @conf the SMC CS conf to apply

> + * @conf: the SMC CS conf to apply

>   *

>   * Applies an SMC CS configuration.

>   * Only valid on post-sama5 SoCs.

> -- 

> 2.25.1

> 


-- 
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
Sasha Levin July 1, 2020, 7:33 p.m. UTC | #3 
Hi

[This is an automated email]

This commit has been processed because it contains a -stable tag.
The stable tag indicates that it's relevant for the following trees: all

The bot has tested the following trees: v5.7.6, v5.4.49, v4.19.130, v4.14.186, v4.9.228, v4.4.228.

v5.7.6: Build OK!
v5.4.49: Build OK!
v4.19.130: Build OK!
v4.14.186: Build OK!
v4.9.228: Failed to apply! Possible dependencies:
    87108dc78eb89 ("memory: atmel-ebi: Enable the SMC clock if specified")
    8eb8c7d844b9d ("memory: atmel-ebi: Simplify SMC config code")
    b0f3ab20e7649 ("mfd: syscon: atmel-smc: Add helper to retrieve register layout")
    b5169d35ed585 ("mtd: nand: atmel: return error code of nand_scan_ident/tail() on error")
    f88fc122cc34c ("mtd: nand: Cleanup/rework the atmel_nand driver")
    f9ce2eddf1769 ("mtd: nand: atmel: Add ->setup_data_interface() hooks")
    fe9d7cb22ef3a ("mfd: syscon: atmel-smc: Add new helpers to ease SMC regs manipulation")

v4.4.228: Failed to apply! Possible dependencies:
    1d8d8b5c852b6 ("mtd: nand: fix drivers abusing mtd->priv")
    4bd4ebcc540c3 ("mtd: nand: make use of mtd_to_nand() in NAND drivers")
    5575075612cad ("mtd: atmel_nand: Support PMECC on SAMA5D2")
    5ddc7bd43ccc7 ("mtd: atmel_nand: Support variable RB_EDGE interrupts")
    66e8e47eae658 ("mtd: pxa3xx_nand: Fix initial controller configuration")
    6a4ec4cd08888 ("memory: add Atmel EBI (External Bus Interface) driver")
    72eaec21b0cf1 ("mtd: nand: atmel_nand: constify atmel_nand_caps structures")
    87108dc78eb89 ("memory: atmel-ebi: Enable the SMC clock if specified")
    8eb8c7d844b9d ("memory: atmel-ebi: Simplify SMC config code")
    b0f3ab20e7649 ("mfd: syscon: atmel-smc: Add helper to retrieve register layout")
    c7f00c29aa846 ("mtd: pxa3xx_nand: Increase the initial chunk size")
    cc00383722db7 ("mtd: nand: atmel: switch to mtd_ooblayout_ops")
    d699ed250c073 ("mtd: nand: make use of nand_set/get_controller_data() helpers")
    ee194289502a6 ("memory/atmel-ebi: Fix ns <-> cycles conversions")
    ee4fec5f44a2c ("memory: atmel-ebi: use PTR_ERR_OR_ZERO() to simplify the code")
    f88fc122cc34c ("mtd: nand: Cleanup/rework the atmel_nand driver")
    fe9d7cb22ef3a ("mfd: syscon: atmel-smc: Add new helpers to ease SMC regs manipulation")


NOTE: The patch will not be queued to stable trees until it is upstream.

How should we proceed with this patch?

-- 
Thanks
Sasha
Lee Jones July 2, 2020, 6:36 a.m. UTC | #4 
On Wed, 01 Jul 2020, Sasha Levin wrote:

> Hi

> 

> [This is an automated email]

> 

> This commit has been processed because it contains a -stable tag.

> The stable tag indicates that it's relevant for the following trees: all

> 

> The bot has tested the following trees: v5.7.6, v5.4.49, v4.19.130, v4.14.186, v4.9.228, v4.4.228.

> 

> v5.7.6: Build OK!

> v5.4.49: Build OK!

> v4.19.130: Build OK!

> v4.14.186: Build OK!

> v4.9.228: Failed to apply! Possible dependencies:

>     87108dc78eb89 ("memory: atmel-ebi: Enable the SMC clock if specified")

>     8eb8c7d844b9d ("memory: atmel-ebi: Simplify SMC config code")

>     b0f3ab20e7649 ("mfd: syscon: atmel-smc: Add helper to retrieve register layout")

>     b5169d35ed585 ("mtd: nand: atmel: return error code of nand_scan_ident/tail() on error")

>     f88fc122cc34c ("mtd: nand: Cleanup/rework the atmel_nand driver")

>     f9ce2eddf1769 ("mtd: nand: atmel: Add ->setup_data_interface() hooks")

>     fe9d7cb22ef3a ("mfd: syscon: atmel-smc: Add new helpers to ease SMC regs manipulation")

> 

> v4.4.228: Failed to apply! Possible dependencies:

>     1d8d8b5c852b6 ("mtd: nand: fix drivers abusing mtd->priv")

>     4bd4ebcc540c3 ("mtd: nand: make use of mtd_to_nand() in NAND drivers")

>     5575075612cad ("mtd: atmel_nand: Support PMECC on SAMA5D2")

>     5ddc7bd43ccc7 ("mtd: atmel_nand: Support variable RB_EDGE interrupts")

>     66e8e47eae658 ("mtd: pxa3xx_nand: Fix initial controller configuration")

>     6a4ec4cd08888 ("memory: add Atmel EBI (External Bus Interface) driver")

>     72eaec21b0cf1 ("mtd: nand: atmel_nand: constify atmel_nand_caps structures")

>     87108dc78eb89 ("memory: atmel-ebi: Enable the SMC clock if specified")

>     8eb8c7d844b9d ("memory: atmel-ebi: Simplify SMC config code")

>     b0f3ab20e7649 ("mfd: syscon: atmel-smc: Add helper to retrieve register layout")

>     c7f00c29aa846 ("mtd: pxa3xx_nand: Increase the initial chunk size")

>     cc00383722db7 ("mtd: nand: atmel: switch to mtd_ooblayout_ops")

>     d699ed250c073 ("mtd: nand: make use of nand_set/get_controller_data() helpers")

>     ee194289502a6 ("memory/atmel-ebi: Fix ns <-> cycles conversions")

>     ee4fec5f44a2c ("memory: atmel-ebi: use PTR_ERR_OR_ZERO() to simplify the code")

>     f88fc122cc34c ("mtd: nand: Cleanup/rework the atmel_nand driver")

>     fe9d7cb22ef3a ("mfd: syscon: atmel-smc: Add new helpers to ease SMC regs manipulation")

> 

> 

> NOTE: The patch will not be queued to stable trees until it is upstream.

> 

> How should we proceed with this patch?


Please drop it.

Greg indicated that these should not be bound for Stable.

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
Sasha Levin July 10, 2020, 2:02 p.m. UTC | #5 
Hi

[This is an automated email]

This commit has been processed because it contains a -stable tag.
The stable tag indicates that it's relevant for the following trees: all

The bot has tested the following trees: v5.7.6, v5.4.49, v4.19.130, v4.14.186, v4.9.228, v4.4.228.

v5.7.6: Build OK!
v5.4.49: Build OK!
v4.19.130: Build OK!
v4.14.186: Build OK!
v4.9.228: Failed to apply! Possible dependencies:
    87108dc78eb89 ("memory: atmel-ebi: Enable the SMC clock if specified")
    8eb8c7d844b9d ("memory: atmel-ebi: Simplify SMC config code")
    b0f3ab20e7649 ("mfd: syscon: atmel-smc: Add helper to retrieve register layout")
    b5169d35ed585 ("mtd: nand: atmel: return error code of nand_scan_ident/tail() on error")
    f88fc122cc34c ("mtd: nand: Cleanup/rework the atmel_nand driver")
    f9ce2eddf1769 ("mtd: nand: atmel: Add ->setup_data_interface() hooks")
    fe9d7cb22ef3a ("mfd: syscon: atmel-smc: Add new helpers to ease SMC regs manipulation")

v4.4.228: Failed to apply! Possible dependencies:
    1d8d8b5c852b6 ("mtd: nand: fix drivers abusing mtd->priv")
    4bd4ebcc540c3 ("mtd: nand: make use of mtd_to_nand() in NAND drivers")
    5575075612cad ("mtd: atmel_nand: Support PMECC on SAMA5D2")
    5ddc7bd43ccc7 ("mtd: atmel_nand: Support variable RB_EDGE interrupts")
    66e8e47eae658 ("mtd: pxa3xx_nand: Fix initial controller configuration")
    6a4ec4cd08888 ("memory: add Atmel EBI (External Bus Interface) driver")
    72eaec21b0cf1 ("mtd: nand: atmel_nand: constify atmel_nand_caps structures")
    87108dc78eb89 ("memory: atmel-ebi: Enable the SMC clock if specified")
    8eb8c7d844b9d ("memory: atmel-ebi: Simplify SMC config code")
    b0f3ab20e7649 ("mfd: syscon: atmel-smc: Add helper to retrieve register layout")
    c7f00c29aa846 ("mtd: pxa3xx_nand: Increase the initial chunk size")
    cc00383722db7 ("mtd: nand: atmel: switch to mtd_ooblayout_ops")
    d699ed250c073 ("mtd: nand: make use of nand_set/get_controller_data() helpers")
    ee194289502a6 ("memory/atmel-ebi: Fix ns <-> cycles conversions")
    ee4fec5f44a2c ("memory: atmel-ebi: use PTR_ERR_OR_ZERO() to simplify the code")
    f88fc122cc34c ("mtd: nand: Cleanup/rework the atmel_nand driver")
    fe9d7cb22ef3a ("mfd: syscon: atmel-smc: Add new helpers to ease SMC regs manipulation")


NOTE: The patch will not be queued to stable trees until it is upstream.

How should we proceed with this patch?

-- 
Thanks
Sasha
diff mbox series

Patch

diff --git a/drivers/mfd/atmel-smc.c b/drivers/mfd/atmel-smc.c
index 17bbe9d1fa740..4aac96d213369 100644
--- a/drivers/mfd/atmel-smc.c
+++ b/drivers/mfd/atmel-smc.c
@@ -237,7 +237,7 @@  EXPORT_SYMBOL_GPL(atmel_smc_cs_conf_set_cycle);
  * atmel_smc_cs_conf_apply - apply an SMC CS conf
  * @regmap: the SMC regmap
  * @cs: the CS id
- * @conf the SMC CS conf to apply
+ * @conf: the SMC CS conf to apply
  *
  * Applies an SMC CS configuration.
  * Only valid on at91sam9/avr32 SoCs.
@@ -257,7 +257,7 @@  EXPORT_SYMBOL_GPL(atmel_smc_cs_conf_apply);
  * @regmap: the HSMC regmap
  * @cs: the CS id
  * @layout: the layout of registers
- * @conf the SMC CS conf to apply
+ * @conf: the SMC CS conf to apply
  *
  * Applies an SMC CS configuration.
  * Only valid on post-sama5 SoCs.