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;
From:   =?ISO-8859-1?Q?R=E9mi?= Denis-Courmont <remi@remlab.net>
To:     Aditya Srivastava <yashsri421@gmail.com>
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 12:27:28 +0300
Message-ID: <52313028.m8L9TnScQ9@philogene>
Organization: Remlab Tmi
In-Reply-To: <20210520182159.31462-1-yashsri421@gmail.com>
References: <20210520182159.31462-1-yashsri421@gmail.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8BIT
Content-Type: text/plain; charset="iso-8859-1"
Precedence: bulk

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.>

-- 
R?mi Denis-Courmont