public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Takashi Iwai <tiwai@suse.de>
To: Aditya Srivastava <yashsri421@gmail.com>
Cc: alsa-devel@alsa-project.org, lukas.bulwahn@gmail.com,
	linux-kernel-mentees@lists.linuxfoundation.org, perex@perex.cz,
	tiwai@suse.com, pierre-louis.bossart@linux.intel.com,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] ALSA: ctxfi: fix comment syntax in file headers
Date: Thu, 18 Mar 2021 10:14:24 +0100	[thread overview]
Message-ID: <s5hv99oj027.wl-tiwai@suse.de> (raw)
In-Reply-To: <20210317203932.23993-1-yashsri421@gmail.com>

On Wed, 17 Mar 2021 21:39:32 +0100,
Aditya Srivastava wrote:
> 
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> There are files in sound/pci/ctxfi which follow this syntax in their file
> headers, i.e. start with '/**' like comments, which causes unexpected
> warnings from kernel-doc.
> 
> E.g., running scripts/kernel-doc -none on sound/pci/ctxfi/ctresource.c
> causes this warning:
> "warning: wrong kernel-doc identifier on line:
>  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved."
> 
> Similarly for other files too.
> 
> Provide a simple fix by replacing the kernel-doc like comment syntax with
> general format, i.e. "/*", to prevent kernel-doc from parsing it.
> 
> Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>

Applied now.  Thanks.


Takashi

      parent reply	other threads:[~2021-03-18  9:15 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-17 20:39 [PATCH] ALSA: ctxfi: fix comment syntax in file headers Aditya Srivastava
2021-03-17 20:50 ` Randy Dunlap
2021-03-18  9:14 ` Takashi Iwai [this message]

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=s5hv99oj027.wl-tiwai@suse.de \
    --to=tiwai@suse.de \
    --cc=alsa-devel@alsa-project.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lukas.bulwahn@gmail.com \
    --cc=perex@perex.cz \
    --cc=pierre-louis.bossart@linux.intel.com \
    --cc=tiwai@suse.com \
    --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