Bug 228715 - Add a note to the Porter's Handbook that "Created by: ..." should not be present in Makefiles of new ports
Summary: Add a note to the Porter's Handbook that "Created by: ..." should not be pres...
Status: Closed Not A Bug
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: freebsd-doc (Nobody)
URL:
Keywords: easy, needs-qa
Depends on:
Blocks:
 
Reported: 2018-06-03 01:54 UTC by Mateusz Piotrowski
Modified: 2018-07-02 21:15 UTC (History)
5 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Mateusz Piotrowski freebsd_committer freebsd_triage 2018-06-03 01:54:37 UTC
I believe that the current policy is not to include the "Created by: ..." line at the top of new Makefiles in the ports tree. I cannot find it in the handbook, however.
Comment 1 Eitan Adler freebsd_committer freebsd_triage 2018-06-03 06:56:17 UTC
Do we need to include text for what not to include? Are people still writing it?
Comment 2 Eitan Adler freebsd_committer freebsd_triage 2018-06-03 07:00:16 UTC
Interestingly, 21789/33297 (65%) of Makefiles still have such a line. Perhaps its time to just remove them entirely.
Comment 3 Mateusz Piotrowski freebsd_committer freebsd_triage 2018-06-03 11:07:32 UTC
(In reply to Eitan Adler from comment #2)

We should probably also teach portlint to bark on such lines.
Comment 4 Mark Linimon freebsd_committer freebsd_triage 2018-06-03 11:10:43 UTC
(In reply to Eitan Adler from comment #2)

I think the policy is "remove them if you happen to be committing to the Makefile otherwise"?
Comment 5 Martin Wilke freebsd_committer freebsd_triage 2018-06-03 12:36:44 UTC
(In reply to Mark Linimon from comment #4)

Yes that was the the current way.
Comment 6 Adam Weinberger freebsd_committer freebsd_triage 2018-06-03 14:16:41 UTC
I'm fine with a note saying that "Created by:" is optional, or even discouraged, but I remain firmly opposed to banning it.
Comment 7 Adam Weinberger freebsd_committer freebsd_triage 2018-06-03 14:17:46 UTC
(In reply to Mark Linimon from comment #4)

The current policy, as I understand it, is that they should never be removed without permission from the listed name.
Comment 8 Mathieu Arnold freebsd_committer freebsd_triage 2018-06-04 13:42:02 UTC
Nobody said it was banned, nobody said it was forbidden.
As it serves no functional purpose, it is simply not required, so it is not documented.