All of lore.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Tony Lindgren <tony@atomide.com>,
	linux-omap@vger.kernel.org, Russell King <linux@armlinux.org.uk>,
	linux-arm-kernel@lists.infradead.org, patches@armlinux.org.uk
Subject: [PATCH 13/13] ARM: OMAP2+: fix kernel-doc warnings
Date: Tue, 16 Jan 2024 17:10:01 -0800	[thread overview]
Message-ID: <20240117011004.22669-14-rdunlap@infradead.org> (raw)
In-Reply-To: <20240117011004.22669-1-rdunlap@infradead.org>

Use the correct function name in a comment.
Add the return value documentation for one function.

These changes prevent these warnings:

wd_timer.c:76: warning: expecting prototype for omap2_wdtimer_reset(). Prototype was for omap2_wd_timer_reset() instead
wd_timer.c:76: warning: No description found for return value of 'omap2_wd_timer_reset'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Tony Lindgren <tony@atomide.com>
Cc: linux-omap@vger.kernel.org
Cc: Russell King <linux@armlinux.org.uk>
Cc: linux-arm-kernel@lists.infradead.org
Cc: patches@armlinux.org.uk
---
KernelVersion: 0dd3ee31125508cd67f7e717

 arch/arm/mach-omap2/wd_timer.c |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff -- a/arch/arm/mach-omap2/wd_timer.c b/arch/arm/mach-omap2/wd_timer.c
