Bug#1042358: openvswitch: FTBFS: make[3]: *** [Makefile:6743: manpage-check] Error 1
On 8/7/23 16:57, Colin Watson wrote: On Mon, Aug 07, 2023 at 04:45:30PM +0200, Thomas Goirand wrote: Ok, so if there's only 5 patches, not 6, then I should be able to manage (even though it's not the best convenient way). Thanks for your patches. I think I possibly understand what you meant now. Is this more convenient? I managed to upload the package with your fixes yesterday. Thanks a lot for your help, I probably would have spend a lot of time not knowing how to patch. Cheers, Thomas Goirand (zigo)
Bug#1042358: openvswitch: FTBFS: make[3]: *** [Makefile:6743: manpage-check] Error 1
On Mon, Aug 07, 2023 at 04:45:30PM +0200, Thomas Goirand wrote:
> Ok, so if there's only 5 patches, not 6, then I should be able to manage
> (even though it's not the best convenient way). Thanks for your patches.
I think I possibly understand what you meant now. Is this more
convenient?
--
Colin Watson (he/him) [cjwat...@debian.org]
>From 45a2a2245f6c73dc6898f63c8d30ffd138920066 Mon Sep 17 00:00:00 2001
From: Colin Watson
Date: Fri, 4 Aug 2023 18:22:31 +0100
Subject: [PATCH v2 0/5] docs: Fix manpage-check warnings with groff 1.23.0
https://bugs.debian.org/1042358 reported a manpage-check failure with
groff 1.23.0 in Debian testing/unstable. Fixing the immediate mistake
here exposed a few other issues in how the tables in ovs-fields(7) are
rendered.
Colin Watson (5):
docs: Wrap more table entries in text blocks
docs: Shorten overly-wide table heading
docs: Tweak width of name column in field property tables
docs: Fix rendering of VLAN Comparison Chart
docs: Run tbl preprocessor in manpage-check rule
Makefile.am | 2 +-
build-aux/extract-ofp-fields | 20 ++--
lib/meta-flow.xml| 25 +
3 files changed, 28 insertions(+), 19 deletions(-)
--
2.39.2
>From 97fb673b2b09747beabe8625ac86dbfc5aa0c023 Mon Sep 17 00:00:00 2001
From: Colin Watson
Date: Fri, 4 Aug 2023 11:19:06 +0100
Subject: [PATCH v2 1/5] docs: Wrap more table entries in text blocks
This fixes a number of "table wider than line length minus indentation"
warnings from tbl. The table cells are too narrow for centered text to
look good, so left-align the contents of the text blocks.
Reported-by: Lucas Nussbaum
Reported-at: https://bugs.debian.org/1042358
Signed-off-by: Colin Watson
---
build-aux/extract-ofp-fields | 12
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/build-aux/extract-ofp-fields b/build-aux/extract-ofp-fields
index efec59c25..2f566d2b9 100755
--- a/build-aux/extract-ofp-fields
+++ b/build-aux/extract-ofp-fields
@@ -189,12 +189,14 @@ def field_to_xml(field_node, f, body, summary):
ovs_version = [int(x) for x in ovs_version_s.split(".")]
if min_ovs_version is None or ovs_version < min_ovs_version:
min_ovs_version = ovs_version
-summary += ["\\fB%s\\fR" % f["name"]]
+summary += ["T{\n.ad l\n\\fB%s\\fR" % f["name"]]
if f["extra_name"]:
summary += [" aka \\fB%s\\fR" % f["extra_name"]]
-summary += [";%d" % f["n_bytes"]]
+summary += ["\nT}"]
+summary += [";T{\n.ad l\n%d" % f["n_bytes"]]
if f["n_bits"] != 8 * f["n_bytes"]:
summary += [" (low %d bits)" % f["n_bits"]]
+summary += ["\nT}"]
summary += [";%s;" % {"MFM_NONE": "no", "MFM_FULLY": "yes"}[f["mask"]]]
summary += ["%s;" % {True: "yes", False: "no"}[f["writable"]]]
summary += ["%s;" % f["prereqs"]]
@@ -203,7 +205,7 @@ def field_to_xml(field_node, f, body, summary):
support += ["OF %s+" % VERSION_REVERSE[min_of_version]]
if min_ovs_version is not None:
support += ["OVS %s+" % ".".join([str(x) for x in min_ovs_version])]
-summary += " and ".join(support)
+summary += ["T{\n.ad l\n", " and ".join(support), "\nT}"]
summary += ["\n"]
# Full description.
@@ -230,8 +232,10 @@ l lx.
body += ["Width:;"]
if f["n_bits"] != 8 * f["n_bytes"]:
body += [
+"T{\n",
"%d bits (only the least-significant %d bits "
-"may be nonzero)" % (f["n_bytes"] * 8, f["n_bits"])
+"may be nonzero)" % (f["n_bytes"] * 8, f["n_bits"]),
+"\nT}",
]
elif f["n_bits"] <= 128:
body += ["%d bits" % f["n_bits"]]
--
2.39.2
>From 36207097b0c3de75d562b93e666c54f954da763c Mon Sep 17 00:00:00 2001
From: Colin Watson
Date: Fri, 4 Aug 2023 18:01:55 +0100
Subject: [PATCH v2 2/5] docs: Shorten overly-wide table heading
Using "NXM/OXM Support" makes these tables a little too wide to fit well
when rendered in 80 columns, causing warnings from groff. There's
already some abbreviation going on here (e.g. "RW?"), so "NXM/OXM?"
seems acceptable.
Reported-by: Lucas Nussbaum
Reported-at: https://bugs.debian.org/1042358
Signed-off-by: Colin Watson
---
build-aux/extract-ofp-fields | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/build-aux/extract-ofp-fields b/build-aux/extract-ofp-fields
index 2f566d2b9..808c6527d 100755
--- a/build-aux/extract-ofp-fields
+++ b/build-aux/extract-ofp-fields
@@ -323,7 +323,7 @@ def group_xml_to_nroff(group_node, fields):
".TS\n",
"tab(;);\n",
"l l l l l l l.\n",
-"Name;Bytes;Mask;RW?;Prereqs;NXM/OXM Support\n",
+"Name;Bytes;Mask;RW?;Prereqs;NXM/OXM?\n",
"\_;\_;\_;\_;\_;\_\n",
]
content += summary
--
2.39.2
>From 7622daa80dad932cab11febfc8afa6a78b1f84ac Mon Sep 17 00:00:00 2001
From: Colin Watson
Date: Fri, 4 Aug 2023 18:18:01 +0100
Subject:
Bug#1042358: openvswitch: FTBFS: make[3]: *** [Makefile:6743: manpage-check] Error 1
On 8/7/23 12:10, Colin Watson wrote: On Mon, Aug 07, 2023 at 10:54:52AM +0200, Thomas Goirand wrote: I very much appreciate that you've sent patches for this bug, thanks for this. However, it is difficult to apply your patches because they are sent inline, and therefore hard to save on disk. Also, I would have done the work by hand to avoid annoying you, but your "Message part 2" doesn't contain the patch at all, only a diffstat. Could you send me the 6 patches as separate files, so I could more easily add them to debian/patches? Or at least send the first patch that's completely missing... I don't mind sending you patches in a different format if it's helpful, but I'm confused; I _did_ send them as separate files, MIME-encapsulated. How else would I have sent them as separate files? The "PATCH v2 0/5" message is a cover letter for the patch set. It's not supposed to contain a patch itself. Cheers, Hi, Ok, so if there's only 5 patches, not 6, then I should be able to manage (even though it's not the best convenient way). Thanks for your patches. Cheers, Thomas Goirand (zigo)
Bug#1042358: openvswitch: FTBFS: make[3]: *** [Makefile:6743: manpage-check] Error 1
On Mon, Aug 07, 2023 at 10:54:52AM +0200, Thomas Goirand wrote: > I very much appreciate that you've sent patches for this bug, thanks for > this. However, it is difficult to apply your patches because they are sent > inline, and therefore hard to save on disk. Also, I would have done the work > by hand to avoid annoying you, but your "Message part 2" doesn't contain > the patch at all, only a diffstat. > > Could you send me the 6 patches as separate files, so I could more easily > add them to debian/patches? Or at least send the first patch that's > completely missing... I don't mind sending you patches in a different format if it's helpful, but I'm confused; I _did_ send them as separate files, MIME-encapsulated. How else would I have sent them as separate files? The "PATCH v2 0/5" message is a cover letter for the patch set. It's not supposed to contain a patch itself. Cheers, -- Colin Watson (he/him) [cjwat...@debian.org]
Bug#1042358: openvswitch: FTBFS: make[3]: *** [Makefile:6743: manpage-check] Error 1
Hi Colin, I very much appreciate that you've sent patches for this bug, thanks for this. However, it is difficult to apply your patches because they are sent inline, and therefore hard to save on disk. Also, I would have done the work by hand to avoid annoying you, but your "Message part 2" doesn't contain the patch at all, only a diffstat. Could you send me the 6 patches as separate files, so I could more easily add them to debian/patches? Or at least send the first patch that's completely missing... Cheers, Thomas Goirand (zigo)
Bug#1042358: openvswitch: FTBFS: make[3]: *** [Makefile:6743: manpage-check] Error 1
On Fri, Aug 04, 2023 at 12:54:31PM +0100, Colin Watson wrote:
> On Wed, Jul 26, 2023 at 10:21:34PM +0200, Lucas Nussbaum wrote:
> > > an.tmac:lib/ovs-fields.7:762: warning: tbl preprocessor failed, or it or
> > > soelim was not run; table(s) likely not rendered (TE macro called with TW
> > > register undefined)
>
> I've sent a patch set for this upstream. It's currently waiting for
> mailing list moderation, but I've attached the messages here.
Frode Nordahl pointed out that this patch set introduces warnings with
earlier versions of groff. Here's an updated version that doesn't.
--
Colin Watson (he/him) [cjwat...@ubuntu.com]
--- Begin Message ---
https://bugs.debian.org/1042358 reported a manpage-check failure with
groff 1.23.0 in Debian testing/unstable. Fixing the immediate mistake
here exposed a few other issues in how the tables in ovs-fields(7) are
rendered.
Colin Watson (5):
docs: Wrap more table entries in text blocks
docs: Shorten overly-wide table heading
docs: Tweak width of name column in field property tables
docs: Fix rendering of VLAN Comparison Chart
docs: Run tbl preprocessor in manpage-check rule
Makefile.am | 2 +-
build-aux/extract-ofp-fields | 20 ++--
lib/meta-flow.xml| 25 +
3 files changed, 28 insertions(+), 19 deletions(-)
--
2.39.2
--- End Message ---
--- Begin Message ---
This fixes a number of "table wider than line length minus indentation"
warnings from tbl. The table cells are too narrow for centered text to
look good, so left-align the contents of the text blocks.
Reported-by: Lucas Nussbaum
Reported-at: https://bugs.debian.org/1042358
Signed-off-by: Colin Watson
---
build-aux/extract-ofp-fields | 12
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/build-aux/extract-ofp-fields b/build-aux/extract-ofp-fields
index efec59c25..2f566d2b9 100755
--- a/build-aux/extract-ofp-fields
+++ b/build-aux/extract-ofp-fields
@@ -189,12 +189,14 @@ def field_to_xml(field_node, f, body, summary):
ovs_version = [int(x) for x in ovs_version_s.split(".")]
if min_ovs_version is None or ovs_version < min_ovs_version:
min_ovs_version = ovs_version
-summary += ["\\fB%s\\fR" % f["name"]]
+summary += ["T{\n.ad l\n\\fB%s\\fR" % f["name"]]
if f["extra_name"]:
summary += [" aka \\fB%s\\fR" % f["extra_name"]]
-summary += [";%d" % f["n_bytes"]]
+summary += ["\nT}"]
+summary += [";T{\n.ad l\n%d" % f["n_bytes"]]
if f["n_bits"] != 8 * f["n_bytes"]:
summary += [" (low %d bits)" % f["n_bits"]]
+summary += ["\nT}"]
summary += [";%s;" % {"MFM_NONE": "no", "MFM_FULLY": "yes"}[f["mask"]]]
summary += ["%s;" % {True: "yes", False: "no"}[f["writable"]]]
summary += ["%s;" % f["prereqs"]]
@@ -203,7 +205,7 @@ def field_to_xml(field_node, f, body, summary):
support += ["OF %s+" % VERSION_REVERSE[min_of_version]]
if min_ovs_version is not None:
support += ["OVS %s+" % ".".join([str(x) for x in min_ovs_version])]
-summary += " and ".join(support)
+summary += ["T{\n.ad l\n", " and ".join(support), "\nT}"]
summary += ["\n"]
# Full description.
@@ -230,8 +232,10 @@ l lx.
body += ["Width:;"]
if f["n_bits"] != 8 * f["n_bytes"]:
body += [
+"T{\n",
"%d bits (only the least-significant %d bits "
-"may be nonzero)" % (f["n_bytes"] * 8, f["n_bits"])
+"may be nonzero)" % (f["n_bytes"] * 8, f["n_bits"]),
+"\nT}",
]
elif f["n_bits"] <= 128:
body += ["%d bits" % f["n_bits"]]
--
2.39.2
--- End Message ---
--- Begin Message ---
Using "NXM/OXM Support" makes these tables a little too wide to fit well
when rendered in 80 columns, causing warnings from groff. There's
already some abbreviation going on here (e.g. "RW?"), so "NXM/OXM?"
seems acceptable.
Reported-by: Lucas Nussbaum
Reported-at: https://bugs.debian.org/1042358
Signed-off-by: Colin Watson
---
build-aux/extract-ofp-fields | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/build-aux/extract-ofp-fields b/build-aux/extract-ofp-fields
index 2f566d2b9..808c6527d 100755
--- a/build-aux/extract-ofp-fields
+++ b/build-aux/extract-ofp-fields
@@ -323,7 +323,7 @@ def group_xml_to_nroff(group_node, fields):
".TS\n",
"tab(;);\n",
"l l l l l l l.\n",
-"Name;Bytes;Mask;RW?;Prereqs;NXM/OXM Support\n",
+"Name;Bytes;Mask;RW?;Prereqs;NXM/OXM?\n",
"\_;\_;\_;\_;\_;\_\n",
]
content += summary
--
2.39.2
--- End Message ---
--- Begin Message ---
groff 1.23.0 has difficulty with hyphenating a number of the entries in
the name column of these tables when rendering in 80-column terminals.
Setting a minimum width for this column gives it an easier time.
Reported-by: Lucas Nussbaum
Reported-at: https://bugs.debian.org/1042358
Bug#1042358: openvswitch: FTBFS: make[3]: *** [Makefile:6743: manpage-check] Error 1
Control: tag -1 patch
On Wed, Jul 26, 2023 at 10:21:34PM +0200, Lucas Nussbaum wrote:
> > an.tmac:lib/ovs-fields.7:762: warning: tbl preprocessor failed, or it or
> > soelim was not run; table(s) likely not rendered (TE macro called with TW
> > register undefined)
I've sent a patch set for this upstream. It's currently waiting for
mailing list moderation, but I've attached the messages here.
--
Colin Watson (he/him) [cjwat...@debian.org]
--- Begin Message ---
https://bugs.debian.org/1042358 reported a manpage-check failure with
groff 1.23.0 in Debian testing/unstable. Fixing the immediate mistake
here exposed a few other issues in how the tables in ovs-fields(7) are
rendered.
Colin Watson (3):
docs: Wrap more table entries in text blocks
docs: Fix rendering of VLAN Comparison Chart
docs: Run tbl preprocessor in manpage-check rule
Makefile.am | 2 +-
build-aux/extract-ofp-fields | 14 +-
lib/meta-flow.xml| 25 +
3 files changed, 23 insertions(+), 18 deletions(-)
--
2.40.1
--- End Message ---
--- Begin Message ---
This fixes a number of "table wider than line length minus indentation"
warnings from tbl.
Reported-by: Lucas Nussbaum
Reported-at: https://bugs.debian.org/1042358
Signed-off-by: Colin Watson
---
build-aux/extract-ofp-fields | 14 +-
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/build-aux/extract-ofp-fields b/build-aux/extract-ofp-fields
index efec59c25..7b5863829 100755
--- a/build-aux/extract-ofp-fields
+++ b/build-aux/extract-ofp-fields
@@ -189,12 +189,14 @@ def field_to_xml(field_node, f, body, summary):
ovs_version = [int(x) for x in ovs_version_s.split(".")]
if min_ovs_version is None or ovs_version < min_ovs_version:
min_ovs_version = ovs_version
-summary += ["\\fB%s\\fR" % f["name"]]
+summary += ["T{\n\\fB%s\\fR" % f["name"]]
if f["extra_name"]:
summary += [" aka \\fB%s\\fR" % f["extra_name"]]
-summary += [";%d" % f["n_bytes"]]
+summary += ["\nT}"]
+summary += [";T{\n%d" % f["n_bytes"]]
if f["n_bits"] != 8 * f["n_bytes"]:
summary += [" (low %d bits)" % f["n_bits"]]
+summary += ["\nT}"]
summary += [";%s;" % {"MFM_NONE": "no", "MFM_FULLY": "yes"}[f["mask"]]]
summary += ["%s;" % {True: "yes", False: "no"}[f["writable"]]]
summary += ["%s;" % f["prereqs"]]
@@ -203,7 +205,7 @@ def field_to_xml(field_node, f, body, summary):
support += ["OF %s+" % VERSION_REVERSE[min_of_version]]
if min_ovs_version is not None:
support += ["OVS %s+" % ".".join([str(x) for x in min_ovs_version])]
-summary += " and ".join(support)
+summary += ["T{\n", " and ".join(support), "\nT}"]
summary += ["\n"]
# Full description.
@@ -230,8 +232,10 @@ l lx.
body += ["Width:;"]
if f["n_bits"] != 8 * f["n_bytes"]:
body += [
+"T{\n",
"%d bits (only the least-significant %d bits "
-"may be nonzero)" % (f["n_bytes"] * 8, f["n_bits"])
+"may be nonzero)" % (f["n_bytes"] * 8, f["n_bits"]),
+"\nT}",
]
elif f["n_bits"] <= 128:
body += ["%d bits" % f["n_bits"]]
@@ -319,7 +323,7 @@ def group_xml_to_nroff(group_node, fields):
".TS\n",
"tab(;);\n",
"l l l l l l l.\n",
-"Name;Bytes;Mask;RW?;Prereqs;NXM/OXM Support\n",
+"Name;Bytes;Mask;RW?;Prereqs;T{\nNXM/OXM Support\nT}\n",
"\_;\_;\_;\_;\_;\_\n",
]
content += summary
--
2.40.1
--- End Message ---
--- Begin Message ---
tbl defaults to expecting table entries to be separated by tab
characters. However, commit 5a0e4aec1af5cf7741c490bce704577e51e536b9
converted these to spaces and inadvertently broke the rendering. Use
semicolons as separators instead; these are less prone to being broken
by tree-wide changes, and match the style used by
build-aux/extract-ofp-fields.
Reported-by: Lucas Nussbaum
Reported-at: https://bugs.debian.org/1042358
Signed-off-by: Colin Watson
---
lib/meta-flow.xml | 25 +
1 file changed, 13 insertions(+), 12 deletions(-)
diff --git a/lib/meta-flow.xml b/lib/meta-flow.xml
index bdd12f6a7..0ac182be1 100644
--- a/lib/meta-flow.xml
+++ b/lib/meta-flow.xml
@@ -3517,23 +3517,24 @@ actions=clone(load:0->NXM_OF_IN_PORT[],output:123)
+tab(;);
r r r r r.
-CriteriaOpenFlow 1.0OpenFlow 1.1OpenFlow 1.2+ NXM
-\_ \_ \_ \_ \_
-[1] \fL\fR/\fL1\fR,\fL??\fR/\fL?\fR
\fL\fR/\fL1\fR,\fL??\fR/\fL?\fR \fL\fR/\fL\fR,\fL--\fR
\fL\fR/\fL\fR
-[2] \fL\fR/\fL0\fR,\fL??\fR/\fL?\fR
\fL\fR/\fL0\fR,\fL??\fR/\fL?\fR \fL\fR/\fL\fR,\fL--\fR
\fL\fR/\fL\fR
-[3] \fL0xxx\fR/\fL0\fR,\fL??\fR/\fL1\fR
\fL0xxx\fR/\fL0\fR,\fL??\fR/\fL1\fR \fL1xxx\fR/\fL\fR,\fL--\fR
\fL1xxx\fR/\fL1fff\fR
-[4]
