Early staging for library makefile use (patch 2 of many)
Fix for broken URLs and delayed problem manifestations.
overview/troubleshooting.rst
----------------------------
o (make test) Wireshark protocol-dissectors returned a 500 error.
o URL accessible when used interactively.
o Workaround: morph the url into an emphasized statement.
howto/code/linting.rst
----------------------
o Modify lint target URLs to reference repo:onf-make VS repo:voltha-docs.
o Update URLs to accommodate temp renaming makefiles/ to makefiles-orig.
makefiles-orig/lint/json.mk
---------------------------
o Exclusions for delayed error condition.
o make lint runs successfully after a clean checkout.
o lint begins failing after targets (build, test, etc) checkout external
repos, create *venv* and generate documents.
o ie: cord-tester/venv_cord
+ [todo] include makefiles/virtualenv/include.mk
o Add simple directory exclusions for now so lint target
will ignore generated content.
Change-Id: Idea00c999f6bf8bfffd8192240005532e13baafe
diff --git a/VERSION b/VERSION
index 7ce9b67..8d81fbf 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.12.6-dev2
+2.12.6-dev3
diff --git a/howto/code/linting.rst b/howto/code/linting.rst
index 84e3692..e17f14b 100644
--- a/howto/code/linting.rst
+++ b/howto/code/linting.rst
@@ -70,14 +70,14 @@
Sources:
-- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/>`__
+- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/>`__
- makefiles/lint/doc8.mk
Notes:
- lint-doc8-all target dependency will create a `python virtual env <https://wiki.opennetworking.org/display/JOEY/PythonVenv>`_
- python 3.10+ requires `virtual env patching <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/patches/>`_ (dynamic, applied when needed).
-- `makefiles/patches/include.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/patches/>`_
+- `makefiles/patches/include.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles-orig/patches/>`__
|
@@ -96,14 +96,14 @@
Sources:
-- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/>`__
+- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/>`__
- makefiles/lint/flake8.mk
Notes:
- lint-flake8-all target dependency will create a `python virtual env <https://wiki.opennetworking.org/display/JOEY/PythonVenv>`_
- python 3.10+ requires `virtual env patching <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/patches/>`_ (dynamic, applied when needed).
-- `makefiles/patches/include.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/patches/>`_
+- `makefiles/patches/include.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles-orig/patches/>`__
|
@@ -134,7 +134,7 @@
Sources:
-- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/>`__
+- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/>`__
|
@@ -153,8 +153,8 @@
Sources:
-- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/>`__
-- `makefiles/lint/json.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/json.mk>`_
+- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/>`__
+- `makefiles/lint/json.mk <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/json.mk>`_
|
@@ -191,9 +191,9 @@
Sources:
-- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/>`__
+- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/>`__
- makefiles/lint/pylint.mk
-- `makefiles/patches/include.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/patches/>`_
+- `makefiles/patches/include.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles-orig/patches/>`__
Notes:
@@ -218,8 +218,8 @@
Sources:
-- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/>`__
-- `makefiles/lint/robot.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/robot.mk>`_
+- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/>`__
+- `makefiles/lint/robot.mk <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/robot.mk>`_
|
@@ -231,7 +231,7 @@
Sources:
-- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/>`__
+- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/>`__
- `Makefiles::doc8 <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/Makefile#98>`_
|
@@ -251,8 +251,8 @@
Sources:
-- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/>`__
-- `makefiles/lint/shell.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/shell.mk>`_
+- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/>`__
+- `makefiles/lint/shell.mk <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/shell.mk>`_
|
@@ -271,8 +271,8 @@
Sources:
-- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/>`__
-- `makefiles/lint/yaml.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles/lint/yaml.mk>`_
+- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/>`__
+- `makefiles/lint/yaml.mk <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/yaml.mk>`_
|
diff --git a/makefiles-orig/lint/json.mk b/makefiles-orig/lint/json.mk
index 1deeaba..f24dba6 100644
--- a/makefiles-orig/lint/json.mk
+++ b/makefiles-orig/lint/json.mk
@@ -42,7 +42,20 @@
## Intent: exhaustive json syntax checking
## -----------------------------------------------------------------------
json-find-args := $(null)
+
+## -----------------------------------------------------------------------
+## [TODO] makefile migration enhancement
+## Move switches into makefiles/onf-make/makefiles/lint/json/excl.mk
+## -----------------------------------------------------------------------
+## makefiles/virtualenv/index.mk could also append $(venv-name) to a
+## global directory exclusion list for central maintenance.
+## -----------------------------------------------------------------------
json-find-args += -name '$(venv-name)'
+
+## Migrate into makefiles/local/lint/json/excl.mk
+json-find-args += -o -name '*venv*'
+json-find-args += -o -name '_build'
+
lint-json-all:
$(HIDE)$(MAKE) --no-print-directory lint-json-install
diff --git a/overview/troubleshooting.rst b/overview/troubleshooting.rst
index 3ff63f1..f61c1a4 100644
--- a/overview/troubleshooting.rst
+++ b/overview/troubleshooting.rst
@@ -58,7 +58,7 @@
----------------
In order to see OMCI packets in Wireshark you'll need to install ``omci.lua`` and ``BinDecHex.lua`` dissectors
-`wiki.wireshark.org/Contrib <https://wiki.wireshark.org/Contrib#protocol-dissectors>`_.
+`wiki.wireshark.org/Contrib` ``http://wiki.wireshark.org/Contrib#protocol-dissectors``
To install them on Ubuntu: