Re: [PATCH v2] kbuild: deb-pkg improve maintainer address generation
On 7 May 2018 at 16:35, Masahiro Yamada <yamada.masahiro@socionext.com> wrote:
> Hi Riku,
>
> 2018-05-07 16:11 GMT+09:00 <riku.voipio@linaro.org>:
>> From: Riku Voipio <riku.voipio@linaro.org>
>>
>> There is multiple issues with the genaration of maintainer string
>>
>> It uses DEBEMAIL and EMAIL enviroment variables, which may contain angle brackets,
>> creating invalid maintainer strings. The documented KBUILD_BUILD_USER and
>> KBUILD_BUILD_HOST variables are not used. Undocumented and uncommon NAME
>> variable is used.
>
> Sorry, I missed to ask you about 'NAME' variable.
>
>
> I checked the Debian Administrator's Handbook.
>
> I see the following description
>
>
> TIP
> Maintainer’s name and email address
>
> Most of the programs involved in package maintenance will look for
> your name and
> email address in the DEBFULLNAME and DEBEMAIL or EMAIL environment variables.
> Defining them once and for all will avoid you having to type them
> multiple times.
> If your usual shell is bash , it is a simple matter of adding the
> following two lines
> in your ~/.bashrc file (you will obviously replace the values with
> more relevant
> ones!):
>
> export EMAIL=”hertzog@debian.org”
> export DEBFULLNAME=”Raphael Hertzog”
>
>
> Indeed, 'NAME' is not mentioned at all here.
>
>
> On the other hand, I also checked the following link
> referred by Mathieu:
> https://manpages.debian.org/unstable/devscripts/dch.1.en.html
>
> If the environment variable DEBFULLNAME is set, this will be used for the
> maintainer full name; if not, then NAME will be checked. If the environment
> variable DEBEMAIL is set, this will be used for the email address. If this
> variable has the form "name <email>", then the maintainer name will also be
> taken from here if neither DEBFULLNAME nor NAME is set.
>
>
> Hmm, debchange checks 'NAME' too.
dch is symlink to debchange. I found one common tool that falls back
from DEBFULLNAME to NAME, reportbug. But almost all other users of
DEBFULLNAME don't:
https://codesearch.debian.net/search?q=DEBFULLNAME&perpkg=1
Supporting DEBFULLNAME and DEBEMAIL makes sense, since they are
explicitly documented Debian variables. EMAIL is commonly used
elsewhere (such as with git). NAME otoh is is not used outside Debian.
And you will have a poor experience in Debian if you have only NAME
set - reportbug will use it, but bts wont.
The main reason to keep NAME, would be historic reasons ("has been
supported in deb-pkg before"). Given that setting a) either
DEBFULLNAME or KBUILD_BUILD_USER is trivial, and b) it's a cosmetic
issue to begin with, I'm not sure it's worth it.
Riku
Reply to: