Bug 171621 - [PATCH] bsd.port.mk; allow Real Names in MAINTAINER lines
Summary: [PATCH] bsd.port.mk; allow Real Names in MAINTAINER lines
Status: In Progress
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Ports Framework (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: Port Management Team
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-09-13 21:30 UTC by Chris Rees
Modified: 2019-09-04 14:13 UTC (History)
1 user (show)

See Also:


Attachments
bsd-port-mk-maintainer-not-just-email.diff (2.92 KB, patch)
2012-09-13 21:30 UTC, Chris Rees
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Rees freebsd_committer 2012-09-13 21:30:01 UTC
	I think it would be very nice to include Real Names in MAINTAINER
lines, just as OpenBSD does.  Stephen@ floated this idea originally, so credit
should go to him.

	There is no technical reason not to do this, and the patch attached will keep the old behaviour for make describe and make maintainer.  The only code that could suffer is code that runs make -VMAINTAINER rather than make maintainer.

	Matthew, p5-FreeBSD-Portindex runs make describe, so no problems there.

	Shaun, portscout will run make -VMAINTAINER if it can't find the maintainer address in INDEX.  I can't see this ever happening... but you can replace -VMAINTAINER with -V_MAINTAINER and it will work just fine.

	Dan, how does freshports get its information?  Will it survive with maintainer entries like that?

	Joe, portlint should stop complaining about this [1].

	How does pointyhat get the MAINTAINER line, and again will it care about the extra data if it doesn't use make maintainer [2]?  I can't find the source code, so I can't check it.

[1] http://www.bayofrum.net/~crees/patches/portlint-relax.diff

[2] http://portsmon.freebsd.org/portoverview.py

	I'm not aware of any issues with this... I'm sure if anything does break, the simplest solution is to replace MAINTAINER with _MAINTAINER in the offending code.

	The autoassigner will still work, because it's still a valid email address.

Fix: I think that the best way to go about this would be to strictly limit the changes initally to a small subset of ports, and iron out problems if they appear.  It's really not a big change.
Comment 1 Edwin Groothuis freebsd_committer 2012-09-13 21:30:53 UTC
Responsible Changed
From-To: freebsd-ports-bugs->portmgr

bsd.port.mk is portmgr territory (via the GNATS Auto Assign Tool)
Comment 2 Dan Langille 2012-09-13 22:41:53 UTC
Initial tests show show FreshPorts is OK with that.

See http://dev.freshports.org/sysutils/bacula-server/ where I faked a =
commit.

FreshPorts gets nearly everything via make -V, and in this case, make -V =
MAINTAINER.

The expected results wind up in the database:

freshports.org=3D# select maintainer from ports where id =3D (select id =
from ports_active where name =3D 'bacula-server');
           maintainer           =20
---------------------------------
 Dan Langille <dan@example.org>
(1 row)

freshports.org=3D#=20

Any problems that arise won't be database related (it clearly captures =
the right stuff).  Therefore, +1 from me.

We might have to amend searches, or perhaps alter the opt-in sequence =
for committers, but I can look into that later.  For now,
such a change would not break incoming commits.  They will still be =
processed, and logged into the database.

--=20
Dan Langille - http://langille.org
Comment 3 Bryan Drewery freebsd_committer 2013-09-08 16:41:05 UTC
Responsible Changed
From-To: portmgr->bdrewery

I'll take it.
Comment 4 Matthew Seaman freebsd_committer 2013-09-08 17:27:07 UTC
Actually p5-FreeBSD-Portindex does not run 'make describe' -- it
effectively runs 'make -V MAINTAINER' to extract the maintainer email
address.

Will need a small patch to the Portindex code to allow it to reproduce
the correct INDEX format, but don't let that prevent this  change being
applied.

	Matthew

-- 
Dr Matthew J Seaman MA, D.Phil.
PGP: http://www.infracaninophile.co.uk/pgpkey

Comment 5 Carlo Strub freebsd_committer 2014-09-14 10:44:58 UTC
Is this PR still relevant?
Comment 6 Chris Rees freebsd_committer 2014-09-14 10:49:34 UTC
Yes, still relevant :)
Comment 7 Baptiste Daroussin freebsd_committer 2019-09-04 14:13:17 UTC
Given how many scripts there are in the wild, we should keep make -VMAINTAINER presenting the mail only part. (which does not prevent from using MAINTAINER= <fullname> <mail> in the Makefile itself.
and probably propose a MAINTAINER_FULL variable or something like that will the full name.

That said if we do start going in that direction we should also defined a preferred encoding as name comes with encoding troubles in many countries