Misc doc edits for release.
release_notes/voltha_2.12.rst
-----------------------------
o Update version and URLs for kafka
o Update version and URLs for olt
howto/release/tasks/index.rst
howto/release/tasks/golang_gofmt_syntax.rst
-------------------------------------------
o Document std golang formatting with gofmt -s -e -w.
o Document content with references (commit message, make lint)
diff --git a/howto/release/tasks/index.rst b/
Include a few edits from gerrit id I6e9658c23f436f83d423f74e01b2966943d2fe08
Change-Id: I27ad46ddd6673a9e35e794b1d3e8bb0644e8260d
diff --git a/VERSION b/VERSION
index 404df31..562510f 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.12.22
+2.12.23
diff --git a/howto/code/linting.rst b/howto/code/linting.rst
index aaba632..b75b96a 100644
--- a/howto/code/linting.rst
+++ b/howto/code/linting.rst
@@ -277,7 +277,7 @@
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.mk>`_
+- `makefiles/lint/robot/*.mk <https://gerrit.opencord.org/plugins/gitiles/onf-make/+/refs/heads/master/makefiles/lint/robot>`_
|
diff --git a/howto/release/tasks/go_mod_update.rst b/howto/release/tasks/go_mod_update.rst
new file mode 100644
index 0000000..171046f
--- /dev/null
+++ b/howto/release/tasks/go_mod_update.rst
@@ -0,0 +1,52 @@
+.. _Release Task Golang Mod Update:
+
+GOLANG: Update go.mod opencord package versions
+===============================================
+
+Update go package version dependencies.
+
+NOTE: Files in the vendor/ directory should not be modified
+
+- Sources are checked in purely for bootstrapping.
+- Ideally vendor/ will be deleted and populated dynamically by git submodules.
+
+.. code-block:: shell-session
+ :caption: Update copyrigth notice ending date.
+
+ % git clone ssh://gerrit.opencord.org:29418/ofagent-go.git
+ % cd ofagent-go
+
+ # ---------------------------------------
+ # Preview packages and versions to modify
+ # ---------------------------------------
+ % grep opencord $(find . ! -path 'vendor/*' -name '*.go' -print)
+
+ # --------------------------------------------------------------
+ # Edit go.mod and update dependencies as needed
+ # --------------------------------------------------------------
+ % ${EDITOR} $(find . ! -path 'vendor/*' -name '*.go' -print)
+
+ % make distclean
+
+ # ------------------------------
+ # Bulk fix golang linting errors
+ # ------------------------------
+ % find . ! -path 'vendor/*' -name '*.go' -print0 | xargs -0 gofmt -s -e -w
+
+ # ---------------------------
+ # Invoke go mod vendor
+ # Invoke go mod tidy
+ # From within a local sandbox
+ # ---------------------------
+ % make mod-update LOCAL_FIX_PERMS=1
+
+ # -------------------------
+ # Check for syntax problems
+ # -------------------------
+ % make lint
+
+ # -----------------------------------
+ # Pre-screen for jenkins job problems
+ # -----------------------------------
+ % make build
+ % make test
diff --git a/howto/release/tasks/golang_gofmt_syntax.rst b/howto/release/tasks/golang_gofmt_syntax.rst
index 0f6bb1e..c34e2de 100644
--- a/howto/release/tasks/golang_gofmt_syntax.rst
+++ b/howto/release/tasks/golang_gofmt_syntax.rst
@@ -6,9 +6,12 @@
Use the gofmt command to reformat golang sources gathered outside the vendor/ directory.
.. code-block:: shell-session
- :caption:
+ :caption: Golang source formatting
+ % git clone ssh://gerrit.opencord.org:29418/voltha-lib-go.git
+ % cd voltha-lib-go
+
+ % make sterile
% make golang-fmt
- % cd mysandbox
% find . ! -path './vendor/\*' -name '*.go' -print | xargs -n1 gofmt -s -e -w
diff --git a/howto/release/tasks/index.rst b/howto/release/tasks/index.rst
index 9507df2..3e305e4 100644
--- a/howto/release/tasks/index.rst
+++ b/howto/release/tasks/index.rst
@@ -14,14 +14,29 @@
BUILD[pre-release]: dependency and module updates
-------------------------------------------------
-- make go mod-update
-- Update copyright notices :ref:`Release Task Copyright`
+- :ref:`Release Task Golang Mod Update`
+- :ref:`Release Task Copyright`
Standard syntax & formatting
----------------------------
- Golang syntax fomatting :ref:`Release Task Golang Syntax`
+golang
+^^^^^^
+
+Use the gofmt command to reformat golang sources gathered outside the vendor/ directory.
+
+.. code-block:: shell-session
+ :caption: Standard syntax formatting for golang source
+
+ % make golang-fmt
+
+ % cd mysandbox
+ % find . ! -path './vendor/\*' -name '*.go' -print0 \
+ | xargs -n1 gofmt -s -e -w
+
+
Chart.yaml
----------
diff --git a/overview/release_process.rst b/overview/release_process.rst
index 3157f7c..5abf658 100644
--- a/overview/release_process.rst
+++ b/overview/release_process.rst
@@ -1,5 +1,6 @@
VOLTHA Release process
======================
+
This document describes the technical steps of VOLTHA's release process.
The document assumes you are creating a release named voltha-X.Y, where X is the major release versio
and the y is the minor.
diff --git a/overview/troubleshooting.rst b/overview/troubleshooting.rst
index 12404b4..1f08de9 100644
--- a/overview/troubleshooting.rst
+++ b/overview/troubleshooting.rst
@@ -36,7 +36,7 @@
And then in wireshark select ``File -> Import from Hex Dump``
-Or you can decode a single packet using this online tool: `https://hpd.gasmi.net <https://hpd.gasmi.net>`_
+Or you can decode a single packet using this online tool: ``http://hpd.gasmi.net``.
To get all the EAPOL packets: ``grep -e '888e' packets.trace``
diff --git a/release_notes/voltha_2.12.rst b/release_notes/voltha_2.12.rst
index e5c06de..b131131 100644
--- a/release_notes/voltha_2.12.rst
+++ b/release_notes/voltha_2.12.rst
@@ -217,12 +217,12 @@
- `X <https://github.com/opencord/igmpproxy/releases/tag/2.9.0>`__
-
* - `kafka <https://gerrit.opencord.org/gitweb?p=kafka-onos.git;a=summary>`__
- - `2.13.1 <https://mvnrepository.com/artifact/org.opencord/kafka/2.13.1>`__
- - `X <https://mvnrepository.com/artifact/org.opencord/kafka-api/2.13.1>`__
- - `X <https://mvnrepository.com/artifact/org.opencord/kafka-app/2.13.1>`__
- - `X <https://mvnrepository.com/artifact/org.opencord/kafka/2.13.1>`__
- - `X <https://gerrit.opencord.org/plugins/gitiles/kafka-onos/+/refs/tags/2.13.1>`__
- - `X <https://github.com/opencord/kafka-onos/releases/tag/2.13.1>`__
+ - `2.13.2 <https://mvnrepository.com/artifact/org.opencord/kafka/2.13.2>`__
+ - `X <https://mvnrepository.com/artifact/org.opencord/kafka-api/2.13.2>`__
+ - `X <https://mvnrepository.com/artifact/org.opencord/kafka-app/2.13.2>`__
+ - `X <https://mvnrepository.com/artifact/org.opencord/kafka/2.13.2>`__
+ - `X <https://gerrit.opencord.org/plugins/gitiles/kafka-onos/+/refs/tags/2.13.2>`__
+ - `X <https://github.com/opencord/kafka-onos/releases/tag/2.13.2>`__
- ``N``
* - `maclearner <https://gerrit.opencord.org/plugins/gitiles/mac-learning>`__
- `1.2.3 <https://mvnrepository.com/artifact/org.opencord/maclearner/1.2.3>`__
@@ -242,12 +242,12 @@
-
* - `olt <https://gerrit.opencord.org/gitweb?p=olt.git;a=summary>`__
- `5.2.6 <https://mvnrepository.com/artifact/org.opencord/olt/5.2.6>`__
- - `X <https://mvnrepository.com/artifact/org.opencord/olt-api/5.2.5>`__
- - `X <https://mvnrepository.com/artifact/org.opencord/olt-app/5.2.5>`__
- - `X <https://mvnrepository.com/artifact/org.opencord/olt/5.2.5>`__
- - `X <https://gerrit.opencord.org/plugins/gitiles/olt/+/refs/tags/5.2.5>`__
- - `X <https://github.com/opencord/olt/releases/tag/5.2.5>`__
- - ``N``
+ - `X <https://mvnrepository.com/artifact/org.opencord/olt-api/5.2.6>`__
+ - `X <https://mvnrepository.com/artifact/org.opencord/olt-app/5.2.6>`__
+ - `X <https://mvnrepository.com/artifact/org.opencord/olt/5.2.6>`__
+ - `X <https://gerrit.opencord.org/plugins/gitiles/olt/+/refs/tags/5.2.6>`__
+ - `X <https://github.com/opencord/olt/releases/tag/5.2.6>`__
+ -
* - `olttopology <https://gerrit.opencord.org/plugins/gitiles/olttopology/>`__
- `1.3.1 <https://mvnrepository.com/artifact/org.opencord/olttopology/1.3.1>`__
- `X <https://mvnrepository.com/artifact/org.opencord/olttopology-api/1.3.1>`__