diff mbox series

ASoC: tegra20-spdif: remove "default m"

Message ID ede103cf7f6914054a73cf8f1d9725ee13a7cf5d.1601149261.git.mirq-linux@rere.qmqm.pl
State New
Headers show
Series ASoC: tegra20-spdif: remove "default m" | expand

Commit Message

Michał Mirosław Sept. 26, 2020, 7:42 p.m. UTC
Make tegra20-spdif default to N as all other drivers do.

Signed-off-by: Michał Mirosław <mirq-linux@rere.qmqm.pl>
Fixes: 774fec338bfc ("ASoC: Tegra: Implement SPDIF CPU DAI")
---
 sound/soc/tegra/Kconfig | 1 -
 1 file changed, 1 deletion(-)

Comments

Thierry Reding Sept. 28, 2020, 8:10 a.m. UTC | #1
On Sat, Sep 26, 2020 at 09:42:40PM +0200, Michał Mirosław wrote:
> Make tegra20-spdif default to N as all other drivers do.
> 
> Signed-off-by: Michał Mirosław <mirq-linux@rere.qmqm.pl>
> Fixes: 774fec338bfc ("ASoC: Tegra: Implement SPDIF CPU DAI")

I don't think this is warranted. This doesn't fix a bug or anything.
It's merely a change in the default configuration. The presence of a
Fixes: tag is typically used as a hint for people to pick this up into
stable releases, but I don't think this qualifies.

> ---
>  sound/soc/tegra/Kconfig | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/sound/soc/tegra/Kconfig b/sound/soc/tegra/Kconfig
> index 3d91bd3e59cd..a62cc87551ac 100644
> --- a/sound/soc/tegra/Kconfig
> +++ b/sound/soc/tegra/Kconfig
> @@ -39,7 +39,6 @@ config SND_SOC_TEGRA20_I2S
>  config SND_SOC_TEGRA20_SPDIF
>  	tristate "Tegra20 SPDIF interface"
>  	depends on SND_SOC_TEGRA
> -	default m
>  	help
>  	  Say Y or M if you want to add support for the Tegra20 SPDIF interface.
>  	  You will also need to select the individual machine drivers to support

So now by default this driver will be disabled, which means that Linux
is going to regress for people that rely on this driver.

You need to at least follow this up with a patch that makes the
corresponding change in both tegra_defconfig and multi_v7_defconfig to
ensure that this driver is going to get built by default.

Given the above it's probably also a good idea to explain a bit more in
the commit message about what you're trying to achieve. Yes, "default n"
is usually the right thing to do and I'm honestly not sure why Stephen
chose to make this "default m" back in the day. Given that it depends on
SND_SOC_TEGRA, which itself is "default n", I think this makes some
sense, even if in retrospect it ended up being a bit inconsistent (you
could probably argue that all patches after this are the ones that were
inconsistent instead). This was merged over 9 years ago and a lot of
common practices have changed over that period of time.

Thierry
Michał Mirosław Sept. 28, 2020, 6:52 p.m. UTC | #2
On Mon, Sep 28, 2020 at 10:10:26AM +0200, Thierry Reding wrote:
> On Sat, Sep 26, 2020 at 09:42:40PM +0200, Michał Mirosław wrote:
> > Make tegra20-spdif default to N as all other drivers do.
> > 
> > Signed-off-by: Michał Mirosław <mirq-linux@rere.qmqm.pl>
> > Fixes: 774fec338bfc ("ASoC: Tegra: Implement SPDIF CPU DAI")
> 
> I don't think this is warranted. This doesn't fix a bug or anything.
> It's merely a change in the default configuration. The presence of a
> Fixes: tag is typically used as a hint for people to pick this up into
> stable releases, but I don't think this qualifies.
[...]

Fixes is just for pointing where the bug or issue originated.  I usually
include it to help you -- the reviewer -- and backporters if they ever
want to use this patch. It is not specific to stable-directed patches.

For stable candidates there is 'Cc: stable' tag (no need for this patch).

> So now by default this driver will be disabled, which means that Linux
> is going to regress for people that rely on this driver.

The bug is that this driver (and only this driver in the whole
sound/soc/tegra directory) defaults to m, where all other drivers default
to n (as the policy aboud drivers seems to be [1]). This won't affect
oldconfig, allyesconfig nor allmodconfig, but will not be selected now
for clean builds - meaning less work for those not building for Tegra2.

[1] https://lkml.org/lkml/2017/11/18/257

> You need to at least follow this up with a patch that makes the
> corresponding change in both tegra_defconfig and multi_v7_defconfig to
> ensure that this driver is going to get built by default.

This I can do. Not all such drivers are enabled, though: eg. AHUB driver
is not. Maybe we need bigger refresh of the defconfigs instead?

> Given the above it's probably also a good idea to explain a bit more in
> the commit message about what you're trying to achieve. Yes, "default n"
> is usually the right thing to do and I'm honestly not sure why Stephen
> chose to make this "default m" back in the day. Given that it depends on
> SND_SOC_TEGRA, which itself is "default n", I think this makes some
> sense, even if in retrospect it ended up being a bit inconsistent (you
> could probably argue that all patches after this are the ones that were
> inconsistent instead). This was merged over 9 years ago and a lot of
> common practices have changed over that period of time.

Yes, this is a cleanup. :-)

Best Regards
Michał Mirosław
diff mbox series

Patch

diff --git a/sound/soc/tegra/Kconfig b/sound/soc/tegra/Kconfig
index 3d91bd3e59cd..a62cc87551ac 100644
--- a/sound/soc/tegra/Kconfig
+++ b/sound/soc/tegra/Kconfig
@@ -39,7 +39,6 @@  config SND_SOC_TEGRA20_I2S
 config SND_SOC_TEGRA20_SPDIF
 	tristate "Tegra20 SPDIF interface"
 	depends on SND_SOC_TEGRA
-	default m
 	help
 	  Say Y or M if you want to add support for the Tegra20 SPDIF interface.
 	  You will also need to select the individual machine drivers to support