linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Aditya Srivastava <yashsri421@gmail.com>
To: "Rémi Denis-Courmont" <remi@remlab.net>
Cc: courmisch@gmail.com, lukas.bulwahn@gmail.com,
	rdunlap@infradead.org,
	linux-kernel-mentees@lists.linuxfoundation.org,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Phonet: fix kernel-doc syntax in file headers
Date: Sat, 22 May 2021 16:56:19 +0530	[thread overview]
Message-ID: <2970b6b6-1450-8eec-a9e9-45629af9417f@gmail.com> (raw)
In-Reply-To: <52313028.m8L9TnScQ9@philogene>

On 22/5/21 2:57 pm, Rémi Denis-Courmont wrote:
> Le jeudi 20 mai 2021, 21:21:59 EEST Aditya Srivastava a écrit :
>> The opening comment mark '/**' is used for highlighting the beginning of
>> kernel-doc comments.
>> The header for include/*/linux/phonet.h files 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.
>> For e.g., running scripts/kernel-doc -none include/linux/phonet.h emits:
>> warning: This comment starts with '/**', but isn't a kernel-doc comment.
>> Refer Documentation/doc-guide/kernel-doc.rst * file phonet.h
>>
>> Provide a simple fix by replacing this occurrence with general comment
>> format, i.e. '/*', to prevent kernel-doc from parsing it.
>>
>> Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
> 
> You could just as well remove the stray "file XX" lines but OK.
> 
> Acked-by: Rémi Denis-Courmont <courmisch@gmail.com.>
> 


Hi Remi and Randy
Thanks for reviewing :)
I'll be sending a v2 with removed filenames

Thanks
Aditya

  reply	other threads:[~2021-05-22 11:26 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-20 18:21 [PATCH] Phonet: fix kernel-doc syntax in file headers Aditya Srivastava
2021-05-20 18:30 ` Randy Dunlap
2021-05-22  9:27 ` Rémi Denis-Courmont
2021-05-22 11:26   ` Aditya Srivastava [this message]
2021-05-22 11:34   ` [PATCH v2] Phonet: fix kernel-doc syntax in file headers and remove file names Aditya Srivastava
2021-05-22 15:16     ` Randy Dunlap
2021-05-23  8:11     ` Rémi Denis-Courmont

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=2970b6b6-1450-8eec-a9e9-45629af9417f@gmail.com \
    --to=yashsri421@gmail.com \
    --cc=courmisch@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lukas.bulwahn@gmail.com \
    --cc=rdunlap@infradead.org \
    --cc=remi@remlab.net \
    /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).