lkml.org 
[lkml]   [2021]   [Dec]   [6]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] remoteproc: Fix remaining wrong return formatting in documentation
On Mon 06 Dec 13:18 CST 2021, Arnaud Pouliquen wrote:

> kernel documentation specification:
> "The return value, if any, should be described in a dedicated section
> named Return."
>
> Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>

Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org>

Thanks,
Bjorn

> ---
> drivers/remoteproc/mtk_scp_ipi.c | 4 ++--
> drivers/remoteproc/st_slim_rproc.c | 2 +-
> 2 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/remoteproc/mtk_scp_ipi.c b/drivers/remoteproc/mtk_scp_ipi.c
> index 6dc955ecab80..00f041ebcde6 100644
> --- a/drivers/remoteproc/mtk_scp_ipi.c
> +++ b/drivers/remoteproc/mtk_scp_ipi.c
> @@ -23,7 +23,7 @@
> *
> * Register an ipi function to receive ipi interrupt from SCP.
> *
> - * Returns 0 if ipi registers successfully, -error on error.
> + * Return: 0 if ipi registers successfully, -error on error.
> */
> int scp_ipi_register(struct mtk_scp *scp,
> u32 id,
> @@ -150,7 +150,7 @@ EXPORT_SYMBOL_GPL(scp_ipi_unlock);
> * When the processing completes, IPI handler registered
> * by scp_ipi_register will be called in interrupt context.
> *
> - * Returns 0 if sending data successfully, -error on error.
> + * Return: 0 if sending data successfully, -error on error.
> **/
> int scp_ipi_send(struct mtk_scp *scp, u32 id, void *buf, unsigned int len,
> unsigned int wait)
> diff --git a/drivers/remoteproc/st_slim_rproc.c b/drivers/remoteproc/st_slim_rproc.c
> index 22096adc1ad3..4ed9467897e5 100644
> --- a/drivers/remoteproc/st_slim_rproc.c
> +++ b/drivers/remoteproc/st_slim_rproc.c
> @@ -216,7 +216,7 @@ static const struct rproc_ops slim_rproc_ops = {
> * obtains and enables any clocks required by the SLIM core and also
> * ioremaps the various IO.
> *
> - * Returns st_slim_rproc pointer or PTR_ERR() on error.
> + * Return: st_slim_rproc pointer or PTR_ERR() on error.
> */
>
> struct st_slim_rproc *st_slim_rproc_alloc(struct platform_device *pdev,
> --
> 2.17.1
>

\
 
 \ /
  Last update: 2021-12-06 21:12    [W:0.178 / U:0.036 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site