feat(tox): add copyright year fixer script

[csit.git] / resources / libraries / bash / entry / tox / README.txt

diff --git a/resources/libraries/bash/entry/tox/README.txt b/resources/libraries/bash/entry/tox/README.txt
index e13b602..9ce21e9 100644 (file)
--- a/resources/libraries/bash/entry/tox/README.txt
+++ b/resources/libraries/bash/entry/tox/README.txt
@@ -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:
@@ -14,6 +14,13 @@
 This directory contains tox scripts and other files they need.
 Generally, a tox script is either a checker (suitable for automated verify)
 or a fixer (manually started, risky as uncommitted edits can be lost).
+
+In the tox verify job we want to avoid running fixers,
+as they can affect what other checkers see
+(e.g. autogen fixer could add more too long lines).
+That is why we keep fixers separate from checkers in principle,
+even for fairly safe tasks (e.g. bumping copyright years).
+
 Each tox script is assumed to be run from tox,
 when working directory is set to ${CSIT_DIR}.
 
@@ -26,14 +33,9 @@ Each checker script should:
 + Only the output suitable for automated processing by an external caller
   should be written to stdout.
 ++ The level of "less verbose" depends on check and state of codebase.
-+ TODO: Should we carefully document which files are
-  whitelisted/blacklisted for a particulat check?
 
 Each fixer script should:
 + Perform edits on current filesystem
 + Not assume git is clean (there may be uncommitted edits).
 + Use "git diff HEAD~" to get both comitted and uncomitted edits to analyze.
 + Output whatever it wants (possibly nothing).
-
-TODO: Should checkers be named differently than fixers?
-      E.g. both scripts and tox environments start with fix_?