From: Alyssa Ross <hi@alyssa.is>
Date: Wed, 9 Oct 2019 13:21:14 +0000 (+0000)
Subject: doc: explain publicinbox.<name>.watchheader
X-Git-Tag: v1.2.0~49
X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=commitdiff_plain;h=8d3e3bd820f8177557281554470e9fbbc3a7487b

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.
---

diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index 4e8ba4da..8d545f7a 100644
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -80,6 +80,9 @@ Default: none; only for L<public-inbox-watch(1)> users
 	[publicinbox "test"]
 		watchheader = List-Id:<test.example.com>
 
+If specified, L<public-inbox-watch(1)> will only process mail matching
+the given header.  Multiple values are not currently supported.
+
 Default: none; only for L<public-inbox-watch(1)> users
 
 =item publicinbox.<name>.nntpmirror
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]