docs: for add_to_config_reload_watch_list

refs: #989
wez · Aug 11, 2021 · 40cb141 · 40cb141
1 parent 8cc90dc
commit 40cb141
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -75,6 +75,7 @@ As features stabilize some brief notes about them will accumulate here.
 * Fixed: macOS: bright window padding on Intel-based macs [#653](https://github.com/wez/wezterm/issues/653), [#716](https://github.com/wez/wezterm/issues/716) and [#1000](https://github.com/wez/wezterm/issues/1000)
 * Improved: wezterm now uses the Dual Source Blending feature of OpenGL to manage subpixel anti-aliasing alpha blending, resulting in improved appearance particularly when using a transparent window over the top of something with a light background. [#932](https://github.com/wez/wezterm/issues/932)
 * Fixed: copying really long lines could falsely introduce line breaks on line wrap boundaries [#874](https://github.com/wez/wezterm/issues/874)
+* New: [wezterm.add_to_config_reload_watch_list](config/lua/wezterm/add_to_config_reload_watch_list.md) function to aid with automatically reloading the config when you've split your config across multiple files. Thanks to [@AusCyberman](https://github.com/AusCyberman)! [#989](https://github.com/wez/wezterm/pull/989)
 
 ### 20210502-154244-3f7122cb
 

diff --git a/docs/config/lua/wezterm/add_to_config_reload_watch_list.md b/docs/config/lua/wezterm/add_to_config_reload_watch_list.md
@@ -0,0 +1,11 @@
+# wezterm.add_to_config_reload_watch_list(path)
+
+*Since: nightly builds only*
+
+Adds `path` to the list of files that are watched for config changes.
+If [automatically_reload_config](../config/automatically_reload_config.md)
+is enabled, then the config will be reloaded when any of the files
+that have been added to the watch list have changed.
+
+The intent of for this to be used together with a custom lua loader
+in a future iteration of wezterm.