VOL-4840 - docs.voltha.org edits
Makefile
patches/python_310_migration.sh
-------------------------------
o Change log message to note venv patching by version.
o Original message could be interpreted as explict patching of wrong version.
makefiles/lint/include.mk
-------------------------
o Document lint targets: usage, commands, makefiles, etc.
Change-Id: I895a0a032f856632c9adf31aa634b6cbf0328cdb
diff --git a/makefiles/help/include.mk b/makefiles/help/include.mk
index 4264c52..0ff8bf4 100644
--- a/makefiles/help/include.mk
+++ b/makefiles/help/include.mk
@@ -21,13 +21,17 @@
@echo "Usage: $(MAKE) [options] [target] ..."
@echo
@echo '[Virtual Env]'
- @echo ' venv Create a python virtual environmen"
+ @echo ' venv Create a python virtual environment'
@echo " $(VENV_NAME)"
@echo
@echo '[CLEAN]'
@echo ' clean Remove generated targets'
@echo ' sterile clean + remove virtual env interpreter install'
@echo
+ @echo '[VIEW]'
+ @echo ' reload Setup to auto-reload sphinx doc changes in browser'
+ @echo ' view-html View generated documentation'
+ @echo
@echo '[HELP]'
@echo ' help Display program help'
@echo ' help-verbose Display additional targets and help'
diff --git a/makefiles/lint.mk b/makefiles/lint/include.mk
similarity index 95%
rename from makefiles/lint.mk
rename to makefiles/lint/include.mk
index cb4b0a7..979a6fb 100644
--- a/makefiles/lint.mk
+++ b/makefiles/lint/include.mk
@@ -22,6 +22,7 @@
include $(MAKEDIR)/lint/json.mk
include $(MAKEDIR)/lint/python.mk
include $(MAKEDIR)/lint/robot.mk
+include $(MAKEDIR)/lint/shell.mk
include $(MAKEDIR)/lint/yaml.mk
# [EOF]
diff --git a/makefiles/lint.mk b/makefiles/lint/shell.mk
similarity index 69%
copy from makefiles/lint.mk
copy to makefiles/lint/shell.mk
index cb4b0a7..da92921 100644
--- a/makefiles/lint.mk
+++ b/makefiles/lint/shell.mk
@@ -15,13 +15,19 @@
# limitations under the License.
# -----------------------------------------------------------------------
-help::
- @echo
- @echo "[LINT]"
+JSON_FILES ?= $(error JSON_FILES= is required)
-include $(MAKEDIR)/lint/json.mk
-include $(MAKEDIR)/lint/python.mk
-include $(MAKEDIR)/lint/robot.mk
-include $(MAKEDIR)/lint/yaml.mk
+.PHONY: lint-shell
+
+lint : lint-shell
+
+lint-shell:
+ shellcheck --version
+ find . \( -name 'staging' -o -name 'vst_venv' \) -prune \
+ -o -name '*.sh' ! -name 'activate.sh' -print0 \
+ | xargs -0 -n1 shellcheck
+
+help::
+ @echo " lint-shell Syntax check bash,bourne,etc sources"
# [EOF]