You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@geode.apache.org by davebarnes97 <gi...@git.apache.org> on 2017/03/23 23:29:52 UTC
[GitHub] geode-native pull request #73: GEODE-2513 Unbrand C++ API docs: Getting Star...
GitHub user davebarnes97 opened a pull request:
https://github.com/apache/geode-native/pull/73
GEODE-2513 Unbrand C++ API docs: Getting Started section
Please review for terminology only. Also in scope is a rewrite of the system "requirements" which are now "guidelines".
NOT in scope are (1) making sure the QuickStarts still run with the new names in place, and (2) un-branding filenames. These are the subjects of separate pull requests in progress.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/davebarnes97/geode-native feature/GEODE-2513-GetStarted
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/geode-native/pull/73.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #73
----
commit ce3b552689d204a554af66dd49118aacf473d815
Author: Dave Barnes <db...@pivotal.io>
Date: 2017-03-23T23:26:05Z
GEODE-2513 Unbrand C++ API docs: Getting Started section
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native pull request #73: GEODE-2513 Unbrand C++ API docs: Getting Star...
Posted by echobravopapa <gi...@git.apache.org>.
Github user echobravopapa commented on a diff in the pull request:
https://github.com/apache/geode-native/pull/73#discussion_r107950403
--- Diff: docs/geode-native-docs/introduction/developing-solaris.html.md.erb ---
@@ -19,25 +19,25 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-This section describes how to build and run a native client application on Solaris.
+This section describes how to build and run a client application on Solaris.
## <a id="developing-solaris__section_B518757C7D7A405F9E43C1232C2D6B56" class="no-quick-link"></a>Step 1. Set Environment Variables
-**Note:** When compiling external projects or applications that are used or referenced by the native client, make sure that you compile them for the same target architecture as your native client installation. For example, if you installed the 32-bit (x86) version of the native client, compile your external projects for 32-bit (x86) architecture.
+**Note:** When compiling external projects or applications that are used or referenced by the client, make sure that you compile them for the same target architecture as your client installation. For example, if you installed the 32-bit (x86) version of the client, compile your external projects for 32-bit (x86) architecture.
-Set the native client environment variables on each Solaris host. For each case, *product-dir* is the path to the native client product directory.
+Set the client environment variables on each Solaris host. For each case, *product-dir* is the path to the client product directory.
**For Bourne and Korn shells (sh, ksh, bash)**
<code>
-GFCPP=_product-dir_; export GFCPP<br />
-PATH=$GFCPP/bin:$PATH;export PATH<br />
-LD\_LIBRARY\_PATH=$GFCPP/lib:$LD\_LIBRARY\_PATH;export LD\_LIBRARY\_PATH
+GEODE=_product-dir_; export GEODE<br />
+PATH=$GEODE/bin:$PATH;export PATH<br />
+LD\_LIBRARY\_PATH=$GEODE/lib:$LD\_LIBRARY\_PATH;export LD\_LIBRARY\_PATH
</code>
--- End diff --
The future life of Solaris is very much up in the air, this section could be removed as I don't think it is regarding the "current" version of SunStudio
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native pull request #73: GEODE-2513 Unbrand C++ API docs: Getting Star...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/geode-native/pull/73
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native pull request #73: GEODE-2513 Unbrand C++ API docs: Getting Star...
Posted by PivotalSarge <gi...@git.apache.org>.
Github user PivotalSarge commented on a diff in the pull request:
https://github.com/apache/geode-native/pull/73#discussion_r107939092
--- Diff: docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb ---
@@ -20,26 +20,26 @@ limitations under the License.
<div class="nav-content">
<ul>
<li>
- <a href="/docs/guide-native/11/about_native_client_users_guide.html">Pivotal GemFire Native Client 9.0 Documentation</a>
+ <a href="/docs/guide-native/11/about_native_client_users_guide.html">Apache Geode Client Documentation</a>
</li>
</ul>
<ul>
- <li>
- <a href="/docs/guide-native/11/getting_started/system_requirements/client_requirements.html">Supported Configurations and System Requirements</a>
- </li>
+ <li>
+ <a href="/docs/guide-native/11/introduction/client_configurations.html">System Configurations</a>
+ </li>
</ul>
<ul>
<li class="has_submenu">
- <a href="/docs/guide-native/11/introduction/native-client-intro.html">Getting Started with a Native Client</a>
+ <a href="/docs/guide-native/11/introduction/native-client-intro.html">Getting Started with the Client</a>
<ul>
<li>
- <a href="/docs/guide-native/11/introduction/native-client-overview.html">About the Native Client</a>
+ <a href="/docs/guide-native/11/introduction/native-client-overview.html">About the Client</a>
</li>
<li>
- <a href="/docs/guide-native/11/introduction/install-overview.html">Installing the Native Client</a>
+ <a href="/docs/guide-native/11/introduction/install-overview.html">Installing the Geode Client</a>
--- End diff --
Elsewhere it's just "Client", not "Geode Client".
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native pull request #73: GEODE-2513 Unbrand C++ API docs: Getting Star...
Posted by echobravopapa <gi...@git.apache.org>.
Github user echobravopapa commented on a diff in the pull request:
https://github.com/apache/geode-native/pull/73#discussion_r107950013
--- Diff: docs/geode-native-docs/introduction/developing-linux.html.md.erb ---
@@ -19,48 +19,48 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-This section describes how to build and run a native client application on Linux.
+This section describes how to build and run a client application on Linux.
-**Note:** When compiling external projects or applications that are used or referenced by the Geode native client, make sure that you compile them for the same target architecture as your native client installation. For example, if you installed the 64-bit (x86) version of the native client, compile your external projects for 64-bit (x86) architecture.
+**Note:** When compiling external projects or applications that are used or referenced by the Geode client, make sure that you compile them for the same target architecture as your client installation. For example, if you installed the 64-bit (x86) version of the client, compile your external projects for 64-bit (x86) architecture.
## <a id="developing-linux__section_4AD6E18611AE42E9942C77DF91347768" class="no-quick-link"></a>Step 1. Set Environment Variables
-Set the native client environment variables on each Linux host. For each case, *product-dir* is the path to the native client product directory.
+Set the client environment variables on each Linux host. For each case, *product-dir* is the path to the client product directory.
**For Bourne and Korn shells (sh, ksh, bash)**
<code>
-GFCPP=_product-dir_;export GFCPP<br />
-PATH=$GFCPP/bin:$PATH;export PATH<br />
-LD\_LIBRARY\_PATH=$GFCPP/lib:$LD\_LIBRARY\_PATH;export LD\_LIBRARY\_PATH
+GEODE=_product-dir_;export GEODE<br />
+PATH=$GEODE/bin:$PATH;export PATH<br />
+LD\_LIBRARY\_PATH=$GEODE/lib:$LD\_LIBRARY\_PATH;export LD\_LIBRARY\_PATH
</code>
-## <a id="developing-linux__section_EFE9D42B05B44F2F958054224BCC5F76" class="no-quick-link"></a>Step 2. Compile C++ Clients and Dynamically Link Them to the GemFire Library
+## <a id="developing-linux__section_EFE9D42B05B44F2F958054224BCC5F76" class="no-quick-link"></a>Step 2. Compile C++ Clients and Dynamically Link Them to the Geode Library
-On Linux, the `g++` compiler is supported. To build and link a C++ client to GemFire on Linux, the compilation command line must include the arguments listed in the following table.
+On Linux, the `g++` compiler is supported. To build and link a C++ client to Geode on Linux, the compilation command line must include the arguments listed in the following table.
<a id="developing-linux__compiler-arguments-linux"></a>
| Argument | Explanation |
|--------------------|----------------------------------------------------------|
| `-D_REENTRANT` | Required to compile Linux programs in a thread-safe way. |
| `-m32` or `-m64` | Enables 32-bit or 64-bit compilation. |
-| `-I$GFCPP/include` | Specifies the native client `include` directory. |
+| `-I$GEODE/include` | Specifies the client `include` directory. |
-The following table lists the linker switches that must be present on the command line when dynamically linking to the GemFire library.
+The following table lists the linker switches that must be present on the command line when dynamically linking to the Geode library.
<a id="developing-linux__table_216E9E87FBB44E39BE26388317F3ACE4"></a>
| Argument | Explanation |
|---------------------|----------------------------------------------------------------------------------------------------|
-| `-rpath $GFCPP/lib` | Tells the linker to look in `$GFCPP/lib` for libraries on which the native client library depends. |
-| `-L$GFCPP/lib` | Tells the linker where to find the named libraries. |
+| `-rpath $GEODE/lib` | Tells the linker to look in `$GEODE/lib` for libraries on which the client library depends. |
+| `-L$GEODE/lib` | Tells the linker where to find the named libraries. |
| `-o durableclient` | Tells the linker to output an object file named 'durableclient'. |
-| `-lgfcppcache` | Links the native client C++ cache library to the compiled executable. |
+| `-lgfcppcache` | Links the client C++ cache library to the compiled executable. |
-The following examples compile and link the `$GFCPP/SampleCode/quickstart/cpp/DurableClient.cpp` client to the `durableclient` output file.
+The following examples compile and link the `$GEODE/SampleCode/quickstart/cpp/DurableClient.cpp` client to the `durableclient` output file.
**Compiling and Dynamically Linking on Linux for 32-bit**
--- End diff --
It would be better to have the examples be for 64-bit, in most cases any new development would be on a 64-bit machine/OS
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native issue #73: GEODE-2513 Unbrand C++ API docs: Getting Started sec...
Posted by davebarnes97 <gi...@git.apache.org>.
Github user davebarnes97 commented on the issue:
https://github.com/apache/geode-native/pull/73
Round 2 incorporates suggestions from reviewers.
Per PivotalSarge, more consistency in the uses of "Client" and "Geode Client".
Per echobravopapa, a lot less system-specific hand-holding. Entire sections about running on Linux, Solaris, and Windows have been deleted.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native pull request #73: GEODE-2513 Unbrand C++ API docs: Getting Star...
Posted by echobravopapa <gi...@git.apache.org>.
Github user echobravopapa commented on a diff in the pull request:
https://github.com/apache/geode-native/pull/73#discussion_r107950987
--- Diff: docs/geode-native-docs/introduction/developing-windows.html.md.erb ---
@@ -21,18 +21,18 @@ limitations under the License.
Geode uses the Visual Studio 2010 Service Pack 1 compiler for C++ programs on Windows, which invokes Microsoft<sup>�</sup> `cl.exe` from the command line at compile time.
-The Geode native client supports .NET 4.0 and Visual Studio 2010. For advantages and more information on the features of .NET 4.0 and Visual Studio 2010 SP1, see [http://msdn.microsoft.com/en-us/library/dd831853(v=vs.100).aspx](http://msdn.microsoft.com/en-us/library/dd831853(v=vs.100).aspx) and [http://msdn.microsoft.com/en-us/library/vstudio/w0x726c2(v=vs.100).aspx](http://msdn.microsoft.com/en-us/library/vstudio/w0x726c2(v=vs.100).aspx).
+The Geode client supports .NET 4.0 and Visual Studio 2010. For advantages and more information on the features of .NET 4.0 and Visual Studio 2010 SP1, see [http://msdn.microsoft.com/en-us/library/dd831853(v=vs.100).aspx](http://msdn.microsoft.com/en-us/library/dd831853(v=vs.100).aspx) and [http://msdn.microsoft.com/en-us/library/vstudio/w0x726c2(v=vs.100).aspx](http://msdn.microsoft.com/en-us/library/vstudio/w0x726c2(v=vs.100).aspx).
Visual Studio 2010 SP1 is the recommended compiler. If you are using any other compiler, contact technical support for assistance.
--- End diff --
Let's remove any references to "contacting tech support" as this is not a concept in an Apache project.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native pull request #73: GEODE-2513 Unbrand C++ API docs: Getting Star...
Posted by echobravopapa <gi...@git.apache.org>.
Github user echobravopapa commented on a diff in the pull request:
https://github.com/apache/geode-native/pull/73#discussion_r107950857
--- Diff: docs/geode-native-docs/introduction/developing-windows.html.md.erb ---
@@ -21,18 +21,18 @@ limitations under the License.
Geode uses the Visual Studio 2010 Service Pack 1 compiler for C++ programs on Windows, which invokes Microsoft<sup>�</sup> `cl.exe` from the command line at compile time.
-The Geode native client supports .NET 4.0 and Visual Studio 2010. For advantages and more information on the features of .NET 4.0 and Visual Studio 2010 SP1, see [http://msdn.microsoft.com/en-us/library/dd831853(v=vs.100).aspx](http://msdn.microsoft.com/en-us/library/dd831853(v=vs.100).aspx) and [http://msdn.microsoft.com/en-us/library/vstudio/w0x726c2(v=vs.100).aspx](http://msdn.microsoft.com/en-us/library/vstudio/w0x726c2(v=vs.100).aspx).
+The Geode client supports .NET 4.0 and Visual Studio 2010. For advantages and more information on the features of .NET 4.0 and Visual Studio 2010 SP1, see [http://msdn.microsoft.com/en-us/library/dd831853(v=vs.100).aspx](http://msdn.microsoft.com/en-us/library/dd831853(v=vs.100).aspx) and [http://msdn.microsoft.com/en-us/library/vstudio/w0x726c2(v=vs.100).aspx](http://msdn.microsoft.com/en-us/library/vstudio/w0x726c2(v=vs.100).aspx).
Visual Studio 2010 SP1 is the recommended compiler. If you are using any other compiler, contact technical support for assistance.
--- End diff --
This section might be removable as well, this is an old version of VisualStudio and if the community wants to update/maintain this to match what they are using that's cool
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---