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 4e8ba4da2fc873f7a855d70fa46dc3e4e93c5714..8d545f7afa247339653b72ceb13183aa749fc70d 100644 (file)
--- 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 3f282f0f1bbdc1310ebee9788ab8be5138eb6056..198c170a6951c94d5bf18e24109a13818d3dd9c7 100644 (file)
--- 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]