[
https://issues.apache.org/jira/browse/GEODE-4171?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16323226#comment-16323226
]
ASF GitHub Bot commented on GEODE-4171:
---------------------------------------
pivotal-jbarrett closed pull request #186: GEODE-4171: Updating out-of-date
content
URL: https://github.com/apache/geode-native/pull/186
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/BUILDING.md b/BUILDING.md
index 4e0c6364..f7e3b09d 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
-
-
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> BUILDING.md is out of date and needs an update.
> -----------------------------------------------
>
> Key: GEODE-4171
> URL: https://issues.apache.org/jira/browse/GEODE-4171
> Project: Geode
> Issue Type: Bug
> Components: native client
> Reporter: Mark Hanson
>
> The command for setting up the build environment is no longer cmake ../src.
> It is cmake .. .
> Also it would be useful to add the -DGEODE_ROOT build variable to make the
> build easier, as well as add the dependency on the geode binaries.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
