From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS20473 45.76.80.0/20 X-Spam-Status: No, score=-3.3 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.6 Received: from mail.smrk.net (mail.smrk.net [45.76.87.244]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA512) (No client certificate requested) by dcvr.yhbt.net (Postfix) with ESMTPS id 95D3C1F406 for ; Mon, 16 Oct 2023 11:33:10 +0000 (UTC) Authentication-Results: dcvr.yhbt.net; dkim=pass (2048-bit key; unprotected) header.d=smrk.net header.i=@smrk.net header.a=rsa-sha256 header.s=20221002 header.b=i99LuufB; dkim-atps=neutral DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=smrk.net; s=20221002; t=1697455974; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=tKHpKJoyAcGdLKKbkYddBekfKQ3ddW9nExmaUBoPEno=; b=i99LuufBm0E/B7qafeHpkbMnXNaQ6/xw+iQUbKznVREsjAGxLdavXpWSYs4J/OTa4wHPkO aHOhBp0a3b4eFelkfQyaJV9Wtl19JSZv0fZd5tWaPh0J9D6Ukl6okSiHrWFmNwOMud1hNk jKp44Nmy1aToJ4PoSJeRgJXMvErhqD284ouCOonkmGi6+YyAe+wXoveDvV25zIHtlRymv3 XZ6aYlof59jtV6vWvlk6NhoW62klEYpR0025ax55Gec4EkxUdLTGKHnSBNzw33F8TQkbIs putmlS1bPGXJOr5xcMreu/r/LevhSLBqxjeOe3OePc+haM96U1xbl0+YJNvIHg== Received: from localhost ( [192.168.5.2]) by smrk (OpenSMTPD) with ESMTPSA id 5e000257 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Mon, 16 Oct 2023 13:32:54 +0200 (CEST) From: =?UTF-8?q?=C5=A0t=C4=9Bp=C3=A1n=20N=C4=9Bmec?= To: meta@public-inbox.org Subject: [PATCH 1/3] doc: fix some typos and grammar Date: Mon, 16 Oct 2023 13:33:02 +0200 Message-ID: <20231016113304.2788497-1-stepnem@smrk.net> X-Mailer: git-send-email 2.42.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: --- Documentation/RelNotes/v1.9.0.eml | 2 +- Documentation/RelNotes/v2.0.0.wip | 6 +++--- Documentation/lei-config.pod | 8 ++++---- Documentation/lei-daemon-kill.pod | 2 +- Documentation/lei-inspect.pod | 4 ++-- Documentation/lei-lcat.pod | 2 +- Documentation/lei-ls-mail-source.pod | 2 +- Documentation/lei-ls-search.pod | 2 +- Documentation/lei-mail-sync-overview.pod | 2 +- Documentation/lei-q.pod | 4 ++-- Documentation/lei-security.pod | 8 ++++---- Documentation/lei-store-format.pod | 2 +- Documentation/lei-up.pod | 4 ++-- TODO | 2 +- install/README | 2 +- lib/PublicInbox/XapHelperCxx.pm | 2 +- 16 files changed, 27 insertions(+), 27 deletions(-) diff --git a/Documentation/RelNotes/v1.9.0.eml b/Documentation/RelNotes/v1.9.0.eml index 2d83cbfec66b..08e16a669a11 100644 --- a/Documentation/RelNotes/v1.9.0.eml +++ b/Documentation/RelNotes/v1.9.0.eml @@ -46,7 +46,7 @@ * 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 diff --git a/Documentation/RelNotes/v2.0.0.wip b/Documentation/RelNotes/v2.0.0.wip index 40c87169ccd9..859d858bd1e1 100644 --- a/Documentation/RelNotes/v2.0.0.wip +++ b/Documentation/RelNotes/v2.0.0.wip @@ -57,11 +57,11 @@ * 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 @@ 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. diff --git a/Documentation/lei-config.pod b/Documentation/lei-config.pod index 23a60c8a6b7c..699f45cbf690 100644 --- a/Documentation/lei-config.pod +++ b/Documentation/lei-config.pod @@ -64,8 +64,8 @@ L Enable debugging output of underlying IMAP and NNTP libraries, currently L and L, respectively. -If using L or L point to a SOCKS proxy, -debugging output for L will be enabled, as +If L or L points to a SOCKS proxy, +debugging output for L will be enabled as well. Disabling L may be required for readability. @@ -104,7 +104,7 @@ C, C, and C. =head1 OPTIONS Most L command-line switches are accepted by C -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 diff --git a/Documentation/lei-daemon-kill.pod b/Documentation/lei-daemon-kill.pod index 48c237b8d3a6..97a81e23f973 100644 --- a/Documentation/lei-daemon-kill.pod +++ b/Documentation/lei-daemon-kill.pod @@ -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 diff --git a/Documentation/lei-inspect.pod b/Documentation/lei-inspect.pod index 19dd8ab5edef..82b9651adeb5 100644 --- a/Documentation/lei-inspect.pod +++ b/Documentation/lei-inspect.pod @@ -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 =head1 COPYRIGHT -Copyright 2021 all contributors L +Copyright all contributors L License: AGPL-3.0+ L diff --git a/Documentation/lei-lcat.pod b/Documentation/lei-lcat.pod index e80738626b51..530b755ebfb2 100644 --- a/Documentation/lei-lcat.pod +++ b/Documentation/lei-lcat.pod @@ -31,7 +31,7 @@ C<-f text> when writing to stdout. Most commonly C (the default) or C 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 diff --git a/Documentation/lei-ls-mail-source.pod b/Documentation/lei-ls-mail-source.pod index 59d14afe6880..0e4859236e56 100644 --- a/Documentation/lei-ls-mail-source.pod +++ b/Documentation/lei-ls-mail-source.pod @@ -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 diff --git a/Documentation/lei-ls-search.pod b/Documentation/lei-ls-search.pod index 0fe4b7595134..367f4ad6d3d3 100644 --- a/Documentation/lei-ls-search.pod +++ b/Documentation/lei-ls-search.pod @@ -26,7 +26,7 @@ C, or C. =item --pretty -Pretty print C or C output. If stdout is opened to +Pretty-print C or C output. If stdout is opened to a tty and used as the C<--output> destination, C<--pretty> is enabled by default. diff --git a/Documentation/lei-mail-sync-overview.pod b/Documentation/lei-mail-sync-overview.pod index e30674bbdff4..7ae7e8872350 100644 --- a/Documentation/lei-mail-sync-overview.pod +++ b/Documentation/lei-mail-sync-overview.pod @@ -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. diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod index c0254ba0bb1a..5f5338490b07 100644 --- a/Documentation/lei-q.pod +++ b/Documentation/lei-q.pod @@ -80,7 +80,7 @@ Disable color (for C<-f reply> and C<-f text>). =item --pretty -Pretty print C or C output. If stdout is opened to +Pretty-print C or C 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. diff --git a/Documentation/lei-security.pod b/Documentation/lei-security.pod index 104bfb48a26c..e54cae90f0c0 100644 --- a/Documentation/lei-security.pod +++ b/Documentation/lei-security.pod @@ -4,7 +4,7 @@ lei - security information =head1 SYNOPSIS -L is intended for use with both publicly-archived +L 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). @@ -74,7 +74,7 @@ fixed (see L). lei currently uses the L and L 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 instances. @@ -83,7 +83,7 @@ L (standard library) is used for NNTP and NNTPS. L and L will use L for TLS if available. In turn, L 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> diff --git a/Documentation/lei-store-format.pod b/Documentation/lei-store-format.pod index 625c60f436a8..d4bb42d5fa67 100644 --- a/Documentation/lei-store-format.pod +++ b/Documentation/lei-store-format.pod @@ -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 diff --git a/Documentation/lei-up.pod b/Documentation/lei-up.pod index 3b7c6f46fed6..8c426942640f 100644 --- a/Documentation/lei-up.pod +++ b/Documentation/lei-up.pod @@ -32,8 +32,8 @@ delays or downtime. The time(s) of the last successful queries are the C values visible from L. -Date formats understood by L may be used. -e.g C<1.hour> or C<3.days> +Date formats understood by L may be used, +e.g., C<1.hour> or C<3.days>. Default: 2.days diff --git a/TODO b/TODO index de628e2e310a..36a7f0cf441a 100644 --- 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). diff --git a/install/README b/install/README index 981e014b9959..e1b5558e0b87 100644 --- a/install/README +++ b/install/README @@ -5,7 +5,7 @@ TL;DR: sudo ./install/deps.perl all Files in this directory are designed for: -* users using from git or tarballs (and not the OS package manager) +* users using git repo or tarballs (and not the OS package manager) * lazy users who can't be bothered to read all of INSTALL diff --git a/lib/PublicInbox/XapHelperCxx.pm b/lib/PublicInbox/XapHelperCxx.pm index 90ddd80fd53d..dbb0a9154a36 100644 --- a/lib/PublicInbox/XapHelperCxx.pm +++ b/lib/PublicInbox/XapHelperCxx.pm @@ -36,7 +36,7 @@ sub xap_cfg (@) { seek($err, 0, SEEK_SET) or die "seek: $!"; $err = do { local $/; <$err> }; die <