pgsql: Stop recommending auto-download of DTD files, and indeed disable

Started by Tom Laneabout 3 years ago3 messageshackers
Jump to latest
#1Tom Lane
tgl@sss.pgh.pa.us

Stop recommending auto-download of DTD files, and indeed disable it.

It appears no longer possible to build the SGML docs without a local
installation of the DocBook DTD, because sourceforge.net now only
permits HTTPS access, and no common version of xsltproc supports that.
Hence, remove the bits of our documentation suggesting that that's
possible or useful.

In fact, we might as well add the --nonet option to the build recipes
automatically, for a bit of extra security.

Also fix our documentation-tool-installation recipes for macOS to
ensure that xmllint and xsltproc are pulled in from MacPorts or
Homebrew. The previous recipes assumed you could use the
Apple-supplied versions of these tools; which still works, except that
you'd need to set an environment variable to ensure that they would
find DTD files provided by those package managers. Simpler and easier
to just recommend pulling in the additional packages.

In HEAD, also document how to build docs using Meson, and adjust
"ninja docs" to just build the HTML docs, for consistency with the
default behavior of doc/src/sgml/Makefile.

In a fit of neatnik-ism, I also made the ordering of the package
lists match the order in which the tools are described at the head
of the appendix.

Aleksander Alekseev, Peter Eisentraut, Tom Lane

Discussion: /messages/by-id/CAJ7c6TO8Aro2nxg=EQsVGiSDe-TstP4EsSvDHd7DSRsP40PgGA@mail.gmail.com

Branch
------
REL_15_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/2ee703c9d1c6bbbae8b19807c23f91d75d17271e

Modified Files
--------------
doc/src/sgml/Makefile | 8 +++++--
doc/src/sgml/docguide.sgml | 55 ++++++++++++++++++++++----------------------
doc/src/sgml/images/Makefile | 2 +-
3 files changed, 34 insertions(+), 31 deletions(-)

#2Robert Haas
robertmhaas@gmail.com
In reply to: Tom Lane (#1)
Re: pgsql: Stop recommending auto-download of DTD files, and indeed disable

On Wed, Feb 8, 2023 at 5:16 PM Tom Lane <tgl@sss.pgh.pa.us> wrote:

Stop recommending auto-download of DTD files, and indeed disable it.

According to this commit:

<para>
The Homebrew-supplied programs require the following environment variable
to be set:
<programlisting>
export XML_CATALOG_FILES=/usr/local/etc/xml/catalog
</programlisting>
Without it, <command>xsltproc</command> will throw errors like this:
<programlisting>
I/O error : Attempt to load network entity
http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd
postgres.sgml:21: warning: failed to load external entity
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd&quot;
...
</programlisting>
</para>

I use MacPorts, rather than Homebrew, but still found it necessary to
do something similar, specifically:

export XML_CATALOG_FILES=/opt/local/etc/xml/catalog

--
Robert Haas
EDB: http://www.enterprisedb.com

#3Robert Haas
robertmhaas@gmail.com
In reply to: Robert Haas (#2)
Re: pgsql: Stop recommending auto-download of DTD files, and indeed disable

On Tue, Mar 21, 2023 at 4:45 PM Robert Haas <robertmhaas@gmail.com> wrote:

I use MacPorts, rather than Homebrew, but still found it necessary to
do something similar, specifically:

export XML_CATALOG_FILES=/opt/local/etc/xml/catalog

Ah, never mind. I had an incorrect value in my environment. If I unset
it completely, it works just as well as setting a correct value.

Sorry for the noise.

--
Robert Haas
EDB: http://www.enterprisedb.com