Received-SPF: pass (google.com: domain of linux-wireless-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Subject: Re: [PATCH 00/10] rsi: fix comment syntax in file headers
To:     Kalle Valo <kvalo@codeaurora.org>,
        Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc:     siva8118@gmail.com, linux-kernel-mentees@lists.linuxfoundation.org,
        amitkarwar@gmail.com, David Miller <davem@davemloft.net>,
        Jakub Kicinski <kuba@kernel.org>,
        linux-wireless <linux-wireless@vger.kernel.org>,
        Netdev <netdev@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
References: <20210314201818.27380-1-yashsri421@gmail.com>
 <CAKXUXMzH-cUVeuCT6eM_0iHzgKpzvZUPO6pKNpD0yUp2td09Ug@mail.gmail.com>
 <87a6r4u7ut.fsf@codeaurora.org>
From:   Aditya <yashsri421@gmail.com>
Message-ID: <643c93f6-1c01-a18d-6ef6-d4d0fb5304fa@gmail.com>
Date:   Mon, 15 Mar 2021 22:58:32 +0530
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101
 Thunderbird/68.10.0
MIME-Version: 1.0
In-Reply-To: <87a6r4u7ut.fsf@codeaurora.org>
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 15/3/21 2:11 pm, Kalle Valo wrote:
> Lukas Bulwahn <lukas.bulwahn@gmail.com> writes:
> 
>> On Sun, Mar 14, 2021 at 9:18 PM Aditya Srivastava <yashsri421@gmail.com> wrote:
>>>
>>> The opening comment mark '/**' is used for highlighting the beginning of
>>> kernel-doc comments.
>>> There are files in drivers/net/wireless/rsi 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 drivers/net/wireless/rsi/rsi_coex.h
>>> causes this warning:
>>> "warning: wrong kernel-doc identifier on line:
>>>  * Copyright (c) 2018 Redpine Signals Inc."
>>>
>>> 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.
>>>
>>
>> Aditya, thanks for starting to clean up the repository following your
>> investigation on kernel-doc warnings.
>>
>> The changes to all those files look sound.
>>
>> However I think these ten patches are really just _one change_, and
>> hence, all can be put into a single commit.
> 
> I agree, this is one logical change to a single driver so one patch will
> suffice. I think for cleanup changes like this one patch per driver is a
> good approach.
> 

Thanks for the feedback Lukas and Kalle. I will be sending the
modified v2.

Thanks
Aditya