Updating copyright headers to match current best practices

.github/check_license.sh

@@ -0,0 +1,66 @@
+#!/usr/bin/env bash
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
+
+echo
+echo "==========================="
+echo "Check SPDX identifier"
+echo "==========================="
+echo
+
+ERROR_FILES=""
+FILES_TO_CHECK=`find . \
+    -size +0 -type f \( -name '*.sh' -o -name '*.py' -o -name 'Makefile' -o -name '*.tcl' \) \
+    \( -not -path "*/.*/*" -not -path "*/third_party/*" -not -path "*/database/*" -not -path "*/env/*" -not -path "*/build/*" \)`
+
+for file in $FILES_TO_CHECK; do
+    echo "Checking $file"
+    grep -q "SPDX-License-Identifier" $file || ERROR_FILES="$ERROR_FILES $file"
+done
+
+if [ ! -z "$ERROR_FILES" ]; then
+    for file in $ERROR_FILES; do
+        echo "ERROR: $file does not have license information."
+    done
+    exit 1
+fi
+
+echo
+echo "==========================="
+echo "Check third party LICENSE"
+echo "==========================="
+echo
+
+function check_if_submodule {
+    for submodule in `git submodule --quiet foreach 'echo $sm_path'`; do
+        if [ "$1" == "$submodule" ]; then
+            return 1
+        fi
+    done
+}
+
+THIRD_PARTY_DIRS=""
+if [[ -e third_party ]]; then
+    THIRD_PARTY_DIRS=`ls third_party --ignore=reformat.tcl --ignore cctz --ignore gflags --ignore yosys `
+fi
+ERROR_NO_LICENSE=""
+
+for dir in $THIRD_PARTY_DIRS; do
+    # Checks if we are not in a submodule
+    if check_if_submodule $dir; then
+        echo "Checking third_party/$dir"
+        [ -f third_party/$dir/LICENSE ] || ERROR_NO_LICENSE="$ERROR_NO_LICENSE $dir"
+    fi
+done
+
+if [ ! -z "$ERROR_NO_LICENSE" ]; then
+    for dir in $ERROR_NO_LICENSE; do
+        echo "ERROR: $dir does not have the LICENSE file."
+    done
+    exit 1
+fi

.github/check_python_scripts.sh

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
+
+echo
+echo "==================================="
+echo "Check Python UTF coding and shebang"
+echo "==================================="
+echo
+
+ERROR_FILES_SHEBANG=""
+ERROR_FILES_UTF_CODING=""
+FILES_TO_CHECK=`find . \
+    -size +0 -type f \( -name '*.py' \) \
+    \( -not -path "*/.*/*" -not -path "*/third_party/*" -not -path "*/env/*" \)`
+
+for file in $FILES_TO_CHECK; do
+    echo "Checking $file"
+    if [[ -x $file ]]; then
+        grep -q "\#\!/usr/bin/env python3" $file || ERROR_FILES_SHEBANG="$ERROR_FILES_SHEBANG $file"
+    fi
+    grep -q "\#.*coding: utf-8" $file || ERROR_FILES_UTF_CODING="$ERROR_FILES_UTF_CODING $file"
+done
+
+if [ ! -z "$ERROR_FILES_SHEBANG" ]; then
+    for file in $ERROR_FILES_SHEBANG; do
+        echo "ERROR: $file does not have the python3 shebang."
+    done
+    exit 1
+fi
+
+if [ ! -z "$ERROR_FILES_UTF_CODING" ]; then
+    for file in $ERROR_FILES_UTF_CODING; do
+        echo "ERROR: $file does not have the UTF encoding set."
+	echo "Add # coding: utf-8"
+    done
+    exit 1
+fi
+
+echo

.github/kokoro/db-full.sh

@@ -1,4 +1,11 @@
 #!/bin/bash
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 set -e
 

.github/kokoro/db-quick.sh

@@ -1,4 +1,11 @@
 #!/bin/bash
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 set -e
 

.github/kokoro/kokoro-cfg.py

