You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by jb...@apache.org on 2018/01/11 17:53:06 UTC
[geode-native] branch develop updated: GEODE-4171: Putting in
changes to fix and clarify the BUILDING.md (#176)
This is an automated email from the ASF dual-hosted git repository.
jbarrett pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode-native.git
The following commit(s) were added to refs/heads/develop by this push:
new f348bf9 GEODE-4171: Putting in changes to fix and clarify the BUILDING.md (#176)
f348bf9 is described below
commit f348bf96e214d7623c14513bb3bf30813dc3f250
Author: Ivan Godwin <ig...@pivotal.io>
AuthorDate: Thu Jan 11 09:53:04 2018 -0800
GEODE-4171: Putting in changes to fix and clarify the BUILDING.md (#176)
---
BUILDING.md | 55 +++++++++++++++++++++++++++++--------------------------
1 file changed, 29 insertions(+), 26 deletions(-)
diff --git a/BUILDING.md b/BUILDING.md
index b526f7f..4e0c636 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -1,43 +1,53 @@
# Building
-## Building on UNIX
- $ cd <clone>
- $ mkdir build
- $ cd build
- $ cmake ../src
- $ cmake --build . -- -j 8
+## System Requirements (All Platforms)
+* [CMake 3.8](https://cmake.org/) or newer
+* C++11 compiler *(see platform specific requirements)*
+* [Doxygen 8.11](http://www.stack.nl/~dimitri/doxygen/download.html) *(for building source documentation)*
+* [Apache Geode](http://geode.apache.org/releases/) binaries installed or available to link against
+
+## Additional Platform-specific Requirements
+* [Mac OS X](#mac-os-x)
+* [Linux](#linux)
+* [Solaris](#solaris)
+* [Windows](#windows)
-### [Mac OS X System Requirements](#mac-os-x)
-### [Linux System Requirements](#linux)
-### [Solaris System Requirements](#solaris)
+## Steps to build
-## Building on Windows
$ cd <clone>
$ mkdir build
$ cd build
- $ cmake ../src
- $ cmake --build . -- /m
+ $ cmake ..
+ $ cmake --build . --
+
+**For faster builds, add parallelism to the last step:**
+
+Unix
+
+ $ cmake --build . -- -j <# of jobs>
-### [Windows System Requirements](#windows)
+Windows
+
+ $ cmake --build . -- /m
## Generator
CMake uses a "generator" to produce configuration files for use by a variety of build tools, e.g., UNIX makefiles, Visual Studio projects. By default a system-specific generator is used by CMake during configuration. (Please see [the CMake documentation](https://cmake.org/documentation/) for further information.) However, in many cases there is a better choice.
-
+
### Mac OS X Generator
The recommended generator on Mac OS X is `Xcode`:
- $ cmake -G "Xcode" ../src
+ $ cmake -G "Xcode" ..
### Windows Generator
The recommended generator on Windows is `Visual Studio 14 2015 Win64`:
- $ cmake -G "Visual Studio 14 2015 Win64" ../src
+ $ cmake -G "Visual Studio 14 2015 Win64" ..
## Finding Geode
-Building requires access to an installation of Geode. By default the value of `GEODE_ROOT` or `GEODE` is used during CMake configuration if either of those shell variables is exported. To explicitly specify the location in which Geode is installed, add `-DGEODE_ROOT=/path/to/geode` to the _initial_ `cmake` execution command before `../src`.
+Building requires access to an installation of Geode. By default the value of `GEODE_ROOT` or `GEODE` is used during CMake configuration if either of those shell variables is exported. To explicitly specify the location in which Geode is installed, add `-DGEODE_ROOT=/path/to/geode` to the _initial_ `cmake` execution command.
## Installing
-By default a system-specific location is used by CMake as the destination of the `install` target, e.g., `/usr/local` on UNIX system. To explicitly specify the location in which the Native Client will be installed, add `-DCMAKE_INSTALL_PREFIX=/path/to/installation/destination` to the _initial_ `cmake` execution command before `../src`.
+By default a system-specific location is used by CMake as the destination of the `install` target, e.g., `/usr/local` on UNIX system. To explicitly specify the location in which the Native Client will be installed, add `-DCMAKE_INSTALL_PREFIX=/path/to/installation/destination` to the _initial_ `cmake` execution command.
**Note:** For consistent results, avoid using the "~" (tilde) abbreviation when specifying paths on the CMake command line.
Interpretation of the symbol varies depending on the option being specified, and on the system or command shell in use.
@@ -49,14 +59,7 @@ Due to limitations in CMake, the documentation must be built as a separate step
$ cmake --build . --target docs
$ cmake --build . --target install
-# System Requirements
-
-## All Platforms
-
-### Required Tools
-* [CMake 3.8](https://cmake.org/) or newer
-* C++11 compiler *(see platform specific requirements)*
-* [Doxygen 8.11](http://www.stack.nl/~dimitri/doxygen/download.html) *(for building source documentation)*
+# Platform-Specific System Requirements
## Mac OS X
* Mac OS X 10.12 (Sierra) or newer
--
To stop receiving notification emails like this one, please contact
['"commits@geode.apache.org" <co...@geode.apache.org>'].