Date: Tue, 20 Jul 2021 19:45:55 -0400
From: Alvaro Herrera <alvherre@alvh.no-ip.org>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: "Jonathan S. Katz" <jkatz@postgresql.org>,
	"Daniel Westermann (DWE)" <daniel.westermann@dbi-services.com>,
	"pgsql-docs@lists.postgresql.org" <pgsql-docs@lists.postgresql.org>
Subject: Re: Link t the souce code
Message-ID: <202107202345.imvyzt5yio5v@alvherre.pgsql>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="cukfwqd3x2sookv2"
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <4187443.1620343820@sss.pgh.pa.us>
Archived-At: 
 <https://www.postgresql.org/message-id/202107202345.imvyzt5yio5v%40alvherre.pgsql>
Precedence: bulk


--cukfwqd3x2sookv2
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit

On 2021-May-06, Tom Lane wrote:

> Alvaro Herrera <alvherre@alvh.no-ip.org> writes:

> > 3. add a separate paragraph that says to obtain the source from the
> > other dir if it's the development one.
> > I kinda prefer the last one, because then we could also suggest to use a
> > Git repo instead of a tarball, which I suppose is the best option anyway.
> 
> Yeah.  There is text mentioning the git repo further down, but it's
> hardly prominent.  We should move it up and recommend that as the
> best thing for dev work.

Here are two patches.  v2 is a minimal change; it just adds a
parenthical comment about the snapshot tarball and a mention of "the
text below" which is where the source code repository is mentioned.

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.

Now, we *could* make this fully correct by adding
--param pg.version.devel 'true'
(or something like that) to the Makefile, and include paragraphs
conditionally to make it fully correct.  I'm not sure it's worth the
effort.

-- 
Álvaro Herrera           39°49'30"S 73°17'W  —  https://www.EnterpriseDB.com/

--cukfwqd3x2sookv2
Content-Type: text/x-diff; charset=utf-8
Content-Disposition: attachment;
	filename="v2-0001-Improve-installation-instructions-a-bit.patch"