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=-2.8 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_PASS,USER_AGENT_NEOMUTT autolearn=ham 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 E418AC10F00 for ; Wed, 6 Mar 2019 09:52:02 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 906DB20661 for ; Wed, 6 Mar 2019 09:52:02 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=armlinux.org.uk header.i=@armlinux.org.uk header.b="I1nigGHr" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730044AbfCFJwB (ORCPT ); Wed, 6 Mar 2019 04:52:01 -0500 Received: from pandora.armlinux.org.uk ([78.32.30.218]:57312 "EHLO pandora.armlinux.org.uk" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729862AbfCFJv6 (ORCPT ); Wed, 6 Mar 2019 04:51:58 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=armlinux.org.uk; s=pandora-2019; h=Sender:In-Reply-To: Content-Transfer-Encoding:Content-Type:MIME-Version:References:Message-ID: Subject:Cc:To:From:Date:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=R04WONfcNjZyfefgQZ+56O4ERxZmYBCtYwY0/aXW1rU=; b=I1nigGHrh5KIuVRutokf3M484 vuZgTMDpnvDMojX5GehXUfyzVCvZP4hOwMroq6q3btSLB7H78Azw1N6qH6zOMwboLQEb3Vw4vvlmA VBFZ7tgUZx0vI71h6e9od/CDL9aZjRMlDWaDDkk2ZzZiplXcXOJjo169JZN/Ow80L1BZLRjHA1Otz 6jw/FrIXvlerhdvNpBBQP4wTSgd55mCEJ8xHXF/B+HGUiqTXyIljh1ELq37Y/4CcM/fgyVqHzmaak 2Gu/BoJO1p04GHR22lbAdvEperUnnymYQEUVCrPThFmgWvCBwiO4z/Mn8JGgheiNFqwGWaQif/WUx d3FjLEvTA==; Received: from shell.armlinux.org.uk ([fd8f:7570:feb6:1:5054:ff:fe00:4ec]:51620) by pandora.armlinux.org.uk with esmtpsa (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.90_1) (envelope-from ) id 1h1TDN-0006u2-RG; Wed, 06 Mar 2019 09:51:53 +0000 Received: from linux by shell.armlinux.org.uk with local (Exim 4.89) (envelope-from ) id 1h1TDH-0003yJ-Qg; Wed, 06 Mar 2019 09:51:47 +0000 Date: Wed, 6 Mar 2019 09:51:47 +0000 From: Russell King - ARM Linux admin To: Lucas Stach Cc: linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, Mark Rutland , Greg Kroah-Hartman , Andy Shevchenko , Peng Hao Subject: Re: Smarter Kconfig help Message-ID: <20190306095147.xyf3d62bywx4v6ji@shell.armlinux.org.uk> References: <20190305173111.t3n6ycktht7kxuhq@shell.armlinux.org.uk> <1551865552.9298.24.camel@pengutronix.de> MIME-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <1551865552.9298.24.camel@pengutronix.de> User-Agent: NeoMutt/20170113 (1.7.2) Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Wed, Mar 06, 2019 at 10:45:52AM +0100, Lucas Stach wrote: > Hi Russell, > > Am Dienstag, den 05.03.2019, 17:31 +0000 schrieb Russell King - ARM Linux admin: > > Guys, > > > > We need to be smarter when writing Kconfig help.  I'm just going > > through updating my build trees with the results of 5.0 development, > > and a number of the help texts are next to useless.  For example, > > > > PVPANIC - is this something that should be enabled for a host or > > guest kernel?  Answer: you have to read the driver code to find out. > > > > IMX_IRQSTEER - which i.MX SoCs does this apply to?  The help text > > just says: > > > >   "Support for the i.MX IRQSTEER interrupt multiplexer/remapper." > > > > which doesn't say which SoCs this should be enabled for - it turns > > out that grepping for the driver's DT compatible string, none of > > the 32-bit ARM cores have support for this, yet we still default > > it to enabled there.  It seems the help text should at the very > > least tell the user that this is not applicable to i.MX SoCs with > > 32-bit ARM cores. > > > > I'm sure there's many other instances of this... I suspect that > > it's caused by review concentrating mostly on the technical aspects > > of the code and the Kconfig help text just gets forgotten about. > > > > Can we at least improve these two options please? > > While I totally agree that the irqsteer driver should only default Y on > 64bit i.MX SoCs, I'm not really sure what to do about the Kconfig help > text. > > Enumerating SoCs in the Kconfig of a IP block driver is always prone to > get outdated. Just as the first example I've been able to come up with, > the MMC_SDHCI_ESDHC_IMX help text says: "This selects the Freescale > eSDHC/uSDHC controller support found on i.MX25, i.MX35 i.MX5x and > i.MX6x.", while the same IP block is to be found on i.MX7 and various > i.MX8. > > For the Kconfig user, who needs to decide if an option is relevant, > outdated SoC information is probably just as bad as no information at > all. How about "This option does not apply to AArch32 based SoCs" or "This option should be enabled for i.MX7 and later SoCs" ? -- RMK's Patch system: https://www.armlinux.org.uk/developer/patches/ FTTC broadband for 0.8mile line in suburbia: sync at 12.1Mbps down 622kbps up According to speedtest.net: 11.9Mbps down 500kbps up 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=-3.0 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_PASS, USER_AGENT_NEOMUTT autolearn=ham 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 81681C43381 for ; Wed, 6 Mar 2019 10:08:19 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 5122520657 for ; Wed, 6 Mar 2019 10:08:19 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="GETHmuQ0"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="Tj69Vwnh"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=armlinux.org.uk header.i=@armlinux.org.uk header.b="I1nigGHr" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 5122520657 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=armlinux.org.uk Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:References: Message-ID:Subject:To:From:Date:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=OCQjeuYvKzS+OOFrrUN+N4Qc5VXuviXVFKlxXylW1ws=; b=GETHmuQ0uucc3b egE++s2Up+Ytn66UFICT0yws8++UpXFy4tnFfSqygtg1IvqyZr9Z4ED46lY7V8C/K/NWBYZaOUFQk LS0cKuO5En6MVYk5WXfPJVCiCrxNzk1BEJtu5MtjlOKuooZ9L90aJovd7ajdTpDZZSEozusVog1pI gzK1gvP/PYi2ld13nicoQ3A4LLsaRWj3N8+QhFPwi12DmFxnLkSlfJFkiFwaTNlEWDF6CkkW7X4b9 TGTa/k3iE0s1Qt91E+vM5C/z58G5wwLFcIdz1E9mcQo4OIkLEsh8qrDgmec0gCTBaoLbiui0B+qPu EGSnO9gMB50tc3wYUWew==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.90_1 #2 (Red Hat Linux)) id 1h1TTD-0003ph-9X; Wed, 06 Mar 2019 10:08:15 +0000 Received: from casper.infradead.org ([2001:8b0:10b:1236::1]) by bombadil.infradead.org with esmtps (Exim 4.90_1 #2 (Red Hat Linux)) id 1h1TT9-0003Jc-LJ for linux-arm-kernel@bombadil.infradead.org; Wed, 06 Mar 2019 10:08:13 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Sender:In-Reply-To: Content-Transfer-Encoding:Content-Type:MIME-Version:References:Message-ID: Subject:Cc:To:From:Date:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=R04WONfcNjZyfefgQZ+56O4ERxZmYBCtYwY0/aXW1rU=; b=Tj69VwnhDp1E8yHme+cFGFa9t Sy7epf1a7kMCEhiT6qN7c+EDWsKBsXZeNIkeey/HADab3ZhMo+z7VWNLQa46S4Wt6CR+3kicBRe23 ETdi1UdycfutSlpoFQUpaRTjnggVUXNrdRFgMzXND+IRbJHmbbx2IdwI/SAQux5zqCk9LCcY/twvl biqdMmitUIIeHSJDlVYsoUuZyzNOdeZjjdsZlg4gu7gcDitlOHE3j2skidQ59VfI3z8675e62QUY9 +iMILjIGuyLe4L61O5oYH7bJlElihtGgpPmJSWuO/uVapHrfP1GbtjeWngDINSnt0MiTAwCbkaJTH ZGnkYGjtA==; Received: from pandora.armlinux.org.uk ([2001:4d48:ad52:3201:214:fdff:fe10:1be6]) by casper.infradead.org with esmtps (Exim 4.90_1 #2 (Red Hat Linux)) id 1h1TFR-00021Q-UU for linux-arm-kernel@lists.infradead.org; Wed, 06 Mar 2019 09:54:04 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=armlinux.org.uk; s=pandora-2019; h=Sender:In-Reply-To: Content-Transfer-Encoding:Content-Type:MIME-Version:References:Message-ID: Subject:Cc:To:From:Date:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=R04WONfcNjZyfefgQZ+56O4ERxZmYBCtYwY0/aXW1rU=; b=I1nigGHrh5KIuVRutokf3M484 vuZgTMDpnvDMojX5GehXUfyzVCvZP4hOwMroq6q3btSLB7H78Azw1N6qH6zOMwboLQEb3Vw4vvlmA VBFZ7tgUZx0vI71h6e9od/CDL9aZjRMlDWaDDkk2ZzZiplXcXOJjo169JZN/Ow80L1BZLRjHA1Otz 6jw/FrIXvlerhdvNpBBQP4wTSgd55mCEJ8xHXF/B+HGUiqTXyIljh1ELq37Y/4CcM/fgyVqHzmaak 2Gu/BoJO1p04GHR22lbAdvEperUnnymYQEUVCrPThFmgWvCBwiO4z/Mn8JGgheiNFqwGWaQif/WUx d3FjLEvTA==; Received: from shell.armlinux.org.uk ([fd8f:7570:feb6:1:5054:ff:fe00:4ec]:51620) by pandora.armlinux.org.uk with esmtpsa (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.90_1) (envelope-from ) id 1h1TDN-0006u2-RG; Wed, 06 Mar 2019 09:51:53 +0000 Received: from linux by shell.armlinux.org.uk with local (Exim 4.89) (envelope-from ) id 1h1TDH-0003yJ-Qg; Wed, 06 Mar 2019 09:51:47 +0000 Date: Wed, 6 Mar 2019 09:51:47 +0000 From: Russell King - ARM Linux admin To: Lucas Stach Subject: Re: Smarter Kconfig help Message-ID: <20190306095147.xyf3d62bywx4v6ji@shell.armlinux.org.uk> References: <20190305173111.t3n6ycktht7kxuhq@shell.armlinux.org.uk> <1551865552.9298.24.camel@pengutronix.de> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <1551865552.9298.24.camel@pengutronix.de> User-Agent: NeoMutt/20170113 (1.7.2) X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20190306_095402_062235_27E588EA X-CRM114-Status: GOOD ( 31.34 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Mark Rutland , Peng Hao , Greg Kroah-Hartman , linux-kernel@vger.kernel.org, Andy Shevchenko , linux-arm-kernel@lists.infradead.org Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Wed, Mar 06, 2019 at 10:45:52AM +0100, Lucas Stach wrote: > Hi Russell, > = > Am Dienstag, den 05.03.2019, 17:31 +0000 schrieb Russell King - ARM Linux= admin: > > Guys, > > = > > We need to be smarter when writing Kconfig help.=A0=A0I'm just going > > through updating my build trees with the results of 5.0 development, > > and a number of the help texts are next to useless.=A0=A0For example, > > = > > PVPANIC - is this something that should be enabled for a host or > > guest kernel?=A0=A0Answer: you have to read the driver code to find out. > > = > > IMX_IRQSTEER - which i.MX SoCs does this apply to?=A0=A0The help text > > just says: > > = > > =A0 "Support for the i.MX IRQSTEER interrupt multiplexer/remapper." > > = > > which doesn't say which SoCs this should be enabled for - it turns > > out that grepping for the driver's DT compatible string, none of > > the 32-bit ARM cores have support for this, yet we still default > > it to enabled there.=A0=A0It seems the help text should at the very > > least tell the user that this is not applicable to i.MX SoCs with > > 32-bit ARM cores. > > = > > I'm sure there's many other instances of this... I suspect that > > it's caused by review concentrating mostly on the technical aspects > > of the code and the Kconfig help text just gets forgotten about. > > = > > Can we at least improve these two options please? > = > While I totally agree that the irqsteer driver should only default Y on > 64bit i.MX SoCs, I'm not really sure what to do about the Kconfig help > text. > = > Enumerating SoCs in the Kconfig of a IP block driver is always prone to > get outdated. Just as the first example I've been able to come up with, > the MMC_SDHCI_ESDHC_IMX help text says: "This selects the Freescale > eSDHC/uSDHC controller support=A0found on i.MX25, i.MX35 i.MX5x and > i.MX6x.", while the same IP block is to be found on i.MX7 and various > i.MX8. > = > For the Kconfig user, who needs to decide if an option is relevant, > outdated SoC information is probably just as bad as no information at > all. How about "This option does not apply to AArch32 based SoCs" or "This option should be enabled for i.MX7 and later SoCs" ? -- = RMK's Patch system: https://www.armlinux.org.uk/developer/patches/ FTTC broadband for 0.8mile line in suburbia: sync at 12.1Mbps down 622kbps = up According to speedtest.net: 11.9Mbps down 500kbps up _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel