mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Maximilian Luz <luzmaximilian@gmail.com>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Cc: Hans de Goede <hdegoede@redhat.com>,
	Mark Gross <mgross@linux.intel.com>,
	linux-kernel@vger.kernel.org,
	platform-driver-x86@vger.kernel.org
Subject: Re: [PATCH v6 16/16] platform/surface: aggregator: fix a kernel-doc markup
Date: Thu, 14 Jan 2021 15:53:07 +0100	[thread overview]
Message-ID: <a0cb2b1a-4546-7864-faaf-3a1db8223189@gmail.com> (raw)
In-Reply-To: <4a6bf33cfbd06654d78294127f2b6d354d073089.1610610937.git.mchehab+huawei@kernel.org>

On 1/14/21 9:04 AM, Mauro Carvalho Chehab wrote:
> A function has a different name between their prototype
> and its kernel-doc markup:
> 
> 	../drivers/platform/surface/aggregator/ssh_request_layer.c:1065: warning: expecting prototype for ssh_rtl_tx_start(). Prototype was for ssh_rtl_start() instead
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>   drivers/platform/surface/aggregator/ssh_request_layer.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/platform/surface/aggregator/ssh_request_layer.c b/drivers/platform/surface/aggregator/ssh_request_layer.c
> index bb1c862411a2..25db4d638cfa 100644
> --- a/drivers/platform/surface/aggregator/ssh_request_layer.c
> +++ b/drivers/platform/surface/aggregator/ssh_request_layer.c
> @@ -1056,7 +1056,7 @@ void ssh_rtl_destroy(struct ssh_rtl *rtl)
>   }
>   
>   /**
> - * ssh_rtl_tx_start() - Start request transmitter and receiver.
> + * ssh_rtl_start() - Start request transmitter and receiver.
>    * @rtl: The request transport layer.
>    *
>    * Return: Returns zero on success, a negative error code on failure.
> 

Thanks! Looks good to me.

Reviewed-by: Maximilian Luz <luzmaximilian@gmail.com>

There seems to be another issue similar to this, specifically the
non-existing ssh_rtl_tx_start() and ssh_rtl_tx_start() are referenced.
Both should point to to ssh_rtl_start() instead. I'll start working on a
patch to fix that right away.

Regards,
Max

  reply	other threads:[~2021-01-14 14:54 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-14  8:04 [PATCH v6 00/16] Fix several bad kernel-doc markups Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 01/16] parport: fix a kernel-doc markup Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 02/16] rapidio: fix kernel-doc a markup Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 03/16] fs: fix kernel-doc markups Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 04/16] pstore/zone: fix a kernel-doc markup Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 05/16] firmware: stratix10-svc: fix kernel-doc markups Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 06/16] connector: fix a kernel-doc markup Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 07/16] lib/crc7: " Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 08/16] memblock: fix kernel-doc markups Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 09/16] w1: fix a kernel-doc markup Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 10/16] selftests: kselftest_harness.h: partially fix kernel-doc markups Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 11/16] scripts: kernel-doc: validate kernel-doc markup with the actual names Mauro Carvalho Chehab
2021-01-14 10:11   ` kernel test robot
2021-01-14 10:16   ` kernel test robot
2021-01-18 20:35   ` Jonathan Corbet
2021-01-19  7:43     ` Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 12/16] net: tip: fix a couple kernel-doc markups Mauro Carvalho Chehab
2021-01-14 15:59   ` Jon Maloy
2021-01-14 18:34     ` Jakub Kicinski
2021-01-14 21:22       ` Johannes Berg
2021-01-14  8:04 ` [PATCH v6 13/16] net: cfg80211: fix a kerneldoc markup Mauro Carvalho Chehab
2021-01-14  8:04 ` [PATCH v6 14/16] reset: core: fix a kernel-doc markup Mauro Carvalho Chehab
2021-01-14  8:25   ` Philipp Zabel
2021-01-14  8:04 ` [PATCH v6 15/16] drm: drm_crc: " Mauro Carvalho Chehab
2021-01-14  8:06   ` Simon Ser
2021-01-14 14:13     ` Simon Ser
2021-01-14  8:04 ` [PATCH v6 16/16] platform/surface: aggregator: " Mauro Carvalho Chehab
2021-01-14 14:53   ` Maximilian Luz [this message]
2021-01-18 18:20   ` Hans de Goede
2021-01-21 19:09 ` [PATCH v6 00/16] Fix several bad kernel-doc markups Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=a0cb2b1a-4546-7864-faaf-3a1db8223189@gmail.com \
    --to=luzmaximilian@gmail.com \
    --cc=corbet@lwn.net \
    --cc=hdegoede@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=mgross@linux.intel.com \
    --cc=platform-driver-x86@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

Powered by JetHome