| Salome Thirot | 9a50023 | 2021-05-13 17:02:27 +0100 | [diff] [blame] | 1 | ####################### |
| 2 | Copyright header checks |
| 3 | ####################### |
| 4 | |
| 5 | This script checks that all text files staged for commit (new and |
| 6 | modified) have the correct license header. It returns the list of files |
| 7 | whose header is missing or not updated. To use it, make sure you have jinja2 |
| 8 | installed (if you are on linux you can run the setup.sh script to install it), |
| 9 | then run the python script from the tfm repository with the name of the |
| 10 | organization, for example: ``python3 run_header_check.py Arm`` To get the list |
| 11 | of known organizations, run ``python3 run_header_check.py --help``. |
| 12 | |
| 13 | The list is stored in a python file called "orgs\_list.py", stored in the |
| 14 | same directory as the script. To add a new organization, add a generic |
| 15 | name and the official denomination used in the copyright header to this |
| 16 | file. |
| 17 | |
| 18 | The copyright header must have the following structure: |
| 19 | Copyright (c) <year>, <organisation>. (optional)All rights reserved. |
| 20 | |
| 21 | -------------- |
| 22 | |
| 23 | *Copyright (c) 2021, Arm Limited. All rights reserved.* |
| 24 | *SPDX-License-Identifier: BSD-3-Clause* |