2024-01-17 05:56:01

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH 00/13] ARM: OMAP2+: fix a bunch of kernel-doc warnings

Fix many kernel-doc warnings in arch/arm/mach-omap2/:

[PATCH 01/13] ARM: OMAP2+: am33xx-restart: fix function name in kernel-doc
[PATCH 02/13] ARM: OMAP2+: clockdomain: fix kernel-doc warnings
[PATCH 03/13] ARM: OMAP2+: clock: fix a function name in kernel-doc
[PATCH 04/13] ARM: OMAP2+: cm33xx: use matching function name in kernel-doc
[PATCH 05/13] ARM: OMAP2+: CMINST: use matching function name in kernel-doc
[PATCH 06/13] ARM: OMAP2+: hwmod: remove misuse of kernel-doc
[PATCH 07/13] ARM: OMAP2+: hwmod: fix kernel-doc warnings
[PATCH 08/13] ARM: OMAP2+: pmic-cpcap: fix kernel-doc warnings
[PATCH 09/13] ARM: OMAP2+: prm44xx: fix a kernel-doc warning
[PATCH 10/13] ARM: OMAP2+: PRM: fix kernel-doc warnings
[PATCH 11/13] ARM: OMAP2+: fix a kernel-doc warning
[PATCH 12/13] ARM: OMAP2+: fix kernel-doc warnings
[PATCH 13/13] ARM: OMAP2+: fix kernel-doc warnings

Cc: Tony Lindgren <[email protected]>
Cc: [email protected]
Cc: Russell King <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: Paul Walmsley <[email protected]>
Cc: "BenoĆ®t Cousson" <[email protected]>
Cc: Kevin Hilman <[email protected]>


2024-01-17 06:09:46

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH 11/13] ARM: OMAP2+: fix a kernel-doc warning

Use the correct function name in a kernel-doc comment to prevent a
warning:

powerdomain.c:1171: warning: expecting prototype for pwrdm_save_context(). Prototype was for pwrdm_restore_context() instead

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Tony Lindgren <[email protected]>
Cc: [email protected]
Cc: Russell King <[email protected]>
Cc: [email protected]
Cc: [email protected]
---
KernelVersion: 0dd3ee31125508cd67f7e717

arch/arm/mach-omap2/powerdomain.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/arch/arm/mach-omap2/powerdomain.c b/arch/arm/mach-omap2/powerdomain.c
--- a/arch/arm/mach-omap2/powerdomain.c
+++ b/arch/arm/mach-omap2/powerdomain.c
@@ -1162,7 +1162,7 @@ static int pwrdm_save_context(struct pow
}

