All of lore.kernel.org
 help / color / mirror / Atom feed
From: Tony Lindgren <tony@atomide.com>
To: Aditya Srivastava <yashsri421@gmail.com>
Cc: linux-kernel@vger.kernel.org, lukas.bulwahn@gmail.com,
	rdunlap@infradead.org, linux@armlinux.org.uk,
	linux-kernel-mentees@lists.linuxfoundation.org,
	linux-doc@vger.kernel.org, linux-omap@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH] ARM: OMAP2+: fix incorrect kernel-doc comment syntax in file
Date: Wed, 31 Mar 2021 09:07:53 +0300	[thread overview]
Message-ID: <YGQRuch0+sw2o3wy@atomide.com> (raw)
In-Reply-To: <20210330205908.26800-1-yashsri421@gmail.com>

* Aditya Srivastava <yashsri421@gmail.com> [210331 00:00]:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for arch/arm/mach-omap2/omap_twl.c 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 warning from kernel-doc:
> "warning: wrong kernel-doc identifier on line:
>  * OMAP and TWL PMIC specific initializations."
> 
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.

Thanks applying into omap-for-v5.13/soc.

Tony

WARNING: multiple messages have this Message-ID (diff)
From: Tony Lindgren <tony@atomide.com>
To: Aditya Srivastava <yashsri421@gmail.com>
Cc: linux-doc@vger.kernel.org, rdunlap@infradead.org,
	linux-kernel@vger.kernel.org, linux@armlinux.org.uk,
	linux-omap@vger.kernel.org,
	linux-kernel-mentees@lists.linuxfoundation.org,
	linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH] ARM: OMAP2+: fix incorrect kernel-doc comment syntax in file
Date: Wed, 31 Mar 2021 09:07:53 +0300	[thread overview]
Message-ID: <YGQRuch0+sw2o3wy@atomide.com> (raw)
In-Reply-To: <20210330205908.26800-1-yashsri421@gmail.com>

* Aditya Srivastava <yashsri421@gmail.com> [210331 00:00]:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for arch/arm/mach-omap2/omap_twl.c 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 warning from kernel-doc:
> "warning: wrong kernel-doc identifier on line:
>  * OMAP and TWL PMIC specific initializations."
> 
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.

Thanks applying into omap-for-v5.13/soc.

Tony
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

WARNING: multiple messages have this Message-ID (diff)
From: Tony Lindgren <tony@atomide.com>
To: Aditya Srivastava <yashsri421@gmail.com>
Cc: linux-kernel@vger.kernel.org, lukas.bulwahn@gmail.com,
	rdunlap@infradead.org, linux@armlinux.org.uk,
	linux-kernel-mentees@lists.linuxfoundation.org,
	linux-doc@vger.kernel.org, linux-omap@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH] ARM: OMAP2+: fix incorrect kernel-doc comment syntax in file
Date: Wed, 31 Mar 2021 09:07:53 +0300	[thread overview]
Message-ID: <YGQRuch0+sw2o3wy@atomide.com> (raw)
In-Reply-To: <20210330205908.26800-1-yashsri421@gmail.com>

* Aditya Srivastava <yashsri421@gmail.com> [210331 00:00]:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for arch/arm/mach-omap2/omap_twl.c 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 warning from kernel-doc:
> "warning: wrong kernel-doc identifier on line:
>  * OMAP and TWL PMIC specific initializations."
> 
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.

Thanks applying into omap-for-v5.13/soc.

Tony

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  parent reply	other threads:[~2021-03-31  6:09 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-30 20:59 [PATCH] ARM: OMAP2+: fix incorrect kernel-doc comment syntax in file Aditya Srivastava
2021-03-30 20:59 ` Aditya Srivastava
2021-03-30 20:59 ` Aditya Srivastava
2021-03-30 21:05 ` Randy Dunlap
2021-03-30 21:05   ` Randy Dunlap
2021-03-30 21:05   ` Randy Dunlap
2021-03-31  6:07 ` Tony Lindgren [this message]
2021-03-31  6:07   ` Tony Lindgren
2021-03-31  6:07   ` Tony Lindgren

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=YGQRuch0+sw2o3wy@atomide.com \
    --to=tony@atomide.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-omap@vger.kernel.org \
    --cc=linux@armlinux.org.uk \
    --cc=lukas.bulwahn@gmail.com \
    --cc=rdunlap@infradead.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 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.