Minor howto and release doc additions
howto/code/voltha-protos.rst
----------------------------
- Document virtualenv setup and lint command.
- Include notes about header longintrepr.h, early VGC related failure.
howto/release/overview.rst
--------------------------
- Review release overview docs for content.
- URL will be linked to from the wiki release tracking page.
Change-Id: I1f45834bb445ba2cc31de33cc4b45653db91f111
diff --git a/howto/code/voltha-protos.rst b/howto/code/voltha-protos.rst
index 71da5e1..9420b0c 100644
--- a/howto/code/voltha-protos.rst
+++ b/howto/code/voltha-protos.rst
@@ -13,7 +13,6 @@
-------------------------
.. code:: bash
-
git clone ssh://gerrit.opencord.org:29418/voltha-protos.git
cd voltha-protos
vi ...
@@ -96,3 +95,38 @@
* - make lint LOCAL_FIX_PERMS=1
- | Syntax check sources for problems prior to checkin.
| LOCAL_FIX_PERMS=1 (optional) can workaround docker related permission problems.
+
+Problems with pip install
+-------------------------
+
+- grpcio `VOL-5348 <https://jira.opencord.org/browse/VOL-5348>`__
+
+ - Clone repo.
+ - Create a skeleton pytyon virtualenv.
+ - From requirements.txt file entries, pip install failing versioned package.
+
+.. code:: bash
+ :caption: Pip install debugging
+
+ # Debug using virtualenv
+ % virtualenv -p python3 .venv
+ % source .venv/bin/activate
+ % pip install grpcio==1.39.0
+
+ # Debug using makefile target 'venv'
+ % echo > requirements.txt
+ % make venv
+ % git checkout requirements.txt
+ % pip install -r requirements.txt
+
+longintrepr.h
+^^^^^^^^^^^^^
+
+.. code:: bash
+ :caption: Include missing header
+
+ mkdir -p include
+ pusdh include
+ find /usr/include -name 'longintrepr.h' -print0 | xargs -0 -I'{}' ln -s {} .
+ popd include
+ export CFLAGS='-I./include'
diff --git a/howto/release/overview.rst b/howto/release/overview.rst
index 1977568..95041e7 100644
--- a/howto/release/overview.rst
+++ b/howto/release/overview.rst
@@ -1,5 +1,5 @@
-Release overview (WIP)
-======================
+Release overview
+================
For a VOLTHA release several actions and patches are applied to each repository.
Release also happens in a hierarchial manner due to dependencies.
@@ -12,10 +12,13 @@
- For release create an initial baseline build to verify no pre-existing corruption or test failures are present.
- - Baseline builds contain bulk cosmetic changes which may include:
+ - Baseline builds contain no logic changes, only bulk cosmetic changes which may include:
- Copyright notice ending date change.
- - Cosmetic comemnt changes in source.
+
+ - Bulk edit scripts: `gather-and-update.sh <https://github.com/joey-onf/copyright/blob/origin/master/gather-and-update.sh>`_, `morph.pl <https://github.com/joey-onf/copyright/blob/origin/master/morph.pl>`_.
+
+ - Cosmetic comment changes in source.
- Syntax formatting (gofmt -s -e -w)
- Baseline builds may also remove suffixes like -dev from the VERSION file.
@@ -37,6 +40,10 @@
- Update go.mod version strings to be appropriate for branch={voltha-2.12, master}
+- Extra credit
+
+ - Run the `pre-commit hook script <https://pre-commit.com/>`_ and cleanup any linting problems reported.
+
NOTE
::
@@ -57,3 +64,9 @@
- Add document references to existing release pages.
- Link to repo dependencies in howto/release/repositories
+
+See Also
+--------
+
+- https://docs.voltha.org/master/release_notes/template.html?highlight=howto
+- `Release Notes <https://docs.voltha.org/master/release_notes/index.html>`_: `template <https://docs.voltha.org/master/release_notes/template.html>`