2023-01-14 06:27:41

by Peter Foley

[permalink] [raw]
Subject: [PATCH] Documentation: Avoid duplicate Kconfig inclusion

Documentation/Kconfig is already included from lib/Kconfig.debug, avoid
including it again and polluting the top-level menu.

Signed-off-by: Peter Foley <[email protected]>
---
Kconfig | 2 --
1 file changed, 2 deletions(-)

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

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

---
base-commit: 97ec4d559d939743e8af83628be5af8da610d9dc
change-id: 20230114-doc-005df4ac8193

Best regards,
--
Peter Foley <[email protected]>


2023-01-14 16:48:36

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] Documentation: Avoid duplicate Kconfig inclusion

Peter Foley <[email protected]> writes:

> Documentation/Kconfig is already included from lib/Kconfig.debug, avoid
> including it again and polluting the top-level menu.
>
> Signed-off-by: Peter Foley <[email protected]>
> ---
> Kconfig | 2 --
> 1 file changed, 2 deletions(-)
>
> diff --git a/Kconfig b/Kconfig
> index 745bc773f5670..97ed6389c9211 100644
> --- a/Kconfig
> +++ b/Kconfig
> @@ -28,5 +28,3 @@ source "crypto/Kconfig"
> source "lib/Kconfig"
>
> source "lib/Kconfig.debug"
> -
> -source "Documentation/Kconfig"
>

The duplicate inclusion does seem worth fixing, but I wonder if you're
deleting the right one? Having the documentation Kconfig under lib
seems a bit strange, somehow; Documentation/ is a top-level directory,
after all.

Thanks,

jon

2023-01-16 01:05:20

by Peter Foley

[permalink] [raw]
Subject: Re: [PATCH] Documentation: Avoid duplicate Kconfig inclusion

On Sat, Jan 14, 2023 at 8:25 AM Jonathan Corbet <[email protected]> wrote:
> The duplicate inclusion does seem worth fixing, but I wonder if you're
> deleting the right one? Having the documentation Kconfig under lib
> seems a bit strange, somehow; Documentation/ is a top-level directory,
> after all.

I thought about that.
Looking at the history, the toplevel inclusion was added in
b1663d7e3a7961 (2019-06-04), and the lib/Kconfig.debug inclusion was
added in 75442fb0ccaacd (2020-10-30).
Given the actual entries in Documentation/Kconfig
(WARN_MISSING_DOCUMENTS and WARN_ABI_ERRORS), putting them under the
"Kernel hacking" menu makes sense to me.
We *could* add a new top-level menu to Documentation/Kconfig, but it
doesn't really seem like an improvement over having them live in
Kernel hacking.

2023-01-16 01:06:26

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] Documentation: Avoid duplicate Kconfig inclusion



On 1/15/23 16:42, Peter Foley wrote:
> On Sat, Jan 14, 2023 at 8:25 AM Jonathan Corbet <[email protected]> wrote:
>> The duplicate inclusion does seem worth fixing, but I wonder if you're
>> deleting the right one? Having the documentation Kconfig under lib
>> seems a bit strange, somehow; Documentation/ is a top-level directory,
>> after all.
>
> I thought about that.
> Looking at the history, the toplevel inclusion was added in
> b1663d7e3a7961 (2019-06-04), and the lib/Kconfig.debug inclusion was
> added in 75442fb0ccaacd (2020-10-30).
> Given the actual entries in Documentation/Kconfig
> (WARN_MISSING_DOCUMENTS and WARN_ABI_ERRORS), putting them under the
> "Kernel hacking" menu makes sense to me.
> We *could* add a new top-level menu to Documentation/Kconfig, but it
> doesn't really seem like an improvement over having them live in
> Kernel hacking.

Since b1663d7e3a7961 puts the Documentation/Kconfig just after
lib/Kconfig.debug, there's not much difference in its location in a
*config menu, but I would rather see it separated (independent) from
lib/Kconfig.debug because I think that it would make any future changes
easier.

Also, b1663d7e3a7961 came first. :)

--
~Randy

2023-01-16 23:39:54

by Peter Foley

[permalink] [raw]
Subject: Re: [PATCH] Documentation: Avoid duplicate Kconfig inclusion

On Sun, Jan 15, 2023 at 4:55 PM Randy Dunlap <[email protected]> wrote:
>
> Since b1663d7e3a7961 puts the Documentation/Kconfig just after
> lib/Kconfig.debug, there's not much difference in its location in a
> *config menu, but I would rather see it separated (independent) from
> lib/Kconfig.debug because I think that it would make any future changes
> easier.
>
> Also, b1663d7e3a7961 came first. :)
>

Fair enough, sent a v2 with the top-level include kept and the Kernel
hacking one removed.