Skip to content

docs: add per-file SPDX licensing metadata - #17

Open
anderslindho wants to merge 2 commits into
docs/correct-license-attributionfrom
docs/add-spdx-headers
Open

anderslindho wants to merge 2 commits into
docs/correct-license-attributionfrom
docs/add-spdx-headers

Conversation

@anderslindho

Copy link
Copy Markdown
Contributor

Follow-up to the review discussion on #14.

This adds SPDX copyright and licence identifiers to the project's EPICS source artifacts: C/C++ sources, Make and configure files, database definitions, and the IOC startup script.

Files derived from makeBaseApp retain their upstream Argonne attribution and year. Project-specific work uses the reccaster holder wording from #14.

A scoped reuse-lint-file hook checks the same files through the existing pre-commit workflow. This deliberately does not claim full REUSE compliance or require metadata on documentation, workflows, .gitignore, or other repository-administration files.

REUSE requires the EPICS licence text under LICENSES/EPICS.txt. The top-level LICENSE remains because that is the layout expected for EPICS distributions; the two files are identical.

This PR is stacked on #14 because its project attribution depends on the holder wording being settled there.

@anderslindho

Copy link
Copy Markdown
Contributor Author

FYI @anjohnson

@anjohnson

Copy link
Copy Markdown

I don't think you need to keep the LICENSE file in the top directory as well as in LICENSES/EPICS.txt, anyone manually looking for the license should be able to find it there. Just make sure that none of the old text explaining where to find it survives (but this code might never have had that anyway).

This looks fine to me either way.

@anderslindho

Copy link
Copy Markdown
Contributor Author

REUSE does allow that, but the current EPICS licensing guidance explicitly says to put the licence text in the top-level directory, so I want to honour that here.

Preserve Argonne's attribution on the makeBaseApp-derived files while
identifying project sources as licensed under EPICS. Project
SPDX-FileCopyrightText lines use the collective holder from COPYRIGHT.
LICENSES/EPICS.txt matches the top-level LICENSE (holders live in
COPYRIGHT).
Use REUSE's scoped file validator to ensure EPICS source, build, database,
and startup files retain copyright and license identifiers without imposing
metadata requirements on unrelated repository files.
@sonarqubecloud

Copy link
Copy Markdown

@anderslindho

Copy link
Copy Markdown
Contributor Author

@jacomago re-requesting your review after the rebase on updated #14.

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