[v1] kconfig: remove references to docs/misc/kconfig{,-language}.txt files

[PATCH] kconfig: remove references to docs/misc/kconfig{,-language}.txt files

Posted by Dmytro Prokopchuk1 3 months, 1 week ago

These files 'docs/misc/kconfig{,-language}.txt' were deleted, but
references are still present in Xen. Remove them to clean-up.

Fixes: f80fe2b34f08 ("xen: Update Kconfig to Linux v5.4")
Signed-off-by: Dmytro Prokopchuk <dmytro_prokopchuk1@epam.com>
---
 INSTALL     | 2 +-
 MAINTAINERS | 1 -
 xen/Kconfig | 2 +-
 3 files changed, 2 insertions(+), 3 deletions(-)

diff --git a/INSTALL b/INSTALL
index eadf108aa5..fbf7bcbcf1 100644
--- a/INSTALL
+++ b/INSTALL
@@ -23,7 +23,7 @@ Xen Hypervisor
 ==============
 
 Xen itself is configured via a `kconfig' system borrowed from Linux.
-See docs/misc/kconfig.txt.
+See https://www.kernel.org/doc/html/latest/kbuild/.
 
 Note that unlike with Linux, and contrary to that document, you cannot
 look at Kconfig files, or the default or generated config files etc.,
diff --git a/MAINTAINERS b/MAINTAINERS
index ecd3f40df8..190da0cddb 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -389,7 +389,6 @@ F:	xen/include/xen/iommu.h
 KCONFIG
 M:	Doug Goldstein <cardoe@cardoe.com>
 S:	Supported
-F:	docs/misc/kconfig{,-language}.txt
 F:	xen/tools/kconfig/
 
 KDD DEBUGGER
diff --git a/xen/Kconfig b/xen/Kconfig
index 07c4accf88..444b022699 100644
--- a/xen/Kconfig
+++ b/xen/Kconfig
@@ -1,6 +1,6 @@
 #
 # For a description of the syntax of this configuration file,
-# see docs/misc/kconfig-language.txt
+# see https://www.kernel.org/doc/html/latest/kbuild/
 #
 mainmenu "Xen/$(SRCARCH) $(XEN_FULLVERSION) Configuration"
 
-- 
2.43.0

Re: [PATCH] kconfig: remove references to docs/misc/kconfig{,-language}.txt files

Posted by Jan Beulich 3 months, 1 week ago

On 29.10.2025 14:38, Dmytro Prokopchuk1 wrote:
> These files 'docs/misc/kconfig{,-language}.txt' were deleted, but
> references are still present in Xen. Remove them to clean-up.
> 
> Fixes: f80fe2b34f08 ("xen: Update Kconfig to Linux v5.4")

Hmm, that commit replaced the .txt files with .rst ones, so maybe you want a
2nd tag here referencing 044503f61c95 ("docs: Delete kconfig docs to fix
licensing violation")?

> --- a/INSTALL
> +++ b/INSTALL
> @@ -23,7 +23,7 @@ Xen Hypervisor
>  ==============
>  
>  Xen itself is configured via a `kconfig' system borrowed from Linux.
> -See docs/misc/kconfig.txt.
> +See https://www.kernel.org/doc/html/latest/kbuild/.

Is linking to "latest" doc really appropriate, when we don't even try to stay
up-to-date? That's what Andrew's commit suggests, but I dare to question this.

> --- a/xen/Kconfig
> +++ b/xen/Kconfig
> @@ -1,6 +1,6 @@
>  #
>  # For a description of the syntax of this configuration file,
> -# see docs/misc/kconfig-language.txt
> +# see https://www.kernel.org/doc/html/latest/kbuild/

Maybe more specifically https://www.kernel.org/doc/html/latest/kbuild/kconfig-language.html
at least here (with latest possibly replaced as per above)?

Jan

Re: [PATCH] kconfig: remove references to docs/misc/kconfig{,-language}.txt files

Posted by Dmytro Prokopchuk1 3 months, 1 week ago


On 10/29/25 15:57, Jan Beulich wrote:
> On 29.10.2025 14:38, Dmytro Prokopchuk1 wrote:
>> These files 'docs/misc/kconfig{,-language}.txt' were deleted, but
>> references are still present in Xen. Remove them to clean-up.
>>
>> Fixes: f80fe2b34f08 ("xen: Update Kconfig to Linux v5.4")
>
> Hmm, that commit replaced the .txt files with .rst ones, so maybe you want a
> 2nd tag here referencing 044503f61c95 ("docs: Delete kconfig docs to fix
> licensing violation")?
Well, I saw that commit, but intentionally selected first one.
Looks like commit 044503f61c95 is more appropriate.

>
>> --- a/INSTALL
>> +++ b/INSTALL
>> @@ -23,7 +23,7 @@ Xen Hypervisor
>>   ==============
>>
>>   Xen itself is configured via a `kconfig' system borrowed from Linux.
>> -See docs/misc/kconfig.txt.
>> +See https://www.kernel.org/doc/html/latest/kbuild/.
>
> Is linking to "latest" doc really appropriate, when we don't even try to stay
> up-to-date? That's what Andrew's commit suggests, but I dare to question this.
If the kconfig directory was imported from the Linux kernel v5.4, I
think the following link is OK:
https://www.kernel.org/doc/html/v5.4/kbuild/

>
>> --- a/xen/Kconfig
>> +++ b/xen/Kconfig
>> @@ -1,6 +1,6 @@
>>   #
>>   # For a description of the syntax of this configuration file,
>> -# see docs/misc/kconfig-language.txt
>> +# see https://www.kernel.org/doc/html/latest/kbuild/
>
> Maybe more specifically https://www.kernel.org/doc/html/latest/kbuild/kconfig-language.html
> at least here (with latest possibly replaced as per above)?
>
> Jan

and here:
https://www.kernel.org/doc/html/v5.4/kbuild/kconfig-language.html

Dmytro.

Re: [PATCH] kconfig: remove references to docs/misc/kconfig{,-language}.txt files

Posted by Jan Beulich 3 months, 1 week ago

On 31.10.2025 13:04, Dmytro Prokopchuk1 wrote:
> On 10/29/25 15:57, Jan Beulich wrote:
>> On 29.10.2025 14:38, Dmytro Prokopchuk1 wrote:
>>> These files 'docs/misc/kconfig{,-language}.txt' were deleted, but
>>> references are still present in Xen. Remove them to clean-up.
>>>
>>> Fixes: f80fe2b34f08 ("xen: Update Kconfig to Linux v5.4")
>>
>> Hmm, that commit replaced the .txt files with .rst ones, so maybe you want a
>> 2nd tag here referencing 044503f61c95 ("docs: Delete kconfig docs to fix
>> licensing violation")?
> Well, I saw that commit, but intentionally selected first one.
> Looks like commit 044503f61c95 is more appropriate.

I'd suggest to keep the other one as well.

Jan