Re: [PATCH] kbuild: improve comments on KBUILD_SRC

[Cao jin]

On 06/29/2017 11:14 PM, Masahiro Yamada wrote:
> 2017-06-23 16:31 GMT+09:00 Cao jin <caoj.fnst@xxxxxxxxxxxxxx>:
>> Original comments is confusing on "OBJ directory", make it clear.
>>
>> Bonus: move comments close to what it want to comment.
>> Signed-off-by: Cao jin <caoj.fnst@xxxxxxxxxxxxxx>
>> ---
>>  Makefile | 7 ++++---
>>  1 file changed, 4 insertions(+), 3 deletions(-)
>>
>> diff --git a/Makefile b/Makefile
>> index 57df756..81c0df9 100644
>> --- a/Makefile
>> +++ b/Makefile
>> @@ -113,8 +113,9 @@ export quiet Q KBUILD_VERBOSE
>>  # The O= assignment takes precedence over the KBUILD_OUTPUT environment
>>  # variable.
>>
>> -# KBUILD_SRC is set on invocation of make in OBJ directory
>> -# KBUILD_SRC is not intended to be used by the regular user (for now)
>> +# KBUILD_SRC is not intended to be used by the regular user (for now),
>> +# it is set on invocation of make in KBUILD_OUTPUT directory, i.e., it
>> +# is set on using "make O=dir/to/store/output/files/"
> 
> O= is not only the way to specify the output directory.
> 
> KBUILD_OUTPUT is used not only for an internal variable
> but also for user interface to specify the output directory
> (via environments).
> 
> 
> How about something like this?
> 
> # KBUILD_SRC is not intended to be used by the regular user (for now),
> # it is set on invocation of make with KBUILD_OUTPUT or O= specified.
> 

Accurate and much better. Thanks a lot. v2 is on the way.

-- 
Sincerely,
Cao jin