style(tox): prepare for fixer scripts

The previous code assumes each tox script is a checker.
We want to add fixer scripts (not voting but editing) soon.

This is the less interesting part of the process,
renaming things and updating comments.

Includes some basic descriptions of how fixers differ from checkers.

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

1 files changed, 15 insertions, 15 deletions

diff --git a/tox.ini b/tox.ini
index 079e689136..126af2d454 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Cisco and/or its affiliates.
+# Copyright (c) 2022 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:
@@ -20,9 +20,9 @@
 # Usage:
 # cd to CSIT root (other directories might use different tox.ini)
 #   $ tox
-# will execute all checks.
+# will execute all default checkers.
 #  $ tox -e pylint
-# will execute only checks defined in "pylint" tox environment.
+# will execute only checkers (or fixers) defined in "pylint" tox environment.
 
 [tox]
 # Fast and brief checkers to front, slow or verbose checkers to back.
@@ -32,48 +32,48 @@ envlist = job_spec, copyright_year, gpl_license, model_version,
 # The following is needed as tox requires setup.py by default.
 skipsdist = true
 # Just a shorthand to avoid long lines.
-checker_dir = ./resources/libraries/bash/entry/check
+script_dir = ./resources/libraries/bash/entry/tox
 
 # TODO: Tox prints various warnings. Figure them out and fix them.
 
 # Recommended ordering withinn testenv definition:
 # + General comments.
 # + ignore_outcome for non-voting checkers,
-# + setenv (PYTHONPATH) for Python-using checkers.
+# + setenv (PYTHONPATH) for Python-using checkers and fixers.
 # + Other Python stuff (e.g. basepython and deps for pylint).
 # + whitelist_externals to enable bash.
-# + commands with a single bash to launch the corresponding checker script.
+# + Commands with a single bash to launch the corresponding script.
 
 # Keep testenvs sorted alphabetically, please.
 
 [testenv:autogen]
 setenv = PYTHONPATH = {toxinidir}
 whitelist_externals = /bin/bash
-commands = bash {[tox]checker_dir}/autogen.sh
+commands = bash {[tox]script_dir}/autogen.sh
 
 [testenv:copyright_year]
 whitelist_externals = /bin/bash
-commands = bash {[tox]checker_dir}/copyright_year.sh
+commands = bash {[tox]script_dir}/copyright_year.sh
 
 [testenv:doc_verify]
 # Fix all documentation error before enabling voting.
 ignore_outcome = true
 whitelist_externals = /bin/bash
-commands = bash {[tox]checker_dir}/doc_verify.sh
+commands = bash {[tox]script_dir}/doc_verify.sh
 
 [testenv:gpl_license]
 whitelist_externals = /bin/bash
-commands = bash {[tox]checker_dir}/gpl_license.sh
+commands = bash {[tox]script_dir}/gpl_license.sh
 
 [testenv:line_length]
 # Fix all transgressions and remove the ignore_outcome flag.
 ignore_outcome = true
 whitelist_externals = /bin/bash
-commands = bash {[tox]checker_dir}/line.sh
+commands = bash {[tox]script_dir}/line.sh
 
 [testenv:model_version]
 whitelist_externals = /bin/bash
-commands = bash {[tox]checker_dir}/model_version.sh
+commands = bash {[tox]script_dir}/model_version.sh
 
 [testenv:new_line_length]
 # Adding .svg, big .rst tables, .yaml and similar still requires long lines.
@@ -81,7 +81,7 @@ commands = bash {[tox]checker_dir}/model_version.sh
 # the checker has to remain non-voting.
 ignore_outcome = true
 whitelist_externals = /bin/bash
-commands = bash {[tox]checker_dir}/new_line.sh
+commands = bash {[tox]script_dir}/new_line.sh
 
 [testenv:pylint]
 # Run pylint, but hide its return value until python warnings are cleared.
@@ -92,7 +92,7 @@ deps =
     pylint==2.4.3
     -r ./requirements.txt
 whitelist_externals = /bin/bash
-commands = bash {[tox]checker_dir}/pylint.sh
+commands = bash {[tox]script_dir}/pylint.sh
 
 # Keep testenvs sorted alphabetically, please.
 
@@ -105,5 +105,5 @@ commands = bash {[tox]checker_dir}/pylint.sh
 # TODO: Create .yaml specific checker, so people can override long line check.
 # TODO: Create .rst specific checker, if there is one allowing
 #       to override line check.
-# TODO: You get the idea, replace line check with something smarter
+# TODO: You get the idea, replace line checker with something smarter
 #       wherever possible.