Misc doc edits
howto/code/release-bugfix.rst
-----------------------------
o Clarify a few items
release_notes/voltha_2.12.rst
-----------------------------
o Update version and URLs for component bng.
o Update version and URLs for component olttopology.
o Remove pppoeagent from the VOLTHA release matrix, present in ONOS.
Change-Id: Ib035bada96466bb526674bf5bb0869a0b11a0bc5
diff --git a/VERSION b/VERSION
index 9d44043..965c65d 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.12.19
+2.12.20
diff --git a/howto/code/linting.rst b/howto/code/linting.rst
index 78f0ce1..e500f4c 100644
--- a/howto/code/linting.rst
+++ b/howto/code/linting.rst
@@ -1,3 +1,5 @@
+.. _code--makefile-lint-targets
+
======================================
Makefile Lint Targets: Syntax Checking
======================================
diff --git a/howto/code/release-bugfix.rst b/howto/code/release-bugfix.rst
index 98679f7..498c9ab 100644
--- a/howto/code/release-bugfix.rst
+++ b/howto/code/release-bugfix.rst
@@ -88,7 +88,16 @@
# ------------------------------------------------------
% grep -i branch .gitreview
+ defaultbranch=voltha-2.12
+
+ # -------------------------------------------------------
+ # On branch=master, defaultbranch=master or will be unset
+ # -------------------------------------------------------
+ % git checkout master
+ % grep -i branch .gitreview
defaultbranch=master
+ % git checkout dev-joey
+
.. code-block:: shell-session
:caption: Tag debugging
@@ -110,6 +119,9 @@
Edit and commit
---------------
+- :ref:`pull-request--commit-message`
+- :ref:`code--makefile-lint-targets`
+
.. code-block:: shell-session
:caption: Edit, commit, rebase and review
@@ -118,7 +130,17 @@
# ----------------------------------------------------------------
{emacs,vi,$EDITOR} ...
- # :ref:`pull-request--commit-message`
+ # ----------------------------------------------------------------
+ # Sanity check for problems
+ # ----------------------------------------------------------------
+ % make help | grep lint
+ % make lint LOCAL_FIX_PERMS=1
+ % make build
+ % make test
+
+ # ----------------------------------------------------------------
+ # Create a patch for upload
+ # ----------------------------------------------------------------
% git commit -F ./commit-message
@@ -128,7 +150,6 @@
.. code-block:: shell-session
:caption: Rebase against release branch ``NOT branch=master``
- # Run one of
% git checkout "voltha-2.12"
% git pull --ff-only origin "voltha-2.12"
% git checkout dev-joey
@@ -150,11 +171,11 @@
.. code-block:: shell-session
:caption: Verify patch creation
- % git review --reviewers "foo@bar.org"
+ % git review --reviewers "foo@bar.org" "bar@tans.org"
::
-Now visit gerrit and verify your release bugfix is correctly decorated.
-In gerrit, review the 'Repo|Branch' item in the top left corner.
-'votlha-2.12' or the release tag will be visible. If branch 'master' is
-listed abandon the patch, it will not be applied to the proper branch.
+ As a cross check visit gerrit and verify your release bugfix is correctly
+ decorated. In gerrit, review the 'Repo|Branch' item in the top left corner.
+ 'votlha-2.12' or the release tag will be visible. If branch 'master' is
+ listed abandon the patch, it will not be applied to the proper branch.
diff --git a/release_notes/voltha_2.12.rst b/release_notes/voltha_2.12.rst
index 736aa32..0f7e33f 100644
--- a/release_notes/voltha_2.12.rst
+++ b/release_notes/voltha_2.12.rst
@@ -196,10 +196,10 @@
- `2.5.1 <https://mvnrepository.com/artifact/org.opencord/bng/2.5.1>`__
- `X <https://mvnrepository.com/artifact/org.opencord/bng-api/2.5.1>`__
- `X <https://mvnrepository.com/artifact/org.opencord/bng-app/2.5.1>`__
- - `X <https://mvnrepository.com/artifact/org.opencord/bng/>`__
+ - `X <https://mvnrepository.com/artifact/org.opencord/bng/2.5.1`__
- `X <https://gerrit.opencord.org/plugins/gitiles/bng/+/refs/tags/2.5.1>`__
- - `X <https://github.com/opencord/bng/tree/2.5.1>`__
- - ``N``
+ - `X <https://github.com/opencord/bng/releases/tag/2.5.1>`__
+ -+
* - `dhcpl2relay <https://gerrit.opencord.org/gitweb?p=dhcpl2relay.git;a=summary>`__
- `2.11.0 <https://mvnrepository.com/artifact/org.opencord/dhcpl2relay/2.11.0>`__
- `X <https://mvnrepository.com/artifact/org.opencord/dhcpl2relay-api/2.11.0>`__
@@ -241,21 +241,21 @@
- `X <https://github.com/opencord/mcast/releases/tag/2.9.1>`__, `T <https://github.com/opencord/mcast/tree/2.9.1>`__
-
* - `olt <https://gerrit.opencord.org/gitweb?p=olt.git;a=summary>`__
- - `5.2.5 <https://mvnrepository.com/artifact/org.opencord/olt/5.2.5>`__
+ - `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``
* - `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>`__
- `X <https://mvnrepository.com/artifact/org.opencord/olttopology-app/1.3.1>`__
- `X <https://mvnrepository.com/artifact/org.opencord/olttopology>`__
- `X <https://gerrit.opencord.org/plugins/gitiles/olttopology/+/refs/tags/1.3.1>`__
- - `X <https://github.com/opencord/olttopology/releases/tag/1.3.1>`__, `tags <https://github.com/opencord/olttopology/tags>`__, `1.3.0 <https://github.com/opencord/olttopology/releases/tag/1.3.0>`_
- - ``N``
+ - `X <https://github.com/opencord/olttopology/releases/tag/1.3.1>`__
+ -
* - `pppoeagent <https://gerrit.opencord.org/plugins/gitiles/pppoeagent/>`__
- `1.3.0 <https://mvnrepository.com/artifact/org.opencord/pppoeagent/1.3.0>`__
- `X <https://mvnrepository.com/artifact/org.opencord/pppoeagent-api/1.3.0>`__
@@ -321,7 +321,7 @@
-
-
-
- -
+ - ``N``
* - `bbsim <https://gerrit.opencord.org/gitweb?p=bbsim.git;a=tree>`__
- ``1.14.4``
- ``4.8.6``
@@ -351,17 +351,7 @@
- `1.1.4(stale) <https://hub.docker.com/layers/voltha/ofagent-go/1.1.4/images/sha256-8231111b69c8643c4981d64abff0a85d71f80763bb98632bb101e92b89882647?context=explore>`_
- `1.6.5(stale) <https://pkg.go.dev/github.com/opencord/ofagent-go/cmd/ofagent>`_
-
- - Y
- * - `openolt agent <https://gerrit.opencord.org/gitweb?p=openolt.git;a=tree>`_
-
- - ``4.2.12``
- -
- -
- - `X <https://github.com/opencord/openolt>`__
- -
- -
- -
- - ``N``
* - `voltctl <https://gerrit.opencord.org/gitweb?p=voltctl.git;a=tree>`_
- ``1.8.3``
-
@@ -382,7 +372,7 @@
- `v7 <https://pkg.go.dev/github.com/opencord/voltha-lib-go/v7>`_
`v5 <https://pkg.go.dev/github.com/opencord/voltha-lib-go/v5>`_
-
- - ``N``
+ - `VOL-526 <https://jira.opencord.org/browse/VOL-526>`_
* - `voltha-lib-go <https://gerrit.opencord.org/plugins/gitiles/voltha-lib-go>`_
- ``7.5.3``
-
@@ -443,16 +433,6 @@
-
-
- ``N``
- * - ppoeagent
- - ``1.2.1``
- -
- -
- -
- -
- -
- -
- -
- - ``N``
* - segmentrouting
- ``3.0.0``
-