[PATCH v1] documentation.conf: fix do_menuconfig description

[PATCH v1] documentation.conf: fix do_menuconfig description

[Joao Marcos Costa]

The current description is only pertinent to the kernel, even though
do_menuconfig task is used by other projects, such as Busybox and
U-Boot.

Replace "for the kernel" by an agnostic alternative (i.e., "in the
compilation directory").

Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
---
 meta/conf/documentation.conf | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf
index ab2addb321..05e4b8bc7f 100644
--- a/meta/conf/documentation.conf
+++ b/meta/conf/documentation.conf
@@ -28,7 +28,7 @@ do_kernel_configcheck[doc] = "Validates the kernel configuration for a linux-yoc
 do_kernel_configme[doc] = "Assembles the kernel configuration for a linux-yocto style kernel"
 do_kernel_link_images[doc] = "Creates a symbolic link in arch/$arch/boot for vmlinux and vmlinuz kernel images"
 do_listtasks[doc] = "Lists all defined tasks for a target"
-do_menuconfig[doc] = "Runs 'make menuconfig' for the kernel"
+do_menuconfig[doc] = "Runs 'make menuconfig' in the compilation directory"
 do_package[doc] = "Analyzes the content of the holding area and splits it into subsets based on available packages and files"
 do_package_index[doc] = "Creates or updates the index in the Package Feed area"
 do_package_qa[doc] = "Runs QA checks on packaged files"
-- 
2.43.0

Re: [OE-core] [PATCH v1] documentation.conf: fix do_menuconfig description

[Alexandre Belloni]

Please follow https://docs.yoctoproject.org/dev/contributor-guide/submit-changes.html#fixing-your-from-identity

On 30/11/2023 16:09:43+0100, Joao Marcos Costa via lists.openembedded.org wrote:
> The current description is only pertinent to the kernel, even though
> do_menuconfig task is used by other projects, such as Busybox and
> U-Boot.
> 
> Replace "for the kernel" by an agnostic alternative (i.e., "in the
> compilation directory").
> 
> Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
> ---
>  meta/conf/documentation.conf | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf
> index ab2addb321..05e4b8bc7f 100644
> --- a/meta/conf/documentation.conf
> +++ b/meta/conf/documentation.conf
> @@ -28,7 +28,7 @@ do_kernel_configcheck[doc] = "Validates the kernel configuration for a linux-yoc
>  do_kernel_configme[doc] = "Assembles the kernel configuration for a linux-yocto style kernel"
>  do_kernel_link_images[doc] = "Creates a symbolic link in arch/$arch/boot for vmlinux and vmlinuz kernel images"
>  do_listtasks[doc] = "Lists all defined tasks for a target"
> -do_menuconfig[doc] = "Runs 'make menuconfig' for the kernel"
> +do_menuconfig[doc] = "Runs 'make menuconfig' in the compilation directory"
>  do_package[doc] = "Analyzes the content of the holding area and splits it into subsets based on available packages and files"
>  do_package_index[doc] = "Creates or updates the index in the Package Feed area"
>  do_package_qa[doc] = "Runs QA checks on packaged files"
> -- 
> 2.43.0
> 

> 
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#191509): https://lists.openembedded.org/g/openembedded-core/message/191509
> Mute This Topic: https://lists.openembedded.org/mt/102895214/3617179
> Group Owner: openembedded-core+owner@lists.openembedded.org
> Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [alexandre.belloni@bootlin.com]
> -=-=-=-=-=-=-=-=-=-=-=-
> 


-- 
Alexandre Belloni, co-owner and COO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com