From 21643101eb11297202d185a937ae8bd0df97cab2 Mon Sep 17 00:00:00 2001
From: Franco Fichtner <franco@opnsense.org>
Date: Wed, 2 Mar 2022 11:00:06 +0100
Subject: [PATCH] interfaces: annotate device dependency issue #5540

The scope for this is larger (VLAN/QinQ/LAGG) so here we just try
to raise awareness for future refactor if other device types.
---
 src/etc/inc/interfaces.inc | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/etc/inc/interfaces.inc b/src/etc/inc/interfaces.inc
index 8e7f0ff73..2b8cb4f23 100644
--- a/src/etc/inc/interfaces.inc
+++ b/src/etc/inc/interfaces.inc
@@ -765,6 +765,7 @@ function interfaces_configure($verbose = false)
         foreach ($list as $device => $if) {
             /* pre-op: configuring the underlying device */
             if (!empty($devices[$device])) {
+                /* XXX devices could depend on other devices */
                 log_msg("Device $device required for $if, configuring now", LOG_ERR);
                 call_user_func_array($devices[$device], [$device]);
                 unset($devices[$device]);
@@ -786,6 +787,7 @@ function interfaces_configure($verbose = false)
 
     /* last but not least start all unconfigured devices */
     foreach ($devices as $name => $function) {
+        /* XXX devices could depend on other devices */
         log_msg("Device $name is not assigned, configuring late", LOG_ERR);
         call_user_func_array($function, [$name]);
     }