diff mbox series

docs/manual: document KBUILD_VERBOSE environment variable

Message ID 20210419160346.6393-1-scileont@gmail.com
State Rejected
Headers show
Series docs/manual: document KBUILD_VERBOSE environment variable | expand

Commit Message

Anton Leontiev April 19, 2021, 4:03 p.m. UTC
Signed-off-by: Anton Leontiev <scileont@gmail.com>
---
 docs/manual/common-usage.txt | 3 +++
 1 file changed, 3 insertions(+)

Comments

Yann E. MORIN April 27, 2021, 7:51 p.m. UTC | #1
Anton, All,

Thanks for this contribution.

On 2021-04-19 19:03 +0300, Anton Leontiev spake thusly:
> Signed-off-by: Anton Leontiev <scileont@gmail.com>
> ---
>  docs/manual/common-usage.txt | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/docs/manual/common-usage.txt b/docs/manual/common-usage.txt
> index 9ba87a8339..699a20fe40 100644
> --- a/docs/manual/common-usage.txt
> +++ b/docs/manual/common-usage.txt
> @@ -69,6 +69,9 @@ to +make+ or set in the environment:
>  
>  * +HOSTCXX+, the host C++ compiler to use
>  * +HOSTCC+, the host C compiler to use
> +* +KBUILD_VERBOSE+, KBuild verbosity; it is essentially the same as specifying
> +  +V=1+ in make arguments. If set, exports itself and +VERBOSE=1+ to all
> +  subprocesses.

The naming of the KBUILD_VERBOSE variable is just an implementation
detail. That it has a similar purpose as a variable of the same name in
Kbuild (the linux kernel buildsystem) is just happenstance.

Buildroot is not using Kbuild, nor is it even remotely based on Kbuild.

After discussing among maintainers, we decided that we did not want to
officially expose that variable.

Regards,
Yann E. MORIN.

>  * +UCLIBC_CONFIG_FILE=<path/to/.config>+, path to
>    the uClibc configuration file, used to compile uClibc, if an
>    internal toolchain is being built.
> -- 
> 2.31.1
> 
> _______________________________________________
> buildroot mailing list
> buildroot@busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot
Anton Leontiev April 28, 2021, 4:39 a.m. UTC | #2
Yann E. MORIN <yann.morin.1998@free.fr>:

> The naming of the KBUILD_VERBOSE variable is just an implementation
> detail. That it has a similar purpose as a variable of the same name in
> Kbuild (the linux kernel buildsystem) is just happenstance.
>
> Buildroot is not using Kbuild, nor is it even remotely based on Kbuild.
>
> After discussing among maintainers, we decided that we did not want to
> officially expose that variable.
>

Then maybe it's better to rename this variable into something like
BR2_VERBOSE?
Peter Korsgaard April 28, 2021, 6:07 a.m. UTC | #3
>>>>> "Anton" == Anton Leontiev <scileont@gmail.com> writes:

 > Yann E. MORIN <yann.morin.1998@free.fr>:
 >> The naming of the KBUILD_VERBOSE variable is just an implementation
 >> detail. That it has a similar purpose as a variable of the same name in
 >> Kbuild (the linux kernel buildsystem) is just happenstance.
 >> 
 >> Buildroot is not using Kbuild, nor is it even remotely based on Kbuild.
 >> 
 >> After discussing among maintainers, we decided that we did not want to
 >> officially expose that variable.
 >> 

 > Then maybe it's better to rename this variable into something like
 > BR2_VERBOSE?

Perhaps. What is your use case for wanting to use an environment
variable instead of the normal V=1 make argument?
Anton Leontiev April 28, 2021, 7:10 a.m. UTC | #4
Peter Korsgaard <peter@korsgaard.com>:
>> Then maybe it's better to rename this variable into something like
>> BR2_VERBOSE?
>
> Perhaps. What is your use case for wanting to use an environment
> variable instead of the normal V=1 make argument?

I have a Jenkins job, which builds Buildroot. I want to add a job
parameter to enable verbose output. Jenkins job parameters are
automatically exposed as environment variables. So I've named it
KBUILD_VERBOSE and that's all, I shouldn't change any commands.
diff mbox series

Patch

diff --git a/docs/manual/common-usage.txt b/docs/manual/common-usage.txt
index 9ba87a8339..699a20fe40 100644
--- a/docs/manual/common-usage.txt
+++ b/docs/manual/common-usage.txt
@@ -69,6 +69,9 @@  to +make+ or set in the environment:
 
 * +HOSTCXX+, the host C++ compiler to use
 * +HOSTCC+, the host C compiler to use
+* +KBUILD_VERBOSE+, KBuild verbosity; it is essentially the same as specifying
+  +V=1+ in make arguments. If set, exports itself and +VERBOSE=1+ to all
+  subprocesses.
 * +UCLIBC_CONFIG_FILE=<path/to/.config>+, path to
   the uClibc configuration file, used to compile uClibc, if an
   internal toolchain is being built.