Skip to contentSkip to conversation

fpga: region: fix kernel-doc

PATCH Superseded Yang Li 3 participants 3 messages Dec 3, 2021 FPGA manager framework

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 fpga: region: fix kernel-doc

Fix function name in of-fpga-region.c kernel-doc comment to remove a warning found by clang(make W=1 LLVM=1).

drivers/fpga/of-fpga-region.c:451: warning: expecting prototype for fpga_region_init(). Prototype was for of_fpga_region_init() instead.

---
 drivers/fpga/of-fpga-region.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/fpga/of-fpga-region.c +1 -1
index 9c662db..50b8305 100644
@@ -444,7 +444,7 @@ static int of_fpga_region_remove(struct platform_device *pdev)
 };
 
 /**
- * fpga_region_init - init function for fpga_region class
+ * of_fpga_region_init - init function for fpga_region class
  * Creates the fpga_region class and registers a reconfig notifier.
  */
 static int __init of_fpga_region_init(void)
Signature · 1 line
1.8.3.1
#1 lore raw

Hi--

Quoted 2 lines · Yang Li

Fix function name in of-fpga-region.c kernel-doc comment to remove a warning found by clang(make W=1 LLVM=1).

The patch below looks good, but the commit message about "found by clang" is not correct. Using 'make W=1' causes scripts/kernel-doc to run, and this warning message is from kernel-doc, not from clang.

Quoted 15 lines

drivers/fpga/of-fpga-region.c:451: warning: expecting prototype for fpga_region_init(). Prototype was for of_fpga_region_init() instead.

---
 drivers/fpga/of-fpga-region.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/fpga/of-fpga-region.c +0 -0
index 9c662db..50b8305 100644

drivers/fpga/of-fpga-region.c static int of_fpga_region_remove(struct platform_device *pdev) · line 450

Quoted 8 lines
drivers/fpga/of-fpga-region.c +1 -1
@@ -444,7 +444,7 @@ static int of_fpga_region_remove(struct platform_device *pdev)
 };
 
 /**
- * fpga_region_init - init function for fpga_region class
+ * of_fpga_region_init - init function for fpga_region class
  * Creates the fpga_region class and registers a reconfig notifier.
  */
 static int __init of_fpga_region_init(void)

thanks.

Signature · 1 line
~Randy
maintainer
#2 lore raw

Hi Yang,

Quoted 27 lines · Randy Dunlap

Hi--

Quoted 2 lines · Yang Li

Fix function name in of-fpga-region.c kernel-doc comment to remove a warning found by clang(make W=1 LLVM=1).

The patch below looks good, but the commit message about "found by clang" is not correct. Using 'make W=1' causes scripts/kernel-doc to run, and this warning message is from kernel-doc, not from clang.

Quoted 16 lines

drivers/fpga/of-fpga-region.c:451: warning: expecting prototype for fpga_region_init(). Prototype was for of_fpga_region_init() instead.

---
 drivers/fpga/of-fpga-region.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/fpga/of-fpga-region.c +0 -0
index 9c662db..50b8305 100644
@@ -444,7 +444,7 @@ static int of_fpga_region_remove(struct platform_device *pdev)
 };
 
Quoted 11 lines

drivers/fpga/of-fpga-region.c static int of_fpga_region_remove(struct platform_device *pdev) · line 450

Quoted 7 lines
drivers/fpga/of-fpga-region.c +1 -1
 /**
- * fpga_region_init - init function for fpga_region class
+ * of_fpga_region_init - init function for fpga_region class
  * Creates the fpga_region class and registers a reconfig notifier.
  */
 static int __init of_fpga_region_init(void)

thanks.

Signature · 1 line
~Randy

Can you resend with these addressed?

Thanks