]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: lei-overview: add performance and bash completion sections
authorKyle Meyer <kyle@kyleam.com>
Sat, 27 Feb 2021 18:03:28 +0000 (13:03 -0500)
committerEric Wong <e@80x24.org>
Sat, 27 Feb 2021 20:18:44 +0000 (16:18 -0400)
Take care of a couple of the items mentioned at
<https://public-inbox.org/meta/20210218202818.GA19443@dcvr>.

Documentation/lei-overview.pod

index 62b62280ad2ddd69f28c4b401eb8a0270ffd250b..c3379caa1bd15d69eea1cbfb4c582cfa38722491 100644 (file)
@@ -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>