diff mbox series

[v3] firewire: init_ohci1394_dma: use correct function names in comments

Message ID 20230410011306.26268-1-rdunlap@infradead.org
State New
Headers
Series [v3] firewire: init_ohci1394_dma: use correct function names in comments |

Commit Message

Randy Dunlap April 10, 2023, 1:13 a.m. UTC 
  Prevent kernel-doc complaints by using the correct function names in
kernel-doc comments:

drivers/firewire/init_ohci1394_dma.c:258: warning: expecting prototype for debug_init_ohci1394_dma(). Prototype was for init_ohci1394_dma_on_all_controllers() instead
drivers/firewire/init_ohci1394_dma.c:289: warning: expecting prototype for setup_init_ohci1394_early(). Prototype was for setup_ohci1394_dma() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Stefan Richter <stefanr@s5r6.in-berlin.de>
Cc: linux1394-devel@lists.sourceforge.net
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Takashi Sakamoto <o-takashi@sakamocchi.jp>
---
v2: rebase/resend, add note to Andrew
v3: add Takashi-san

 drivers/firewire/init_ohci1394_dma.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Takashi Sakamoto April 11, 2023, 12:05 a.m. UTC | #1 
On Sun, Apr 09, 2023 at 06:13:06PM -0700, Randy Dunlap wrote:
> Prevent kernel-doc complaints by using the correct function names in
> kernel-doc comments:
> 
> drivers/firewire/init_ohci1394_dma.c:258: warning: expecting prototype for debug_init_ohci1394_dma(). Prototype was for init_ohci1394_dma_on_all_controllers() instead
> drivers/firewire/init_ohci1394_dma.c:289: warning: expecting prototype for setup_init_ohci1394_early(). Prototype was for setup_ohci1394_dma() instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Stefan Richter <stefanr@s5r6.in-berlin.de>
> Cc: linux1394-devel@lists.sourceforge.net
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: Takashi Sakamoto <o-takashi@sakamocchi.jp>
> ---
> v2: rebase/resend, add note to Andrew
> v3: add Takashi-san
> 
>  drivers/firewire/init_ohci1394_dma.c |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Thank you to remind it to me.

Acked-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
 
By the way, I got enough access permission to linux1394.git repository
and I'm preparing it for maintenance work (not done yet).

* https://git.kernel.org/pub/scm/linux/kernel/git/ieee1394/linux1394.git/

After finishing the preparation (e.g. joining to linux-next integration),
I'll apply your patch and tell it to you, within the week.

> diff -- a/drivers/firewire/init_ohci1394_dma.c b/drivers/firewire/init_ohci1394_dma.c
> --- a/drivers/firewire/init_ohci1394_dma.c
> +++ b/drivers/firewire/init_ohci1394_dma.c
> @@ -251,7 +251,7 @@ static inline void __init init_ohci1394_
>  }
>  
>  /**
> - * debug_init_ohci1394_dma - scan for OHCI1394 controllers and init DMA on them
> + * init_ohci1394_dma_on_all_controllers - scan for OHCI1394 controllers and init DMA on them
>   * Scans the whole PCI space for OHCI1394 controllers and inits DMA on them
>   */
>  void __init init_ohci1394_dma_on_all_controllers(void)
> @@ -283,7 +283,7 @@ void __init init_ohci1394_dma_on_all_con
>  }
>  
>  /**
> - * setup_init_ohci1394_early - enables early OHCI1394 DMA initialization
> + * setup_ohci1394_dma - enables early OHCI1394 DMA initialization
>   */
>  static int __init setup_ohci1394_dma(char *opt)
>  {

Kind regards

Takashi Sakamoto
Takashi Sakamoto April 20, 2023, 4:04 p.m. UTC | #2 
On Sun, Apr 09, 2023 at 06:13:06PM -0700, Randy Dunlap wrote:
> Prevent kernel-doc complaints by using the correct function names in
> kernel-doc comments:
> 
> drivers/firewire/init_ohci1394_dma.c:258: warning: expecting prototype for debug_init_ohci1394_dma(). Prototype was for init_ohci1394_dma_on_all_controllers() instead
> drivers/firewire/init_ohci1394_dma.c:289: warning: expecting prototype for setup_init_ohci1394_early(). Prototype was for setup_ohci1394_dma() instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Stefan Richter <stefanr@s5r6.in-berlin.de>
> Cc: linux1394-devel@lists.sourceforge.net
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: Takashi Sakamoto <o-takashi@sakamocchi.jp>
> ---
> v2: rebase/resend, add note to Andrew
> v3: add Takashi-san
> 
>  drivers/firewire/init_ohci1394_dma.c |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

The patch is applied to for-next branch for v6.4 kernel:

* https://git.kernel.org/pub/scm/linux/kernel/git/ieee1394/linux1394.git/

You can see the patch in linux-next integration as well.


Thanks for your patience

Takashi Sakamoto
diff mbox series

Patch

diff -- a/drivers/firewire/init_ohci1394_dma.c b/drivers/firewire/init_ohci1394_dma.c
--- a/drivers/firewire/init_ohci1394_dma.c
+++ b/drivers/firewire/init_ohci1394_dma.c
@@ -251,7 +251,7 @@  static inline void __init init_ohci1394_
 }
 
 /**
- * debug_init_ohci1394_dma - scan for OHCI1394 controllers and init DMA on them
+ * init_ohci1394_dma_on_all_controllers - scan for OHCI1394 controllers and init DMA on them
  * Scans the whole PCI space for OHCI1394 controllers and inits DMA on them
  */
 void __init init_ohci1394_dma_on_all_controllers(void)
@@ -283,7 +283,7 @@  void __init init_ohci1394_dma_on_all_con
 }
 
 /**
- * setup_init_ohci1394_early - enables early OHCI1394 DMA initialization
+ * setup_ohci1394_dma - enables early OHCI1394 DMA initialization
  */
 static int __init setup_ohci1394_dma(char *opt)
 {