Skip to content

Clean up src/ file headers - #1954

Open
davidharrishmc wants to merge 9 commits into
openhwfoundation:mainfrom
davidharrishmc:dh/sv-headers
Open

davidharrishmc wants to merge 9 commits into
openhwfoundation:mainfrom
davidharrishmc:dh/sv-headers

Conversation

@davidharrishmc

@davidharrishmc davidharrishmc commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Builds on #1950 (license trim); merge that first so this PR shows only its own changes.

For every .sv file in src/:

  • Correct the filename line (about 20 were wrong or missing).
  • Written: original author(s), checked against git history (following renames and copies by hand where git --follow was misled by identical license text). Every author is listed by name. An email address appears only where that file's header already had it; none are added from commit metadata or copied from other files. Existing authors are kept where history predates the January 2021 import.
  • Modified: people who made functional changes to that file; whitespace, comment, lint, rename, and tree-wide mechanical commits don't count.
  • Purpose: one clear sentence, with important caveats (unsupported features, spec references) kept on the following lines.
  • Copyright: <creation year>-26 Harvey Mudd College & Oklahoma State University.
  • The six MIT-licensed files (binencoder, decoder, priorityonehot, prioritythermometer, hptw, privileged) keep their MIT notice unchanged.

Header comments only; no code changes. #1950's trim also touches the four modules #1952 deletes, so whichever of #1952 and this PR merges second resolves four trivial modify/delete conflicts.

🤖 Generated with Claude Code

davidharrishmc and others added 4 commits October 10, 2026 05:54
The LICENSE file holds the full Solderpad/Apache text. File headers now
keep only the copyright line and the SPDX-License-Identifier line.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Fix filename lines, give every author a name, check Written against git
history, list contributors of functional changes under Modified, rewrite
Purpose as one sentence, and set copyright to <creation year>-27. Replace
the remaining MIT license text, all on HMC/OSU-copyrighted files, with the
SPDX identifier.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@davidharrishmc

Copy link
Copy Markdown
Contributor Author

Review notes: no code changes (token streams match main in every file), but two licensing questions need sign-off before merging:

🤖 Generated with Claude Code

davidharrishmc and others added 2 commits October 16, 2026 03:32
Twenty coverage tests added on main after this branch was made still carried the
Solderpad/Apache notice paragraph; trim them to the copyright and SPDX lines like
the rest.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@davidharrishmc

Copy link
Copy Markdown
Contributor Author

Merge order: contains #1950. Merge #1950 first, or close it in favour of this PR. It has trivial conflicts with the #1952 stack: 4 modify/delete conflicts, plus one in spi_fifo.sv.

🤖 Generated with Claude Code

davidharrishmc and others added 2 commits October 16, 2026 04:18
… license

Remove the 323 email addresses the header cleanup took from commit metadata or
copied from other files; keep an address only where that file's header already
had it, and give just the name otherwise.  Restore the MIT license notice, as on
main, in binencoder, decoder, priorityonehot, prioritythermometer, hptw and
privileged, without adding an SPDX line.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@davidharrishmc

Copy link
Copy Markdown
Contributor Author

Updated per review:

  • Email addresses: an address stays only where that file's header on main already had it; everywhere else the author is listed by name. This removes 323 addresses from 149 headers, including those taken from commit metadata (institutional and personal) and those copied from other files into files that never had them.
  • Licensing: the six MIT files (binencoder, decoder, priorityonehot, prioritythermometer, hptw, privileged) keep main's MIT notice unchanged, with no SPDX line added. The description had said five files.
  • Merged the updated Trim license boilerplate to the SPDX identifier #1950, which includes current main. The PR is still comment-only: with comments and whitespace stripped, every file matches main.
  • Still open: the -27 end year in the copyright lines is unchanged pending a decision.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@davidharrishmc

Copy link
Copy Markdown
Contributor Author

Copyright end years changed from -27 to -26 in all 222 headers the PR touches (2026 alone in pwm_apb.sv, whose start year is 2026); still comment-only.

🤖 Generated with Claude Code

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.

1 participant