feat(tox): add copyright year fixer script

It uses rather simple sed commands, but seems to work well enough.

+ Improve readme.
+ Shortened comments about why 3 lines.

Change-Id: I50b395dfeb586f671f7c4c82f22369de90b351ec
Signed-off-by: Vratko Polak <vrpolak@cisco.com>

1 files changed, 3 insertions, 6 deletions

diff --git a/resources/libraries/bash/entry/tox/copyright_year.sh b/resources/libraries/bash/entry/tox/copyright_year.sh
index 9ed9fcb653..272763100e 100644
--- a/resources/libraries/bash/entry/tox/copyright_year.sh
+++ b/resources/libraries/bash/entry/tox/copyright_year.sh
@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Cisco and/or its affiliates.
+# Copyright (c) 2024 Cisco and/or its affiliates.
 # 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:
@@ -24,10 +24,7 @@ set -exuo pipefail
 # but not the current year (in the same line).
 # The offending lines are stored to copyright_year.log (overwriting).
 #
-# 3 lines were chosen, because first two lines could be shebang and empty line,
-# and more than 3 lines would start failing on files with multiple copyright
-# holders. There, only the last updating entity needs to bump its year,
-# and put other copyright lines below.
+# 3 lines were chosen, because first two lines could be shebang and empty line.
 
 # "set -eu" handles failures from the following two lines.
 BASH_CHECKS_DIR="$(dirname $(readlink -e "${BASH_SOURCE[0]}"))"
@@ -42,7 +39,7 @@ IFS=$'\n'
 files=($(git diff --name-only HEAD~ || true))
 unset IFS
 truncate -s 0 "copyright_year.log" || die
-# A change can have thousands of files, supress console output in the cycle.
+# A change can have thousands of files, supress console output for the cycle.
 set +x
 for fil in "${files[@]}"; do
     # Greps do "fail" on 0 line output, we need to ignore that