Re: INSTALL file

From: Stephen Frost <sfrost(at)snowman(dot)net>
To: Andreas 'ads' Scherbaum <ads(at)pgug(dot)de>
Cc: Michael Paquier <michael(at)paquier(dot)xyz>, Andrew Dunstan <andrew(dot)dunstan(at)2ndquadrant(dot)com>, pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Re: INSTALL file
Date: 2018-11-01 17:41:33
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers


* Andreas 'ads' Scherbaum (ads(at)pgug(dot)de) wrote:
> On 01.11.18 07:26, Michael Paquier wrote:
> >>It includes links to the website, as well as the short version of the
> >>installation instructions.
> >+The installation instructions are listed on the website:
> >+
> >+

I don't think we should link to the "Short version" directly here, the
above URL should be the "installation.html" one.. With a caveat, see

> >+Short version:
> >+
> >+./configure
> >+make
> >+su
> >+make install
> >+adduser postgres
> >+mkdir /usr/local/pgsql/data
> >+chown postgres /usr/local/pgsql/data
> >+su - postgres
> >+/usr/local/pgsql/bin/initdb -D /usr/local/pgsql/data
> >+/usr/local/pgsql/bin/pg_ctl -D /usr/local/pgsql/data -l logfile start
> >
> >Adding a section about installation and another one about documentation
> >are good things. Now for the installation section I disagree about
> >adding this detailed way of doing things, and just adding a URL looks
> >enough.
> Was thinking about this, but then decided to add it as an example,
> and see what people think.

I like having the detail, but I'd go farther, really. Here's my


Detailed instructions for many Unix platforms is available here:

To build PostgreSQL on most Unix variants, the following are required:

GNU make, version 3.8 or newer
ISO/ANSI C compilar (at least C99-compliant)
Flex 2.5.31 or later, and Bison 1.875 or later (for building from git)
Perl 5.8.3 (for building from git)

PostgreSQL has many additional capabilities which can be enabled using
configure --enable switches but many of those also depend on additional
libraries. See the installation instructions for details.

To build PostgreSQL, run the following commands:


PostgreSQL can then be installed using 'make install', which will
require being a superuser to install into the default directory.
The installation location can be changed by passing '--prefix' to
'configure'. Run './configure --help' for additional options.


Detailed instructions for building on Windows is available here:

To build PostgreSQL on Windows, either Visual Studio Express 2017
for Windows Desktop or Microsoft Visual C++ 2005 (or later) should be
installed. PostgreSQL can also be build using MinGW or Cygwin using
the Unix instructions.

... some details about how to actually use VSE 2017 would be good


Once the PostgreSQL software is installed, the first step to having a
running database is to initialize a PostgreSQL database using the
'initdb' command, eg:

initdb -D mydatabase

After the database system has been initialized, PostgreSQL can be
started by using the pg_ctl command:

pg_ctl -D mydatabase -l logfile start

Once PostgreSQL is running, you can connect to it using the psql
command-line client. A default database called 'postgres' was created
by 'initdb'.


Full documentation for PostgreSQL is available online here:

To build the PostgreSQL documentation on most Unix variants, the
following tools are required:

.... whatever these are

To build PostgreSQL's documentation on Unix, run:

make docs

The documentation, once built by 'make docs', will be available in
various formats in the 'doc/src/sgml' directory.

> >Now there is also a problem, the README would point out to the
> >development version of the documentation. As this is made at working
> >using git, I could personally live with having stable branches also
> >refer to the development version, but it could also make sense to have
> >each stable branch point to the URL of the versions they work on.
> That is a bit problematic. The README lives on git first, and therefore
> should point to the development version. The release process
> can replace this with links to the current version.

I'm not sure that I'm really following this, because we aren't pointing
to the development documentation, just the 'current' documentation, and
that seems fine, and there's links on that page to the other versions of
the page for each major version of PostgreSQL, in case someone pulled an
older branch or such.

In short, I think we're fine to just use the 'current' URLs in this

I'd also update the 'Makefile' bit we have at the root to refer to the
README instead of the INSTALL file.



In response to


Browse pgsql-hackers by date

  From Date Subject
Next Message Andres Freund 2018-11-01 17:54:23 Re: replication_slots usability issue
Previous Message Andres Freund 2018-11-01 17:15:27 Re: Parallel threads in query