| commit | f6ff96526c7e4857b948eee24e9d50ab80f67956 | [log] [tgz] |
|---|---|---|
| author | Sam Elliott <selliott@lowrisc.org> | Tue Jun 02 18:18:54 2020 +0100 |
| committer | Sam Elliott <sam@lenary.co.uk> | Fri Jul 17 18:59:24 2020 +0100 |
| tree | 3cd86ba028c3cb38815ec8a59878d299c1e2783b | |
| parent | 45fb1c6cce4f7a2a46283c1da99413ac27bda763 [diff] |
[util] Add Licence Checker This commit adds a script which can checks the licence headers in our source code against an expected licence header. The script can check most text file formats that we have checked into the repository, though it has some limitations. It ensures the entire licence appears on consecutive lines in the first comment in the file, and those lines contain nothing else. The primary limitation of the checker is that each file suffix can only match one comment style, which is used for checking for the licence header. In text formats which accept multiple comment styles, there is now a canonical one that the licence must use. Where available, the licence should use a line comment style. The other limitation is for files where the canonical style is block comments, like `/* */`, each line must be wrapped in the comment prefix and suffix, rather than the whole licence header being wrapped in a single comment prefix and suffix. This is an artefact of how the checker searches for the licence. The checker is configured using a hjson file, which contains the exact licence header, and a list of file patterns to exclude from checking the licence for, which is used to exclude vendored and other externally sourced files. Signed-off-by: Sam Elliott <selliott@lowrisc.org>
OpenTitan is an open source silicon Root of Trust (RoT) project. OpenTitan will make the silicon RoT design and implementation more transparent, trustworthy, and secure for enterprises, platform providers, and chip manufacturers. OpenTitan is administered by lowRISC CIC as a collaborative project to produce high quality, open IP for instantiation as a full-featured product. See the OpenTitan site and OpenTitan docs for more information about the project.
This repository contains hardware, software and utilities written as part of the OpenTitan project. It is structured as monolithic repository, or “monorepo”, where all components live in one repository. It exists to enable collaboration across partners participating in the OpenTitan project.
The project contains comprehensive documentation of all IPs and tools. You can access it online at docs.opentitan.org.
Have a look at CONTRIBUTING for guidelines on how to contribute code to this repository.
Unless otherwise noted, everything in this repository is covered by the Apache License, Version 2.0 (see LICENSE for full text).