[PATCH] of: overlay: enable of_overlay_fdt_apply() kerneldoc

Luca Ceresoli posted 1 patch 2 years, 1 month ago
drivers/of/overlay.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] of: overlay: enable of_overlay_fdt_apply() kerneldoc
Posted by Luca Ceresoli 2 years, 1 month ago
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(-)

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

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

Best regards,
-- 
Luca Ceresoli <luca.ceresoli@bootlin.com>
Re: [PATCH] of: overlay: enable of_overlay_fdt_apply() kerneldoc
Posted by Rob Herring 2 years, 1 month ago
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!
Re: [PATCH] of: overlay: enable of_overlay_fdt_apply() kerneldoc
Posted by Geert Uytterhoeven 2 years, 1 month ago
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

-- 
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds