Re: [PATCH 1/2] doc: add lei-mail-sync-overview manpage

[Eric Wong <e@80x24.org>]

Kyle Meyer <kyle@kyleam.com> wrote:
> Eric Wong writes:
> > +++ b/Documentation/lei-export-kw.pod
> > @@ -12,6 +12,9 @@ lei export-kw MFOLDER [MFOLDER...]
> >  
> >  C<lei export-kw> propagates keywords (e.g. C<seen>, C<answered>,
> >  C<flagged>, etc.) from lei/store to IMAP folders and/or Maildirs.
> > +It only works for messages lei knows about (e.g. was used as a
> > +C<lei q --output>, or imported via L<lei-import(1)>, or indexed
> > +via L<lei-index(1)>.
> 
> The closing paren is missing here.

Yup.

> > +++ b/Documentation/lei-index.pod
> > @@ -20,6 +20,9 @@ Combined with L<lei-q(1)>, C<lei index> allows Maildir users to
> >  have similar functionality to L<mairix(1)> by not duplicating
> >  messages into C<lei/store>.
> >  
> > +Occasional invocations of C<lei-refresh-mail-sync --all=local>
> > +is recommended to keep indexed messages retrievable.
> 
> "Occasional invocations ... is" -> "Occasional invocations ... are"?
> 
> Or perhaps "Occasionally invoking ... is"

I think I'll go with "are"

> > +=head1 TYPICAL WORKFLOW
> > +
> > +  # import mail from a user's IMAP inbox and give it the "inbox" label:
> > +  lei import +L:inbox imaps://user@example.com/INBOX
> > +
> > +  # dump "inbox" labeled files from the past week to a Maildir
> > +  lei q L:inbox rt:last.week.. -o /tmp/results
> > +
> > +  # open /tmp/results in your favorite mail agent.  If inotify or kevent
> > +  # works, keyword changes (e.g. marking messages as `seen').
> 
> Is this part incomplete (maybe "are synchronized" is missing at the
> end)?

Yes, "are synchronized automatically".  Will squash the
following in, thanks:

diff --git a/Documentation/lei-export-kw.pod b/Documentation/lei-export-kw.pod
index b6d175f1..4cb673ac 100644
--- a/Documentation/lei-export-kw.pod
+++ b/Documentation/lei-export-kw.pod
@@ -14,7 +14,7 @@ C<lei export-kw> propagates keywords (e.g. C<seen>, C<answered>,
 C<flagged>, etc.) from lei/store to IMAP folders and/or Maildirs.
 It only works for messages lei knows about (e.g. was used as a
 C<lei q --output>, or imported via L<lei-import(1)>, or indexed
-via L<lei-index(1)>.
+via L<lei-index(1)>).
 
 It does not delete, write, nor modify messages themselves;
 it only sets metadata on Maildirs and IMAP folders.
diff --git a/Documentation/lei-index.pod b/Documentation/lei-index.pod
index de088538..f8ff6950 100644
--- a/Documentation/lei-index.pod
+++ b/Documentation/lei-index.pod
@@ -21,7 +21,7 @@ have similar functionality to L<mairix(1)> by not duplicating
 messages into C<lei/store>.
 
 Occasional invocations of C<lei-refresh-mail-sync --all=local>
-is recommended to keep indexed messages retrievable.
+are recommended to keep indexed messages retrievable.
 
 =head1 OPTIONS
 
diff --git a/Documentation/lei-mail-sync-overview.pod b/Documentation/lei-mail-sync-overview.pod
index dfe1034c..e30674bb 100644
--- a/Documentation/lei-mail-sync-overview.pod
+++ b/Documentation/lei-mail-sync-overview.pod
@@ -21,7 +21,8 @@ Future work will be done to improve it and add IMAP IDLE support.
   lei q L:inbox rt:last.week.. -o /tmp/results
 
   # open /tmp/results in your favorite mail agent.  If inotify or kevent
-  # works, keyword changes (e.g. marking messages as `seen').
+  # works, keyword changes (e.g. marking messages as `seen') are
+  # synchronized automatically.
 
   # If the inotify queue overflows, or if lei-daemon crashes,
   # "lei index" will tell lei about keyword changes: