lib-program-client: Document the purpose of the use_dotstream setting.

diff --git a/src/lib-program-client/program-client.h b/src/lib-program-client/program-client.h
index 4fa335a38ba166f88d008eee66c45683571241bb..0d4275df210acc50d1c563d98f1faa1916a37329 100644 (file)
--- a/src/lib-program-client/program-client.h
+++ b/src/lib-program-client/program-client.h
@@ -22,7 +22,11 @@ struct program_client_settings {
        bool allow_root:1;
        bool debug:1;
        bool drop_stderr:1;
-       /* use o_stream_dot */
+       /* use o_stream_dot, which is mainly useful to make sure that an
+          unexpectedly closed connection doesn't cause the partial input to
+          be accepted as valid and complete program input. This is always
+          enabled for 'net' program clients, which may likely encounter
+          unexpected connection termination. */
        bool use_dotstream:1;
 };