Re: [PATCH 01/10] of: device: Fix function name in header and demote kernel-doc abuse

On Fri, 12 Mar 2021, Rob Herring wrote:

On Fri, Mar 12, 2021 at 4:08 AM Lee Jones [off-list ref] wrote:

quoted

Fixes the following W=1 kernel build warning(s):

 drivers/of/device.c:72: warning: expecting prototype for of_dma_configure(). Prototype was for of_dma_configure_id() instead
 drivers/of/device.c:263: warning: Function parameter or member 'dev' not described in 'of_device_modalias'
 drivers/of/device.c:263: warning: Function parameter or member 'str' not described in 'of_device_modalias'
 drivers/of/device.c:263: warning: Function parameter or member 'len' not described in 'of_device_modalias'
 drivers/of/device.c:280: warning: Function parameter or member 'dev' not described in 'of_device_uevent'
 drivers/of/device.c:280: warning: Function parameter or member 'env' not described in 'of_device_uevent'

Cc: Rob Herring <robh+dt@kernel.org>
Cc: Frank Rowand <redacted>
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <redacted>
---
 drivers/of/device.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/of/device.c b/drivers/of/device.c
index 6cb86de404f1c..64ee363abde24 100644
--- a/drivers/of/device.c
+++ b/drivers/of/device.c

@@ -53,7 +53,7 @@ int of_device_add(struct platform_device *ofdev)
 }

 /**
- * of_dma_configure - Setup DMA configuration
+ * of_dma_configure_id - Setup DMA configuration
  * @dev:       Device to apply DMA configuration
  * @np:                Pointer to OF node having DMA configuration
  * @force_dma:  Whether device is to be set up by of_dma_configure() even if

@@ -256,7 +256,7 @@ int of_device_request_module(struct device *dev)
 }
 EXPORT_SYMBOL_GPL(of_device_request_module);

-/**
+/*

We should fix the kerneldoc on public functions. Demoting is fine on
static or internal to the DT code.

This file is not referenced by Kernel-Doc.

  `git grep kernel-doc:: | grep drivers/of`

quoted

  * of_device_modalias - Fill buffer with newline terminated modalias string
  */
 ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)

@@ -273,7 +273,7 @@ ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)
 }
 EXPORT_SYMBOL_GPL(of_device_modalias);

-/**
+/*
  * of_device_uevent - Display OF related uevent information
  */
 void of_device_uevent(struct device *dev, struct kobj_uevent_env *env)

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog