Re: Viability of text HISTORY/INSTALL/regression README files (was Re: [COMMITTERS] pgsql: Document a few more regression test hazards.)

From: Robert Haas <robertmhaas(at)gmail(dot)com>
To: Noah Misch <noah(at)leadboat(dot)com>
Cc: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, "pgsql-hackers(at)postgresql(dot)org" <pgsql-hackers(at)postgresql(dot)org>, pgsql-docs <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Viability of text HISTORY/INSTALL/regression README files (was Re: [COMMITTERS] pgsql: Document a few more regression test hazards.)
Date: 2014-02-05 18:27:38
Message-ID: CA+TgmobAS1wK7CgjC3bnT8CRscMEkjm2P+Ew9jt7yDTdoen5Vw@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers pgsql-docs pgsql-hackers

On Tue, Feb 4, 2014 at 11:43 PM, Noah Misch <noah(at)leadboat(dot)com> wrote:
>> Right. I mean, a lot of the links say things like "Section 26.2"
>> which obviously makes no sense in a standalone text file.
>
> For <xref>s normally displayed that way, text output could emit a URL, either
> inline or in the form of a footnote. For link targets (e.g. SQL commands)
> having a friendly text fragment for <xref> sites, use the normal fragment.

True. If we're going to keep these things around, something like that
would avoid some annoyances for documentation authors. But I still
think we ought to just nuke them, because who cares?

--
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-05 18:42:05 pgsql: Minor improvements to replication slot documentation.
Previous Message Noah Misch 2014-02-05 04:43:28 Re: Viability of text HISTORY/INSTALL/regression README files (was Re: [COMMITTERS] pgsql: Document a few more regression test hazards.)

Browse pgsql-docs by date

  From Date Subject
Next Message Stefan Kaltenbrunner 2014-02-06 19:49:35 Re: [DOCS] Re: Viability of text HISTORY/INSTALL/regression README files (was Re: [COMMITTERS] pgsql: Document a few more regression test hazards.)
Previous Message Noah Misch 2014-02-05 04:43:28 Re: Viability of text HISTORY/INSTALL/regression README files (was Re: [COMMITTERS] pgsql: Document a few more regression test hazards.)

Browse pgsql-hackers by date

  From Date Subject
Next Message Robert Haas 2014-02-05 18:31:23 Re: should we add a XLogRecPtr/LSN SQL type?
Previous Message Robert Haas 2014-02-05 18:26:15 Re: Patch: show xid and xmin in pg_stat_activity and pg_stat_replication