From ab89b1654e9de0a2e71775bf88f401fd4c41044c Mon Sep 17 00:00:00 2001 From: Sean Whalen Date: Fri, 20 Mar 2026 20:12:25 -0400 Subject: [PATCH] Enhance usage documentation for config reload: clarify behavior on successful reload and error handling --- docs/source/usage.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/source/usage.md b/docs/source/usage.md index cd4640e..2883f13 100644 --- a/docs/source/usage.md +++ b/docs/source/usage.md @@ -666,8 +666,15 @@ Mailbox connection settings (IMAP host/credentials, Microsoft Graph, Gmail API, Maildir path) are **not** reloaded — changing those still requires a full restart. -If the new configuration file contains errors, the reload is aborted -and the previous configuration remains active. Check the logs for +On a **successful** reload, existing output client connections are +closed and new ones are created from the updated configuration. The +service then resumes watching with the new settings. + +If the new configuration file contains errors (missing required +settings, unreachable output destinations, etc.), the **entire reload +is aborted** — no output clients are replaced and the previous +configuration remains fully active. This means a typo in one section +will not take down an otherwise working setup. Check the logs for details: ```bash