1
0
mirror of https://github.com/postgrespro/pg_probackup.git synced 2025-02-03 14:01:57 +02:00

Update README with new instructions to use source code

This has been forgotten 04834e73 that added a dependency to the Postgres
source tree when building.
This commit is contained in:
Michael Paquier 2016-01-19 09:26:16 +09:00
parent 2882954b95
commit 3a9cc02d71

28
README
View File

@ -19,20 +19,11 @@ https://github.com/michaelpq/pg_arman.
Installation
------------
Compiling pg_arman requires a PostgreSQL installation and can be done in
two ways:
Compiling pg_arman requires a PostgreSQL installation to be in place
as well as a raw source tree. Pass the path to the PostgreSQL source tree
to make, in the top_srcdir variable:
1. Put pg_arman project directory inside PostgreSQL source tree as
contrib/pg_arman, and use this command for compilation:
$ cd $POSTGRES_SOURCE/contrib/pg_arman
$ make
2. Keep the project directory as-is and use the PGXS development
infrastructure provided by a PostgreSQL installation to perform the
compilation:
$ make USE_PGXS=1
make USE_PGXS=1 top_srcdir=<path to PostgreSQL source tree>
In addition, you must have pg_config in $PATH.
@ -55,7 +46,8 @@ In order to generate the documentation, the variables XMLTO and ASCIIDOC
need to be set to proper values indicating where are located the binaries
of respectively xmlto and asciidoc. An example of build is as follows:
$ make USE_PGXS=1 ASCIIDOC=asciidoc XMLTO=xmlto
make top_srcdir=<path to PostgreSQL source tree> \
ASCIIDOC=asciidoc XMLTO=xmlto
They could as well be set as environment variables for development
purposes.
@ -64,7 +56,7 @@ On OSX, it is necessary to set XML_CATALOG_FILES to point to the correct
xml catalogs. In the case of an environment with Homebrew after having
install xmlto and asciidoc:
$ export XML_CATALOG_FILES="/usr/local/etc/xml/catalog"
export XML_CATALOG_FILES="/usr/local/etc/xml/catalog"
Regression tests
----------------
@ -72,11 +64,7 @@ Regression tests
The test suite of pg_arman is available in the code tree and can be
launched in a way similar to common PostgreSQL extensions and modules:
1) "make check" or "make installcheck" if the project directory is
located in PostgreSQL code tree.
2) "make installcheck" on an already installed server if project
directory is kept as-is.
make installcheck
License
-------