user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
From: Eric Wong <e@80x24.org>
To: "Štěpán Němec" <stepnem@smrk.net>
Cc: meta@public-inbox.org
Subject: Re: [PATCH 5/5] Fix some typos/grammar/errors in docs and comments
Date: Mon, 28 Aug 2023 21:11:54 +0000	[thread overview]
Message-ID: <20230828211154.M621959@dcvr> (raw)
In-Reply-To: <20230828104246.936281-5-stepnem@smrk.net>

Štěpán Němec <stepnem@smrk.net> wrote:
> Please note the FIXME added in this patch: I lacked the confidence to
> repair that paragraph on my own.

> --- a/Documentation/public-inbox-daemon.pod
> +++ b/Documentation/public-inbox-daemon.pod
> @@ -101,6 +101,8 @@ Default: 1
>  The default TLS certificate for HTTPS, IMAPS, NNTPS, POP3S and/or STARTTLS
>  support if the C<cert> option is not given with C<--listen>.
>  
> +=for comment FIXME this paragraph needs repair
> +
>  Well-known TCP ports automatically get TLS or STARTTLS support
>  If using systemd-compatible socket activation and a TCP listener
>  on port well-known ports (563 is inherited, it is automatically

Thanks for noticing, my brain spews gibberish much of the time :x
Perhaps something like the following is clearer?

-----8<-----
Subject: [PATCH] doc: daemon: clarify TLS and well-known ports

Reported-by: Štěpán Němec <stepnem@smrk.net>
---
 Documentation/public-inbox-daemon.pod | 13 +++++--------
 1 file changed, 5 insertions(+), 8 deletions(-)

diff --git a/Documentation/public-inbox-daemon.pod b/Documentation/public-inbox-daemon.pod
index c5c88bdd..187c17d0 100644
--- a/Documentation/public-inbox-daemon.pod
+++ b/Documentation/public-inbox-daemon.pod
@@ -101,14 +101,11 @@ Default: 1
 The default TLS certificate for HTTPS, IMAPS, NNTPS, POP3S and/or STARTTLS
 support if the C<cert> option is not given with C<--listen>.
 
-=for comment FIXME this paragraph needs repair
-
-Well-known TCP ports automatically get TLS or STARTTLS support
-If using systemd-compatible socket activation and a TCP listener
-on port well-known ports (563 is inherited, it is automatically
-NNTPS when this option is given.  When a listener on port 119 is
-inherited and this option is given, it automatically gets
-STARTTLS support.
+Well-known TCP ports automatically get TLS or STARTTLS support if using
+systemd-compatible socket activation.  That is, ports 443, 563, 993, and
+995 support HTTPS, NNTPS, IMAPS, and POP3S, respectively; while ports
+110, 119, and 143 support STARTTLS on POP3, NNTP, and IMAP,
+respectively.
 
 =item --key /path/to/key
 

  reply	other threads:[~2023-08-28 21:11 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-08-28 10:42 [PATCH 1/5] ci/profiles.sh: fix case matching logic Štěpán Němec
2023-08-28 10:42 ` [PATCH 2/5] watch: remove unused variable Štěpán Němec
2023-08-28 10:42 ` [PATCH 3/5] spawn: remove stray variable $ndc_err Štěpán Němec
2023-08-28 10:42 ` [PATCH 4/5] spawn: remove distracting empty line Štěpán Němec
2023-08-28 10:42 ` [PATCH 5/5] Fix some typos/grammar/errors in docs and comments Štěpán Němec
2023-08-28 21:11   ` Eric Wong [this message]
2023-08-28 21:22     ` Štěpán Němec
2023-08-28 21:38       ` 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=20230828211154.M621959@dcvr \
    --to=e@80x24.org \
    --cc=meta@public-inbox.org \
    --cc=stepnem@smrk.net \
    /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).