From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from metis.whiteo.stw.pengutronix.de (metis.whiteo.stw.pengutronix.de [185.203.201.7]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 9F29B145B18 for ; Mon, 6 Jan 2025 15:02:16 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.203.201.7 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1736175740; cv=none; b=c1XABeOOljyhiyUeGQgnWAhA8k66NpzmIea1Nd5clfYX1pljkssEe7CQofgDEe5RP2sutAMb0yz8SlWn+1S7eI+lA6QlIKI4ysLgzbubnpuZkS5qVGW57LjIUe+BNx09YdJhjckRKke/DKqGl4GYWvzGTwW8uQKfa4jvnG1i0Lc= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1736175740; c=relaxed/simple; bh=RUgj21o1orAhDHRMIInYYQC7vBjnTmht8VkGSvspP3Q=; h=Message-ID:Date:MIME-Version:Subject:To:Cc:References:From: In-Reply-To:Content-Type; b=RPitC7hXosJZbddpdgY0zh5sRtQEgXZzy/wUZLvPSnzrhDJTld4EZkmGuxd7ioOh885zqJJtgC1LJxOVYLIWkxcjijJNNIXIMR7/HboLwc09p7TkvezF9aRTbyR9rWKD9j2n9PszD9YaOP8gHRGHfzWnjhszfcRRuMVxm0km9hc= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de; spf=pass smtp.mailfrom=pengutronix.de; arc=none smtp.client-ip=185.203.201.7 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pengutronix.de Received: from ptz.office.stw.pengutronix.de ([2a0a:edc0:0:900:1d::77] helo=[127.0.0.1]) by metis.whiteo.stw.pengutronix.de with esmtp (Exim 4.92) (envelope-from ) id 1tUocQ-0005F6-QU; Mon, 06 Jan 2025 16:02:14 +0100 Message-ID: Date: Mon, 6 Jan 2025 16:02:14 +0100 Precedence: bulk X-Mailing-List: workflows@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH RFC 2/2] docs: process: submitting-patches: clarify imperative mood suggestion To: Jonathan Corbet Cc: workflows@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Rob Herring , Frank Li , kernel@pengutronix.de References: <20241220-submitting-patches-imperative-v1-0-ee874c1859b3@pengutronix.de> <20241220-submitting-patches-imperative-v1-2-ee874c1859b3@pengutronix.de> <87r05p10bt.fsf@trenco.lwn.net> <87sepwt2fe.fsf@trenco.lwn.net> Content-Language: en-US From: Ahmad Fatoum In-Reply-To: <87sepwt2fe.fsf@trenco.lwn.net> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-SA-Exim-Connect-IP: 2a0a:edc0:0:900:1d::77 X-SA-Exim-Mail-From: a.fatoum@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: workflows@vger.kernel.org Hello Jon, On 06.01.25 15:57, Jonathan Corbet wrote: > Ahmad Fatoum writes: > >> Hello Jon, >> >> On 30.12.24 19:40, Jonathan Corbet wrote: >>> Ahmad Fatoum writes: >>> >>>> While we expect commit message titles to use the imperative mood, >>>> it's ok for commit message bodies to first include a blurb describing >>>> the background of the patch, before delving into what's being done >>>> to address the situation. >>>> >>>> Make this clearer by adding a clarification after the imperative mood >>>> suggestion as well as listing Rob Herring's commit 52bb69be6790 >>>> ("dt-bindings: ata: pata-common: Add missing additionalProperties on >>>> child nodes") as a good example commit message. >>>> >>>> Signed-off-by: Ahmad Fatoum >>> >>> I'm rather less convinced about this one. We already have a whole >>> section on describing changes. Given that this crucial document is >>> already long and hard enough to get through, I don't really think that >>> adding some duplicate information - and the noise of more labels - is >>> going to improve things. >> >> Do you agree with the content of the patch in principle? >> >> My changes were motivated by a disagreement about the necessity of having >> to use the imperative mood throughout as I described in my cover letter, >> so I still think think that a clarification is appropriate. >> >> Would a v2 without the example at the end be acceptable? > > I will always consider a patch, but the example isn't the concern, > really. The information you are trying to add to an already too-long > document is already present there; I think that repeating it, and making > this crucial document that much more unapproachable, would actively make > things worse. Ok, thanks for the prompt response. Cheers, Ahmad > > Thanks, > > jon > -- Pengutronix e.K. | | Steuerwalder Str. 21 | http://www.pengutronix.de/ | 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 | Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |