mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Paul Walmsley <paul@pwsan.com>, 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 10/13] ARM: OMAP2+: PRM: fix kernel-doc warnings
Date: Tue, 16 Jan 2024 17:09:58 -0800	[thread overview]
Message-ID: <20240117011004.22669-11-rdunlap@infradead.org> (raw)
In-Reply-To: <20240117011004.22669-1-rdunlap@infradead.org>

Use the correct function name in a kernel-doc comment.
Add function parameter descriptions in 2 places.
These changes prevent the following warnings:

prm_common.c:384: warning: expecting prototype for prm_clear_context_lost_flags_old(). Prototype was for prm_clear_context_loss_flags_old() instead
prm_common.c:505: warning: Function parameter or struct member 'vp_id' not described in 'omap_prm_vp_check_txdone'
prm_common.c:522: warning: Function parameter or struct member 'vp_id' not described in 'omap_prm_vp_clear_txdone'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Paul Walmsley <paul@pwsan.com>
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/prm_common.c |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff -- a/arch/arm/mach-omap2/prm_common.c b/arch/arm/mach-omap2/prm_common.c
--- a/arch/arm/mach-omap2/prm_common.c
+++ b/arch/arm/mach-omap2/prm_common.c
@@ -370,7 +370,7 @@ bool prm_was_any_context_lost_old(u8 par
 }
 
 /**
- * prm_clear_context_lost_flags_old - clear context loss flags (old API)
+ * prm_clear_context_loss_flags_old - clear context loss flags (old API)
  * @part: PRM partition ID (e.g., OMAP4430_PRM_PARTITION)
  * @inst: PRM instance offset (e.g., OMAP4430_PRM_MPU_INST)
  * @idx: CONTEXT register offset
@@ -497,6 +497,7 @@ int omap_prm_clear_mod_irqs(s16 module,
 
 /**
  * omap_prm_vp_check_txdone - check voltage processor TX done status
+ * @vp_id: unique VP instance ID
  *
  * Checks if voltage processor transmission has been completed.
  * Returns non-zero if a transmission has completed, 0 otherwise.
@@ -514,6 +515,7 @@ u32 omap_prm_vp_check_txdone(u8 vp_id)
 
 /**
  * omap_prm_vp_clear_txdone - clears voltage processor TX done status
+ * @vp_id: unique VP instance ID
  *
  * Clears the status bit for completed voltage processor transmission
  * returned by prm_vp_check_txdone.

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

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-17  1:09 [PATCH 00/13] ARM: OMAP2+: fix a bunch of " 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 ` [PATCH 02/13] ARM: OMAP2+: clockdomain: fix kernel-doc warnings 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 ` [PATCH 04/13] ARM: OMAP2+: cm33xx: use matching " Randy Dunlap
2024-01-17  1:09 ` [PATCH 05/13] ARM: OMAP2+: CMINST: " 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 ` [PATCH 07/13] ARM: OMAP2+: hwmod: fix kernel-doc warnings Randy Dunlap
2024-01-17  1:09 ` [PATCH 08/13] ARM: OMAP2+: pmic-cpcap: " 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 [this message]
2024-01-17  1:09 ` [PATCH 11/13] ARM: OMAP2+: " Randy Dunlap
2024-01-17  1:10 ` [PATCH 12/13] ARM: OMAP2+: fix kernel-doc warnings Randy Dunlap
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 16:52   ` Randy Dunlap
2024-01-18  8:57     ` Tony Lindgren
2024-01-26  8:39       ` Tony Lindgren
2024-02-01  9:32     ` Russell King (Oracle)
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-11-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=paul@pwsan.com \
    --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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®