add doc/global-wait.md

2 files changed, 35 insertions, 0 deletions

diff --git a/doc/global-wait.md b/doc/global-wait.md
new file mode 100644
index 0000000..9fcaa96
--- /dev/null
+++ b/doc/global-wait.md
@@ -0,0 +1,34 @@
+Wait for configuration und functions
+====================================
+
+[◀ Go back to main README](../README.md)
+
+Description
+-----------
+
+The global scripts `global-config`, `global-config-overlay` and
+`global-functions` are run by scheduler at system startup. Running another
+script at system startup may result in race condition where configuration
+and/or function are not yet available. This script is supposed to wait
+for everything being prepared.
+
+Requirements and installation
+-----------------------------
+
+Just install the script:
+
+    $ScriptInstallUpdate global-wait;
+
+... and add it to your scheduler, for example in combination with
+[bridge-port](bridge-port.md):
+
+    / system scheduler add name=bridge-port-to-default on-event="/ system script { run global-wait; run bridge-port-to-default; }" start-time=startup;
+
+See also
+--------
+
+* [Manage ports in bridge](bridge-port.md)
+
+---
+[◀ Go back to main README](../README.md)  
+[▲ Go back to top](#top)
diff --git a/global-wait b/global-wait
index 29d634d..7e3cc6c 100644
--- a/global-wait
+++ b/global-wait
@@ -3,6 +3,7 @@
 # Copyright (c) 2020 Christian Hesse <mail@eworm.de>
 #
 # wait for global-functions to finish
+# https://git.eworm.de/cgit/routeros-scripts/about/doc/global-wait.md
 
 :global GlobalFunctionsReady;