add comments clarifying bridge reasons

canonical · Oct 16, 2024 · 5c34c30 · 5c34c30
1 parent dd942d5
commit 5c34c30
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/subiquity/models/source.py b/subiquity/models/source.py
@@ -67,7 +67,12 @@ def __attrs_post_init__(self):
 
 
 class BridgeKernelReason(enum.Enum):
+    # When bridge_reasons contains "drivers", some driver packages are known to
+    # be behind, so we should fall back to the bridge kernel.
     DRIVERS = "drivers"
+    # When bridge_reasons contains "zfs", we should use the bridge kernel as
+    # the default kernel is not yet known to the kernel team to be sufficiently
+    # stable.
     ZFS = "zfs"
 
 

diff --git a/subiquity/server/controllers/kernel.py b/subiquity/server/controllers/kernel.py
@@ -113,6 +113,9 @@ def _confirmed(self):
 
     def _drivers_decided(self):
         drivers_controller = self.app.controllers.Drivers
+        # while the term DRIVERS is used here, only some drivers are expected
+        # to trigger bridge kernel fallback, and only then if DRIVERS is listed
+        # as one of the bridge_reasons.
         self._maybe_set_bridge_kernel(
             BridgeKernelReason.DRIVERS,
             drivers_controller.model.do_install