Skip to contentSkip to conversation

bus/fsl-mc: fix doc warning

PATCH In review ChenXiaoSong 2 participants 2 messages Jun 7, 2021 QorIQ DPAA2 fsl-mc bus driver

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 bus/fsl-mc: fix doc warning

Fix gcc W=1 warning:

drivers/bus/fsl-mc/dprc.c:345: warning: Function parameter or member 'attr' not described in 'dprc_get_attributes' drivers/bus/fsl-mc/dprc.c:521: warning: Function parameter or member 'obj_type' not described in 'dprc_get_obj_region'

---
 drivers/bus/fsl-mc/dprc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/bus/fsl-mc/dprc.c +2 -2
index 27b0a01bad9b..c862e9119b4d 100644
@@ -334,7 +334,7 @@ int dprc_clear_irq_status(struct fsl_mc_io *mc_io,
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPRC object
- * @attributes	Returned container attributes
+ * @attr	Returned container attributes
  *
  * Return:     '0' on Success; Error code otherwise.
  */
@@ -504,7 +504,7 @@ EXPORT_SYMBOL_GPL(dprc_set_obj_irq);
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPRC object
- * @obj_type;	Object type as returned in dprc_get_obj()
+ * @obj_type:	Object type as returned in dprc_get_obj()
  * @obj_id:	Unique object instance as returned in dprc_get_obj()
  * @region_index: The specific region to query
  * @region_desc:  Returns the requested region descriptor
Signature · 1 line
2.25.4
#1 lore raw

Hi,

Quoted 25 lines · ChenXiaoSong

Fix gcc W=1 warning:

drivers/bus/fsl-mc/dprc.c:345: warning: Function parameter or member 'attr' not described in 'dprc_get_attributes' drivers/bus/fsl-mc/dprc.c:521: warning: Function parameter or member 'obj_type' not described in 'dprc_get_obj_region'

---
 drivers/bus/fsl-mc/dprc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/bus/fsl-mc/dprc.c +1 -1
index 27b0a01bad9b..c862e9119b4d 100644
@@ -334,7 +334,7 @@ int dprc_clear_irq_status(struct fsl_mc_io *mc_io,
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPRC object
- * @attributes	Returned container attributes
+ * @attr	Returned container attributes
  *
  * Return:     '0' on Success; Error code otherwise.
  */

drivers/bus/fsl-mc/dprc.c EXPORT_SYMBOL_GPL(dprc_set_obj_irq); · line 510

Quoted 8 lines
drivers/bus/fsl-mc/dprc.c +1 -1
@@ -504,7 +504,7 @@ EXPORT_SYMBOL_GPL(dprc_set_obj_irq);
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPRC object
- * @obj_type;	Object type as returned in dprc_get_obj()
+ * @obj_type:	Object type as returned in dprc_get_obj()
  * @obj_id:	Unique object instance as returned in dprc_get_obj()
  * @region_index: The specific region to query
  * @region_desc:  Returns the requested region descriptor

Thanks for the patch. This was already submitted [1] as part of a larger series [2] by Lee Jones.

[1] https://lore.kernel.org/patchwork/patch/1436378/
[2] https://lore.kernel.org/patchwork/cover/1436375/

---
Best Regards, Laurentiu