diff mbox series

[ovs-dev] docs: handle multi line headers for nroff

Message ID 20200213172727.1360871-1-ihrachys@redhat.com
State New
Headers show
Series [ovs-dev] docs: handle multi line headers for nroff | expand

Commit Message

Ihar Hrachyshka Feb. 13, 2020, 5:27 p.m. UTC
Before the fix, headers split into multiple lines were producing bogus
quote characters in nroff output and failed to indent headers properly.

Specifically, it fixes a header and its indentation in
ovn-architecture(7).

Signed-off-by: Ihar Hrachyshka <ihrachys@redhat.com>
---
 python/build/nroff.py | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

Comments

Ben Pfaff Feb. 13, 2020, 7:08 p.m. UTC | #1
On Thu, Feb 13, 2020 at 12:27:27PM -0500, Ihar Hrachyshka wrote:
> Before the fix, headers split into multiple lines were producing bogus
> quote characters in nroff output and failed to indent headers properly.
> 
> Specifically, it fixes a header and its indentation in
> ovn-architecture(7).
> 
> Signed-off-by: Ihar Hrachyshka <ihrachys@redhat.com>

Thanks, applied to master.

(nroff is such a miserable format!)
diff mbox series

Patch

diff --git a/python/build/nroff.py b/python/build/nroff.py
index a94907757..09795ab52 100644
--- a/python/build/nroff.py
+++ b/python/build/nroff.py
@@ -290,6 +290,11 @@  fillval = .2
 \\}"""
 
 
+def flatten_header(s):
+    s = s.strip()
+    return re.sub(r'\s+', ' ', s)
+
+
 def block_xml_to_nroff(nodes, para='.PP'):
     HEADER_TAGS = ('h1', 'h2', 'h3', 'h4')
     s = ''
@@ -373,7 +378,9 @@  def block_xml_to_nroff(nodes, para='.PP'):
                 to_upper = node.tagName == 'h1'
                 s += ".%s \"" % nroffTag
                 for child_node in node.childNodes:
-                    s += inline_xml_to_nroff(child_node, font, to_upper)
+                    s += flatten_header(
+                        inline_xml_to_nroff(child_node, font, to_upper)
+                    )
                 s += "\"\n"
             elif node.tagName == 'pre':
                 fixed = node.getAttribute('fixed')