geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dbar...@apache.org
Subject geode-native git commit: GEODE-2513 Unbranding docs: QuickStart examples This closes #81
Date Wed, 29 Mar 2017 22:20:53 GMT
Repository: geode-native
Updated Branches:
  refs/heads/develop 89cdf0b84 -> 572e7135a


GEODE-2513 Unbranding docs: QuickStart examples
This closes #81


Project: http://git-wip-us.apache.org/repos/asf/geode-native/repo
Commit: http://git-wip-us.apache.org/repos/asf/geode-native/commit/572e7135
Tree: http://git-wip-us.apache.org/repos/asf/geode-native/tree/572e7135
Diff: http://git-wip-us.apache.org/repos/asf/geode-native/diff/572e7135

Branch: refs/heads/develop
Commit: 572e7135af93b92687ef4e0ff653dc554f7f467e
Parents: 89cdf0b
Author: Dave Barnes <dbarnes@pivotal.io>
Authored: Wed Mar 29 14:20:46 2017 -0700
Committer: Dave Barnes <dbarnes@pivotal.io>
Committed: Wed Mar 29 15:20:35 2017 -0700

----------------------------------------------------------------------
 BUILDING.md                                            |  3 +++
 .../introduction/install-overview.html.md.erb          |  3 +++
 .../introduction/quickstart.html.md.erb                | 13 ++++++-------
 3 files changed, 12 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/geode-native/blob/572e7135/BUILDING.md
----------------------------------------------------------------------
diff --git a/BUILDING.md b/BUILDING.md
index 5f61c0f..29ff26f 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -39,6 +39,9 @@ Building requires access to an installation of Geode. By default the value
of `G
 ## 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`.
 
+**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.
+
 Due to limitations in CMake, the documentation must be built as a separate step before installation:
 
     $ cd <clone>

http://git-wip-us.apache.org/repos/asf/geode-native/blob/572e7135/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 3ffaafc..a73aa03 100644
--- a/docs/geode-native-docs/introduction/install-overview.html.md.erb
+++ b/docs/geode-native-docs/introduction/install-overview.html.md.erb
@@ -147,6 +147,9 @@ commands using `sudo` to allow CMake to write output files to protected
location
 `/usr/local`.) To explicitly specify the location in which the Geode Client will be installed,
 define `CMAKE_INSTALL_PREFIX=/install-destination` in the initial `cmake` configuration 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.
+
 To build and install the client libraries:
 
   1. Create a build directory and set it as the current working directory.

http://git-wip-us.apache.org/repos/asf/geode-native/blob/572e7135/docs/geode-native-docs/introduction/quickstart.html.md.erb
----------------------------------------------------------------------
diff --git a/docs/geode-native-docs/introduction/quickstart.html.md.erb b/docs/geode-native-docs/introduction/quickstart.html.md.erb
index 1fe03f7..341978d 100644
--- a/docs/geode-native-docs/introduction/quickstart.html.md.erb
+++ b/docs/geode-native-docs/introduction/quickstart.html.md.erb
@@ -65,8 +65,6 @@ installation directory. Add the Geode libraries shown here to your `CLASSPATH`:
 
     <code>
     % GEODE\_ROOT=_geode-install-dir_; export GEODE\_ROOT <br />
-    %&nbsp;CLASSPATH=$GEODE\_ROOT/lib/geode.jar:$GEODE\_ROOT/lib/antlr.jar:$GEODE\_ROOT/lib/gfSecurityImpl.jar:$CLASSPATH<br
/>
-    %  export CLASSPATH <br />
     %&nbsp;CLASSPATH=$GEODE\_ROOT/lib/geode-dependencies.jar:$GEODE\_ROOT/lib/antlr-2.7.7.jar:$CLASSPATH<br
/>
     %  export CLASSPATH <br />
     </code>
@@ -86,11 +84,12 @@ JDK. Add `$JAVA_HOME/bin` to the start of your `PATH`.
     % export LD\_LIBRARY\_PATH<br />
     </code>
 
-4. Set the `OPENSSL_ROOT_DIR` environment variable, pointing it to the parent folder for
the OpenSSL binaries created from the tarball. Add `OPENSSL/lib` to `LD_LIBRARY_PATH`:
+4. Set the `OPENSSL_ROOT_DIR` environment variable, pointing it to the parent folder for
the OpenSSL binaries created from the tarball. Add `OPENSSL_ROOT_DIR/lib` to `LD_LIBRARY_PATH`:
+
     <code>
     % OPENSSL\_ROOT\_DIR=_parent-folder-for-openssl-binaries_<br />
-    %  export OPENSSL<br />
-    % LD\_LIBRARY\_PATH=$OPENSSL\_ROOT\_DIR/lib:${LD\_LIBRARY\_PATH}<br />
+    %  export OPENSSL\_ROOT\_DIR<br />
+    % LD\_LIBRARY\_PATH=$OPENSSL\_ROOT\_DIR/lib:$LD\_LIBRARY\_PATH<br />
     % export LD\_LIBRARY\_PATH
     </code>
 
@@ -109,7 +108,7 @@ and a third time to install the resulting library into the client installation
d
 tree:
 
     <code>
-    % cmake _client-installdir_/templates/security -DGEODE=_client-installdir_<br />
+    % cmake -DGEODE=_client-installdir_ -DCMAKE_INSTALL_PREFIX=/installation-destination
_client-installdir_/templates/security <br />
     ... creates a makefile and other supporting files<br />
     % cmake --build .<br />
     ... builds  securityImpl plug-in<br />
@@ -179,7 +178,7 @@ binaries created from the tarball. Add  `%OPENSSL_ROOT_DIR%\bin` to `PATH`
and `
     <code>
     \> set OPENSSL\_ROOT\_DIR=c:\OpenSSL<br />
     \> set PATH=%OPENSSL\_ROOT\_DIR%\bin;%PATH%<br />
-    \> set LD\_LIBRARY\_PATH=%OPENSSL%\bin;%LD\_LIBRARY\_PATH%<br />
+    \> set LD\_LIBRARY\_PATH=%OPENSSL\_ROOT\_DIR%\bin;%LD\_LIBRARY\_PATH%<br />
     </code>
 
 5. Create a directory in which to build the `securityImpl` plug-in. This directory (shown
here as


Mime
View raw message