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 55F43C04A95 for ; Tue, 25 Oct 2022 15:07:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232445AbiJYPHf (ORCPT ); Tue, 25 Oct 2022 11:07:35 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35634 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232080AbiJYPHd (ORCPT ); Tue, 25 Oct 2022 11:07:33 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [IPv6:2604:1380:4641:c500::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0890F127433 for ; Tue, 25 Oct 2022 08:07:31 -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 dfw.source.kernel.org (Postfix) with ESMTPS id 826BA619AB for ; Tue, 25 Oct 2022 15:07:31 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id DC7DCC433C1; Tue, 25 Oct 2022 15:07:30 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1666710450; bh=KBAz+zP2xRFULFevvRqjgfOjPO0WQHFMxkqYkpGJFtQ=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=YeumVQBOf2KlsN8wrxnRtiF01T8ZtyhunJRFtDHjdMsrM1f4SSglK+3FUScVNc4PJ Z6CIo5m7DV6WN9wEAjYehFbXYgaVJTBLFv7TOG/4zOw7rzYAUEQ/uz3QypS+ZrQv4h rKo+xgfBg7UejCiBoZXxBfnk0shWvxnqBSjM4pEnxV3YEtApWczZQ992vMNd7r5RqU Ao/7YKw9nC6DpGI7m8Hvecq6sFzPrv+dnEohWh0kPbWgDWRNceQzDVhQAQCCjHvK3U THtFTYm1XhxmOh13mWaLaC+/I0CmdwjP0vNTzh/Wy8ikJbn4+tT/ADizP/DhjqSNRi tdxh+L1mkdCdw== Received: from sofa.misterjones.org ([185.219.108.64] helo=goblin-girl.misterjones.org) by disco-boy.misterjones.org with esmtpsa (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.95) (envelope-from ) id 1onLWa-001YrF-Gz; Tue, 25 Oct 2022 16:07:28 +0100 Date: Tue, 25 Oct 2022 16:07:28 +0100 Message-ID: <86mt9kdjrj.wl-maz@kernel.org> From: Marc Zyngier To: "Tyler Hicks (Microsoft)" Cc: Mark Rutland , Daniel Lezcano , Thomas Gleixner , Vijay Balakrishna , Will Deacon , linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH] clocksource/drivers/arm_arch_timer: Fix event stream param in Kconfig In-Reply-To: <20221025141854.22ppd7mw3vb6esgr@sequoia> References: <20221024195118.871907-1-code@tyhicks.com> <86pmegdwug.wl-maz@kernel.org> <20221025141854.22ppd7mw3vb6esgr@sequoia> User-Agent: Wanderlust/2.15.9 (Almost Unreal) SEMI-EPG/1.14.7 (Harue) FLIM-LB/1.14.9 (=?UTF-8?B?R29qxY0=?=) APEL-LB/10.8 EasyPG/1.0.0 Emacs/27.1 (aarch64-unknown-linux-gnu) MULE/6.0 (HANACHIRUSATO) MIME-Version: 1.0 (generated by SEMI-EPG 1.14.7 - "Harue") Content-Type: text/plain; charset=US-ASCII X-SA-Exim-Connect-IP: 185.219.108.64 X-SA-Exim-Rcpt-To: code@tyhicks.com, mark.rutland@arm.com, daniel.lezcano@linaro.org, tglx@linutronix.de, vijayb@linux.microsoft.com, will@kernel.org, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org X-SA-Exim-Mail-From: maz@kernel.org X-SA-Exim-Scanned: No (on disco-boy.misterjones.org); SAEximRunCond expanded to false Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi Tyler, On Tue, 25 Oct 2022 15:18:54 +0100, "Tyler Hicks (Microsoft)" wrote: > > On 2022-10-25 11:24:55, Marc Zyngier wrote: > > Hi Tyler, > > > > On Mon, 24 Oct 2022 20:51:18 +0100, > > Tyler Hicks wrote: > > > > > > From: "Tyler Hicks (Microsoft)" > > > > > > Fix the event stream timer command line parameter name that's documented > > > in the Kconfig description for CONFIG_ARM_ARCH_TIMER_EVTSTREAM. It > > > didn't match the command line parameter name that's actually honored in > > > the source code. > > > > > > Reported-by: Vijay Balakrishna > > > Fixes: 46fd5c6b3059 ("clocksource/drivers/arm_arch_timer: Control the evtstrm via the cmdline") > > > Cc: stable@vger.kernel.org > > > > No, this really doesn't deserve a Cc: stable. This bit may be wrong, > > but we have the correct information in the kernel-parameters.txt file, > > which is authoritative AFAIC. > > Thanks for the review! > > I added the stable tag because it caused an actual waste of time in an > investigation. Upon discovering this option, I didn't notice the subtle > difference in cmdline parameter name from the Kconfig, to the > kernel-parameters.txt file and the code. I ran long-running stress tests > with the incorrect parameter name copied and pasted from the Kconfig. > This error resulted in a bad data point in the investigation and it took > a second set of eyes (Vijay's) to uncover my mistake days later when we > were trying to reconcile the bad data point with other good data points. I appreciate this has caused a certain waste of time, but the rules for stable inclusion are pretty clear: it has to be a runtime bug. Documentation bugs, as irritating as they are, do not fall into this category (it really *is* a typo). Thanks, M. -- Without deviation from the norm, progress is not possible.