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 1AF62C00140 for ; Fri, 5 Aug 2022 07:22:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235722AbiHEHWU (ORCPT ); Fri, 5 Aug 2022 03:22:20 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58360 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234451AbiHEHWR (ORCPT ); Fri, 5 Aug 2022 03:22:17 -0400 Received: from ams.source.kernel.org (ams.source.kernel.org [IPv6:2604:1380:4601:e00::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6A7F818397 for ; Fri, 5 Aug 2022 00:22:16 -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 2BC3DB8275D for ; Fri, 5 Aug 2022 07:22:15 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 924BEC433D7; Fri, 5 Aug 2022 07:22:13 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1659684133; bh=7u3HxRp5NFkFE+bl2pbrO1Vom3p6Ci1YJ5qGLzvW4kE=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=azUJW5HYl58q1jtoW4R7du9BvdG+qkRb7prxjH+hedfeH0LmF3zZCxUUe+xDopn4R WJ/drZzI97s3LMWdGFFxeaq9CIB/7HPxRx9dY2OaYzOI+J3zI8TTCkSZrl22v0+mfy KSMO02rpN6P995pDym/k/rwdDRvyz79An4JOD1boHBR3bulgkQOoLWNEEFLLcx8mcT Sp7YKaUVQNlUbxJcvx0r+FON07ySnLVMCNOwbAKdmDt0iik34ZYW51BdACFDSYhokR ZIi6wFKueDQbygGVQy9R85SZwNNohoPPc6nQc89nkK7rEs2aitDagfzNZF4C+Oxw/Z 0TdtHLp5Pgreg== Date: Fri, 5 Aug 2022 00:22:11 -0700 From: Eric Biggers To: Siddh Raman Pant Cc: Jonathan Corbet , David Howells , Randy Dunlap , Mauro Carvalho Chehab , Christophe JAILLET , Eric Dumazet , linux-kernel , linux-kernel-mentees Subject: Re: [PATCH 2/3] kernel/watch_queue: Improve struct annotation formatting Message-ID: References: <6bac2d4c2b50d921eb16fa5344ffe258be90c651.1659618705.git.code@siddh.me> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <6bac2d4c2b50d921eb16fa5344ffe258be90c651.1659618705.git.code@siddh.me> Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Thu, Aug 04, 2022 at 07:00:23PM +0530, Siddh Raman Pant wrote: > Improve formatting struct annotations in watch_queue.h, so that they > fall in the preferred 80 character limit. > > Signed-off-by: Siddh Raman Pant This patch isn't just fixing overly long lines, but rather is introducing kerneldoc comments and documenting things that weren't documented before. That's fine, but please make the commit message accurately describe the patch. > diff --git a/include/linux/watch_queue.h b/include/linux/watch_queue.h > index fc6bba20273b..c99c39ec6548 100644 > --- a/include/linux/watch_queue.h > +++ b/include/linux/watch_queue.h > @@ -18,57 +18,103 @@ > > struct cred; > > +/** > + * watch_type_filter - Filter on watch type If you're going to use kerneldoc comments, they should be correctly formatted. This is not, since it's missing the word struct. You can run this command to see the kerneldoc warnings: ./scripts/kernel-doc -v -none include/linux/watch_queue.h > + * @lock: Spinlock Please make sure that comments provide useful information and don't just repeat what the code says. - Eric