Page MenuHomeFreeBSD

Porter's Handbook: explain ports signature policy for older ports
ClosedPublic

Authored by crees on Feb 9 2020, 2:57 PM.
Tags
None
Referenced Files
Unknown Object (File)
Mon, Mar 25, 7:06 AM
Unknown Object (File)
Dec 21 2023, 11:38 PM
Unknown Object (File)
Dec 21 2023, 10:56 PM
Unknown Object (File)
Dec 20 2023, 4:13 AM
Unknown Object (File)
Nov 9 2023, 9:10 AM
Unknown Object (File)
Nov 7 2023, 2:10 AM
Unknown Object (File)
Nov 5 2023, 11:56 PM
Unknown Object (File)
Oct 8 2023, 8:04 AM
Subscribers

Details

Reviewers
crees
Summary

Explain ports signature policy for older ports

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 37536
Build 34425: arc lint + arc unit

Event Timeline

While I agree with the sentiment, is this definitely policy?

The "Created by" lines are the new way of doing things, all the Makefiles were converted a really long while back.

This paragraph should be axed instead of adding something unrelated to it.

Also, those lines are are not documented on purpose, you don't have to touch them.

I proposed this patch because I feel there is some confusion on the topic. This feeling comes from my own experience when I was a new contributor.

In particular, when I started working on ports about 18 months ago, I tried to sign new ports with "Created by:" lines: once it was rejected, once it was accepted. Thus, I thought that those lines were cases of "additional information [that] has been declared obsolete, and is being phased out" and that the time it was accepted it was by mistake. Later, when submitting patches to ports, since I thought that "Created by:" lines were obsolete I removed them: once the removal was accepted, once it was rejected. I then changed my interpretation thinking that old "Created by:" lines should be kept, but no new such lines should be created (and I tried to correct the removal of the line that was accepted, but without success: the maintainer of the port was against restoring it).

For these reasons, I feel there is some confusion on the topic and that it should be solved. Moreover, we risk to frustrate new contributors if we refuse new ports signatures without a consistent rule.
Can we do something about it? Maybe "axing" the paragraph as suggested is the solution? Should I submit a patch to remove it then? (I am not a native English speaker: I think that by "axed" you mean "removed": please correct me if I am wrong).

Thanks.

Mat does indeed mean that the paragraph should be removed, and I'm inclined to agree- we don't have any

# Ports collection Makefile for xxxx

in our tree any more, which is why the paragraph existed in the first place. Without this, I guess there isn't really an issue around it.

I think it might be better to have it in the more detailed part, which submitters should be reading anyway-- patch incoming.

@crees Feel free to commandeer the review if you need it to submit the right patch in the most natural way: I would not take offense :)

I really, really, do not like the "Created by" mention to come back in the example Makefile. Otherwise, people will keep adding more.

linimon retitled this revision from Explain ports signature policy for older ports to Porter's Handbook: explain ports signature policy for older ports.Mar 8 2020, 2:23 AM
linimon added a subscriber: linimon.
crees added a reviewer: salvadore.

Just get rid of this paragraph entirely, and the header in the sample

crees removed a reviewer: salvadore.
crees removed a reviewer: docs.
This revision is now accepted and ready to land.Mar 4 2021, 12:28 PM