Re: Link t the souce code

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
Cc: "Jonathan S(dot) Katz" <jkatz(at)postgresql(dot)org>, "Daniel Westermann (DWE)" <daniel(dot)westermann(at)dbi-services(dot)com>, "pgsql-docs(at)lists(dot)postgresql(dot)org" <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: Link t the souce code
Date: 2021-07-21 00:09:04
Message-ID: 647690.1626826144@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org> writes:
> v3 rewrites the text more aggressively, so that it opens with
> instructions to clone the Git repo, and the released version tarballs
> are mentioned further down. The bad thing about this one is that in the
> devel version it still talks about files that don't exist; for example
> in branch master it renders as:

> Alternatively, the released versions can be obtained from the download
> section of our website: https://www.postgresql.org/ftp/source/. You
> should get a file named postgresql-15devel.tar.gz or
> postgresql-15devel.tar.bz2. After you have obtained the file, unpack it:>
> tar xfa postgresql-15devel.tar.gz
> This will create a directory postgresql-15devel under the current
directory with the PostgreSQL sources. Change into that directory for
> the rest of the installation procedure.

ISTM that specifying an exact version number here is rather pointless
anyway. Could we drop the reference to an exact file name, and write
something like

Alternatively, source code for released versions can be obtained
from the download section of our website:
https://www.postgresql.org/ftp/source/.
Download the postgresql-<replaceable>version</replaceable>.tar.gz or
postgresql-<replaceable>version</replaceable>.tar.bz2 file for the
version you are interested in, then unpack it:
tar xfa postgresql-<replaceable>version</replaceable>.tar.gz
This will create a directory
postgresql-<replaceable>version</replaceable> under the current ...

Admittedly, someone who doesn't grok that
<replaceable>version</replaceable> is a variable might be confused
initially, but I think they'd soon figure it out after seeing the
file names on the server.

regards, tom lane

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Peter Eisentraut 2021-07-21 15:27:42 Re: Link t the souce code
Previous Message Alvaro Herrera 2021-07-20 23:45:55 Re: Link t the souce code