Re: New developer papercut - Makefile references INSTALL

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Magnus Hagander <magnus(at)hagander(dot)net>
Cc: Andres Freund <andres(at)anarazel(dot)de>, Robert Haas <robertmhaas(at)gmail(dot)com>, Josef Šimánek <josef(dot)simanek(at)gmail(dot)com>, samay sharma <smilingsamay(at)gmail(dot)com>, Tim McNamara <tim(at)mcnamara(dot)nz>, PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: New developer papercut - Makefile references INSTALL
Date: 2022-03-09 17:06:48
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

Magnus Hagander <magnus(at)hagander(dot)net> writes:
> On Mon, Mar 7, 2022 at 11:51 PM Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
>> Doesn't really help people working from git, I think, because the
>> master branch is always going to claim to be "devel" even when you
>> rewind it to some old state. Maybe we can assume people doing
>> such a thing have even more clue ... but on the whole I'd rather
>> not add the additional complication.

> Well it could per major version couldn't it? When we start working on
> v16, we stamp master as that, and we could use that for the links. It
> will work "for the past", but if will of course not be able to track
> how the docs changes between the individual commits -- since our
> website only has the latest release for each one. If we need that it
> needs to be in the source tree -- but is that actually a requirement?

I think that adds more complication than usefulness. ISTM having the
master branch not identify itself more specifically than "devel" is
actually a good thing in this context, for precisely the reason that
the corresponding docs are likely to be in flux. Seeing "v16" seems
likely to lull people into a false sense of certainty that whatever
they find on the web matches the code they actually have.

So I'm coming to the position that the README file ought not contain
any link more specific than
and that it should then tell you to look at the installation chapters
in the appropriate version's docs. (Considering we have multiple
installation chapters nowadays, we couldn't provide an exact URL

regards, tom lane

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Chapman Flack 2022-03-09 17:12:07 Re: Postgres restart in the middle of exclusive backup and the presence of backup_label file
Previous Message Andres Freund 2022-03-09 16:55:37 Re: [RFC] building postgres with meson