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

2014-02-07 Thread Peter Eisentraut
On 2/4/14, 3:28 PM, Robert Haas 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.

The man pages have the same issue.  For example from man postgres:

Other possible file layouts are discussed in Section 18.2, "File
Locations", in the documentation.

The same could (probably) be done with the INSTALL file.



-- 
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers


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

2014-02-06 Thread Stefan Kaltenbrunner
On 02/05/2014 07:27 PM, Robert Haas wrote:
> On Tue, Feb 4, 2014 at 11:43 PM, Noah Misch  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 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  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?

I dont care about HISTORY and even less so about regress_README but I
would prefer to keep INSTALL because I know that people do look at that
one...


Stefan


-- 
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers