geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jbarr...@apache.org
Subject [geode-native] branch develop updated: GEODE-4171: Updating out-of-date content (#186)
Date Thu, 11 Jan 2018 23:38:06 GMT
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 251612b  GEODE-4171: Updating out-of-date content (#186)
251612b is described below

commit 251612bfcb12841633d15c9b7f7dcdae5d40d1fd
Author: Ivan Godwin <igodwin@pivotal.io>
AuthorDate: Thu Jan 11 15:38:04 2018 -0800

    GEODE-4171: Updating out-of-date content (#186)
---
 BUILDING.md | 23 ++++++++++-------------
 1 file changed, 10 insertions(+), 13 deletions(-)

diff --git a/BUILDING.md b/BUILDING.md
index 4e0c636..f7e3b09 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -1,12 +1,14 @@
 # Building
 
-## System Requirements (All Platforms)
+## Prerequisites (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
+   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.
+
+### Platform-Specific Prerequisites
 * [Mac OS X](#mac-os-x)
 * [Linux](#linux)
 * [Solaris](#solaris)
@@ -18,15 +20,15 @@
     $ mkdir build
     $ cd build
     $ cmake ..
-    $ cmake --build . --
+    $ cmake --build . -- <optional parallelism parameters>
 
-**For faster builds, add parallelism to the last step:**
+**For faster builds, use optional parallelism parameters in the last step:**
 
-Unix
+**Unix**
 
 	$ cmake --build . -- -j <# of jobs>
 
-Windows
+**Windows**
 
 	$ cmake --build . -- /m
 
@@ -43,9 +45,6 @@ The recommended generator on Windows is `Visual Studio 14 2015 Win64`:
 
 	$ 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.
-
 ## 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.
 
@@ -59,7 +58,7 @@ Due to limitations in CMake, the documentation must be built as a separate
step
     $ cmake --build . --target docs
     $ cmake --build . --target install
 
-# Platform-Specific System Requirements
+# Platform-Specific Prerequisites
 
 ## Mac OS X
 * Mac OS X 10.12 (Sierra) or newer
@@ -69,7 +68,7 @@ Due to limitations in CMake, the documentation must be built as a separate
step
 * [XCode](https://developer.apple.com/xcode/download/)
 * Xcode command line developer tools
 
-    `$ xcode-select --install` 
+    `$ xcode-select --install`
 
 ### Optional Tools
 * [CMake GUI](https://cmake.org/)
@@ -105,5 +104,3 @@ Due to limitations in CMake, the documentation must be built as a separate
step
 
 ### Required Tools
 * [Solaris Studio 12.6](http://www.oracle.com/technetwork/server-storage/developerstudio/downloads/index.html)
or newer
-
-	

-- 
To stop receiving notification emails like this one, please contact
['"commits@geode.apache.org" <commits@geode.apache.org>'].

Mime
View raw message