backpatching documentation after conversion to XML

From: Peter Eisentraut <peter(dot)eisentraut(at)2ndquadrant(dot)com>
To: pgsql-docs <pgsql-docs(at)postgresql(dot)org>
Subject: backpatching documentation after conversion to XML
Date: 2017-10-21 16:57:00
Message-ID: 609dc528-6eab-522d-5b7d-842bd83159e5@2ndquadrant.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

In a nearby message, Tom pointed out that the ongoing conversion of the
documentation sources from SGML to XML could/will cause problems when
backpatching. The changes made so far would merely cause merge
conflicts but there is an additional issue to consider that can cause
compatibility problems.

When we finally convert the sources from SGML to XML, we will have to
change empty tags such as

<xref linkend="foo">

to XML syntax

<xref linkend="foo"/>

(like HTML versus XHTML). The problem is that if you backpatch that
literally into an SGML source, it will be interpreted as

<xref linkend="foo">>

(i.e., an additional character will appear in the output) without an
indication of an error.

One workaround (other than being careful) would be to write

<xref linkend="foo"></xref>

and maintain that style until the last SGML-based version goes EOL.

Another workaround would be to backpatch a check that greps for
something like '[^<]/>' in *.sgml and errors on that.

(AFAICT, this is the last major issue impacting the conversion, so when
we have resolved this, this can go ahead.)

Thoughts?

--
Peter Eisentraut http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Peter Eisentraut 2017-10-21 16:58:04 Re: no more SGML empty tags
Previous Message Tom Lane 2017-10-19 15:11:58 Re: no more SGML empty tags