2023-01-20 03:25:42 +08:00
|
|
|
Read this section if there are some SPDX warnings above.
|
2023-01-11 04:02:37 +08:00
|
|
|
Pleasing checkpatch is hard when adding new files because:
|
|
|
|
|
|
2023-01-20 03:25:42 +08:00
|
|
|
- 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 //
|
2023-01-11 04:02:37 +08:00
|
|
|
|
2023-01-20 03:25:42 +08:00
|
|
|
A trick is to keep the SPDX separate, see solution below.
|
2023-01-11 04:02:37 +08:00
|
|
|
|
|
|
|
|
References:
|
|
|
|
|
- https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/license-rules.rst#n71
|
|
|
|
|
- https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=9f3a89926d6d
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Start .h files like this:
|
|
|
|
|
```
|
|
|
|
|
/* SPDX-License-Identifier: ... */
|
|
|
|
|
/*
|
|
|
|
|
* Copyright(c) ...
|
|
|
|
|
*
|
|
|
|
|
* Author: ...
|
|
|
|
|
*/
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Start .c files like this:
|
|
|
|
|
```
|
|
|
|
|
// SPDX-License-Identifier: ...
|
|
|
|
|
/*
|
|
|
|
|
* Copyright(c) ...
|
|
|
|
|
*
|
|
|
|
|
* Author: ...
|
|
|
|
|
*/
|
|
|
|
|
```
|