/**
- * pwrdm_save_context - restore powerdomain registers
+ * pwrdm_restore_context - restore powerdomain registers
*
* Restore powerdomain control registers after a suspend or resume
* event.

2024-01-17 07:41:09

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH 10/13] ARM: OMAP2+: PRM: fix kernel-doc warnings

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 <[email protected]>
Cc: Paul Walmsley <[email protected]>
Cc: Tony Lindgren <[email protected]>
Cc: [email protected]
Cc: Russell King <[email protected]>
Cc: [email protected]
Cc: [email protected]
---
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.

2024-01-17 08:56:06

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH 09/13] ARM: OMAP2+: prm44xx: fix a kernel-doc warning

Use the correct function name in a kernel-doc comment to prevent a
warning:

prm44xx.c:421: warning: expecting prototype for omap44xx_prm_clear_context_lost_flags_old(). Prototype was for omap44xx_prm_clear_context_loss_flags_old() instead

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Paul Walmsley <[email protected]>
Cc: Tony Lindgren <[email protected]>
Cc: [email protected]
Cc: Russell King <[email protected]>
Cc: [email protected]
Cc: [email protected]
---
KernelVersion: 0dd3ee31125508cd67f7e717

arch/arm/mach-omap2/prm44xx.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/arch/arm/mach-omap2/prm44xx.c b/arch/arm/mach-omap2/prm44xx.c
--- a/arch/arm/mach-omap2/prm44xx.c
+++ b/arch/arm/mach-omap2/prm44xx.c
@@ -407,7 +407,7 @@ static bool omap44xx_prm_was_any_context
}

/**
- * omap44xx_prm_clear_context_lost_flags_old - clear context loss flags
+ * omap44xx_prm_clear_context_loss_flags_old - clear context loss flags
* @part: PRM partition ID (e.g., OMAP4430_PRM_PARTITION)
* @inst: PRM instance offset (e.g., OMAP4430_PRM_MPU_INST)
* @idx: CONTEXT register offset

2024-01-17 15:40:17

by Tony Lindgren

[permalink] [raw]
Subject: Re: [PATCH 00/13] ARM: OMAP2+: fix a bunch of kernel-doc warnings

* Randy Dunlap <[email protected]> [240117 01:10]:
> Fix many kernel-doc warnings in arch/arm/mach-omap2/:

Thanks for fixing these. These are unlikely to conflict with anything so
please queue them along with other clean-up:

Acked-by: Tony Lindgren <[email protected]>

Or alternatively let me know if you want me to apply them.

Regards,

Tony

2024-01-17 22:01:05

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH 00/13] ARM: OMAP2+: fix a bunch of kernel-doc warnings



On 1/17/24 05:13, Tony Lindgren wrote:
> * Randy Dunlap <[email protected]> [240117 01:10]:
>> Fix many kernel-doc warnings in arch/arm/mach-omap2/:
>
> Thanks for fixing these. These are unlikely to conflict with anything so
> please queue them along with other clean-up:
>
> Acked-by: Tony Lindgren <[email protected]>
>
> Or alternatively let me know if you want me to apply them.

Yes, please go ahead and apply them.

Thanks.

--
#Randy

2024-01-18 15:01:26

by Tony Lindgren

[permalink] [raw]
Subject: Re: [PATCH 00/13] ARM: OMAP2+: fix a bunch of kernel-doc warnings

* Randy Dunlap <[email protected]> [240117 16:52]:
>
>
> On 1/17/24 05:13, Tony Lindgren wrote:
> > * Randy Dunlap <[email protected]> [240117 01:10]:
> >> Fix many kernel-doc warnings in arch/arm/mach-omap2/:
> >
> > Thanks for fixing these. These are unlikely to conflict with anything so
> > please queue them along with other clean-up:
> >
> > Acked-by: Tony Lindgren <[email protected]>
> >
> > Or alternatively let me know if you want me to apply them.
>
> Yes, please go ahead and apply them.

OK will do after -rc1.

Thanks,

Tony

2024-01-26 14:57:30

by Tony Lindgren

[permalink] [raw]
Subject: Re: [PATCH 00/13] ARM: OMAP2+: fix a bunch of kernel-doc warnings

* Tony Lindgren <[email protected]> [240118 08:57]:
> * Randy Dunlap <[email protected]> [240117 16:52]:
> > Yes, please go ahead and apply them.
>
> OK will do after -rc1.

Applied now into omap-for-v6.9/soc branch thanks [0].

Tony

[0] https://git.kernel.org/pub/scm/linux/kernel/git/tmlind/linux-omap.git/log/?h=omap-for-v6.9/soc

2024-02-01 17:45:15

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH 00/13] ARM: OMAP2+: fix a bunch of kernel-doc warnings



On 2/1/24 01:32, Russell King (Oracle) wrote:
> On Wed, Jan 17, 2024 at 08:52:16AM -0800, Randy Dunlap wrote:
>>
>>
>> On 1/17/24 05:13, Tony Lindgren wrote:
>>> * Randy Dunlap <[email protected]> [240117 01:10]:
>>>> Fix many kernel-doc warnings in arch/arm/mach-omap2/:
>>>
>>> Thanks for fixing these. These are unlikely to conflict with anything so
>>> please queue them along with other clean-up:
>>>
>>> Acked-by: Tony Lindgren <[email protected]>
>>>
>>> Or alternatively let me know if you want me to apply them.
>>
>> Yes, please go ahead and apply them.
>
> If you intend people other than me to apply patches, then please do not
> copy the patches to the patch system. I now have to go through all 16
> patches and search the mailing list to find out what happened... and so
> far for the few I've checked, other people have applied them. So I'm
> coming to the conclusion I should just discard the entire lot.
>

Got it. and sorry about that. :(


--
#Randy