From: Kyle Meyer <kyle@kyleam.com>
Date: Sat, 27 Feb 2021 18:03:28 +0000 (-0500)
Subject: doc: lei-overview: add performance and bash completion sections
X-Git-Tag: v1.7.0~1050
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=b4603182d50456dc410093efd4d921078559fd42;hp=ee308223d51344a3d8557bf42229c289652045d8;p=public-inbox.git

doc: lei-overview: add performance and bash completion sections

Take care of a couple of the items mentioned at
<https://public-inbox.org/meta/20210218202818.GA19443@dcvr>.
---

diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod
index 62b62280..c3379caa 100644
--- a/Documentation/lei-overview.pod
+++ b/Documentation/lei-overview.pod
@@ -71,6 +71,23 @@ file by invoking C<mutt -f %f>.
 
 =back
 
+=head1 PERFORMANCE NOTES
+
+L<Inline::C> is recommended for performance.  To enable it, create
+C<~/.cache/public-inbox/inline-c/>.
+
+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).
+
+=head1 BASH COMPLETION
+
+Preliminary Bash completion for lei is provided in
+C<contrib/completion/>.  Contributions adding support for other
+shells, as well as improvements to the existing Bash completion, are
+welcome.
+
 =head1 CONTACT
 
 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>