Daf rename fix (#45)

* hanges for Branch rename Signed-off-by: David Ferguson <[email protected]> * Added to accomodate branch rename from master -> main Signed-off-by: David Ferguson <[email protected]> * Improve typesetting Signed-off-by: David Ferguson <[email protected]> * Remove some trailing whitespace Signed-off-by: David Ferguson <[email protected]> --------- Signed-off-by: David Ferguson <[email protected]>
omec-project · Oct 17, 2024 · ee7c67a · ee7c67a
1 parent 4074eb1
commit ee7c67a
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/conf.py b/conf.py
@@ -71,8 +71,11 @@ def get_version():
 prep_commands = [
 ]
 
-# include only the branches matching master and sdcore-*
-smv_branch_whitelist = r'^(master|sdcore-.*)$'
+# include only the branches matching main and sdcore-*
+# Note, we changed 'master' to 'main', so 'master' may show up repeatedly in
+# documentation.  Simply use 'main' where you expect to see 'master' branch 
+# items.
+smv_branch_whitelist = r'^(main|sdcore-.*)$'
 
 # Don't include any tags - smv docs say you can put None here, but that is broken
 # https://github.com/Holzhaus/sphinx-multiversion/issues/47

diff --git a/release/process.rst b/release/process.rst
@@ -5,6 +5,11 @@
 Release Process
 ===============
 
+NOTE -- On or around Oct 16, 2024, the 'master' branch was renamed to be
+'main'.  Interpret documentation and expectations accordingly.  Not all
+references were updated to reflect the change.  Hopefully, all build
+statements were.
+
 Prerequisites
 -------------
 
@@ -36,7 +41,7 @@ All docker images are tagged based on their git tags.
 
 * For released versions, the CI system should prevent a Dockerfile from
   referencing a parent containers that are a moving target, such as ``latest``
-  or ``master``.
+  or ``main``.
 
   * This allows a container to be rebuilt given an arbitrary git commit with
     fair confidence that it will result in the same code in the container.