IGNITE-4100: Improved README and DEVNOTES for CPP.
Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/eac5f0c0 Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/eac5f0c0 Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/eac5f0c0 Branch: refs/heads/ignite-4242 Commit: eac5f0c05b85b620f979bd73d5043ae521b6f2f4 Parents: ef9d6cf Author: Igor Sapego <[email protected]> Authored: Thu Nov 10 21:13:13 2016 +0300 Committer: Igor Sapego <[email protected]> Committed: Thu Nov 10 21:13:13 2016 +0300 ---------------------------------------------------------------------- modules/platforms/cpp/DEVNOTES.txt | 10 +++++++--- modules/platforms/cpp/README.txt | 10 +++++++--- modules/platforms/cpp/examples/README.txt | 16 +++++++++------- 3 files changed, 23 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/eac5f0c0/modules/platforms/cpp/DEVNOTES.txt ---------------------------------------------------------------------- diff --git a/modules/platforms/cpp/DEVNOTES.txt b/modules/platforms/cpp/DEVNOTES.txt index 924b0d8..5d0b2eb 100644 --- a/modules/platforms/cpp/DEVNOTES.txt +++ b/modules/platforms/cpp/DEVNOTES.txt @@ -3,7 +3,9 @@ Apache Ignite C++ Build Instructions Here you can find instruction on how to build Apache Ignite C++ core library and stand-alone node binary. To build examples you need to build and install core Apache Ignite library then refer to $IGNITE_HOME/platforms/cpp/example/README.txt for -futher instructions. +further instructions. + +For details on ODBC driver installation and usage please refer to odbc/README.txt. Building on Linux With Autotools ---------------------------------- @@ -15,7 +17,9 @@ Common Requirements: * JAVA_HOME environment variable must be set pointing to Java installation directory. * IGNITE_HOME environment variable must be set to Ignite installation directory. * To build ODBC driver you need to install ODBC Driver Manager on you system. - Apache Ignite has been tested with UnixODBC. + Apache Ignite has been tested with UnixODBC. Make sure that you install development + version of the driver manager which contains header files that are necessary for + building a driver. Building the Apache Ignite C++ components: * Navigate to the directory $IGNITE_HOME/platforms/cpp @@ -37,7 +41,7 @@ use configure script with the following arguments: With the config like that you should not have any ignite dependencies as jvm.dll installed to build ODBC driver. -NOTE: You may want to use "make install" command to install Ignite libraries and heasders +NOTE: You may want to use "make install" command to install Ignite libraries and headers for your operation system. Note however that this action may require superuser privileges. Building on Windows with Visual Studio (tm) http://git-wip-us.apache.org/repos/asf/ignite/blob/eac5f0c0/modules/platforms/cpp/README.txt ---------------------------------------------------------------------- diff --git a/modules/platforms/cpp/README.txt b/modules/platforms/cpp/README.txt index dbde9f0..b1d7eef 100644 --- a/modules/platforms/cpp/README.txt +++ b/modules/platforms/cpp/README.txt @@ -2,7 +2,7 @@ Apache Ignite C++ ================================== Apache Ignite C++ provides data grid functionality. -Using Apache Ignite C++ APIs you can execute perform concurrent operations on +Using Apache Ignite C++ APIs you can perform concurrent operations on the data stored in cache. Apache Ignite C++ can access cluster and share data with .Net and @@ -11,14 +11,18 @@ Java applications using binary object format. Support for the following will be added in next releases: * ACID transactions management. * Distributed locks. - * Async operations. + * Asynchronous operations. * Cache SQL continuous queries. * Event listening. * Compute grid functionality. Full source code is provided. Users should build the library for intended platform. + For build instructions please refer to DEVNOTES.txt. +For details on ODBC driver installation and usage please refer to +$IGNITE_HOME/platforms/cpp/odbc/README.txt. + Linux info ============== @@ -49,7 +53,7 @@ Files list: * ignite.exe - executable to start standalone Ignite C++ node. * ignite.core.dll - Ignite C++ API library. - * odbc.dll - Ignite ODBC driver. + * ignite.odbc.dll - Ignite ODBC driver. Development: http://git-wip-us.apache.org/repos/asf/ignite/blob/eac5f0c0/modules/platforms/cpp/examples/README.txt ---------------------------------------------------------------------- diff --git a/modules/platforms/cpp/examples/README.txt b/modules/platforms/cpp/examples/README.txt index 29df732..91e4869 100644 --- a/modules/platforms/cpp/examples/README.txt +++ b/modules/platforms/cpp/examples/README.txt @@ -6,8 +6,13 @@ Common requirements * Java Development Kit (JDK) must be installed: https://java.com/en/download/index.jsp * JAVA_HOME environment variable must be set pointing to Java installation directory. * IGNITE_HOME environment variable must be set to Ignite installation directory. - * Ignite must be build and packaged using Maven. You can use the followin Maven command: mvn clean package -DskipTests - * Apache Ignite C++ must be built according to instructions for your platform. + * Ignite must be built and packaged using Maven. You can use the following Maven command: mvn clean package -DskipTests + * Apache Ignite C++ must be built according to instructions for your platform. Refer to + $IGNITE_HOME/platforms/cpp/DEVNOTES.txt for instructions. + * For odbc-example additionally ODBC Driver Manager must be present and installed on your platform and + Apache Ignite ODBC driver must be built and installed according to instructions for your platform. Refer to + $IGNITE_HOME/platforms/cpp/DEVNOTES.txt for build instructions and to $IGNITE_HOME/platforms/cpp/odbc/README.txt. + for installation instructions. Running examples on Linux ---------------------------------- @@ -22,11 +27,8 @@ To build examples execute the following commands one by one from examples root d As a result executables will appear in every example's directory. -Before running examples ensure that: - * LD_LIBRARY_PATH environment variable is set and pointing to a directory with "libjvm.so" library. Typically this - library is located in $JAVA_HOME/jre/lib/amd64/server directory. - * For odbc-example additionaly ODBC Driver Manager must be present and installed on your platform and - Apache Ignite ODBC driver must be built and installed according to instructions for your platform. +Before running examples ensure that LD_LIBRARY_PATH environment variable is set and pointing to a directory with +"libjvm.so" library. Typically this library is located in $JAVA_HOME/jre/lib/amd64/server directory. Running examples on Windows ----------------------------------
