Skip to content

[SKIP CI] .github/SPDX-README.md: clarify .c/.h difference and applicability #6973

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.

Sign up for GitHub

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

Merged
lgirdwood merged 1 commit into from
Jan 27, 2023
Merged

[SKIP CI] .github/SPDX-README.md: clarify .c/.h difference and applicability #6973

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .github/workflows/SPDX-README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
Read this section if there are some SPDX warnings above.
Pleasing checkpatch is hard when adding new files because:

- checkpatch wants a different SPDX style for .c versus .h files!
- SOF rejects C99 comments starting with //
- checkpatch requests a different SPDX style for .c versus .h files.
This is because some .h files are included in linker scripts or
assembly code.
- Some SOF reviewers reject C99 comments starting with //

The trick is to keep the SPDX separate. See solution below.
A trick is to keep the SPDX separate, see solution below.

References:
- https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/license-rules.rst#n71
Expand Down