about summary refs log tree commit homepage
path: root/Documentation/public-inbox-watch.pod
diff options
context:
space:
mode:
authorAlyssa Ross <hi@alyssa.is>2019-10-09 13:21:14 +0000
committerEric Wong <e@80x24.org>2019-10-10 08:46:24 +0000
commit8d3e3bd820f8177557281554470e9fbbc3a7487b (patch)
treee8f809f0b9b948fc9dcfbd8a1d85bbdf1622cbf4 /Documentation/public-inbox-watch.pod
parent2968a77518b7c7cae5df702233dc83e4a559c3a9 (diff)
downloadpublic-inbox-8d3e3bd820f8177557281554470e9fbbc3a7487b.tar.gz
doc: explain publicinbox.<name>.watchheader
It wasn't clear to me exactly what this does -- in particular, what
happens if it isn't specified?  Does it support multiple values?  A
very brief explanation can answer both of these questions without
making somebody look at the code.
Diffstat (limited to 'Documentation/public-inbox-watch.pod')
-rw-r--r--Documentation/public-inbox-watch.pod4
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod
index 3f282f0f..198c170a 100644
--- a/Documentation/public-inbox-watch.pod
+++ b/Documentation/public-inbox-watch.pod
@@ -15,7 +15,11 @@ In ~/.public-inbox/config:
                 mainrepo = /path/to/test.example.com.git
 
                 ; config keys specific to public-inbox-watch:
+
                 watch = maildir:/path/to/maildirs/.INBOX.test/
+
+                ; optional, emails that don't have a header matching
+                ; value will be skipped
                 watchheader = List-Id:<test.example.com>
 
         [publicinboxwatch]