From: Kyle Meyer <kyle@kyleam.com>
To: meta@public-inbox.org
Subject: [PATCH 3/3] doc: lei-overview: add performance and bash completion sections
Date: Sat, 27 Feb 2021 13:03:28 -0500 [thread overview]
Message-ID: <20210227180328.28057-4-kyle@kyleam.com> (raw)
In-Reply-To: <20210227180328.28057-1-kyle@kyleam.com>
Take care of a couple of the items mentioned at
<https://public-inbox.org/meta/20210218202818.GA19443@dcvr>.
---
Documentation/lei-overview.pod | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod
index 62b62280ad2ddd69..c3379caa1bd15d69 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>
--
2.30.1
next prev parent reply other threads:[~2021-02-27 18:03 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-27 18:03 [PATCH 0/3] doc: lei manpages, round 3 Kyle Meyer
2021-02-27 18:03 ` [PATCH 1/3] doc: lei: update manpages Kyle Meyer
2021-02-27 18:03 ` [PATCH 2/3] doc: lei-import: drop markup of "stdin" Kyle Meyer
2021-02-27 18:03 ` Kyle Meyer [this message]
2021-02-27 20:20 ` [PATCH 0/3] doc: lei manpages, round 3 Eric Wong
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://public-inbox.org/README
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210227180328.28057-4-kyle@kyleam.com \
--to=kyle@kyleam.com \
--cc=meta@public-inbox.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).