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 X-Spam-Level: X-Spam-Status: No, score=-10.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BEA50C433ED for ; Thu, 20 May 2021 07:25:03 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id A2FB661074 for ; Thu, 20 May 2021 07:25:03 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230444AbhETH0X (ORCPT ); Thu, 20 May 2021 03:26:23 -0400 Received: from wout2-smtp.messagingengine.com ([64.147.123.25]:42279 "EHLO wout2-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229536AbhETH0W (ORCPT ); Thu, 20 May 2021 03:26:22 -0400 Received: from compute3.internal (compute3.nyi.internal [10.202.2.43]) by mailout.west.internal (Postfix) with ESMTP id 2D74C1C81; Thu, 20 May 2021 03:25:00 -0400 (EDT) Received: from imap2 ([10.202.2.52]) by compute3.internal (MEProxy); Thu, 20 May 2021 03:25:00 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=aj.id.au; h= mime-version:message-id:in-reply-to:references:date:from:to:cc :subject:content-type; s=fm2; bh=YGzMf60Q5zwVXsxdpGeNbxkVIZVOJSx edpBbmYYWTL8=; b=dwfiAaGl+wHsZJTkcORZR/XCLH4P19DMvOzG30nHjwdY+Ri 7a41hUSDmIy9fjIVWWq/ycHP6T4epn6snZKNv0phhEUpGeHinncTLiKVW7S7RPW6 r+GZAVpplRK3rmopQL/la1LrPx0Al1wb4xcYwkb9Z2ADHbM/3HYxFmeO67Bn3iKT YclkyWzhDua5/p6UiKVWoQuC04rUwOT4SHOH19qGENLmTwmkZpyYmoDWHTORjnHL RQtnTFhfGZfeePXsnlaoAF+K3BhxnYQfeVYnUvJt+u6RrNjuUt/ibRZ0ZCnds1he 10ie0hxlfelIuRH/xktv9aDEThJRxR8MYJbGmiw== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to:x-me-proxy :x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=fm2; bh=YGzMf6 0Q5zwVXsxdpGeNbxkVIZVOJSxedpBbmYYWTL8=; b=u8WSnZPFROdo/iv7EPEgkb HkFHTKk+Wf8sJX90efqGY1F6OW4UFYuaJ35NrZwzSGzWk0C4KgvHlmL8VuGskU5z kXOk+DPpNhwBXNclzJHnusinvzVchcy3cP0dNNesupCF6fCQ5CvsrXRauszrpdvM RhAoG6kOTVMsYSPUoYkSfFmINbMDgGxRoHAevv/STnxt65Ys/UWxZkuq88nMbmiG ELMfCbvwhz/lkPnz7YJbTLy589iWQgsnZ9CIucykYwTqq69t9u42I4Rd3QsBlYd8 a+iO2QbMoonm9P2FkGGj0WKxZNNE2krKxN5gFVFzCTDg17ZPvxlXBBOOnGmzcrOA == X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrvdejtddguddvudcutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmd enucfjughrpefofgggkfgjfhffhffvufgtsehttdertderredtnecuhfhrohhmpedftehn ughrvgifucflvghffhgvrhihfdcuoegrnhgurhgvfiesrghjrdhiugdrrghuqeenucggtf frrghtthgvrhhnpeehhfefkefgkeduveehffehieehudejfeejveejfedugfefuedtuedv hefhveeuffenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhroh hmpegrnhgurhgvfiesrghjrdhiugdrrghu X-ME-Proxy: Received: by mailuser.nyi.internal (Postfix, from userid 501) id D2325A004B5; Thu, 20 May 2021 03:24:58 -0400 (EDT) X-Mailer: MessagingEngine.com Webmail Interface User-Agent: Cyrus-JMAP/3.5.0-alpha0-448-gae190416c7-fm-20210505.004-gae190416 Mime-Version: 1.0 Message-Id: In-Reply-To: References: <20210520015704.489737-1-andrew@aj.id.au> Date: Thu, 20 May 2021 16:54:37 +0930 From: "Andrew Jeffery" To: "Lukas Bulwahn" Cc: "Linux Doc Mailing List" , "Dwaipayan Ray" , "Joe Perches" , "Jonathan Corbet" , "Linux Kernel Mailing List" , openbmc@lists.ozlabs.org, "Jiri Slaby" Subject: Re: [PATCH] Documentation: checkpatch: Tweak BIT() macro include Content-Type: text/plain Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Thu, 20 May 2021, at 16:28, Lukas Bulwahn wrote: > On Thu, May 20, 2021 at 3:57 AM Andrew Jeffery wrote: > > > > While include/linux/bitops.h brings in the BIT() macro, it was moved to > > include/linux/bits.h in [1]. Since [1] BIT() has moved again into > > include/vdso/bits.h via [2]. > > > > I think the move to the vDSO header can be considered a implementation > > detail, so for now update the checkpatch documentation to recommend use > > of include/linux/bits.h. > > > > [1] commit 8bd9cb51daac ("locking/atomics, asm-generic: Move some macros from to a new file") > > [2] commit 3945ff37d2f4 ("linux/bits.h: Extract common header for vDSO") > > > > Cc: Jiri Slaby > > Signed-off-by: Andrew Jeffery > > Looks sound to me. > > I would prefer a bit of word-smithing the commit message by just > removing the references: > > So: > > > While include/linux/bitops.h brings in the BIT() macro, it was moved to > > include/linux/bits.h in commit 8bd9cb51daac ("locking/atomics, asm-generic: Move some macros from to a new file"). Since that commit, BIT() has moved again into > > include/vdso/bits.h via commit 3945ff37d2f4 ("linux/bits.h: Extract common header for vDSO"). > > > > I think the move to the vDSO header can be considered a implementation > > detail, so for now update the checkpatch documentation to recommend use > > of include/linux/bits.h. > > > > And then drop references [1] and [2]. > > Andrew, what do you think? I mostly did this because initially I wrapped the commit message and checkpatch spat out errors when it failed to properly identify the commit description for [1]. But, leaving the description unwrapped inline in the text feels untidy as it's just a work-around to dodge a shortcoming of checkpatch. With the reference style the long line moves out of the way and checkpatch can identify the commit descriptions, at the expense of complaints about line length instead. But the line length issue was only a warning and so didn't seem quite so critical. While the referencing style is terse I felt it was a reasonable compromise that didn't involve fixing checkpatch to fix the checkpatch documentation :/ Andrew