format-code: document current linter-config hashes
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: Idbfe0ef20b156e75a28986035c12df97577dfd65
diff --git a/scripts/format-code.sh b/scripts/format-code.sh
index d51fede..d6e3a2d 100755
--- a/scripts/format-code.sh
+++ b/scripts/format-code.sh
@@ -105,11 +105,23 @@
cd "${DIR}"
echo -e " ${BLUE}Formatting code under${NORMAL} $DIR"
-
+# Config hashes:
+# LINTER_REQUIRE - The requirements to run a linter, semi-colon separated.
+# 1. Executable.
+# 2. [optional] Configuration file.
+# 3. [optional] Global fallback configuration file.
+#
+# LINTER_IGNORE - An optional set of semi-colon separated ignore-files
+# specific to the linter.
+#
+# LINTER_TYPES - The file types supported by the linter, semi-colon separated.
+#
+# LINTER_CONFIG - The config (from LINTER_REQUIRE) chosen for the repository.
+#
declare -A LINTER_REQUIRE=()
-declare -A LINTER_CONFIG=()
declare -A LINTER_IGNORE=()
declare -A LINTER_TYPES=()
+declare -A LINTER_CONFIG=()
LINTER_REQUIRE+=([commit_spelling]="codespell")
LINTER_TYPES+=([commit_spelling]="commit")