Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Date:   Thu, 18 Mar 2021 10:13:40 +0100
Message-ID: <s5hwnu4j03f.wl-tiwai@suse.de>
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, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] ALSA: asihpi: fix comment syntax in file headers
In-Reply-To: <20210317202144.20290-1-yashsri421@gmail.com>
References: <20210317202144.20290-1-yashsri421@gmail.com>
User-Agent: Wanderlust/2.15.9 (Almost Unreal) SEMI/1.14.6 (Maruoka)
 FLIM/1.14.9 (=?UTF-8?B?R29qxY0=?=) APEL/10.8 Emacs/25.3
 (x86_64-suse-linux-gnu) MULE/6.0 (HANACHIRUSATO)
MIME-Version: 1.0 (generated by SEMI 1.14.6 - "Maruoka")
Content-Type: text/plain; charset=US-ASCII
Precedence: bulk

On Wed, 17 Mar 2021 21:21:44 +0100,
Aditya Srivastava wrote:
> 
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> There are files in sound/pci/asihpi 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/asihpi/hpidspcd.h
> causes this warning:
> "warning: Cannot understand
>  on line 4 - I thought it was a doc line"
> 
> 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