summaryrefslogtreecommitdiffstats
path: root/resources/libraries/bash/entry/check/README.txt
diff options
context:
space:
mode:
authorVratko Polak <vrpolak@cisco.com>2020-10-30 09:44:41 +0100
committerVratko Polak <vrpolak@cisco.com>2020-10-30 09:44:41 +0100
commit1c2097ca62c74abf9380b2c03fdcc2eb0aad16f1 (patch)
tree152409ff329a553a6355e5e55bdd74d8f5f5226e /resources/libraries/bash/entry/check/README.txt
parent1eadcabab5f547f705a69c59262e09c1d1a98182 (diff)
Tox: Add copyright checkermain
Created by copying out a small subset of CSIT code. Removed CSIT references, e.g. CSIT_DIR -> ROOT_DIR. Change-Id: Id4c17fe9c99e74fcf02a48abf4a3cfaa57f890cb Signed-off-by: Vratko Polak <vrpolak@cisco.com>
Diffstat (limited to 'resources/libraries/bash/entry/check/README.txt')
-rw-r--r--resources/libraries/bash/entry/check/README.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/resources/libraries/bash/entry/check/README.txt b/resources/libraries/bash/entry/check/README.txt
new file mode 100644
index 0000000..6f6efae
--- /dev/null
+++ b/resources/libraries/bash/entry/check/README.txt
@@ -0,0 +1,25 @@
+# Copyright (c) 2020 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:
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+This directory contains checker scripts and other files they need.
+Each checker script is assumed to be run from tox,
+when working directory is set to root of git repo.
+Each script should:
++ Return nonzero exit code when it fails.
+++ The tox might ignore the code when the check is not blocking.
++ Write less verbose output to stderr.
++ Write (to stderr) PASSED or FAILED to help with debugging.
++ Direct more verbose output to appropriately named .log file.
++ 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.