[14/15] mmc: host: cqhci: Demote faux kerneldoc header down to basic comment block
diff mbox series

Message ID 20200701124702.908713-15-lee.jones@linaro.org
State In Next
Commit 1efc762b9dbb1d37087f710e28179f2c398b26d1
Headers show
Series
  • Clean-up MMC's W=1 build warnings
Related show

Commit Message

Lee Jones July 1, 2020, 12:47 p.m. UTC
cqhci_host_alloc_tdl()'s function header is the only one in
kerneldoc format.  Which seems odd as it's not part of an
external API and isn't referenced anywhere else.  Seeing as
there has also been no attempt to describe the expected
function arguments either, we're going to assume that this is
not actually a bona fide kerneldoc use-case.

Fixes the following W=1 kernel build warning:

 drivers/mmc/host/cqhci.c:163: warning: Function parameter or member 'cq_host' not described in 'cqhci_host_alloc_tdl'

Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Ritesh Harjani <riteshh@codeaurora.org>
Cc: Asutosh Das <asutoshd@codeaurora.org>
Cc: Venkat Gopalakrishnan <venkatg@codeaurora.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/mmc/host/cqhci.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Adrian Hunter July 2, 2020, 6:43 a.m. UTC | #1
On 1/07/20 3:47 pm, Lee Jones wrote:
> cqhci_host_alloc_tdl()'s function header is the only one in
> kerneldoc format.  Which seems odd as it's not part of an
> external API and isn't referenced anywhere else.  Seeing as
> there has also been no attempt to describe the expected
> function arguments either, we're going to assume that this is
> not actually a bona fide kerneldoc use-case.
> 
> Fixes the following W=1 kernel build warning:
> 
>  drivers/mmc/host/cqhci.c:163: warning: Function parameter or member 'cq_host' not described in 'cqhci_host_alloc_tdl'
> 
> Cc: Adrian Hunter <adrian.hunter@intel.com>
> Cc: Ritesh Harjani <riteshh@codeaurora.org>
> Cc: Asutosh Das <asutoshd@codeaurora.org>
> Cc: Venkat Gopalakrishnan <venkatg@codeaurora.org>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>

Acked-by: Adrian Hunter <adrian.hunter@intel.com>

> ---
>  drivers/mmc/host/cqhci.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/mmc/host/cqhci.c b/drivers/mmc/host/cqhci.c
> index 75934f3c117eb..8cc277b4ffe9e 100644
> --- a/drivers/mmc/host/cqhci.c
> +++ b/drivers/mmc/host/cqhci.c
> @@ -144,7 +144,7 @@ static void cqhci_dumpregs(struct cqhci_host *cq_host)
>  		CQHCI_DUMP(": ===========================================\n");
>  }
>  
> -/**
> +/*
>   * The allocated descriptor table for task, link & transfer descritors
>   * looks like:
>   * |----------|
>

Patch
diff mbox series

diff --git a/drivers/mmc/host/cqhci.c b/drivers/mmc/host/cqhci.c
index 75934f3c117eb..8cc277b4ffe9e 100644
--- a/drivers/mmc/host/cqhci.c
+++ b/drivers/mmc/host/cqhci.c
@@ -144,7 +144,7 @@  static void cqhci_dumpregs(struct cqhci_host *cq_host)
 		CQHCI_DUMP(": ===========================================\n");
 }
 
-/**
+/*
  * The allocated descriptor table for task, link & transfer descritors
  * looks like:
  * |----------|