@@ -1,4 +1,13 @@
 #!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 db_full = """\
 # Format: //devtools/kokoro/config/proto/build.proto

.github/kokoro/steps/git.sh

@@ -1,4 +1,11 @@
 #!/bin/bash
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 set -e
 

.github/kokoro/steps/hostinfo.sh

@@ -1,4 +1,11 @@
 #!/bin/bash
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 set -e
 

.github/kokoro/steps/hostsetup.sh

@@ -1,4 +1,11 @@
 #!/bin/bash
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 set -e
 

.github/kokoro/steps/prjxray-env.sh

@@ -1,4 +1,11 @@
 #!/bin/bash
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 set -e
 

.github/kokoro/steps/xilinx.sh

@@ -1,4 +1,11 @@
 #!/bin/bash
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 # Fix up things related to Xilinx tool chain.
 

.github/kokoro/tests.sh

@@ -1,4 +1,11 @@
 #!/bin/bash
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 set -e
 

.github/update-contributing.py

@@ -1,4 +1,13 @@
 #!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 # Header
 contrib = ["""\

.travis.yml

@@ -32,3 +32,8 @@ jobs:
       script:
         - make format
         - test $(git status --porcelain | wc -l) -eq 0 || { git diff; false; }
+
+    - name: "License Checks"
+      script:
+        - ./.github/check_license.sh
+        - ./.github/check_python_scripts.sh

AUTHORS

@@ -0,0 +1,20 @@
+# This is the list of Project X-Ray's significant contributors.
+#
+# This does not necessarily list everyone who has contributed code,
+# especially since many employees of one corporation may be contributing.
+# To see the full list of contributors, see the revision history in
+# source control.
+Antmicro
+Google LLC
+Claire Wolf
+Rick Altherr
+Jake Mercer
+Mehdi Khairy
+Davide
+Herbert Poetzl
+Mitja Kleider
+Oguz Meteer
+David Shah
+Felix Held
+Leonardo Romor
+Paul Schulz

COPYING → LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2017  The Project X-Ray Authors. All rights reserved.
+Copyright (C) 2017-2020  The Project X-Ray Authors.
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

Makefile

@@ -1,3 +1,10 @@
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 SHELL = bash
 ALL_EXCLUDE = third_party .git env build docs/env
 
@@ -118,6 +125,12 @@ format: format-cpp format-docs format-py format-tcl format-trailing-ws
 
 .PHONY: format format-cpp format-py format-tcl format-trailing-ws
 
+check-license:
+	@./.github/check_license.sh
+	@./.github/check_python_scripts.sh
+
+.PHONY: check-license
+
 # Targets related to Project X-Ray databases
 # ------------------------
 

docs/Makefile

@@ -1,3 +1,10 @@
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 # Minimal makefile for Sphinx documentation
 #
 

docs/conf.py

@@ -1,4 +1,11 @@
 # -*- coding: utf-8 -*-
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 #
 # Project X-Ray documentation build configuration file, created by
 # sphinx-quickstart on Mon Feb  5 11:04:37 2018.

download-latest-db.sh

@@ -1,4 +1,11 @@
 #!/usr/bin/env bash
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 GITHUB_PROTO=${1:-https}
 GITHUB_URL=$GITHUB_PROTO://github.com/SymbiFlow/prjxray-db.git

experiments/clbpips/Makefile

@@ -1,3 +1,10 @@
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 N := 5
 SPECIMENS := $(addprefix specimen_,$(shell seq -f '%03.0f' $(N)))

experiments/clbpips/generate.py

@@ -1,4 +1,13 @@
 #!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 from prjxray.segmaker import Segmaker
 

experiments/clbpips/generate.sh

@@ -1,4 +1,11 @@
 #!/bin/bash
+# Copyright (C) 2017-2020  The Project X-Ray Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 
 source ../../utils/environment.sh
 source ${XRAY_GENHEADER}

experiments/clbpips/generate.tcl

@@ -1,3 +1,10 @@
+# Copyright (C) 2017-2020  The Project X-Ray Authors
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
 create_project -force -part $::env(XRAY_PART) design design
 
 read_verilog ../top.v