]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: lei-add-watch: add warning about unreliability
authorEric Wong <e@80x24.org>
Thu, 28 Oct 2021 11:14:59 +0000 (11:14 +0000)
committerEric Wong <e@80x24.org>
Thu, 28 Oct 2021 19:17:11 +0000 (19:17 +0000)
This needs work at some point in the future.

Documentation/lei-add-watch.pod

index 609846181578371916e5753c1948d5a4ffb1bd8d..1b48b43b589c0f89f6bd1e0ed94d1bac4a11a6e6 100644 (file)
@@ -11,6 +11,11 @@ lei add-watch [OPTIONS] LOCATION [LOCATION...]
 Tell lei to watch C<LOCATION> for new messages and flag changes.
 Currently only Maildir locations are supported.
 
+WARNING: watches are not always reliable, occasional use
+of L<lei-index(1)> and L<lei-refresh-mail-sync(1)> is recommended
+if L<lei-daemon(8)> crashes or needs to be restarted.  This will
+be improved in the future.
+
 =for comment
 TODO: Document --state?  Believe valid values are pause, import-ro,
 
@@ -23,11 +28,10 @@ L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
 
 =head1 COPYRIGHT
 
-Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
+Copyright all contributors L<mailto:meta@public-inbox.org>
 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 
-
 =head1 SEE ALSO
 
 L<lei-ls-watch(1)>, L<lei-rm-watch(1)>