This commit adds kernel-doc style comments with complete parameter
descriptions for the function partial_decompress().
Signed-off-by: Yang Li <[email protected]>
---
arch/powerpc/boot/decompress.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/arch/powerpc/boot/decompress.c b/arch/powerpc/boot/decompress.c
index 977eb15a6d17..6835cb53f034 100644
--- a/arch/powerpc/boot/decompress.c
+++ b/arch/powerpc/boot/decompress.c
@@ -101,7 +101,7 @@ static void print_err(char *s)
* @input_size: length of the input buffer
* @outbuf: output buffer
* @output_size: length of the output buffer
- * @skip number of output bytes to ignore
+ * @_skip: number of output bytes to ignore
*
* This function takes compressed data from inbuf, decompresses and write it to
* outbuf. Once output_size bytes are written to the output buffer, or the
--
2.20.1.7.g153144c
Fix some function names in kernel-doc comments.
Signed-off-by: Yang Li <[email protected]>
---
arch/powerpc/sysdev/fsl_gtm.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/arch/powerpc/sysdev/fsl_gtm.c b/arch/powerpc/sysdev/fsl_gtm.c
index 39186ad6b3c3..71e07883eb48 100644
--- a/arch/powerpc/sysdev/fsl_gtm.c
+++ b/arch/powerpc/sysdev/fsl_gtm.c
@@ -77,7 +77,7 @@ struct gtm {
static LIST_HEAD(gtms);
/**
- * gtm_get_timer - request GTM timer to use it with the rest of GTM API
+ * gtm_get_timer16 - request GTM timer to use it with the rest of GTM API
* Context: non-IRQ
*
* This function reserves GTM timer for later use. It returns gtm_timer
@@ -110,7 +110,7 @@ struct gtm_timer *gtm_get_timer16(void)
EXPORT_SYMBOL(gtm_get_timer16);
/**
- * gtm_get_specific_timer - request specific GTM timer
+ * gtm_get_specific_timer16 - request specific GTM timer
* @gtm: specific GTM, pass here GTM's device_node->data
* @timer: specific timer number, Timer1 is 0.
* Context: non-IRQ
@@ -276,7 +276,7 @@ EXPORT_SYMBOL(gtm_set_timer16);
* crop precision of the "usec" argument, thus usec is limited to 16 bits
* (single timer width).
*/
-int gtm_set_exact_timer16(struct gtm_timer *tmr, u16 usec, bool reload)
+int gtm_set_exact_utimer16(struct gtm_timer *tmr, u16 usec, bool reload)
{
/* quite obvious, frequency which is enough for µSec precision */
const int freq = 1000000;
--
2.20.1.7.g153144c
This commit adds kernel-doc style comments with complete parameter
descriptions for the function smp_startup_cpu().
Signed-off-by: Yang Li <[email protected]>
---
arch/powerpc/platforms/cell/smp.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/arch/powerpc/platforms/cell/smp.c b/arch/powerpc/platforms/cell/smp.c
index 30394c6f8894..bdb7adde798d 100644
--- a/arch/powerpc/platforms/cell/smp.c
+++ b/arch/powerpc/platforms/cell/smp.c
@@ -55,6 +55,8 @@ static cpumask_t of_spin_map;
/**
* smp_startup_cpu() - start the given cpu
*
+ * @lcpu: Logical CPU ID of the CPU to be started.
+ *
* At boot time, there is nothing to do for primary threads which were
* started from Open Firmware. For anything else, call RTAS with the
* appropriate start location.
--
2.20.1.7.g153144c
On 4/6/24 11:39 PM, Yang Li wrote:
> This commit adds kernel-doc style comments with complete parameter
> descriptions for the function partial_decompress().
>
> Signed-off-by: Yang Li <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> arch/powerpc/boot/decompress.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/arch/powerpc/boot/decompress.c b/arch/powerpc/boot/decompress.c
> index 977eb15a6d17..6835cb53f034 100644
> --- a/arch/powerpc/boot/decompress.c
> +++ b/arch/powerpc/boot/decompress.c
> @@ -101,7 +101,7 @@ static void print_err(char *s)
> * @input_size: length of the input buffer
> * @outbuf: output buffer
> * @output_size: length of the output buffer
> - * @skip number of output bytes to ignore
> + * @_skip: number of output bytes to ignore
> *
> * This function takes compressed data from inbuf, decompresses and write it to
> * outbuf. Once output_size bytes are written to the output buffer, or the
--
#Randy
On 4/6/24 11:39 PM, Yang Li wrote:
> This commit adds kernel-doc style comments with complete parameter
> descriptions for the function smp_startup_cpu().
>
> Signed-off-by: Yang Li <[email protected]>
> ---
> arch/powerpc/platforms/cell/smp.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/arch/powerpc/platforms/cell/smp.c b/arch/powerpc/platforms/cell/smp.c
> index 30394c6f8894..bdb7adde798d 100644
> --- a/arch/powerpc/platforms/cell/smp.c
> +++ b/arch/powerpc/platforms/cell/smp.c
> @@ -55,6 +55,8 @@ static cpumask_t of_spin_map;
> /**
> * smp_startup_cpu() - start the given cpu
> *
> + * @lcpu: Logical CPU ID of the CPU to be started.
Does this work with the blank line between the function and parameter?
(i.e., no kernel-doc warnings?)
Usually it's done without the extra line.
Otherwise the additional line for @lcpu: looks good to me.
Thanks.
> + *
> * At boot time, there is nothing to do for primary threads which were
> * started from Open Firmware. For anything else, call RTAS with the
> * appropriate start location.
--
#Randy
On 4/6/24 11:39 PM, Yang Li wrote:
> Fix some function names in kernel-doc comments.
>
> Signed-off-by: Yang Li <[email protected]>
> ---
> arch/powerpc/sysdev/fsl_gtm.c | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/arch/powerpc/sysdev/fsl_gtm.c b/arch/powerpc/sysdev/fsl_gtm.c
> index 39186ad6b3c3..71e07883eb48 100644
> --- a/arch/powerpc/sysdev/fsl_gtm.c
> +++ b/arch/powerpc/sysdev/fsl_gtm.c
> @@ -77,7 +77,7 @@ struct gtm {
> static LIST_HEAD(gtms);
>
> /**
> - * gtm_get_timer - request GTM timer to use it with the rest of GTM API
> + * gtm_get_timer16 - request GTM timer to use it with the rest of GTM API
ack
> * Context: non-IRQ
> *
> * This function reserves GTM timer for later use. It returns gtm_timer
> @@ -110,7 +110,7 @@ struct gtm_timer *gtm_get_timer16(void)
> EXPORT_SYMBOL(gtm_get_timer16);
>
> /**
> - * gtm_get_specific_timer - request specific GTM timer
> + * gtm_get_specific_timer16 - request specific GTM timer
ack
> * @gtm: specific GTM, pass here GTM's device_node->data
> * @timer: specific timer number, Timer1 is 0.
> * Context: non-IRQ
> @@ -276,7 +276,7 @@ EXPORT_SYMBOL(gtm_set_timer16);
> * crop precision of the "usec" argument, thus usec is limited to 16 bits
> * (single timer width).
> */
> -int gtm_set_exact_timer16(struct gtm_timer *tmr, u16 usec, bool reload)
> +int gtm_set_exact_utimer16(struct gtm_timer *tmr, u16 usec, bool reload)
No, change the kernel-doc comment instead. Otherwise the caller will fail to link.
> {
> /* quite obvious, frequency which is enough for µSec precision */
> const int freq = 1000000;
thanks.
--
#Randy
Yang Li <[email protected]> writes:
> This commit adds kernel-doc style comments with complete parameter
> descriptions for the function partial_decompress().
This change log doesn't match the subject or the patch.
cheers
> Signed-off-by: Yang Li <[email protected]>
> ---
> arch/powerpc/boot/decompress.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/arch/powerpc/boot/decompress.c b/arch/powerpc/boot/decompress.c
> index 977eb15a6d17..6835cb53f034 100644
> --- a/arch/powerpc/boot/decompress.c
> +++ b/arch/powerpc/boot/decompress.c
> @@ -101,7 +101,7 @@ static void print_err(char *s)
> * @input_size: length of the input buffer
> * @outbuf: output buffer
> * @output_size: length of the output buffer
> - * @skip number of output bytes to ignore
> + * @_skip: number of output bytes to ignore
> *
> * This function takes compressed data from inbuf, decompresses and write it to
> * outbuf. Once output_size bytes are written to the output buffer, or the
> --
> 2.20.1.7.g153144c