On 02/27/2018 01:38 PM, Josh Poimboeuf wrote:
> On Tue, Feb 27, 2018 at 09:52:31PM +0100, Robin Jarry wrote:
>> 2018-02-27, Josh Poimboeuf:
>>> In Documentation/kbuild/kbuild.txt, we have the following environment
>>> variables:
>>>
>>> KCFLAGS
>>> --------------------------------------------------
>>> Additional options to the C compiler (for built-in and modules).
>>>
>>> CFLAGS_KERNEL
>>> --------------------------------------------------
>>> Additional options for $(CC) when used to compile
>>> code that is compiled as built-in.
>>>
>>> CFLAGS_MODULE
>>> --------------------------------------------------
>>> Additional module specific options to use for $(CC).
>>>
>>> LDFLAGS_MODULE
>>> --------------------------------------------------
>>> Additional options used for $(LD) when linking modules.
>>>
>>> LDFLAGS_vmlinux
>>> --------------------------------------------------
>>> Additional options passed to final link of vmlinux.
>>>
>>> So instead of
>>>
>>> HOST_CFLAGS
>>> HOST_LDFLAGS
>>>
>>> maybe it would be more consistent to call them
>>>
>>> CFLAGS_HOST
>>> LDFLAGS_HOST
>>>
>>> ?
>>
>> I had missed this file. Indeed {C,LD}FLAGS_HOST are much less confusing!
>>
>>> Also, the new environment variables should be documented in the above
>>> file.
>>
>> Sure, I'll do that. However, I feel like I should also leave the
>> paragraph in Documentation/admin-guide/README.txt.
>>
>> What do you think?
>
> [ Adding Jon Corbet to CC in case he has an opinion. ]
>
> I think that paragraph in the admin guide seems a bit out of place,
> because that file only seems to cover the most common cases.
>
> No other env variables are described in that file (and some of the
> previously existing env variables are much more likely to be used than
> these new ones anyway).
>
> It might be a good idea to instead just add a reference to kbuild.txt,
> suggesting the user refer to that file if they want to learn more about
> what env variables can be used to customize the build.
(IMHO :) I agree, the addition to admin-guide/README.rst (not .txt) is in
the wrong place, although it could contain a pointer to kbuild/ like Josh says.
And if you do move that text to kbuild/, please change "non standard" to
"non-standard" in 2 places.
thanks,
--
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-kbuild" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
