Extract lint-robot from linting and move into a separate documentation page
Change-Id: I3045b07cbdef4d7b59c26736c8cfa1383215baaf
diff --git a/howto/code/lint/lint-robot.rst b/howto/code/lint/lint-robot.rst
new file mode 100644
index 0000000..b1e2dfb
--- /dev/null
+++ b/howto/code/lint/lint-robot.rst
@@ -0,0 +1,26 @@
+.. _Makefile Target lint-robot:
+
+LINT: lint-robot
+================
+
+Robot Testing Framework (python)
+================================
+
+Command: rflint `robotframework-lint <https://pypi.org/project/robotframework-lint/>`_
+
+.. code:: bash
+
+ make clean
+ make lint 2>&1 | tee log
+ make lint-robot-all 2>&1 | tee log
+ make lint-robot-mod 2>&1 | tee log
+ make lint-robot-src 2>&1 | tee log
+
+Sources:
+
+- `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>`_
+
+.. seealso:
+
+`robotframework.org <https://robotframework.org>`_
diff --git a/howto/code/linting.rst b/howto/code/linting.rst
index 2763e53..b417ffb 100644
--- a/howto/code/linting.rst
+++ b/howto/code/linting.rst
@@ -4,14 +4,15 @@
Makefile Lint Targets: Syntax Checking
======================================
-Targets
-=======
+Makefile Linting: By language
+-----------------------------
.. code:: bash
- git clone ssh://gerrit.opencord.org:29418/voltha-helm-charts.git
- cd voltha-helm-charts
- make help | grep lint
+ % git clone ssh://gerrit.opencord.org:29418/onf-make.git
+ % cd onf-make
+
+ % make help | grep lint
lint-chart chart_version_check.sh
lint-doc8 Syntax check *.rst documentation files.
lint-helm Syntax check helm configs
@@ -20,7 +21,6 @@
lint-robot Syntax check robot sources using rflint
lint-shell Syntax check bash,bourne,etc sources
lint-yaml Syntax check yaml source using yamllint
- UNSTABLE= Build targets prone to failure (lint-helm)
[PYTHON]
lint-python Syntax check using available python tools
@@ -29,11 +29,40 @@
|
+Makefile Linting: By language target
+------------------------------------
+
+.. list-table:: Bulk sandbox linting
+ :widths: 20, 60
+ :header-rows: 1
+
+ * - Make Target
+ - Description
+ * - help | grpe lint
+ - Display available help for lint targets and flags.
+ * - make lint
+ - Invoke all source linters, linting is conditional by language.
+
+.. list-table:: Language and tool specific linting targets
+ :widths: 20, 60
+ :header-rows: 1
+
+ * - lint-{topic}-help
+ - Display extended help for a topic, supported targets and flags, etc.
+ * - lint-{topic}-all
+ - Lint everything available by file extension.
+ * - lint-{topic}-mod
+ - Lint locally modified files (git ls-files -m | lint)
+ * - lint-{topic}-src
+ - Lint a list of files passed in (make lint-{topic}-src VAR=list-of-files)
+
.. seealso::
- :ref:`Makefile Target lint-chart`
- :ref:`Makefile Target lint-helm`
+- :ref:`Makefile Target lint-robot`
+|
All Sources
===========
@@ -47,7 +76,6 @@
|
-
Makefile help
=============
@@ -169,26 +197,6 @@
|
-Helm Charts
-===========
-
-Command(s):
-- `helmlint.sh <https://gerrit.opencord.org/plugins/gitiles/helm-repo-tools/+/refs/heads/master/helmlint.sh>`_
-
-.. code:: bash
-
- make clean
- make lint-chart lint-helm 2>&1 | tee log
-
-Sources:
-
-- `makefiles/lint <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/makefiles/lint/>`__
-- `makefiles/lint/helm/include.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/makefiles/lint/helm/include.mk>`_
-- [`master <https://gerrit.opencord.org/plugins/gitiles/helm-repo-tools/+/refs/heads/master>`__] `helm-repo-tools <https://gerrit.opencord.org/plugins/gitiles/helm-repo-tools>`_
-
-|
-
-
Golang
======
@@ -266,26 +274,6 @@
|
-Robot
-=====
-
-Command: rflint `robotframework-lint <https://pypi.org/project/robotframework-lint/>`_
-
-.. code:: bash
-
- make clean
- make lint 2>&1 | tee log
- make lint-robot-all 2>&1 | tee log
- make lint-robot-modified 2>&1 | tee log
-
-Sources:
-
-- `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>`_
-
-|
-
-
Shell / Command Line Scripts
============================
diff --git a/howto/release/charts/index.rst b/howto/release/charts/index.rst
index 59f4308..bc3204b 100644
--- a/howto/release/charts/index.rst
+++ b/howto/release/charts/index.rst
@@ -5,4 +5,5 @@
:maxdepth: 1
voltha-openolt-adapter
+ voltha-openonu-adapter
notes