of: overlay: enable of_overlay_fdt_apply() kerneldoc

Message ID 20231106-of_overlay_fdt_apply-kerneldoc-v1-1-9a2d132bc6c1@bootlin.com
State New
Headers
Series of: overlay: enable of_overlay_fdt_apply() kerneldoc |

Commit Message

Luca Ceresoli Nov. 6, 2023, 1:03 p.m. UTC
  of_overlay_fdt_apply() already has a kerneldoc-formatted documentation,
except it is nor marked as such. Adding the second asterisk is enough for
the documentation to take it into account correctly.

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
 drivers/of/overlay.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


---
base-commit: d2f51b3516dade79269ff45eae2a7668ae711b25
change-id: 20231106-of_overlay_fdt_apply-kerneldoc-56ab41cc83d3

Best regards,
  

Comments

Geert Uytterhoeven Nov. 6, 2023, 4:40 p.m. UTC | #1
On Mon, Nov 6, 2023 at 2:03 PM Luca Ceresoli <luca.ceresoli@bootlin.com> wrote:
> of_overlay_fdt_apply() already has a kerneldoc-formatted documentation,
> except it is nor marked as such. Adding the second asterisk is enough for
> the documentation to take it into account correctly.
>
> Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>

Reviewed-by: Geert Uytterhoeven <geert+renesas@glider.be>

Gr{oetje,eeting}s,

                        Geert
  
Rob Herring Nov. 8, 2023, 6:07 p.m. UTC | #2
On Mon, 06 Nov 2023 14:03:24 +0100, Luca Ceresoli wrote:
> of_overlay_fdt_apply() already has a kerneldoc-formatted documentation,
> except it is nor marked as such. Adding the second asterisk is enough for
> the documentation to take it into account correctly.
> 
> Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
> ---
>  drivers/of/overlay.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 

Applied, thanks!
  

Patch

diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c
index a9a292d6d59b..2ae7e9d24a64 100644
--- a/drivers/of/overlay.c
+++ b/drivers/of/overlay.c
@@ -964,7 +964,7 @@  static int of_overlay_apply(struct overlay_changeset *ovcs,
 	return ret;
 }
 
-/*
+/**
  * of_overlay_fdt_apply() - Create and apply an overlay changeset
  * @overlay_fdt:	pointer to overlay FDT
  * @overlay_fdt_size:	number of bytes in @overlay_fdt