* [PATCH] remoteproc: Fix remaining wrong return formatting in documentation
@ 2021-12-06 19:18 Arnaud Pouliquen
2021-12-06 20:11 ` Bjorn Andersson
2021-12-08 17:27 ` Mathieu Poirier
0 siblings, 2 replies; 3+ messages in thread
From: Arnaud Pouliquen @ 2021-12-06 19:18 UTC (permalink / raw)
To: Bjorn Andersson, Mathieu Poirier
Cc: arnaud.pouliquen, linux-stm32, linux-kernel, linux-remoteproc,
Matthias Brugger
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>
---
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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] remoteproc: Fix remaining wrong return formatting in documentation
2021-12-06 19:18 [PATCH] remoteproc: Fix remaining wrong return formatting in documentation Arnaud Pouliquen
@ 2021-12-06 20:11 ` Bjorn Andersson
2021-12-08 17:27 ` Mathieu Poirier
1 sibling, 0 replies; 3+ messages in thread
From: Bjorn Andersson @ 2021-12-06 20:11 UTC (permalink / raw)
To: Arnaud Pouliquen
Cc: Mathieu Poirier, linux-stm32, linux-kernel, linux-remoteproc,
Matthias Brugger
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
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] remoteproc: Fix remaining wrong return formatting in documentation
2021-12-06 19:18 [PATCH] remoteproc: Fix remaining wrong return formatting in documentation Arnaud Pouliquen
2021-12-06 20:11 ` Bjorn Andersson
@ 2021-12-08 17:27 ` Mathieu Poirier
1 sibling, 0 replies; 3+ messages in thread
From: Mathieu Poirier @ 2021-12-08 17:27 UTC (permalink / raw)
To: Arnaud Pouliquen
Cc: Bjorn Andersson, linux-stm32, linux-kernel, linux-remoteproc,
Matthias Brugger
On Mon, Dec 06, 2021 at 08:18:58PM +0100, 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>
> ---
> 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.
> */
Applied.
Thanks,
Mathieu
>
> struct st_slim_rproc *st_slim_rproc_alloc(struct platform_device *pdev,
> --
> 2.17.1
>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-12-08 17:27 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-12-06 19:18 [PATCH] remoteproc: Fix remaining wrong return formatting in documentation Arnaud Pouliquen
2021-12-06 20:11 ` Bjorn Andersson
2021-12-08 17:27 ` Mathieu Poirier
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.