All of lore.kernel.org
 help / color / mirror / Atom feed
From: Russell King - ARM Linux admin <linux@armlinux.org.uk>
To: linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org
Cc: Lucas Stach <l.stach@pengutronix.de>,
	Peng Hao <peng.hao2@zte.com.cn>,
	Mark Rutland <mark.rutland@arm.com>,
	Andy Shevchenko <andy.shevchenko@gmail.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Subject: Smarter Kconfig help
Date: Tue, 5 Mar 2019 17:31:12 +0000	[thread overview]
Message-ID: <20190305173111.t3n6ycktht7kxuhq@shell.armlinux.org.uk> (raw)

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?

-- 
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

WARNING: multiple messages have this Message-ID (diff)
From: Russell King - ARM Linux admin <linux@armlinux.org.uk>
To: linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org
Cc: Mark Rutland <mark.rutland@arm.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Andy Shevchenko <andy.shevchenko@gmail.com>,
	Peng Hao <peng.hao2@zte.com.cn>,
	Lucas Stach <l.stach@pengutronix.de>
Subject: Smarter Kconfig help
Date: Tue, 5 Mar 2019 17:31:12 +0000	[thread overview]
Message-ID: <20190305173111.t3n6ycktht7kxuhq@shell.armlinux.org.uk> (raw)

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?

-- 
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

             reply	other threads:[~2019-03-05 17:31 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-05 17:31 Russell King - ARM Linux admin [this message]
2019-03-05 17:31 ` Smarter Kconfig help Russell King - ARM Linux admin
2019-03-06  9:35 ` Mark Rutland
2019-03-06  9:35   ` Mark Rutland
2019-03-06 12:50   ` Russell King - ARM Linux admin
2019-03-06 12:50     ` Russell King - ARM Linux admin
2019-03-06  9:45 ` Lucas Stach
2019-03-06  9:45   ` Lucas Stach
2019-03-06  9:51   ` Russell King - ARM Linux admin
2019-03-06  9:51     ` Russell King - ARM Linux admin
2019-03-06 10:49     ` Andy Shevchenko
2019-03-06 10:49       ` Andy Shevchenko
2019-03-06 11:34       ` Russell King - ARM Linux admin
2019-03-06 11:34         ` Russell King - ARM Linux admin
2019-03-06 12:42         ` Russell King - ARM Linux admin
2019-03-06 12:42           ` Russell King - ARM Linux admin
2019-03-06 20:16           ` Enrico Weigelt, metux IT consult
2019-03-06 20:16             ` Enrico Weigelt, metux IT consult
2019-03-06 20:22             ` Russell King - ARM Linux admin
2019-03-06 20:22               ` Russell King - ARM Linux admin
2019-03-09  3:25               ` Randy Dunlap
2019-03-09  3:25                 ` Randy Dunlap
2019-03-21 20:36   ` Pavel Machek
2019-03-21 20:36     ` Pavel Machek

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190305173111.t3n6ycktht7kxuhq@shell.armlinux.org.uk \
    --to=linux@armlinux.org.uk \
    --cc=andy.shevchenko@gmail.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=l.stach@pengutronix.de \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=peng.hao2@zte.com.cn \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.