Re: [PATCH] Drop accidental macro definition in postconf.5

[Wietse Venema]

Christian G?ttsche:
> Groff interprets lines staring with a single quote as commands.
> Enclose in double quotes instead.
> 
> Found by Lintian:
> 
>     groff-message usr/share/man/man5/postconf.5.gz (line 1) 13368: warning: 
> macro 'close'' not defined
> 
> See the line in question missing at 
> https://manpages.debian.org/bullseye/postfix/postconf.5.en.html
> ---
>  man/man5/postconf.5 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/man/man5/postconf.5 b/man/man5/postconf.5
> index e48c7cb..3cdf4c9 100644
> --- a/man/man5/postconf.5
> +++ b/man/man5/postconf.5
> @@ -13742,7 +13742,7 @@ This feature is available in Postfix 2.3 and later.
>  A workaround for implementations that hang Postfix while shutting
>  down a TLS session, until Postfix times out. With this enabled,
>  Postfix will not wait for the remote TLS peer to respond to a TLS
> -'close' notification. This behavior is recommended for TLSv1.0 and
> +"close" notification. This behavior is recommended for TLSv1.0 and
>  later.

Someone sent a patch last month to replace \' with '. So that's why
this is happening now.

Unfortunately, your fix is unmaintainable. The nroff 'man' source
is generated from HTML, and when that HTML is updated, a quote that
was originally in the middle of a line may end up at the beginning
of a line.

The fix is to change the scripts that convert from HTML or source
comment into nroff 'man' source, so that they prepend for example
\& (non-printing zero-width) to a line that would start with '.

The patch looks like a teletype output after decoding analog noise.
It reminds me of my first days with UNIX.

        Wietse

diff --exclude=man --exclude=html --exclude=README_FILES --exclude=INSTALL 
--exclude=.indent.pro -r -ur 
/var/tmp/postfix-3.7-20220103/mantools/postconf2man ./mantools/postconf2man
--- /var/tmp/postfix-3.7-20220103/mantools/postconf2man 2020-07-25 
18:29:16.000000000 -0400
+++ ./mantools/postconf2man     2022-01-05 14:16:07.000000000 -0500
@@ -38,6 +38,7 @@
     # Even \134 comes out as \e. What brain damage is this?
     #$block =~ s/\n\./\n\\\&./g;
     $block =~ s/\n\./\n\134\&./g;
+    $block =~ s/\n'/\n\134\&'/g;
     if ($block =~ /<H2>/) {
        $block =~ s/<H2><a[^>]+>([^<]+)<\/a><\/H2>/\n.SH \1\n/g;
        $block =~ tr/a-z/A-Z/;
diff --exclude=man --exclude=html --exclude=README_FILES --exclude=INSTALL 
--exclude=.indent.pro -r -ur /var/tmp/postfix-3.7-20220103/mantools/srctoman 
./mantools/srctoman
--- /var/tmp/postfix-3.7-20220103/mantools/srctoman     2016-02-06 
20:03:01.000000000 -0500
+++ ./mantools/srctoman 2022-01-05 14:52:46.000000000 -0500
@@ -103,6 +103,9 @@
     /^\./{
        s/\([^ ]\)-/\1\\-/g
     }
+    /^'"'"'/{
+       s/^/\\\&/
+    }
     /^[^.]/{
        s/-/\\-/g
     }