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=-8.3 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE, SPF_PASS,USER_AGENT_SANE_1 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 59902C43461 for ; Wed, 16 Sep 2020 02:26:40 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 1E28120809 for ; Wed, 16 Sep 2020 02:26:40 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726355AbgIPC0i (ORCPT ); Tue, 15 Sep 2020 22:26:38 -0400 Received: from wtarreau.pck.nerim.net ([62.212.114.60]:41852 "EHLO 1wt.eu" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726200AbgIPC0h (ORCPT ); Tue, 15 Sep 2020 22:26:37 -0400 Received: (from willy@localhost) by pcw.home.local (8.15.2/8.15.2/Submit) id 08G2Pq0t013475; Wed, 16 Sep 2020 04:25:52 +0200 Date: Wed, 16 Sep 2020 04:25:52 +0200 From: Willy Tarreau To: Bhaskar Chowdhury Cc: b.zolnierkie@samsung.com, linux-fbdev@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, corbet@lwn.net, rdunlap@infradead.org, gregkh@linuxfoundation.org, daniel@ffwll.ch, yuanmingbuaa@gmail.com, nopitydays@gmail.com, zhangyunhai@nsfocus.com, luto@amacapital.net, torvalds@linux-foundation.org Subject: Re: [PATCH] docs: fb: Remove framebuffer scrollback option for boot Message-ID: <20200916022552.GB13409@1wt.eu> References: <20200915222511.17140-1-unixbhaskar@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20200915222511.17140-1-unixbhaskar@gmail.com> User-Agent: Mutt/1.6.1 (2016-04-27) Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Bhaskar, your patches still all use very similar subjects and commit messages which are pretty confusing as they only differ by words unrelated to their real differences. It is important that the commit messages help the reader guess what is being touched, so if you're splitting your work into multiple patches, you need to indicate the difference in each message. What I can propose to make things clearer: docs: fb: Remove framebuffer scrollback boot option docs: fb: Remove matroxfb scrollback boot option docs: fb: Remove sstfb scrollback boot option docs: fb: Remove vesafb scrollback boot option Alternately they can all be merged into the first one under the same name, but then the detailed commit message should specifically list them. In addition below: On Wed, Sep 16, 2020 at 03:55:11AM +0530, Bhaskar Chowdhury wrote: > This patch remove the scrollback option under boot options. > Plus readjust the numbers for the options in that section. > > Commit 973c096f6a85(vgacon: remove software scrollback support) > Commit 50145474f6ef(fbcon: remove soft scrollback code) This is still not clear. The message should indicate the "why" more than the "what" which can be figured from the patch. In addition, only the fbcon commit is a cause for these changes. Last, Greg mentioned that the format is 'commit xxx ("subject")'. What about this: The "scrollback" boot option was removed by commit 50145474f6ef ("fbcon: remove soft scrollback code"), but the doc for fbcon was not updated. This patch updates the fbcon doc and renumbers the sections. If you merge all your patches together, you can have this: The "scrollback" boot option was removed by commit 50145474f6ef ("fbcon: remove soft scrollback code"), but the fb docs were not updated. This patch removes reference to this option in the fbcon, matroxfb, sstfb and vesafb docs and renumbers the sections as needed. And please increase your version so that it's more obvious that this replaces previous series. Call it v3 or v4 or whatever higher than the highest you've ever sent so that it's easier for your readers to ignore the older ones. Ideally after your signed-off-by you should add a "---" line with a quick changelog indicating what changed from the previous ones (just for reviewers, this will not be merged), for example: Signed-off-by: Bhaskar Chowdhury --- v3: clarify message description, update all fb drivers in the same patch v2: reword commit message Hoping this helps, Willy