2021-03-07 17:49:12

by Sergei Trofimovich

[permalink] [raw]
Subject: [PATCH] docs: don't include Documentation/Kconfig twice

Before the change there were two inclusions of Documentation/Kconfig:
lib/Kconfig.debug:source "Documentation/Kconfig"
Kconfig: source "Documentation/Kconfig"

Kconfig also included 'source "lib/Kconfig.debug"'.

Noticed as two 'make menuconfig' entries in both top level menu
and in 'Kernel hacking' menu. The patch keeps entries only in
'Kernel hacking'.

CC: Mauro Carvalho Chehab <[email protected]>
CC: Jonathan Corbet <[email protected]>
Signed-off-by: Sergei Trofimovich <[email protected]>
---
Kconfig | 2 --
1 file changed, 2 deletions(-)

diff --git a/Kconfig b/Kconfig
index 745bc773f567..97ed6389c921 100644
--- a/Kconfig
+++ b/Kconfig
@@ -28,5 +28,3 @@ source "crypto/Kconfig"
source "lib/Kconfig"

source "lib/Kconfig.debug"
-
-source "Documentation/Kconfig"
--
2.30.1


2021-03-10 18:35:08

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] docs: don't include Documentation/Kconfig twice

On 3/7/21 6:00 AM, Sergei Trofimovich wrote:
> Before the change there were two inclusions of Documentation/Kconfig:
> lib/Kconfig.debug:source "Documentation/Kconfig"
> Kconfig: source "Documentation/Kconfig"
>
> Kconfig also included 'source "lib/Kconfig.debug"'.
>
> Noticed as two 'make menuconfig' entries in both top level menu
> and in 'Kernel hacking' menu. The patch keeps entries only in
> 'Kernel hacking'.
>
> CC: Mauro Carvalho Chehab <[email protected]>
> CC: Jonathan Corbet <[email protected]>
> Signed-off-by: Sergei Trofimovich <[email protected]>

Hi,
OK, it shouldn't be there in 2 places.

The current usage is good under Kernel Hacking (development),
but I can easily foresee cases where we would want user-selectable
Documentation/Kconfig options, so IMO it would be better to be
more independent (i.e., not in lib/Kconfig.debug).

Anyway, for either way that it's fixed:

Reviewed-by: Randy Dunlap <[email protected]>


> ---
> Kconfig | 2 --
> 1 file changed, 2 deletions(-)
>
> diff --git a/Kconfig b/Kconfig
> index 745bc773f567..97ed6389c921 100644
> --- a/Kconfig
> +++ b/Kconfig
> @@ -28,5 +28,3 @@ source "crypto/Kconfig"
> source "lib/Kconfig"
>
> source "lib/Kconfig.debug"
> -
> -source "Documentation/Kconfig"
>

thanks.
--
~Randy

2021-03-15 21:41:03

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] docs: don't include Documentation/Kconfig twice

Sergei Trofimovich <[email protected]> writes:

> Before the change there were two inclusions of Documentation/Kconfig:
> lib/Kconfig.debug:source "Documentation/Kconfig"
> Kconfig: source "Documentation/Kconfig"
>
> Kconfig also included 'source "lib/Kconfig.debug"'.
>
> Noticed as two 'make menuconfig' entries in both top level menu
> and in 'Kernel hacking' menu. The patch keeps entries only in
> 'Kernel hacking'.
>
> CC: Mauro Carvalho Chehab <[email protected]>
> CC: Jonathan Corbet <[email protected]>
> Signed-off-by: Sergei Trofimovich <[email protected]>
> ---
> Kconfig | 2 --
> 1 file changed, 2 deletions(-)
>
> diff --git a/Kconfig b/Kconfig
> index 745bc773f567..97ed6389c921 100644
> --- a/Kconfig
> +++ b/Kconfig
> @@ -28,5 +28,3 @@ source "crypto/Kconfig"
> source "lib/Kconfig"
>
> source "lib/Kconfig.debug"
> -
> -source "Documentation/Kconfig"
> --
> 2.30.1

I agree with not including it twice. Under "kernel hacking" seems like
the wrong place to keep it, though. There's a lot more than kernel
hacking in the kernel docs, I don't think we should bury it in quite
that way. So I'd delete the other one.

Thanks,

jon