[util] Vendor licence-checker
Signed-off-by: Sam Elliott <selliott@lowrisc.org>
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index bbc98ef..dc5d012 100644
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -190,7 +190,7 @@
changed_files="$(git diff --name-only --diff-filter=ACMRTUXB "$fork_origin")"
if [[ -n "$changed_files" ]]; then
set -o pipefail
- xargs util/licence-checker.py --config util/licence-checker.hjson <<< "$changed_files" | tee licence-checker-output
+ xargs util/lowrisc_misc-linters/licence-checker/licence-checker.py --config util/licence-checker.hjson <<< "$changed_files" | tee licence-checker-output
if [[ $? != 0 ]]; then
echo -n "##vso[task.logissue type=error]"
echo "Licence header check failed. Please check output of util/licence-checker.py on the noted failures."
diff --git a/util/lowrisc_misc-linters.lock.hjson b/util/lowrisc_misc-linters.lock.hjson
new file mode 100644
index 0000000..df16465
--- /dev/null
+++ b/util/lowrisc_misc-linters.lock.hjson
@@ -0,0 +1,14 @@
+// Copyright lowRISC contributors.
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+// This file is generated by the util/vendor script. Please do not modify it
+// manually.
+
+{
+ upstream:
+ {
+ url: https://github.com/lowRISC/misc-linters.git
+ rev: 83e07743a75d8a5425dd7074f64e8ce00439144c
+ }
+}
diff --git a/util/lowrisc_misc-linters.vendor.hjson b/util/lowrisc_misc-linters.vendor.hjson
new file mode 100644
index 0000000..0cd0b76
--- /dev/null
+++ b/util/lowrisc_misc-linters.vendor.hjson
@@ -0,0 +1,19 @@
+// Copyright lowRISC contributors.
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+{
+ name: "lowrisc_misc-linters",
+ target_dir: "lowrisc_misc-linters",
+
+ upstream: {
+ url: "https://github.com/lowRISC/misc-linters.git",
+ rev: "master",
+ },
+
+ exclude_from_upstream: [
+ // We shouldn't reformat upstream code
+ '.style.yapf',
+ // Avoid licence checker configuration confusion
+ 'licence-checker.hjson',
+ ]
+}
diff --git a/util/lowrisc_misc-linters/CLA b/util/lowrisc_misc-linters/CLA
new file mode 100644
index 0000000..8b628e0
--- /dev/null
+++ b/util/lowrisc_misc-linters/CLA
@@ -0,0 +1,87 @@
+lowRISC CIC
+Contributor License Agreement ("Agreement") v1.0
+
+You accept and agree to the following terms and conditions for Your present and
+future Contributions submitted to the Project. Except for the license granted
+herein to the Project and recipients of software distributed by the Project,
+You reserve all right, title, and interest in and to Your Contributions.
+
+1. Definitions.
+
+"You" (or "Your") shall mean the copyright owner or legal entity authorized by
+the copyright owner that is making this Agreement with the Project. For legal
+entities, the entity making a Contribution and all other entities that control,
+are controlled by, or are under common control with that entity are considered
+to be a single Contributor. For the purposes of this definition, "control"
+means (i) the power, direct or indirect, to cause the direction or management
+of such entity, whether by contract or otherwise, or (ii) ownership of fifty
+percent (50%) or more of the outstanding shares, or (iii) beneficial ownership
+of such entity.
+
+"Contribution" shall mean any original work of authorship, including any
+modifications or additions to an existing work, that is intentionally submitted
+by You to the Project for inclusion in, or documentation of, any of the
+products owned or managed by the Project (the "Work"). For the purposes of this
+definition, "submitted" means any form of electronic, verbal, or written
+communication sent to the Project or its representatives, including but not
+limited to communication on electronic mailing lists, source code control
+systems, and issue tracking systems that are managed by, or on behalf of, the
+Project for the purpose of discussing and improving the Work, but excluding
+communication that is conspicuously marked or otherwise designated in writing
+by You as "Not a Contribution."
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+Agreement, You hereby grant to the Project and to recipients of software
+distributed by the Project a perpetual, worldwide, non-exclusive, no-charge,
+royalty-free, irrevocable copyright license to reproduce, prepare derivative
+works of, publicly display, publicly perform, sublicense, and distribute Your
+Contributions and such derivative works.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+Agreement, You hereby grant to the Project and to recipients of the Work
+distributed by the Project a perpetual, worldwide, non-exclusive, no-charge,
+royalty-free, irrevocable (except as stated in this section) patent license to
+make, have made, use, offer to sell, sell, import, and otherwise transfer the
+Work, where such license applies only to those patent claims licensable by You
+that are necessarily infringed by Your Contribution(s) alone or by combination
+of Your Contribution(s) with the Work to which such Contribution(s) was
+submitted. If any entity institutes patent litigation against You or any other
+entity (including a cross-claim or counterclaim in a lawsuit) alleging that
+your Contribution, or the Work to which you have contributed, constitutes
+direct or contributory patent infringement, then any patent licenses granted to
+that entity under this Agreement for that Contribution or Work shall terminate
+as of the date such litigation is filed.
+
+4. You represent that you are legally entitled to grant the above license. If
+your employer(s) has rights to intellectual property that you create that
+includes your Contributions, you represent that you have received permission to
+make Contributions on behalf of that employer, that your employer has waived
+such rights for your Contributions to the Project, or that your employer has
+executed a separate Corporate CLA with the Project.
+
+5. You represent that each of Your Contributions is Your original creation (see
+section 7 for submissions on behalf of others). You represent that Your
+Contribution submissions include complete details of any third-party license or
+other restriction (including, but not limited to, related patents and
+trademarks) of which you are personally aware and which are associated with any
+part of Your Contributions.
+
+6. You are not expected to provide support for Your Contributions, except to
+the extent You desire to provide support. You may provide support for free, for
+a fee, or not at all. Unless required by applicable law or agreed to in
+writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES
+OR CONDITIONS OF ANY KIND, either express or implied, including, without
+limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
+MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+
+7. Should You wish to submit work that is not Your original creation, You may
+submit it to the Project separately from any Contribution, identifying the
+complete details of its source and of any license or other restriction
+(including, but not limited to, related patents, trademarks, and license
+agreements) of which you are personally aware, and conspicuously marking the
+work as "Submitted on behalf of a third-party: [named here]".
+
+8. You agree to notify the Project of any facts or circumstances of which you
+become aware that would make these representations inaccurate in any respect.
+
+Please sign: __________________________________ Date: ________________
diff --git a/util/lowrisc_misc-linters/CONTRIBUTING.md b/util/lowrisc_misc-linters/CONTRIBUTING.md
new file mode 100644
index 0000000..fa837d9
--- /dev/null
+++ b/util/lowrisc_misc-linters/CONTRIBUTING.md
@@ -0,0 +1,48 @@
+# Contributing code to the misc-linters repository
+
+## Contributor License Agreement
+
+Contributions to misc-linters must be accompanied by sign-off text that indicates
+acceptance of the Contributor License Agreement (see [CLA](CLA) for full
+text), which is closely derived from the Apache Individual Contributor License
+Agreement. The sign-off text must be included once per commit, in the commit
+message. The sign-off can be automatically inserted using a command such as
+`git commit -s`, which will generate the text in the form:
+`Signed-off-by: Random J Developer <random@developer.example.org>`
+
+By adding this sign-off, you are certifying:
+
+_By signing-off on this submission, I agree to be bound by the terms of the
+Contributor License Agreement located at the root of the project repository,
+and I agree that this submission constitutes a "Contribution" under that
+Agreement._
+
+Please note that this project and any contributions to it are public and that
+a record of all contributions (including any personal information submitted
+with it, including a sign-off) is maintained indefinitely and may be
+redistributed consistent with this project or the open source license(s)
+involved.
+
+## Quick guidelines
+
+* Keep a clean commit history. This means no merge commits, and no long series
+ of "fixup" patches (rebase or squash as appropriate). Structure work as a
+ series of logically ordered, atomic patches. `git rebase -i` is your friend.
+* Changes should be made via pull request, with review. Do not commit until
+ you've had an explicit "looks good to me". We don't yet have, but plan to
+ create a policy describing code owners and the like. In the meantime use your
+ best judgement. If you're submitting a change against something that was 90%
+ authored by a single person, you'll want to get their ACK before committing.
+* When changes are restricted to a specific area, you are recommended to add a
+ tag to the beginning of the first line of the commit message in square
+ brackets. e.g. "[UART] Fix bug #157".
+* Code review is not design review and doesn't remove the need for discussing
+ implementation options. If you would like to make a large-scale change or
+ discuss multiple implementation options, discuss on the mailing list.
+* Create pull requests from a fork rather than making new branches in
+ `github.com/lowrisc/misc-linters`.
+* Do not force push.
+* Do not attempt to commit code with a non-Apache license without discussing
+ first.
+* If a relevant bug or tracking issue exists, reference it in the pull request
+ and commits.
diff --git a/util/lowrisc_misc-linters/LICENSE b/util/lowrisc_misc-linters/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/util/lowrisc_misc-linters/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/util/lowrisc_misc-linters/README.md b/util/lowrisc_misc-linters/README.md
new file mode 100644
index 0000000..09391ed
--- /dev/null
+++ b/util/lowrisc_misc-linters/README.md
@@ -0,0 +1,21 @@
+# lowRISC's Miscellaneous Linters
+
+## About the project
+
+These are linters and checkers, usually for source code, which we have written
+for various lowRISC projects.
+
+They include
+* `licence-checker/licence-checker.py` which will ensure source code in your
+ repository contains correctly formatted licence headers. This is designed to
+ be reused: it is configured with `licence-checker.hjson`.
+
+## How to contribute
+
+Have a look at [CONTRIBUTING](./CONTRIBUTING.md) for guidelines on how to
+contribute code to this repository.
+
+## Licensing
+
+Unless otherwise noted, everything in this repository is covered by the Apache
+License, Version 2.0 (see [LICENSE](./LICENSE) for full text).
diff --git a/util/lowrisc_misc-linters/dependencies.txt b/util/lowrisc_misc-linters/dependencies.txt
new file mode 100644
index 0000000..306d460
--- /dev/null
+++ b/util/lowrisc_misc-linters/dependencies.txt
@@ -0,0 +1,8 @@
+# Copyright lowRISC contributors.
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+hjson
+tabulate
+yapf
+
diff --git a/util/lowrisc_misc-linters/licence-checker/README.md b/util/lowrisc_misc-linters/licence-checker/README.md
new file mode 100644
index 0000000..b70d01f
--- /dev/null
+++ b/util/lowrisc_misc-linters/licence-checker/README.md
@@ -0,0 +1,21 @@
+# Licence Checker
+
+This script can check most text file formats that we have checked our
+repositories, 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.
diff --git a/util/licence-checker.py b/util/lowrisc_misc-linters/licence-checker/licence-checker.py
similarity index 100%
rename from util/licence-checker.py
rename to util/lowrisc_misc-linters/licence-checker/licence-checker.py
