From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 985ACC43334 for ; Tue, 7 Jun 2022 11:03:36 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S242445AbiFGLDd (ORCPT ); Tue, 7 Jun 2022 07:03:33 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48274 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S242878AbiFGLA5 (ORCPT ); Tue, 7 Jun 2022 07:00:57 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [IPv6:2604:1380:4641:c500::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C6697303 for ; Tue, 7 Jun 2022 04:00:42 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 63C3261556 for ; Tue, 7 Jun 2022 11:00:42 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 0F0DDC385A5; Tue, 7 Jun 2022 11:00:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=linuxfoundation.org; s=korg; t=1654599641; bh=NCRYi15R3SZXtnylokP+CV2OP6UTPKNRKneK+LCEpG0=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=ILDaKY5ugYGsxjq64AvD2ysNnh0lwMQfUX31OEtuMOLB15NMj9whtQz/IwJamuE0n KOosLjA/tUa0TDajoaTZ7HU3GhWFivLIpk6uPwlJFR5HkBM4K2Cb/EHWQpgN0qQDSs NqZudHs6sArM4mjJXfyJWnuXLd8mipD8YgISVE3Q= Date: Tue, 7 Jun 2022 13:00:36 +0200 From: Greg KH To: Bagas Sanjaya Cc: Jiapeng Chong , Larry.Finger@lwfinger.net, phil@philpotter.co.uk, linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org, Abaci Robot Subject: Re: [PATCH] staging: r8188eu: Fix kernel-doc Message-ID: References: <20220524083914.68736-1-jiapeng.chong@linux.alibaba.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Mon, Jun 06, 2022 at 02:58:56PM +0700, Bagas Sanjaya wrote: > On Mon, Jun 06, 2022 at 07:53:02AM +0200, Greg KH wrote: > > On Tue, May 24, 2022 at 04:39:14PM +0800, Jiapeng Chong wrote: > > > Fix the following W=1 kernel warnings: > > > > > > drivers/staging/r8188eu/hal/rtl8188e_phycfg.c:291: warning: expecting > > > prototype for Function(). Prototype was for rtl8188e_PHY_SetRFReg() > > > instead. > > > > > > drivers/staging/r8188eu/hal/rtl8188e_phycfg.c:257: warning: expecting > > > prototype for Function(). Prototype was for rtl8188e_PHY_QueryRFReg() > > > instead. > > > > Please put build warning lines all on one line. > > > > > > > > Reported-by: Abaci Robot > > > > No, gcc reported this, not a robot, right? > > > > You have read Documentation/process/researcher-guidelines.rst for how to > > properly document patches that are created by research tools like this, > > right? Please fix this commit up to follow those requirements please. > > > > Hi Greg and Jiapeng, > > First, IMO this is not research tool (in the sense of academic purposes), > but development bot used in corporate environment, kinda like kernel > test robot . When the bot reports any build warnings, > these will be followed up by developers proposing fixes. Ok, then please document it as such and point to where we can find out more information about it. > What I see in the patch message is just "Fix this warning..." without > saying why there is the warning. Which isn't ok. > Second, gcc DOESN'T, again DOESN'T, report "expecting prototype" > warnings. These are from scripts/kernel-doc, which enabled these > warnings on W=1 build. Yes, the kernel build reports this, not a random "robot". > So the underlying problem is mismatching function name in kernel-doc > comment and actual function. Agreed, so the changelog should say as such. thanks, greg k-h