From 0a1eb9fa82108ea8cdee3801a686dfa14aa533b1 Mon Sep 17 00:00:00 2001 From: Jason Volk Date: Mon, 4 May 2020 16:28:14 -0700 Subject: [PATCH] doc: Update BUILD instructions. [ci skip] --- doc/BUILD.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/doc/BUILD.md b/doc/BUILD.md index 1e3865e88..fc92b660e 100644 --- a/doc/BUILD.md +++ b/doc/BUILD.md @@ -9,14 +9,11 @@ made their way to mainstream systems. Important notes that may affect you: Ubuntu Cosmic (18.10). All earlier releases (including 18.04 LTS) can configure with `--with-included-boost` as instructed below. -- RocksDB: The required version is available through `apt` as `librocksdb-dev` on -Ubuntu Disco (19.04). All earlier releases (including 18.04 LTS) can configure -with `--with-included-rocksdb` and skip the next bullet. - - RocksDB: THE COMPLETE SOURCE-CODE OF ROCKSDB MUST BE AVAILABLE TO BUILD CONSTRUCT. -This is different from the `include/` and `lib/` files installed by `librocksdb-dev` -with 19.04 or later (which is also required). If you are on 19.04, 19.10, or 20.04 -or later, provide the source-code with the following: +This is different from the `include/` and `lib/` files installed by your +distribution's package system. You do not have to build the source, but it must +be available. ALL UBUNTU USERS MUST BUILD THE SOURCE AS WELL (SKIP TO NEXT BULLET). + ``` git submodule update --init deps/rocksdb cd deps/rocksdb @@ -24,6 +21,12 @@ git fetch --tags --force git checkout v5.17.2 ``` +- RocksDB: All Ubuntu users on all releases must configure Construct with the +option `--with-included-rocksdb`. This will fetch and properly build rocksdb. + +> Ubuntu builds their library with `-Bsymbolic-functions`. This conflicts with +the requirements of Construct's embedding. + ##### Installation Primer A general overview of what construct will build and install is given here. At