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.3 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_PASS,USER_AGENT_MUTT 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 12A6DC43381 for ; Wed, 6 Mar 2019 09:35:43 +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 D52D820675 for ; Wed, 6 Mar 2019 09:35:42 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="HgDe11JK" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org D52D820675 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=arm.com 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=ZIwroX0Qk1EO9zPyiuJADMZJfUi48HLKkFezzoxtGy8=; b=HgDe11JKm4AIHI iAVD/sQn9LYZZ+j7X/yo/snyMpn6x/NplBwdZTUWcr+p9hAsMVbFFpk4rT1ZKxpPeBwO2aT6JGXeu Niruf7FINj/inWPrl7STITurSdZWT7LGFHb3w5E+2x0S0Lgjj4v3buxD6JH2T2PprJT//9ha0rktL dkBR1opPY0a6A1kxoWbVNBZIcoEDaFz9SPxUwj/2JtDYTibIEm0kLT37hcpdCQuitfL74KhFzKVuG NE/RIpyRb1xgv1unMb75vXicVxzO4/HMbE77Edi6GC/dAX9okP0kGMMtxLmK0MDfotPF2yd7DYbuj mRWdk01KfxGUo75zwv0A==; 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 1h1SxZ-0003xw-Bh; Wed, 06 Mar 2019 09:35:33 +0000 Received: from foss.arm.com ([217.140.101.70]) by bombadil.infradead.org with esmtp (Exim 4.90_1 #2 (Red Hat Linux)) id 1h1SxW-0003wv-En for linux-arm-kernel@lists.infradead.org; Wed, 06 Mar 2019 09:35:31 +0000 Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.72.51.249]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id E9966A78; Wed, 6 Mar 2019 01:35:27 -0800 (PST) Received: from lakrids.cambridge.arm.com (usa-sjc-imap-foss1.foss.arm.com [10.72.51.249]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 927913F71D; Wed, 6 Mar 2019 01:35:26 -0800 (PST) Date: Wed, 6 Mar 2019 09:35:21 +0000 From: Mark Rutland To: Russell King - ARM Linux admin Subject: Re: Smarter Kconfig help Message-ID: <20190306093521.GA50994@lakrids.cambridge.arm.com> References: <20190305173111.t3n6ycktht7kxuhq@shell.armlinux.org.uk> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20190305173111.t3n6ycktht7kxuhq@shell.armlinux.org.uk> User-Agent: Mutt/1.11.1+11 (2f07cb52) (2018-12-01) X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20190306_013530_504993_955265AA X-CRM114-Status: GOOD ( 17.93 ) 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: Peng Hao , Greg Kroah-Hartman , linux-kernel@vger.kernel.org, Andy Shevchenko , linux-arm-kernel@lists.infradead.org, Lucas Stach Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Tue, Mar 05, 2019 at 05:31:12PM +0000, Russell King - ARM Linux admin wrote: > Guys, Hi Russell, > 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. When I looked at the help text: This driver provides support for the pvpanic device. pvpanic is a paravirtualized device provided by QEMU; it lets a virtual machine (guest) communicate panic events to the host. ... it seemed clear to me that this was for a guest, given the text says QEMU provides the device. I guess you read that as meaning QEMU asks the host kernel to provide the device to the guest? Do you have a suggestion for how to word that unambiguously? > 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. Just to be clear, in general what you want is for Kconfig help to be clearer about *when* an option is relevant, right? I'll try to bear that in mind when reviewing in future. Thanks, Mark. _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel