Re: pgsql: Document a few more regression test hazards.

From: Robert Haas <robertmhaas(at)gmail(dot)com>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: Robert Haas <rhaas(at)postgresql(dot)org>, pgsql-committers <pgsql-committers(at)postgresql(dot)org>
Subject: Re: pgsql: Document a few more regression test hazards.
Date: 2014-02-04 01:09:01
Message-ID: CA+Tgmob0Jx_9v9KK95gojkjojeP2hTa38_P8JtOFXVDjjSkT=A@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers pgsql-docs pgsql-hackers

On Mon, Feb 3, 2014 at 4:38 PM, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
> Robert Haas <rhaas(at)postgresql(dot)org> writes:
>> Document a few more regression test hazards.
>
> guaibasaurus doesn't like this patch: you need to be more careful
> about links, because the regression instructions are supposed to
> compile as a standalone document.
>
> Easy answer is to get rid of the link to RUNTIME-CONFIG-QUERY-ENABLE.
> I think there's some hack you can use to make it sort-of-work standalone
> too; look at the release notes for examples.

Fascinating. I knew that there was a HISTORY file that got built from
the release notes, but I didn't realize there was something similar
being built from regress.sgml. I'll rephase that passage to avoid the
link.

I wonder if these standalone things are really worthwhile. The whole
point of this, ten years ago, was that people who were trying to get
started with PostgreSQL might not have had neither the doc toolchain
nor convenient Internet access available. Plain text documentation
was essential for getting off the ground. This seems much less
relevant today; is the annoyance of not being able to use links
everywhere really buying us anything at this point?

--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company

In response to

Responses

Browse pgsql-committers by date

  From Date Subject
Next Message Robert Haas 2014-02-04 01:20:05 pgsql: Rephrase text to avoid links in regress.sgml
Previous Message Tom Lane 2014-02-04 00:48:31 pgsql: Fix lexing of U& sequences just before EOF.

Browse pgsql-docs by date

  From Date Subject
Next Message Tom Lane 2014-02-04 01:48:06 Viability of text HISTORY/INSTALL/regression README files (was Re: [COMMITTERS] pgsql: Document a few more regression test hazards.)
Previous Message Tom Lane 2014-02-03 21:38:42 Re: pgsql: Document a few more regression test hazards.

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2014-02-04 01:10:22 Re: should we add a XLogRecPtr/LSN SQL type?
Previous Message Peter Geoghegan 2014-02-04 00:40:33 Re: Failure while inserting parent tuple to B-tree is not fun