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 49B11C433EF for ; Thu, 2 Jun 2022 08:29:49 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231879AbiFBI3s (ORCPT ); Thu, 2 Jun 2022 04:29:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33152 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231469AbiFBI3r (ORCPT ); Thu, 2 Jun 2022 04:29:47 -0400 Received: from ams.source.kernel.org (ams.source.kernel.org [145.40.68.75]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A1AC1BD1; Thu, 2 Jun 2022 01:29:45 -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 ams.source.kernel.org (Postfix) with ESMTPS id 6A853B81EE7; Thu, 2 Jun 2022 08:29:44 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 89790C385A5; Thu, 2 Jun 2022 08:29:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=linuxfoundation.org; s=korg; t=1654158583; bh=BN4ioYNda/zi1dUexn63v19SN0dic1eefabXoCOtF/0=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=uDxZymjw2BgFZlHAEzqWseLq8V13tknkA7ow/IGnxZS780a8ozkQILk85azdoYV37 Ba28hnTd+6sz8ee0vUxEoJGgTBlQve768PCxL4rl6irsntMm0MOSasfy9aRYUzskjT Ft0tquR1j5LEAwXWyOQPj4M3R2IV2Ab9AdGaECPM= Date: Thu, 2 Jun 2022 10:29:40 +0200 From: Greg KH To: Bagas Sanjaya Cc: linux-doc@vger.kernel.org, kernel test robot , Randy Dunlap , =?iso-8859-1?Q?Jos=E9_Exp=F3sito?= , Nikolai Kondrashov , Jiri Kosina , Benjamin Tissoires , llvm@lists.linux.dev, stable@vger.kernel.org, linux-input@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH v3] HID: uclogic: properly format kernel-doc comment for hid_dbg() wrappers Message-ID: References: <20220602082321.313143-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20220602082321.313143-1-bagasdotme@gmail.com> Precedence: bulk List-ID: X-Mailing-List: stable@vger.kernel.org On Thu, Jun 02, 2022 at 03:23:21PM +0700, Bagas Sanjaya wrote: > Running kernel-doc script on drivers/hid/hid-uclogic-params.c, it found > 6 warnings for hid_dbg() wrapper functions below: > > drivers/hid/hid-uclogic-params.c:48: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * Dump tablet interface pen parameters with hid_dbg(), indented with one tab. > drivers/hid/hid-uclogic-params.c:48: warning: missing initial short description on line: > * Dump tablet interface pen parameters with hid_dbg(), indented with one tab. > drivers/hid/hid-uclogic-params.c:48: info: Scanning doc for function Dump > drivers/hid/hid-uclogic-params.c:80: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * Dump tablet interface frame parameters with hid_dbg(), indented with two > drivers/hid/hid-uclogic-params.c:80: warning: missing initial short description on line: > * Dump tablet interface frame parameters with hid_dbg(), indented with two > drivers/hid/hid-uclogic-params.c:80: info: Scanning doc for function Dump > drivers/hid/hid-uclogic-params.c:105: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * Dump tablet interface parameters with hid_dbg(). > drivers/hid/hid-uclogic-params.c:105: warning: missing initial short description on line: > * Dump tablet interface parameters with hid_dbg(). > > One of them is reported by kernel test robot. > > Fix these warnings by properly format kernel-doc comment for these > functions. None of this is needed for stable kernels releases as no code is being modified. thanks, greg k-h