Skip to content

SPDX license identifiers to atf-c - #128

Merged
ngie-eign merged 2 commits into
freebsd:masterfrom
illuusio:spdx-license-identifier-atf-c
Nov 6, 2026
Merged

ngie-eign merged 2 commits into
freebsd:masterfrom
illuusio:spdx-license-identifier-atf-c

Conversation

@illuusio

@illuusio illuusio commented May 21, 2026 •

Copy link
Copy Markdown
Contributor

Add BSD-2-Clause identifiers to atf-c to C-source and header files. This does not comply FreeBSD style(9) guidance.

@illuusio illuusio changed the title Spdx license identifier atf c Spdx license identifiers atf-c May 21, 2026
@illuusio illuusio changed the title Spdx license identifiers atf-c SPDX license identifiers atf-c May 21, 2026
@illuusio illuusio changed the title SPDX license identifiers atf-c SPDX license identifiers to atf-c May 21, 2026

@ngie-eign ngie-eign left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This change actually breaks the BSD-2-Clause text.

Please put the SPDX ID on its own line outside the body of the licensing text, e.g.,

/* Copyright (c)...
 * All rights reserved.
 * ...
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.   */
/** SPDX-License-Identifier: BSD-2-Clause **/

I could make a similar change, but if you're interested in doing this (for licensing mining reasons), I'm more than happy to have you lead this effort.

@emaste

emaste commented Aug 17, 2026

Copy link
Copy Markdown
Member

This change actually breaks the BSD-2-Clause text.

How so? SPDX tags merely need to be in a comment near the top of the file.

@illuusio

Copy link
Copy Markdown
Contributor Author

Yes I can make needed changes but I have bit similar view than @emaste that SDPX-License-indentifier should be as top as possible.

@ngie-eign

ngie-eign commented Sep 6, 2026 •

Copy link
Copy Markdown
Contributor

The original issue was also more the fact that the licensing text itself had been broken up from the required BSD license boilerplate.
For example:

/**
 * Copyright (c)...
 * SPDX-License-Identifier: BSD-2-Clause
 * All rights reserved.
 *
 * ...
 */

Doing what's shown above can confuse naïve license parsers (which don't expect that text there), can confuse humans (one line in a large block of text is harder to notice; people could copy-paste the bad template), and reduces the overall benefit of the SPDX license ID lines.
My recommendation to move the SPDX license ID outside the license block was to highlight its presence. Whether it's at the top or lower down in the file is less relevant than the other points I highlighted above.

@illuusio

Copy link
Copy Markdown
Contributor Author

Doing what's shown above can confuse naïve license parsers (which don't expect that text there), can confuse humans (one line in a large block of text is harder to notice; people could copy-paste the bad template), and reduces the overall benefit of the SPDX license ID lines.
My recommendation to move the SPDX license ID outside the license block was to highlight its presence. Whether it's at the top or lower down in the file is less relevant than the other points I highlighted above.

I'm ok with this reasoning as said current BSD SDPX documentation is simply hazard to parsers. What do you thing @emaste?

@emaste

emaste commented Sep 21, 2026

Copy link
Copy Markdown
Member

/* SPDX... */ is fine with me

@ngie-eign

Copy link
Copy Markdown
Contributor

same as long as the existing copyright tort is left in place.

Add BSD-2-Clause identifiers to atf-c to C-source and header files

Sponsored by:  The FreeBSD Foundation
Signed-off-by: Tuukka Pasanen <tuukka.pasanen@ilmi.fi>
@ngie-eign
ngie-eign force-pushed the spdx-license-identifier-atf-c branch from 280ca58 to 872274d Compare November 5, 2026 17:43
@ngie-eign
ngie-eign self-requested a review November 5, 2026 17:44
@ngie-eign

Copy link
Copy Markdown
Contributor

@illuusio : I put the SPDX comments below the copyright tort to diff reduce with :master. Please let me know if you are ok with squashing/merging the changes.

@illuusio

illuusio commented Nov 6, 2026

Copy link
Copy Markdown
Contributor Author

Sorry being bit lazy with this and many thanks that you made update. It been on my list ages. LGTM and squash is ok to me.

@ngie-eign
ngie-eign merged commit c4c523e into freebsd:master Nov 6, 2026
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