Skip to content

Commit

Permalink
update some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JerrySievert committed Dec 10, 2018
1 parent 18b5d92 commit d86f104
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 18 deletions.
21 changes: 5 additions & 16 deletions docs/BUILDING.md
Expand Up @@ -8,15 +8,16 @@ Building PLV8 for MacOS or Linux has some specific requirements:
* g++ or clang++
* Python 2 (for v8)
* pgk-config (linux only for v8)
* libc++-dev (linux only)

### Downloading Source

Downloading the source code is very straightforward:

```
$ wget https://github.com/plv8/plv8/archive/v2.3.3.tar.gz
$ tar -xvzf v2.3.3.tar.gz
$ cd plv8-2.3.3
$ wget https://github.com/plv8/plv8/archive/v2.3.8.tar.gz
$ tar -xvzf v2.3.8.tar.gz
$ cd plv8-2.3.8
$ make
```

Expand All @@ -28,13 +29,7 @@ Building is simple:
$ make
```

This will download `v8` and compile it as well. If you have a shared modern
version of `v8` available (6.4.388.40 or above), you can compile it against a
shared module:

```
$ make -f Makefile.shared
```
This will download `v8` and compile it as well.

| Note: If you have multiple versions of PostgreSQL installed like 9.5 and 9.6, Plv8 will only be built for PostgreSQL 9.6. This is because make calls pg_config to get the version number, which will always be the latest version installed. If you need to build Plv8 for PostgreSQL 9.5 while you have 9.6 installed pass make the PG_CONFIG variable to your 9.5 version of pg_config. This works for `make`, `make -f Makefile.shared`, and `make install`. For example in Ubuntu:

Expand Down Expand Up @@ -172,9 +167,3 @@ This will build and package the extension for installation.
To install, you simply need to `unzip` the file created. The name will depend
on the version of PLV8 and the version of Postgres. An example is
`plv8-2.3.1-postgresql-10-x64.zip`.

### TODO

* Generate configuration files
* Generate control files
* Generate sql files
4 changes: 2 additions & 2 deletions docs/README.md
Expand Up @@ -4,7 +4,7 @@ PLV8 is a _trusted_ Javascript language extension for PostgreSQL. It can be
used for _stored procedures_, _triggers_, etc.

PLV8 works with most versions of Postgres, but works best with `9.1` and above,
including `10.0` and `10.1`.
including `10.0` and `11`.

## Installing PLV8

Expand Down Expand Up @@ -36,7 +36,7 @@ As of PLV8 version `2.3.3`, you can use upgrade scripts to upgrade your
installation from any verion higher than `1.5.0`:

```
=# ALTER EXTENSION plv8 UPDATE TO `2.3.3`;
=# ALTER EXTENSION plv8 UPDATE TO `2.3.8`;
```

Note that until the database has been restarted, the old version of PLV8 will
Expand Down

0 comments on commit d86f104

Please sign in to comment.