linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Aditya Srivastava <yashsri421@gmail.com>,
	krzysztof.kozlowski@canonical.com
Cc: lukas.bulwahn@gmail.com,
	linux-kernel-mentees@lists.linuxfoundation.org,
	linux-doc@vger.kernel.org, linux-nfc@lists.01.org,
	netdev@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] NFC: nfcmrvl: fix kernel-doc syntax in file headers
Date: Sun, 23 May 2021 14:31:56 -0700	[thread overview]
Message-ID: <f194e3a9-c541-8ee9-3332-22f25d7a7bc5@infradead.org> (raw)
In-Reply-To: <20210523210909.5359-1-yashsri421@gmail.com>

On 5/23/21 2:09 PM, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for drivers/nfc/nfcmrvl follows this syntax, but the content
> inside does not comply with kernel-doc.
> 
> This line was probably not meant for kernel-doc parsing, but is parsed
> due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
> causes unexpected warnings from kernel-doc.
> For e.g., running scripts/kernel-doc -none on drivers/nfc/nfcmrvl/spi.c
> causes warning:
> warning: expecting prototype for Marvell NFC(). Prototype was for SPI_WAIT_HANDSHAKE() instead
> 
> Provide a simple fix by replacing such occurrences with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
> 
> Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  drivers/nfc/nfcmrvl/fw_dnld.h | 2 +-
>  drivers/nfc/nfcmrvl/i2c.c     | 2 +-
>  drivers/nfc/nfcmrvl/nfcmrvl.h | 2 +-
>  drivers/nfc/nfcmrvl/spi.c     | 2 +-
>  drivers/nfc/nfcmrvl/uart.c    | 2 +-
>  drivers/nfc/nfcmrvl/usb.c     | 2 +-
>  6 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/drivers/nfc/nfcmrvl/fw_dnld.h b/drivers/nfc/nfcmrvl/fw_dnld.h
> index ee4a339c05fd..058ce77b3cbc 100644
> --- a/drivers/nfc/nfcmrvl/fw_dnld.h
> +++ b/drivers/nfc/nfcmrvl/fw_dnld.h
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * Marvell NFC driver: Firmware downloader
>   *
>   * Copyright (C) 2015, Marvell International Ltd.
> diff --git a/drivers/nfc/nfcmrvl/i2c.c b/drivers/nfc/nfcmrvl/i2c.c
> index 18cd96284b77..c5420616b7bc 100644
> --- a/drivers/nfc/nfcmrvl/i2c.c
> +++ b/drivers/nfc/nfcmrvl/i2c.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * Marvell NFC-over-I2C driver: I2C interface related functions
>   *
>   * Copyright (C) 2015, Marvell International Ltd.
> diff --git a/drivers/nfc/nfcmrvl/nfcmrvl.h b/drivers/nfc/nfcmrvl/nfcmrvl.h
> index de68ff45e49a..e84ee18c73ae 100644
> --- a/drivers/nfc/nfcmrvl/nfcmrvl.h
> +++ b/drivers/nfc/nfcmrvl/nfcmrvl.h
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * Marvell NFC driver
>   *
>   * Copyright (C) 2014-2015, Marvell International Ltd.
> diff --git a/drivers/nfc/nfcmrvl/spi.c b/drivers/nfc/nfcmrvl/spi.c
> index 8e0ddb434770..dec0d3eb3648 100644
> --- a/drivers/nfc/nfcmrvl/spi.c
> +++ b/drivers/nfc/nfcmrvl/spi.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * Marvell NFC-over-SPI driver: SPI interface related functions
>   *
>   * Copyright (C) 2015, Marvell International Ltd.
> diff --git a/drivers/nfc/nfcmrvl/uart.c b/drivers/nfc/nfcmrvl/uart.c
> index e5a622ce4b95..7194dd7ef0f1 100644
> --- a/drivers/nfc/nfcmrvl/uart.c
> +++ b/drivers/nfc/nfcmrvl/uart.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * Marvell NFC-over-UART driver
>   *
>   * Copyright (C) 2015, Marvell International Ltd.
> diff --git a/drivers/nfc/nfcmrvl/usb.c b/drivers/nfc/nfcmrvl/usb.c
> index 888e298f610b..bcd563cb556c 100644
> --- a/drivers/nfc/nfcmrvl/usb.c
> +++ b/drivers/nfc/nfcmrvl/usb.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * Marvell NFC-over-USB driver: USB interface related functions
>   *
>   * Copyright (C) 2014, Marvell International Ltd.
> 


-- 
~Randy


  reply	other threads:[~2021-05-23 21:31 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-23 21:09 [PATCH] NFC: nfcmrvl: fix kernel-doc syntax in file headers Aditya Srivastava
2021-05-23 21:31 ` Randy Dunlap [this message]
2021-05-24  1:00 ` patchwork-bot+netdevbpf

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=f194e3a9-c541-8ee9-3332-22f25d7a7bc5@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=krzysztof.kozlowski@canonical.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-nfc@lists.01.org \
    --cc=lukas.bulwahn@gmail.com \
    --cc=netdev@vger.kernel.org \
    --cc=yashsri421@gmail.com \
    /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;
as well as URLs for NNTP newsgroup(s).