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/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.