[VOL-5009] - Update release notes
config.mk
makefiles/*
-----------
o Refresh library makefiles from https://github.com/opencord/onf-make.
o More lint targets added with exclusions in config.mk
makefiles/virtualenv.mk
patches/lib/python3.10/site-packages/robot/utils/normalizing.py/patch
patches/lib/python3.10/site-packages/robot/utils/robottypes3.py/patch
patches/python_310_migration.sh
---------------------------------------------------------------------
o Continue normalizing virtualenv install directory.
o Update patches to modify .venv VS vst_venv [, vdoc_venv, vfoo_venv, vbar_venv, ...)
o virtualenv.mk now defines named targets for patching-up-to 3.10 installs.
release_notes/voltha_2.12.rst
-----------------------------
o Update version string info.
o Onos component table condensed and populated with versioned urls.
o voltha components table is a WIP.
howto/release/repositories/
---------------------------
o Begin capturing repo-specific activities for release.
o Silly having to figure this out each release cycle.
o Automation and release helper scripts can be found here:
- https://github.com/joey-onf/voltha-release
sphinx_conf/exclude_patterns.py
-------------------------------
o Roach squashing exercise, external repos pulled in as git-submodules.
o New repository files appear as problems when running 'make reload'
o Exclude files to squelch messages.
Change-Id: I7adf7b84498511f5cde1e43ad304f9e33283241e
diff --git a/sphinx_conf/exclude_patterns.py b/sphinx_conf/exclude_patterns.py
index 82bf7c7..3c5fade 100644
--- a/sphinx_conf/exclude_patterns.py
+++ b/sphinx_conf/exclude_patterns.py
@@ -27,6 +27,54 @@
'CODE_OF_CONDUCT.md',
'*/CODE_OF_CONDUCT.md',
+ # -----------------------------------------------------------------------
+ # WARNING: Roach squashing exercise ahead.
+ # External repos are sub-modules, sphinx will complain when new files added.
+ # -----------------------------------------------------------------------
+ # Why are repos pulled in:
+ # - external linkage/direct viewing of the truth ?
+ # - generated content, documentation links ?
+ # -----------------------------------------------------------------------
+ # Roach squash: filter files individually as they are added or found (make lint)
+ # Simple answer: bulk exclude by subdir to catch all variants.
+ # Unknown: will the subdir exclusion break doc generation or navigation ?
+ # -----------------------------------------------------------------------
+ # 'device-management-interface/README.md',
+
+ # -----------------------------------------------------------------------
+ # Jump through hoops for this one:
+ # o openolt/ is an external repo
+ # o lint reported a problem with URL aliases ./BUILDING and .SECURITY
+ # o Cannot exclude by existing or literal path so resort to wildcard
+ # -----------------------------------------------------------------------
+
+ 'openolt/README.md',
+ # [SECURITY.md](./SECURITY.md)
+ # [BUILDING guide](BUILDING.md)
+
+ 'openolt/olt-sw-upgrade/README.md',
+ 'voltha-helm-charts/makefiles/',
+ # 'voltha-helm-charts/makefiles/README.md',
+ 'voltha-helm-charts/makefiles/README.md',
+ #
+ 'voltha-openonu-adapter-go/templates/README.md',
+ # 'device-management-interface/docs/RpcGuidelines.md',
+ 'voltha-system-tests/patches/*',
+ 'voltha-system-tests/scripts/flog/',
+ #
+ 'voltha-system-tests/etc/README.md',
+ 'voltha-system-tests/scripts/README.md',
+ #
+ 'voltctl/MULTIPLE_STACKS.md',
+ 'voltha-system-tests/tests/data/onos-files/README.md',
+ 'voltha-openonu-adapter-go/docs/ONU_Upgrade_Notes.md',
+
+ # WARNING: toctree contains reference to excluded document
+ # 'openolt/README.md',
+ # 'voltha-openonu-adapter-go/README.md',
+ 'repos/openolt/BUILDING.md',
+ 'repos/openolt/SECURITY.md',
+
# Ignore all:
'makefiles',
'__pycache__',
@@ -36,10 +84,11 @@
# Revisit: one directory pattern is sufficient.
# makefiles/virtualenv.mk normalizes all of this
- '**/doc_venv',
+ '**/doc_venv',
'**/venv_docs',
'**/virtualenv',
'**/vst_venv',
+ '**/venv_cord',
]
# [EOF]