--- a/arch/arm/mach-omap2/wd_timer.c
+++ b/arch/arm/mach-omap2/wd_timer.c
@@ -57,7 +57,7 @@ int omap2_wd_timer_disable(struct omap_h
 }
 
 /**
- * omap2_wdtimer_reset - reset and disable the WDTIMER IP block
+ * omap2_wd_timer_reset - reset and disable the WDTIMER IP block
  * @oh: struct omap_hwmod *
  *
  * After the WDTIMER IP blocks are reset on OMAP2/3, we must also take
@@ -71,6 +71,8 @@ int omap2_wd_timer_disable(struct omap_h
  * during a normal merge window.  omap_hwmod_softreset() should be
  * renamed to omap_hwmod_set_ocp_softreset(), and omap_hwmod_softreset()
  * should call the hwmod _ocp_softreset() code.
+ *
+ * Returns: %0 on success or -errno value on error.
  */
 int omap2_wd_timer_reset(struct omap_hwmod *oh)
 {

WARNING: multiple messages have this Message-ID (diff)
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Tony Lindgren <tony@atomide.com>,
	linux-omap@vger.kernel.org, Russell King <linux@armlinux.org.uk>,
	linux-arm-kernel@lists.infradead.org, patches@armlinux.org.uk
Subject: [PATCH 13/13] ARM: OMAP2+: fix kernel-doc warnings
Date: Tue, 16 Jan 2024 17:10:01 -0800	[thread overview]
Message-ID: <20240117011004.22669-14-rdunlap@infradead.org> (raw)
In-Reply-To: <20240117011004.22669-1-rdunlap@infradead.org>

Use the correct function name in a comment.
Add the return value documentation for one function.

These changes prevent these warnings:

wd_timer.c:76: warning: expecting prototype for omap2_wdtimer_reset(). Prototype was for omap2_wd_timer_reset() instead
wd_timer.c:76: warning: No description found for return value of 'omap2_wd_timer_reset'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Tony Lindgren <tony@atomide.com>
Cc: linux-omap@vger.kernel.org
Cc: Russell King <linux@armlinux.org.uk>
Cc: linux-arm-kernel@lists.infradead.org
Cc: patches@armlinux.org.uk
---
KernelVersion: 0dd3ee31125508cd67f7e717

 arch/arm/mach-omap2/wd_timer.c |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff -- a/arch/arm/mach-omap2/wd_timer.c b/arch/arm/mach-omap2/wd_timer.c
--- a/arch/arm/mach-omap2/wd_timer.c
+++ b/arch/arm/mach-omap2/wd_timer.c
@@ -57,7 +57,7 @@ int omap2_wd_timer_disable(struct omap_h
 }
 
 /**
- * omap2_wdtimer_reset - reset and disable the WDTIMER IP block
+ * omap2_wd_timer_reset - reset and disable the WDTIMER IP block
  * @oh: struct omap_hwmod *
  *
  * After the WDTIMER IP blocks are reset on OMAP2/3, we must also take
@@ -71,6 +71,8 @@ int omap2_wd_timer_disable(struct omap_h
  * during a normal merge window.  omap_hwmod_softreset() should be
  * renamed to omap_hwmod_set_ocp_softreset(), and omap_hwmod_softreset()
  * should call the hwmod _ocp_softreset() code.
+ *
+ * Returns: %0 on success or -errno value on error.
  */
 int omap2_wd_timer_reset(struct omap_hwmod *oh)
 {

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  parent reply	other threads:[~2024-01-17  1:10 UTC|newest]

Thread overview: 40+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-17  1:09 [PATCH 00/13] ARM: OMAP2+: fix a bunch of kernel-doc warnings Randy Dunlap
2024-01-17  1:09 ` Randy Dunlap
2024-01-17  1:09 ` [PATCH 01/13] ARM: OMAP2+: am33xx-restart: fix function name in kernel-doc Randy Dunlap
2024-01-17  1:09   ` Randy Dunlap
2024-01-17  1:09 ` [PATCH 02/13] ARM: OMAP2+: clockdomain: fix kernel-doc warnings Randy Dunlap
2024-01-17  1:09   ` Randy Dunlap
2024-01-17  1:09 ` [PATCH 03/13] ARM: OMAP2+: clock: fix a function name in kernel-doc Randy Dunlap
2024-01-17  1:09   ` Randy Dunlap
2024-01-17  1:09 ` [PATCH 04/13] ARM: OMAP2+: cm33xx: use matching " Randy Dunlap
2024-01-17  1:09   ` Randy Dunlap
2024-01-17  1:09 ` [PATCH 05/13] ARM: OMAP2+: CMINST: " Randy Dunlap
2024-01-17  1:09   ` Randy Dunlap
2024-01-17  1:09 ` [PATCH 06/13] ARM: OMAP2+: hwmod: remove misuse of kernel-doc Randy Dunlap
2024-01-17  1:09   ` Randy Dunlap
2024-01-17  1:09 ` [PATCH 07/13] ARM: OMAP2+: hwmod: fix kernel-doc warnings Randy Dunlap
2024-01-17  1:09   ` Randy Dunlap
2024-01-17  1:09 ` [PATCH 08/13] ARM: OMAP2+: pmic-cpcap: " Randy Dunlap
2024-01-17  1:09   ` Randy Dunlap
2024-01-17  1:09 ` [PATCH 09/13] ARM: OMAP2+: prm44xx: fix a kernel-doc warning Randy Dunlap
2024-01-17  1:09   ` Randy Dunlap
2024-01-17  1:09 ` [PATCH 10/13] ARM: OMAP2+: PRM: fix kernel-doc warnings Randy Dunlap
2024-01-17  1:09   ` Randy Dunlap
2024-01-17  1:09 ` [PATCH 11/13] ARM: OMAP2+: fix a kernel-doc warning Randy Dunlap
2024-01-17  1:09   ` Randy Dunlap
2024-01-17  1:10 ` [PATCH 12/13] ARM: OMAP2+: fix kernel-doc warnings Randy Dunlap
2024-01-17  1:10   ` Randy Dunlap
2024-01-17  1:10 ` Randy Dunlap [this message]
2024-01-17  1:10   ` [PATCH 13/13] " Randy Dunlap
2024-01-17 13:13 ` [PATCH 00/13] ARM: OMAP2+: fix a bunch of " Tony Lindgren
2024-01-17 13:13   ` Tony Lindgren
2024-01-17 16:52   ` Randy Dunlap
2024-01-17 16:52     ` Randy Dunlap
2024-01-18  8:57     ` Tony Lindgren
2024-01-18  8:57       ` Tony Lindgren
2024-01-26  8:39       ` Tony Lindgren
2024-01-26  8:39         ` Tony Lindgren
2024-02-01  9:32     ` Russell King (Oracle)
2024-02-01  9:32       ` Russell King (Oracle)
2024-02-01 16:27       ` Randy Dunlap
2024-02-01 16:27         ` Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240117011004.22669-14-rdunlap@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-omap@vger.kernel.org \
    --cc=linux@armlinux.org.uk \
    --cc=patches@armlinux.org.uk \
    --cc=tony@atomide.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.