From d23024177f5dd8101d9efb59de466c20fdf89cdd Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Fri, 24 Sep 2021 12:51:07 +0000 Subject: doc: lei-overview: implicit stdin, correct Inline::C notes Implicit stdin based on standard input being a pipe or regular file is here to stay, so save users the trouble of typing '-' or '--stdin'. Inline::C is required as of commit 1d6e1f9a6a66 (lei: require Socket::MsgHdr or Inline::C, drop oneshot, 2021-05-26); but Socket::MsgHdr still gives a noticeable improvement in bash completion speed. Also, spell-out "MESSAGE-ID" since "MID" is actually not a common abbreviation ("MSGID" is used by RFC 3977 and several other RFCs, I recall). --- Documentation/lei-overview.pod | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index e80cb094..40a7b0aa 100644 --- a/Documentation/lei-overview.pod +++ b/Documentation/lei-overview.pod @@ -33,7 +33,7 @@ Show message with the git blob OID of 59ec517f9. If a message with that OID isn't found, check if the current git repository has the blob, trying to reconstruct it from a message if needed. -=item $ lei blob 59ec517f9 | lei tag - -F eml +kw:flagged +L:next +=item $ lei blob 59ec517f9 | lei tag -F eml +kw:flagged +L:next Set the "flagged" keyword and "next" label on the message with the blob OID of 59ec517f9. @@ -92,18 +92,18 @@ and written. Search for all flagged messages that also have a "next" label. -=item $ lei p2q HEAD | lei q --stdin -tt -o /tmp/mdir +=item $ lei p2q HEAD | lei q -tt -o /tmp/mdir Search for messages that have post-image git blob IDs that match those of the current repository's HEAD commit, writing them to the Maildir directory "mdir" and flagging the messages that were an exact match. -=item $ git show -s HEAD | lei lcat - +=item $ git show -s HEAD | lei lcat Display a local message for the public-inbox link contained in a commit message. -=item $ lei q -f text m:MID | lei rediff -U5 - +=item $ lei q -f text m:MESSAGE-ID | lei rediff -U5 Feed a message containing a diff to L to regenerate its diff with five context lines. Unless C<--git-dir> is specified, this @@ -114,13 +114,15 @@ code repository. =head1 PERFORMANCE NOTES -L is recommended for performance. To enable it, create -C<~/.cache/public-inbox/inline-c/>. +L is required, lei runs as a background daemon to reduce +startup costs and can provide real-time L/L +Maildir monitoring. L (p5-IO-KQueue on FreeBSD) and +L (liblinux-inotify2-perl and perl-Linux-Inotify2 in +.deb and .rpm-based distros, respectively) are recommended. -If Socket::MsgHdr is installed (libsocket-msghdr-perl in Debian), the -first invocation of lei starts a daemon, reducing the startup cost of -for future invocations (which is particularly important for Bash -completion). +L is optional (libsocket-msghdr-perl in Debian), +and further improves startup performance. Its effect is most felt +when using shell completion. =head1 BASH COMPLETION -- cgit v1.2.3-24-ge0c7