2022-04-12 21:03:36

by Bru Moreira-Guedes

[permalink] [raw]
Subject: [PATCH v2 1/3] staging: vme: Adjusted VME_USER in Kconfig

Currently, the VME_USER driver is in the staging tree Kconfig, unlike
other VME drivers already moved to the main portions of the kernel tree.
Its configuration is, however, nested into the VME_BUS config option,
which might be misleading.

Since the staging tree "[...] is used to hold stand-alone[1] drivers and
filesystem that are not ready to be merged into the main portion of the
Linux kernel tree [...]"[1], IMHO all staging drivers should appear
nested into the Main Menu -> Device Drivers -> Staging Drivers to make
sure the user don't pick it without being fully aware of its staging
status as it could be the case in Menu -> Device Drivers -> VME bridge
support (the current location).

With this change menuconfig users will clearly know this is not a driver
in the main portion of the kernel tree and decide whether to build it or
not with that clearly in mind.

This change goes into the same direction of commit 4b4cdf3979c3
("STAGING: Move staging drivers back to staging-specific menu")

CHANGELOG
v1:
- Sourced "drivers/staging/vme/devices/Kconfig" in
"drivers/staging/Kconfig" and unsourced in "drivers/vme/Kconfig".

v2:
- Turned into a patchset to (1) fix missing "depends on" missing entry
in config VME_USER at "drivers/staging/vme/devices/Kconfig",
affecting the behavior of this patch, and (2) fix unnecessary
remaining files from the time the whole vme subtree was in staging.

REFERENCES
[1] https://lkml.org/lkml/2009/3/18/314

Signed-off-by: Bruno Moreira-Guedes <[email protected]>
---
drivers/staging/Kconfig | 2 ++
drivers/vme/Kconfig | 2 --
2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/staging/Kconfig b/drivers/staging/Kconfig
index 932acb4e8cbc..0545850eb2ff 100644
--- a/drivers/staging/Kconfig
+++ b/drivers/staging/Kconfig
@@ -88,4 +88,6 @@ source "drivers/staging/qlge/Kconfig"

source "drivers/staging/wfx/Kconfig"

+source "drivers/staging/vme/devices/Kconfig"
+
endif # STAGING
diff --git a/drivers/vme/Kconfig b/drivers/vme/Kconfig
index 936392ca3c8c..c13dd9d2a604 100644
--- a/drivers/vme/Kconfig
+++ b/drivers/vme/Kconfig
@@ -15,6 +15,4 @@ source "drivers/vme/bridges/Kconfig"

source "drivers/vme/boards/Kconfig"

-source "drivers/staging/vme/devices/Kconfig"
-
endif # VME
--
2.35.1


Attachments:
(No filename) (2.30 kB)
signature.asc (235.00 B)
Download all attachments

2022-04-12 21:43:33

by Alison Schofield

[permalink] [raw]
Subject: Re: [PATCH v2 1/3] staging: vme: Adjusted VME_USER in Kconfig

On Tue, Apr 12, 2022 at 03:55:21AM -0300, Bruno Moreira-Guedes wrote:

'Adjusted' is unecessarily vague. In the commit msg try to say
exactly what the patch did. Write in the imperative tense, like
you are issuing commands.

Something like 'Move VME staging driver to staging Kconfig' , or
'Source vme driver from staging Kconfig'.

> Currently, the VME_USER driver is in the staging tree Kconfig, unlike
> other VME drivers already moved to the main portions of the kernel tree.
> Its configuration is, however, nested into the VME_BUS config option,
> which might be misleading.
>
> Since the staging tree "[...] is used to hold stand-alone[1] drivers and
> filesystem that are not ready to be merged into the main portion of the
> Linux kernel tree [...]"[1], IMHO all staging drivers should appear

Skip the 'IMHO'. It's all your HO and if you state anything incorrectly,
your reviewers should catch it. If you are truly making a wild guess
about something, either look into it further, or not it in a question
below the '---'.

This commit message is otherwise very well written. It explains the
why of this patch nicely.

Again, for this set, perhaps the changelog in the cover letter only.

> nested into the Main Menu -> Device Drivers -> Staging Drivers to make
> sure the user don't pick it without being fully aware of its staging
> status as it could be the case in Menu -> Device Drivers -> VME bridge
> support (the current location).
>
> With this change menuconfig users will clearly know this is not a driver
> in the main portion of the kernel tree and decide whether to build it or
> not with that clearly in mind.
>
> This change goes into the same direction of commit 4b4cdf3979c3
> ("STAGING: Move staging drivers back to staging-specific menu")
>
> CHANGELOG
> v1:
> - Sourced "drivers/staging/vme/devices/Kconfig" in
> "drivers/staging/Kconfig" and unsourced in "drivers/vme/Kconfig".
>
> v2:
> - Turned into a patchset to (1) fix missing "depends on" missing entry
> in config VME_USER at "drivers/staging/vme/devices/Kconfig",
> affecting the behavior of this patch, and (2) fix unnecessary
> remaining files from the time the whole vme subtree was in staging.
>
> REFERENCES
> [1] https://lkml.org/lkml/2009/3/18/314
>
> Signed-off-by: Bruno Moreira-Guedes <[email protected]>
> ---
> drivers/staging/Kconfig | 2 ++
> drivers/vme/Kconfig | 2 --
> 2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/staging/Kconfig b/drivers/staging/Kconfig
> index 932acb4e8cbc..0545850eb2ff 100644
> --- a/drivers/staging/Kconfig
> +++ b/drivers/staging/Kconfig
> @@ -88,4 +88,6 @@ source "drivers/staging/qlge/Kconfig"
>
> source "drivers/staging/wfx/Kconfig"
>
> +source "drivers/staging/vme/devices/Kconfig"
> +
> endif # STAGING
> diff --git a/drivers/vme/Kconfig b/drivers/vme/Kconfig
> index 936392ca3c8c..c13dd9d2a604 100644
> --- a/drivers/vme/Kconfig
> +++ b/drivers/vme/Kconfig
> @@ -15,6 +15,4 @@ source "drivers/vme/bridges/Kconfig"
>
> source "drivers/vme/boards/Kconfig"
>
> -source "drivers/staging/vme/devices/Kconfig"
> -
> endif # VME
> --
> 2.35.1
>