[PATCH xtables-addons] doc: fix quoted string in libxt_DNETMAP man-page.

[PATCH xtables-addons] doc: fix quoted string in libxt_DNETMAP man-page.

[Jeremy Sowden]

In roff, lines beginning with a single quote are control lines.  In the
libxt_DNETMAP man-page there is a single-quoted string at the beginning
of a line, which troff tries and fails to interpret as a macro:

  troff: <standard input>:49: warning: macro 'S'' not defined

This means that the line is not output.

Adjust the formatting of the paragraph to move the string from the
beginning of the line.

Fixes: 2b38d081a50b ("doc: spelling and grammar corrections to DNETMAP")
Signed-off-by: Jeremy Sowden <jeremy@azazel.net>
---
 extensions/libxt_DNETMAP.man | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/extensions/libxt_DNETMAP.man b/extensions/libxt_DNETMAP.man
index 7a8fe404435b..56cd2a68c6e6 100644
--- a/extensions/libxt_DNETMAP.man
+++ b/extensions/libxt_DNETMAP.man
@@ -45,8 +45,8 @@ The module creates the following entries for each new specified subnet:
 Contains the binding table for the given \fIsubnet/mask\fP. Each line contains
 \fBprenat address\fR, \fBpostnat address\fR, \fBttl\fR (seconds until the entry
 times out), \fBlasthit\fR (last hit to the entry in seconds relative to system
-boot time). Please note that the \fBttl\fR and \fBlasthit\fR entries contain an
-'\fBS\fR' in case of a static binding.
+boot time). Please note that the \fBttl\fR and \fBlasthit\fR entries contain
+an '\fBS\fR' in case of a static binding.
 .TP
 \fB/proc/net/xt_DNETMAP/\fR\fIsubnet\fR\fB_\fR\fImask\fR\fB_stat\fR
 Contains statistics for a given \fIsubnet/mask\fP. The line contains four
-- 
2.27.0

Re: [PATCH xtables-addons] doc: fix quoted string in libxt_DNETMAP man-page.

[Jan Engelhardt]

On Tuesday 2020-07-21 10:31, Jeremy Sowden wrote:

>In roff, lines beginning with a single quote are control lines.  In the
>libxt_DNETMAP man-page there is a single-quoted string at the beginning
>of a line, which troff tries and fails to interpret as a macro:

Is there some escaping magic available that would make this work as 
well? I would fear that if the next person (me included) comes around 
to use an editor's "wrap at 80 cols" feature, that the quote might 
re-shift to the start of line. If all else, I'd just pick " over ' - in 
the hope that that does not have a special meaning.

>-boot time). Please note that the \fBttl\fR and \fBlasthit\fR entries contain an
>-'\fBS\fR' in case of a static binding.
>+boot time). Please note that the \fBttl\fR and \fBlasthit\fR entries contain
>+an '\fBS\fR' in case of a static binding.

Re: [PATCH xtables-addons] doc: fix quoted string in libxt_DNETMAP man-page.

[Jeremy Sowden]

[-- Attachment #1: Type: text/plain, Size: 1100 bytes --]

On 2020-07-21, at 11:16:00 +0200, Jan Engelhardt wrote:
> On Tuesday 2020-07-21 10:31, Jeremy Sowden wrote:
> > In roff, lines beginning with a single quote are control lines.  In
> > the libxt_DNETMAP man-page there is a single-quoted string at the
> > beginning of a line, which troff tries and fails to interpret as a
> > macro:
>
> Is there some escaping magic available that would make this work as
> well? I would fear that if the next person (me included) comes around
> to use an editor's "wrap at 80 cols" feature, that the quote might
> re-shift to the start of line. If all else, I'd just pick " over ' -
> in the hope that that does not have a special meaning.

Good point.  I had another look at the documentation and found escape-
sequences for opening and closing single quotes.  I'll send out a new
version of the patch.

> > -boot time). Please note that the \fBttl\fR and \fBlasthit\fR entries contain an
> > -'\fBS\fR' in case of a static binding.
> > +boot time). Please note that the \fBttl\fR and \fBlasthit\fR entries contain
> > +an '\fBS\fR' in case of a static binding.

J.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]