From 47b88550be46c2d217c0384f1635f6c7478b618f Mon Sep 17 00:00:00 2001
From: Mechiel Lukkien <mechiel@ueber.net>
Date: Fri, 10 Mar 2023 11:42:50 +0100
Subject: [PATCH] add a little explanation about sconf, the config file syntax

---
 config/doc.go | 5 +++++
 gendoc.sh     | 5 +++++
 2 files changed, 10 insertions(+)

diff --git a/config/doc.go b/config/doc.go
index 6b801f7..cf5511c 100644
--- a/config/doc.go
+++ b/config/doc.go
@@ -2,6 +2,11 @@
 Package config holds the configuration file definitions for mox.conf (Static)
 and domains.conf (Dynamic).
 
+These config files are in "sconf" format.  Summarized: Indent with tabs, "#" as
+first non-whitespace character makes the line a comment (you cannot have a line
+with both a value and a comment), strings are not quoted/escaped and can never
+span multiple lines. See https://pkg.go.dev/github.com/mjl-/sconf for details.
+
 Annotated empty/default configuration files you could use as a starting point
 for your mox.conf and domains.conf, as generated by "mox config
 describe-static" and "mox config describe-domains":
diff --git a/gendoc.sh b/gendoc.sh
index 013735e..4647c7e 100755
--- a/gendoc.sh
+++ b/gendoc.sh
@@ -45,6 +45,11 @@ cat <<EOF
 Package config holds the configuration file definitions for mox.conf (Static)
 and domains.conf (Dynamic).
 
+These config files are in "sconf" format.  Summarized: Indent with tabs, "#" as
+first non-whitespace character makes the line a comment (you cannot have a line
+with both a value and a comment), strings are not quoted/escaped and can never
+span multiple lines. See https://pkg.go.dev/github.com/mjl-/sconf for details.
+
 Annotated empty/default configuration files you could use as a starting point
 for your mox.conf and domains.conf, as generated by "mox config
 describe-static" and "mox config describe-domains":