All of lore.kernel.org
 help / color / mirror / Atom feed
From: Felipe Balbi <balbi@kernel.org>
To: Aditya Srivastava <yashsri421@gmail.com>
Cc: yashsri421@gmail.com, lukas.bulwahn@gmail.com,
	rdunlap@infradead.org, gregkh@linuxfoundation.org,
	linux-kernel-mentees@lists.linuxfoundation.org,
	linux-doc@vger.kernel.org, linux-usb@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] USB: gadget: udc: fix kernel-doc syntax in file headers
Date: Thu, 03 Jun 2021 17:33:13 +0300	[thread overview]
Message-ID: <87czt3c91y.fsf@kernel.org> (raw)
In-Reply-To: <20210522115227.9977-1-yashsri421@gmail.com>

[-- Attachment #1: Type: text/plain, Size: 916 bytes --]

Aditya Srivastava <yashsri421@gmail.com> writes:

> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for drivers/usb/gadget/udc/trace 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 drivers/usb/gadget/udc/trace.h
> emits:
> warning: expecting prototype for udc.c(). Prototype was for TRACE_SYSTEM() instead
>
> 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>

Acked-by: Felipe Balbi <balbi@kernel.org>

-- 
balbi

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 511 bytes --]

WARNING: multiple messages have this Message-ID (diff)
From: Felipe Balbi <balbi@kernel.org>
To: Aditya Srivastava <yashsri421@gmail.com>
Cc: linux-usb@vger.kernel.org, linux-doc@vger.kernel.org,
	rdunlap@infradead.org, linux-kernel@vger.kernel.org,
	yashsri421@gmail.com,
	linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [PATCH] USB: gadget: udc: fix kernel-doc syntax in file headers
Date: Thu, 03 Jun 2021 17:33:13 +0300	[thread overview]
Message-ID: <87czt3c91y.fsf@kernel.org> (raw)
In-Reply-To: <20210522115227.9977-1-yashsri421@gmail.com>


[-- Attachment #1.1: Type: text/plain, Size: 916 bytes --]

Aditya Srivastava <yashsri421@gmail.com> writes:

> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for drivers/usb/gadget/udc/trace 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 drivers/usb/gadget/udc/trace.h
> emits:
> warning: expecting prototype for udc.c(). Prototype was for TRACE_SYSTEM() instead
>
> 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>

Acked-by: Felipe Balbi <balbi@kernel.org>

-- 
balbi

[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 511 bytes --]

[-- Attachment #2: Type: text/plain, Size: 201 bytes --]

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

  parent reply	other threads:[~2021-06-03 14:33 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-22 11:52 [PATCH] USB: gadget: udc: fix kernel-doc syntax in file headers Aditya Srivastava
2021-05-22 11:52 ` Aditya Srivastava
2021-05-22 15:09 ` Randy Dunlap
2021-05-22 15:09   ` Randy Dunlap
2021-06-03 14:33 ` Felipe Balbi [this message]
2021-06-03 14:33   ` Felipe Balbi

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=87czt3c91y.fsf@kernel.org \
    --to=balbi@kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --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.