change to use reuse tooling for copyright and license compliance

commit does the following:
* remove old pre-commit for copyright/license header annotation
* add reuse lint check for compliance
* fix old header formats on files
* and new reuse headers to files that were missing them
* add github action to check for compliance
* add pre-commit hook to run reuse lint to check compliance
* add reuse badge to README

related to rivosinc#5

Signed-off-by: Kevin Broch <kbroch@rivosinc.com>

Author: kbroch-rivosinc

.clang-format

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # Based off Open Titan's
 BasedOnStyle: Google
 AllowShortIfStatementsOnASingleLine: false

.github/workflows/reuse.yml

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+name: reuse
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: reuse Compliance Check
+      uses: fsfe/reuse-action@v1

.gitignore

@@ -1 +1,5 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
 .vscode

.gitlab-ci.yml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
 include:
   # https://gitlab.ba.rivosinc.com/rv/group_gitlab_config/raw/rivos/main/ci_includes/pre-commit-lint.yml
   - project: 'rv/group_gitlab_config'

.pre-commit-config.yaml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
 repos:
   # pull mirror from: https://github.com/pre-commit/pre-commit-hooks
   - repo: https://gitlab.ba.rivosinc.com/pub/it/pre-commit-hooks.git
@@ -40,22 +44,12 @@ repos:
     hooks:
       - id: yapf
 
-  # pull mirror from: https://github.com/Lucas-C/pre-commit-hooks
-  - repo: https://gitlab.ba.rivosinc.com/pub/it/lucas-c-pre-commit-hooks
-    rev: v1.1.11
+  # pull mirror of https://github.com/fsfe/reuse-tool (slightly modified)
+  - repo: https://github.com/rivosinc/reuse-tool
+    rev: '3a95909a30d51467575a95b8cabdc7949bb8e7bd'
     hooks:
-      - id: insert-license
-        files: \.py$
-        args:
-          - --license-filepath
-          - LICENSE_HDR.txt
-      - id: insert-license
-        files: \.(c|h|cc|cpp|S|svh|sv|svp)$
-        args:
-          - --license-filepath
-          - LICENSE_HDR.txt
-          - --comment-style
-          - //
+      # Check compliance
+      - id: reuse
 
   # pull mirror from: https://github.com/jumanjihouse/pre-commit-hooks.git
   - repo: https://gitlab.ba.rivosinc.com/pub/it/jumanjihouse_pre-commit-hooks

.pylintrc

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
 [MESSAGES CONTROL]
 
 disable=

.style.yapf

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
 [style]
 # lowRISC style is basically pep8
 based_on_style = pep8