Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 802CF200C49 for ; Fri, 17 Mar 2017 22:01:38 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 7EB59160B80; Fri, 17 Mar 2017 21:01:38 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 52664160B70 for ; Fri, 17 Mar 2017 22:01:37 +0100 (CET) Received: (qmail 72437 invoked by uid 500); 17 Mar 2017 21:01:36 -0000 Mailing-List: contact commits-help@geode.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@geode.apache.org Delivered-To: mailing list commits@geode.apache.org Received: (qmail 72421 invoked by uid 99); 17 Mar 2017 21:01:36 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 17 Mar 2017 21:01:36 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 167EEDFB7D; Fri, 17 Mar 2017 21:01:36 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: dbarnes@apache.org To: commits@geode.apache.org Date: Fri, 17 Mar 2017 21:01:36 -0000 Message-Id: <66fb2d4e50d14ac39588e366da44dfd7@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [1/3] geode-native git commit: GEODE-2521 geode native docs: Document installation from source archived-at: Fri, 17 Mar 2017 21:01:38 -0000 Repository: geode-native Updated Branches: refs/heads/develop aaa5c9540 -> 6eb93f686 GEODE-2521 geode native docs: Document installation from source Project: http://git-wip-us.apache.org/repos/asf/geode-native/repo Commit: http://git-wip-us.apache.org/repos/asf/geode-native/commit/5e194a7d Tree: http://git-wip-us.apache.org/repos/asf/geode-native/tree/5e194a7d Diff: http://git-wip-us.apache.org/repos/asf/geode-native/diff/5e194a7d Branch: refs/heads/develop Commit: 5e194a7dcab8ab059fcca856d3765e40a97e4c3b Parents: 013b336 Author: Dave Barnes Authored: Thu Mar 16 15:52:12 2017 -0700 Committer: Dave Barnes Committed: Fri Mar 17 11:41:40 2017 -0700 ---------------------------------------------------------------------- BUILDING.md | 4 +- .../source/subnavs/geode-nc-nav.erb | 13 +- .../introduction/install-overview.html.md.erb | 178 ++++++++++++++++++- .../introduction/install-unix.html.md.erb | 50 ------ .../introduction/install-windows.html.md.erb | 77 -------- .../introduction/install_opensource.md | 22 --- .../introduction/uninstall.html.md.erb | 55 ------ 7 files changed, 174 insertions(+), 225 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode-native/blob/5e194a7d/BUILDING.md ---------------------------------------------------------------------- diff --git a/BUILDING.md b/BUILDING.md index da142c1..4b3f851 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -77,7 +77,7 @@ Due to limitations in CMake, the documentation must be built as a separate step ### Required Tools * [Visual Studio 2013](https://www.visualstudio.com) or newer -* [Cygwin](https://www.cygwin.com/) +* [Cygwin](https://www.cygwin.com/) (for the patch tool) ## Linux * RHEL/CentOS 6 @@ -86,7 +86,7 @@ Due to limitations in CMake, the documentation must be built as a separate step * SLES 12 ### Required Tools -* [GCC 4.6](https://gcc.gnu.org) or newer +* [GCC 4.9](https://gcc.gnu.org) or newer ### Optional Tools * [Eclipse CDT 8.8](https://eclipse.org/cdt/) or newer http://git-wip-us.apache.org/repos/asf/geode-native/blob/5e194a7d/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb b/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb index e61c9ea..291c0e5 100644 --- a/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb +++ b/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb @@ -38,19 +38,8 @@ limitations under the License.
  • About the Native Client
    • -
  • +
  • Installing the Native Client -
  • Running Native Client Applications http://git-wip-us.apache.org/repos/asf/geode-native/blob/5e194a7d/docs/geode-native-docs/introduction/install-overview.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/introduction/install-overview.html.md.erb b/docs/geode-native-docs/introduction/install-overview.html.md.erb index 6cf604d..f04c80d 100644 --- a/docs/geode-native-docs/introduction/install-overview.html.md.erb +++ b/docs/geode-native-docs/introduction/install-overview.html.md.erb @@ -19,16 +19,180 @@ See the License for the specific language governing permissions and limitations under the License. --> -Installing and uninstalling the native client varies based on operating system. +To install the Geode Native Client, you build the client libraries from a source distribution. +To build the client libraries: -- **[Installing on Linux or Solaris](install-unix.html)** + 1. Download the source distribution. + 2. Install prerequisites and tools. + 3. Build and install the client libraries. - Install the native client on Linux or Solaris by extracting the contents of a ZIP file, and setting up the environment. +# Download the Source Distribution -- **[Installing on Windows](install-windows.html)** +Download Geode Native Client sources from the [Releases page of the Apache Geode +website](http://geode.apache.org/releases/) and unpack the archive in a location of your choice. +For example, if your downloaded archive is named `apache-geode-src-1.1.0.tar.gz` and your target +directory is represented by _geode-native-installdir_: - Install the native client by using the Windows installer GUI interface or the command line. + ``` + $ cd geode-native-installdir + $ tar xvzf ~/Downloads/apache-geode-src-1.1.0.tar.gz + x ./ + x ./geode-native + x ./BUILDING.md + x ./LICENSE + x ./README.md + ... + ``` + +Be sure to review the `BUILDING.md` file in the top-level directory of your source release for build +information and `README.md` for general information. + +# Prerequisites + +In order to build the Geode Native Client libraries, your system must provide certain prerequisites: + + - Compatible operating system + - Apache Geode + - CMake + - C++11 compiler + - Doxygen + - Optional tools + +See the following sections for details. + +## Operating Systems + +The following operating systems are known to be compatible with the Apache Geode Native Client. +The list is not exhaustive, others may also work. + +| Operating System | Version | +|------------------|---------| +| Linux | RHEL/CentOS 6 | +| | RHEL/CentOS 7 | +| | SLES 11 | +| | SLES 12 | +| Windows | Windows 8.1 64-bit | +| | Windows 10 64-bit | +| | Windows Server 2012 64-bit | +| | Windows Server 2012 R2 64-bit | +| macOS | MacOS 10.12 (Sierra) | +| Solaris | Solaris 10 SPARC | +| | Solaris 10 x86 | +| | Solaris 11 SPARC | +| | Solaris 11 x86 | + + +## Geode + +Building the client libraries requires access to an installation of Geode. Geode libraries are referenced during the +client build process, and the Geode executables are needed if you wish to run examples and tests. + +If the `GEODE` environment variable is defined, CMake uses it to determine the location of your Geode installation. +Otherwise, CMake searches some system-specific default locations. To explicitly specify the location in which Geode +is installed, define `GEODE_ROOT=/path/to/geode` in your initial `cmake` configuration command. + +## CMake + +CMake version 3.4 or newer is required to build the native client and its QuickStart examples. To download and install +CMake, follow the instructions on [cmake.org] (https://cmake.org). + +CMake uses a "generator" to produce configuration files for use by a variety of build tools, such as +Unix makefiles or 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 some cases there is a better choice. + +| System | Recommended CMake Generator +|---------------|------------------------------| +| Windows | Visual Studio 12 2013 Win64 | +| Mac | XCode | + +Specify the generator with the -G option. For example, on Windows: + + ``` + $ cmake -G "Visual Studio 12 2013 Win64" ../src + ``` + +## C++11 Compiler +Integrated development environments (IDEs) for various systems usually include the compilers that you need. +This table shows recommended versions for some of the most popular systems. + +| System | IDE / Compiler| Version +|---------------|---------------|---------------| +| Linux | GCC | [4.9](https://gcc.gnu.org) or newer | +| Windows | Visual Studio | [2013](https://www.visualstudio.com) or newer | +| Mac | XCode | [8.2.1](https://developer.apple.com/xcode/download/) or newer | +| Solaris | Solaris Studio |[12.4](http://www.oracle.com/technetwork/server-storage/solarisstudio/downloads/index-jsp-141149.html) or newer | + + +## Doxygen + +[Doxygen 8.11](http://www.stack.nl/~dimitri/doxygen/download.html) is needed for building source documentation. + +## Optional Build Environment Tools + +The CMake utility performs much of the configuration required to build and install the client libraries. + +You may find some optional tools to be helpful in certain environments. Here are some that might be useful. + +| System | Optional Tool | +|---------------|---------------| +| Linux | [Eclipse CDT 8.8](https://eclipse.org/cdt/) or newer | +| Mac | [CMake GUI](https://cmake.org/files/v3.4/cmake-3.4.3-Darwin-x86_64.dmg) | +| | [Doxygen GUI](http://ftp.stack.nl/pub/users/dimitri/Doxygen-1.8.11.dmg) | + +  + +# Build and Install + +The Geode Native source distribution comes with CMake files for building and installing the client libraries. + +CMake uses a default system-specific location as the destination of the `install` target, for +example, `/usr/local` on Unix systems. (On Unix systems, you may need to execute your `cmake` +commands using `sudo` to allow CMake to write output files to protected locations, such as +`/usr/local`.) To explicitly specify the location in which the Native Client will be installed, +define `CMAKE_INSTALL_PREFIX=/install-destination` in the initial `cmake` configuration command. + +To build and install the client libraries: + + 1. Create a build directory and set it as the current working directory. + + ``` + $ cd geode-native-installdir + $ mkdir build + $ cd build + ``` + + 2. Run CMake to configure the system for the CMake commands that follow. Specify any environment variables + on this first CMake command line. In its simplest form, the configuration command specifies only the location of the + CMake templates: + + ``` + $ cmake ../src + ``` + + In this example, the command includes a pointer to Geode and an installation destination: + + + ``` + $ cmake -DGEODE_ROOT=/geode-installdir -DCMAKE_INSTALL_PREFIX=/installation-destination ../src + ``` + + 3. Run CMake to perform the build. + + ``` + $ cmake --build . + ``` + + 4. Run CMake to build the documentation. + + ``` + $ cmake --build . --target docs + ``` + + 5. Run Cmake to perform the installation. + + ``` + $ cmake --build . --target install + ``` -- **[Uninstalling the Native Client](uninstall.html)** - Uninstalling the native client varies based on operating system. http://git-wip-us.apache.org/repos/asf/geode-native/blob/5e194a7d/docs/geode-native-docs/introduction/install-unix.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/introduction/install-unix.html.md.erb b/docs/geode-native-docs/introduction/install-unix.html.md.erb deleted file mode 100644 index 6d6320a..0000000 --- a/docs/geode-native-docs/introduction/install-unix.html.md.erb +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Installing on Linux or Solaris ---- - - - -Install the native client on Linux or Solaris by extracting the contents of a ZIP file, and setting up the environment. - -## Installation Prerequisites - -Before installing the GemFire native client, complete the following prerequisites: - -- Confirm that your system meets the hardware and software requirements described in [GemFire Native Client Supported Configurations](../getting_started/system_requirements/gemfire_native_client_requirements.html#concept_7AE0C1CB11244095A50CCB52A09A09A1). -- From the [Pivotal GemFire download page](https://network.pivotal.io/products/pivotal-gemfire), select **Download**. -- Under File Groups, select and download the Pivotal GemFire native client ZIP file appropriate for your operating system and processor architecture. - - For Linux platforms, download `pivotal-gemfire-nativeclient-linux-64bit-XXX.zip`. `XXX` represents the version number of the product, for example `9.0.0`. - - For Solaris platforms, download `pivotal-gemfire-nativeclient-Solaris-ARCHITECTURE-64bit-XXX.zip`. `ARCHITECTURE` will be `sparc` or `x86`, matching your platform's processor. `XXX` represents the version number of the product, for example `9.0.0`. - -## Uncompress the ZIP File - -Uncompress the ZIP file. For example: - -```pre -unzip pivotal-gemfire-nativeclient-linux-64bit-9.0.0.zip -``` -The directory created is the *product-dir* used in setting environment variables. - -## Environment Variables - -Set the environment: - -- Set the `GFCPP` environment variable to *product-dir*. -- Add `$GFCPP/bin` to the `PATH`. -- Add `$GFCPP/lib` to the `LD_LIBRARY_PATH`. - http://git-wip-us.apache.org/repos/asf/geode-native/blob/5e194a7d/docs/geode-native-docs/introduction/install-windows.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/introduction/install-windows.html.md.erb b/docs/geode-native-docs/introduction/install-windows.html.md.erb deleted file mode 100644 index 1e47466..0000000 --- a/docs/geode-native-docs/introduction/install-windows.html.md.erb +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: Installing on Windows ---- - - - -Install the native client by using the Windows installer GUI interface or the command line. - -## Prerequisites - -Before installing the GemFire native client, complete the following prerequisites: - -- Confirm that your system meets the hardware and software requirements described in [Windows Support Details](../getting_started/system_requirements/gemfire_native_client_requirements.html#concept_7AE0C1CB11244095A50CCB52A09A09A1__section_3A8A0684D68E467EBA498D939E91C5AA). -- From the [Pivotal GemFire download page](https://network.pivotal.io/products/pivotal-gemfire), select **Download**. -- On the Pivotal GemFire product download page, select and download the Pivotal GemFire native client MSI appropriate for your hardware architecture. - -**Note:** -If you do not install the native client using the MSI installer or the msiexec command-line, then you will need to manually perform the configuration steps, such as configure your `GFCPP` and `PATH` environment variables, and install the Microsoft Visual C++ 2013 Redistributable Package. - -## Install with the Windows Installer - -The native client can be installed on Windows by using the `pivotal-gemfire-nativeclient-64bit-XXX.msi` Windows installer. `XXX` represents the version of the product, for example `9.0.0`. The installer requires `msiexec` version 3.0 or higher. - -While logged in with administrative privileges, -double-click the MSI file to start the installation. -Enter the installation location of the native client when prompted. - -The MSI installer installs the Microsoft Visual C++ 2013 Redistributable Package for your platform architecture ([https://www.microsoft.com/en-us/download/details.aspx?id=40784](https://www.microsoft.com/en-us/download/details.aspx?id=40784)). This package contains runtime libraries required by the native client. - -The MSI installer automatically configures these native client system environment settings: - -- Sets the `GFCPP` environment variable to *product-dir*, where *product-dir* represents the installation location chosen. -- Adds `%GFCPP%\bin` to the Windows `PATH`. - -## Install from the MSI Command Line - -To use the command line for installation, substitute an appropriate value for `XXX` in a command with syntax: - -``` pre -msiexec /q /i pivotal-gemfire-nativeclient-64bit-XXX.msi ^ -DEFAULT_INSTALLDIR= -``` - -The following table lists common `msiexec` command-line options, along with an explanation of their usage. For a list of all command-line options, enter `msiexec/?`. - - - -| Option | Explanation | -|-----------------------------|---------------------------------------------------------------------| -| `/q` | Creates a quiet installation with no interface or prompts. | -| `/i` | Indicates that the product is to be installed or configured. | -| `DEFAULT_INSTALLDIR=` | Specifies the destination directory, if different from the default. | -| `/x` | Indicates a product uninstall procedure. | - -## Repair a Windows Installation - -If problems occur with your Windows native client installation you can initiate a repair operation to restore any missing elements or registry settings. - -1. Double-click the MSI file, then click Next in the Setup Wizard screen. -2. In the following screen, click the Repair button. -3. In the next screen, click the Repair button. - http://git-wip-us.apache.org/repos/asf/geode-native/blob/5e194a7d/docs/geode-native-docs/introduction/install_opensource.md ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/introduction/install_opensource.md b/docs/geode-native-docs/introduction/install_opensource.md deleted file mode 100644 index d0cdb56..0000000 --- a/docs/geode-native-docs/introduction/install_opensource.md +++ /dev/null @@ -1,22 +0,0 @@ -Cmake is required to build the native client and its quickstart examples. To download and install cmake, follow the instructions on [cmake.org] (https://cmake.org). - -Installation on Mac: - -- Checkout Geode sources - -- Checkout NC branch - -- cd geode. NC sources are in 'src' subdir. - -- create build dir (e.g. build-nc) at same level as 'src'. - -- cmake config: `cmake ../src -DCMAKE_INSTALL_PREFIX=/Users/dbarnes/Repo/geode/build-nc` (if prefix not specified, will be installed to `/usr/local`) - -- cmake build: `cmake --build .` - -- cmake build: `cmake --build . --target docs` - -- cmake install: `cmake --build . --target install` - - - http://git-wip-us.apache.org/repos/asf/geode-native/blob/5e194a7d/docs/geode-native-docs/introduction/uninstall.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/introduction/uninstall.html.md.erb b/docs/geode-native-docs/introduction/uninstall.html.md.erb deleted file mode 100644 index 9d635f8..0000000 --- a/docs/geode-native-docs/introduction/uninstall.html.md.erb +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Uninstalling the Native Client ---- - - - -Uninstalling the native client varies based on operating system. - -## Uninstall on Linux and Solaris - -To uninstall on Linux and Solaris platforms, delete the product directory and all of its subdirectories. - -## Uninstall on Windows - -To uninstall on Windows platforms, use the MSI installer graphical interface, its command-line interface, or the Windows Control Panel. - -**Uninstall from MSI Installer Graphical Interface** - -1. Double-click the MSI file, then click Next in the Setup Wizard screen. -2. In the following screen, click the Remove button. -3. In the next screen, click the Remove button and then click Finish. - -**Uninstall from MSI Installer Command-Line** - -Follow this MSI command-line syntax for a quiet uninstall: - -``` pre -msiexec /q /x pivotal-gemfire-nativeclient-64bit-XXX.msi ^ -DEFAULT_INSTALLDIR= -``` - -[MSI Command-Line Options](install-windows.html#install-windows__tbl-msi-options) lists common `msiexec` command-line options, along with an explanation of their usage. `msiexec/?` lists all command-line options. -The `/x` option uninstalls the product. - -**Uninstall from the Control Panel** - -1. From the Control Panel, open Add or Remove Programs. -2. Select the appropriate native client installation. -3. Click the Remove button. -