Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

committers-guide: Update SPDX links #428

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jlduran
Copy link
Member

@jlduran jlduran commented Oct 14, 2024

No description provided.

@jlduran
Copy link
Member Author

jlduran commented Oct 14, 2024

Tangentially related:
I cannot find the information about the importance of the - symbol preceding the license block.
Is it used to find the license block when auditing licensing information or something similar?

@bsdimp
Copy link
Member

bsdimp commented Oct 14, 2024

Tangentially related: I cannot find the information about the importance of the - symbol preceding the license block. Is it used to find the license block when auditing licensing information or something similar?

Once, long ago, indent(3) would not touch comments starting with /*-. But not too many people used it. Fast forward to the 90s or early 2000s. I wrote a crappy tool to parse out license statements. It was super ugly perl and super slow. So I repurposed that as a marker, convinced the project to adopt it and touched almost every file in the tree. The parser was faster, but I couldn't get it released. I think nobody else ever used it.

So, it's officially part our guides. But it could be dropped in new stuff..

@jlduran
Copy link
Member Author

jlduran commented Oct 14, 2024

Tangentially related: I cannot find the information about the importance of the - symbol preceding the license block. Is it used to find the license block when auditing licensing information or something similar?

Once, long ago, indent(3) would not touch comments starting with /*-. But not too many people used it. Fast forward to the 90s or early 2000s. I wrote a crappy tool to parse out license statements. It was super ugly perl and super slow. So I repurposed that as a marker, convinced the project to adopt it and touched almost every file in the tree. The parser was faster, but I couldn't get it released. I think nobody else ever used it.

So, it's officially part our guides. But it could be dropped in new stuff..

Wonderful info! My main issue with it was adapting it to other languages, more specifically, lua (---?), I've seen it in some shell scripts (and atf-sh scripts) as well (#-). Knowing where it came from and that it can be omitted is good to know, thank you!

@jlduran
Copy link
Member Author

jlduran commented Oct 14, 2024

Found it!

For my future reference:

freebsd/freebsd-src@9ddb49c

Remember to also include man pages.

Copy link
Contributor

@concussious concussious left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants