]> git.ipfire.org Git - thirdparty/public-inbox.git/commitdiff
doc: fix some typos and grammar
authorŠtěpán Němec <stepnem@smrk.net>
Mon, 16 Oct 2023 11:33:02 +0000 (13:33 +0200)
committerEric Wong <e@80x24.org>
Tue, 17 Oct 2023 03:33:32 +0000 (03:33 +0000)
[ew: leave install/README unchanged pending wording changes]

15 files changed:
Documentation/RelNotes/v1.9.0.eml
Documentation/RelNotes/v2.0.0.wip
Documentation/lei-config.pod
Documentation/lei-daemon-kill.pod
Documentation/lei-inspect.pod
Documentation/lei-lcat.pod
Documentation/lei-ls-mail-source.pod
Documentation/lei-ls-search.pod
Documentation/lei-mail-sync-overview.pod
Documentation/lei-q.pod
Documentation/lei-security.pod
Documentation/lei-store-format.pod
Documentation/lei-up.pod
TODO
lib/PublicInbox/XapHelperCxx.pm

index 2d83cbfec66b28b8a92e1d2e03997615c75f4b30..08e16a669a11595cd624e5c5073fee8429d6ec91 100644 (file)
@@ -46,7 +46,7 @@ Search improvements:
   * patchid: prefix search support added to WWW and lei for
     "git patch-id --stable" support
 
-  * text inside base-85 binary patches are no longer indexed
+  * text inside base-85 binary patches is no longer indexed
     to avoid false positives
 
   * for lei users, "lei reindex" now exists and is required
index 40c87169ccd91f36a62db5bd9fd062cf72fa214b..859d858bd1e1ec33e2972f6100e54d1b24eb6728 100644 (file)
@@ -57,11 +57,11 @@ lei
 
   * compatibility with SQLite <3.8.3 on CentOS 7.x
 
-  * fix `lei q -tt' on locally-indexed messages (still broken for remotes:
+  * fix `lei q -tt' on locally indexed messages (still broken for remotes:
     https://public-inbox.org/meta/20230226170931.M947721@dcvr/ )
 
   * `lei import' now sets labels+keywords consistently on all
-     already-imported messages
+     already imported messages
 
 solver (used by lei (rediff|blob), and PublicInbox::WWW)
 
@@ -101,7 +101,7 @@ PublicInbox::SaPlugin::ListMirror
 
 Search improvements (lei and PublicInbox::WWW)
 
-  * quoted text inside base-85 binary patches are no longer indexed
+  * quoted text inside base-85 binary patches is no longer indexed
 
 Thanks to all the bug reporters and users who made this release
 possible.
index 23a60c8a6b7c98a35c675e266f6c2d3c3b75ffb7..699f45cbf6908926d86da5a70eba9f90b345a180 100644 (file)
@@ -64,8 +64,8 @@ L<https://rt.cpan.org/Ticket/Display.html?id=129967>
 
 Enable debugging output of underlying IMAP and NNTP libraries,
 currently L<Mail::IMAPClient> and L<Net::NNTP>, respectively.
-If using L<imap.proxy> or L<nntp.proxy> point to a SOCKS proxy,
-debugging output for L<IO::Socket::Socks> will be enabled, as
+If L<imap.proxy> or L<nntp.proxy> points to a SOCKS proxy,
+debugging output for L<IO::Socket::Socks> will be enabled as
 well.
 
 Disabling L<imap.compress> may be required for readability.
@@ -104,7 +104,7 @@ C<frag>, C<func>, and C<context>.
 =head1 OPTIONS
 
 Most L<git-config(1)> command-line switches are accepted by C<lei config>
-as-is.  The most-frequently-used options are expected to be:
+as is.  The most frequently used options are expected to be:
 
 =over 4
 
@@ -112,7 +112,7 @@ as-is.  The most-frequently-used options are expected to be:
 
 =item --edit
 
-Opens an editor to edit the lei config file
+Open an editor to edit the lei config file.
 
 =item -l
 
index 48c237b8d3a6052ab943a683f34288c6d5371943..97a81e23f973d56239b00bd256aa19e259e2082e 100644 (file)
@@ -31,7 +31,7 @@ remain running after a short while after this takes effect.
 =back
 
 =for comment
-SIGQUIT and SIGINT currently do what SIGTERM do, may change...
+SIGQUIT and SIGINT currently do what SIGTERM does, may change...
 
 =head1 CONTACT
 
index 19dd8ab5edef210ee658af664405c52af400a382..82b9651adeb54ede014ac3911b7089a6b076b088 100644 (file)
@@ -26,7 +26,7 @@ An inboxdir, extindex topdir, or Xapian shard
 
 =item --pretty
 
-Pretty print output.  If stdout is opened to a tty, C<--pretty> is
+Pretty-print output.  If stdout is opened to a tty, C<--pretty> is
 enabled by default.
 
 =item -
@@ -47,7 +47,7 @@ L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
 
 =head1 COPYRIGHT
 
-Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
+Copyright all contributors L<mailto:meta@public-inbox.org>
 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 
index e80738626b5152fefcfcad192c2c036531d794e2..530b755ebfb2bdef3c8fb3abc8bd3b761e0f56f9 100644 (file)
@@ -31,7 +31,7 @@ C<-f text> when writing to stdout.
 
 Most commonly C<text> (the default) or C<reply> to
 display the message(s) in a format suitable for trimming
-and sending as a email reply.
+and sending as an email reply.
 
 =item --stdin
 
index 59d14afe688068a250c881a589e5a0b869dc1e96..0e4859236e5640f8bd434dc2c8a24a4bf7dcc66d 100644 (file)
@@ -28,7 +28,7 @@ Format output as JSON and include more information.
 
 =item --pretty
 
-Pretty print JSON output.  If stdout is opened to a tty, C<--pretty>
+Pretty-print JSON output.  If stdout is opened to a tty, C<--pretty>
 is enabled by default.
 
 =item --ascii
index 0fe4b759513486dff416e720c7d7938722d0050f..367f4ad6d3d34504be44dbbfe1eb47b80ce6fa70 100644 (file)
@@ -26,7 +26,7 @@ C<jsonl>, or C<concatjson>.
 
 =item --pretty
 
-Pretty print C<json> or C<concatjson> output.  If stdout is opened to
+Pretty-print C<json> or C<concatjson> output.  If stdout is opened to
 a tty and used as the C<--output> destination, C<--pretty> is enabled
 by default.
 
index e30674bbdff48504c13d1004abd1b61cbfb07a61..7ae7e8872350656c4d395b398e1b112071e90bb0 100644 (file)
@@ -20,7 +20,7 @@ Future work will be done to improve it and add IMAP IDLE support.
   # 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
+  # Open /tmp/results in your favorite mail agent.  If inotify or kevent
   # works, keyword changes (e.g. marking messages as `seen') are
   # synchronized automatically.
 
index c0254ba0bb1ac81cc0c525399f9473ddd98c77db..5f5338490b0772929dac1cf36be702dd4a1bca34 100644 (file)
@@ -80,7 +80,7 @@ Disable color (for C<-f reply> and C<-f text>).
 
 =item --pretty
 
-Pretty print C<json> or C<concatjson> output.  If stdout is opened to
+Pretty-print C<json> or C<concatjson> output.  If stdout is opened to
 a tty and used as the C<--output> destination, C<--pretty> is enabled
 by default.
 
@@ -218,7 +218,7 @@ Default: fcntl,dotlock
 
 =item -n NUMBER
 
-Fuzzy limit the number of matches per-local external and lei/store.
+Fuzzy-limit the number of matches per local external and lei/store.
 Messages added by the L<--threads> switch do not count towards this
 limit, and there is no limit on remote externals.
 
index 104bfb48a26cd4ffb5493ae02d8638a3f99f675c..e54cae90f0c065fc757b75c32cae23f0a239d89f 100644 (file)
@@ -4,7 +4,7 @@ lei - security information
 
 =head1 SYNOPSIS
 
-L<lei(1)> is intended for use with both publicly-archived
+L<lei(1)> is intended for use with both publicly archived
 and "private" mail in personal mailboxes.  This document is
 intended to give an overview of security implications and
 lower^Wmanage user expectations.
@@ -66,7 +66,7 @@ other users on the local system.
 
 =head1 CORE DUMPS
 
-In case any process crashes, a core dumps may contain passwords or
+In case any process crashes, a core dump may contain passwords or
 contents of sensitive messages.  Please report these so they can be
 fixed (see L</CONTACT>).
 
@@ -74,7 +74,7 @@ fixed (see L</CONTACT>).
 
 lei currently uses the L<curl(1)> and L<git(1)> executables in
 C<$PATH> for HTTP and HTTPS network access.  Interactive
-authentication for HTTP and HTTPS is not-yet-supported since all
+authentication for HTTP and HTTPS is not yet supported since all
 currently supported HTTP/HTTPS sources are L<PublicInbox::WWW>
 instances.
 
@@ -83,7 +83,7 @@ L<Net::NNTP> (standard library) is used for NNTP and NNTPS.
 
 L<Mail::IMAPClient> and L<Net::NNTP> will use L<IO::Socket::SSL>
 for TLS if available.  In turn, L<IO::Socket::SSL> uses the
-widely-installed OpenSSL library.
+widely installed OpenSSL library.
 
 STARTTLS will be attempted if advertised by the server
 unless IMAPS or NNTPS are used.  C<-c imap.starttls=0>
index 625c60f436a8cb3361e905f30e3b4c0a12239252..d4bb42d5fa67c360b6e15d074ea22806ea1f3699 100644 (file)
@@ -67,7 +67,7 @@ the "same" message.
 
 =head2 mail_sync.sqlite3
 
-This SQLite database maintained for bidirectional mapping of
+This SQLite database is maintained for bidirectional mapping of
 git blobs to IMAP UIDs, Maildir file names, and NNTP article numbers.
 
 It is also used for retrieving messages from Maildirs indexed by
index 3b7c6f46fed64eb2170e16e25a4b3827025451fe..8c426942640fe368dbbdc2e880682a0f06632a4c 100644 (file)
@@ -32,8 +32,8 @@ delays or downtime.
 The time(s) of the last successful queries are the C<lastresult>
 values visible from L<lei-edit-search(1)>.
 
-Date formats understood by L<git-rev-parse(1)> may be used.
-e.g C<1.hour> or C<3.days>
+Date formats understood by L<git-rev-parse(1)> may be used,
+e.g., C<1.hour> or C<3.days>.
 
 Default: 2.days
 
diff --git a/TODO b/TODO
index de628e2e310ae38f6f55687d7c564fc78fb9b94c..36a7f0cf441ac6cdd7ec4a50ab5dd5a6b83877d4 100644 (file)
--- a/TODO
+++ b/TODO
@@ -26,7 +26,7 @@ all need to be considered for everything we introduce.)
   archive locations to avoid SPOF.
 
 * optional Cache::FastMmap support so production deployments won't
-  need Varnish (Varnish doesn't protect NNTP nor IMAP, either)
+  need Varnish (Varnish doesn't protect NNTP or IMAP, either)
 
 * dogfood and take advantage of new kernel APIs (while maintaining
   portability to older Linux, free BSDs and maybe Hurd).
index 90ddd80fd53dd1fa766ace9fad93843d351eb023..dbb0a9154a36a6f58ac4db788eb47df5bac444d9 100644 (file)
@@ -36,7 +36,7 @@ sub xap_cfg (@) {
        seek($err, 0, SEEK_SET) or die "seek: $!";
        $err = do { local $/; <$err> };
        die <<EOM;
-@$cmd failed: Xapian devlopment files missing? (\$?=$?)
+@$cmd failed: Xapian development files missing? (\$?=$?)
 $err
 EOM
 }