[PATCH] ARM: zynq: slcr: fix function prototype kernel-doc warnings

[PATCH] ARM: zynq: slcr: fix function prototype kernel-doc warnings

[Randy Dunlap]

Use the same name in the function prototype description and the function
to prevent kernel-doc warnings:

slcr.c:158: warning: expecting prototype for zynq_slcr_cpu_state(). Prototype was for zynq_slcr_cpu_state_read() instead
slcr.c:176: warning: expecting prototype for zynq_slcr_cpu_state(). Prototype was for zynq_slcr_cpu_state_write() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Michal Simek <michal.simek@amd.com>
Cc: Russell King <linux@armlinux.org.uk>
Cc: linux-arm-kernel@lists.infradead.org
Cc: patches@armlinux.org.uk
---
KernelVersion: 0dd3ee31125508cd67f7e717

 arch/arm/mach-zynq/slcr.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff -- a/arch/arm/mach-zynq/slcr.c b/arch/arm/mach-zynq/slcr.c
--- a/arch/arm/mach-zynq/slcr.c
+++ b/arch/arm/mach-zynq/slcr.c
@@ -146,7 +146,7 @@ void zynq_slcr_cpu_stop(int cpu)
 }
 
 /**
- * zynq_slcr_cpu_state - Read/write cpu state
+ * zynq_slcr_cpu_state_read - Read cpu state
  * @cpu:	cpu number
  *
  * SLCR_REBOOT_STATUS save upper 2 bits (31/30 cpu states for cpu0 and cpu1)
@@ -165,7 +165,7 @@ bool zynq_slcr_cpu_state_read(int cpu)
 }
 
 /**
- * zynq_slcr_cpu_state - Read/write cpu state
+ * zynq_slcr_cpu_state_write - Write cpu state
  * @cpu:	cpu number
  * @die:	cpu state - true if cpu is going to die
  *

Re: [PATCH] ARM: zynq: slcr: fix function prototype kernel-doc warnings

[Michal Simek]

On 1/14/24 06:17, Randy Dunlap wrote:
> Use the same name in the function prototype description and the function
> to prevent kernel-doc warnings:
> 
> slcr.c:158: warning: expecting prototype for zynq_slcr_cpu_state(). Prototype was for zynq_slcr_cpu_state_read() instead
> slcr.c:176: warning: expecting prototype for zynq_slcr_cpu_state(). Prototype was for zynq_slcr_cpu_state_write() instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Michal Simek <michal.simek@amd.com>
> Cc: Russell King <linux@armlinux.org.uk>
> Cc: linux-arm-kernel@lists.infradead.org
> Cc: patches@armlinux.org.uk
> ---
> KernelVersion: 0dd3ee31125508cd67f7e717
> 
>   arch/arm/mach-zynq/slcr.c |    4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff -- a/arch/arm/mach-zynq/slcr.c b/arch/arm/mach-zynq/slcr.c
> --- a/arch/arm/mach-zynq/slcr.c
> +++ b/arch/arm/mach-zynq/slcr.c
> @@ -146,7 +146,7 @@ void zynq_slcr_cpu_stop(int cpu)
>   }
>   
>   /**
> - * zynq_slcr_cpu_state - Read/write cpu state
> + * zynq_slcr_cpu_state_read - Read cpu state
>    * @cpu:	cpu number
>    *
>    * SLCR_REBOOT_STATUS save upper 2 bits (31/30 cpu states for cpu0 and cpu1)
> @@ -165,7 +165,7 @@ bool zynq_slcr_cpu_state_read(int cpu)
>   }
>   
>   /**
> - * zynq_slcr_cpu_state - Read/write cpu state
> + * zynq_slcr_cpu_state_write - Write cpu state
>    * @cpu:	cpu number
>    * @die:	cpu state - true if cpu is going to die
>    *


Applied.
Thanks,
Michal