You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by ig...@apache.org on 2019/04/30 18:14:48 UTC

[geode-native] branch develop updated: GEODE-6623: Corrected typos and language (#481)

This is an automated email from the ASF dual-hosted git repository.

igodwin pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode-native.git


The following commit(s) were added to refs/heads/develop by this push:
     new 6c0107d  GEODE-6623: Corrected typos and language (#481)
6c0107d is described below

commit 6c0107de440a7a78f83c71dbf44b9fe352e50ecd
Author: Ivan Godwin <ig...@pivotal.io>
AuthorDate: Tue Apr 30 11:14:44 2019 -0700

    GEODE-6623: Corrected typos and language (#481)
    
    Co-authored-by: Dave Barnes <db...@pivotal.io>
---
 clicache/src/Cache.hpp                             |  6 +++---
 clicache/src/PoolFactory.hpp                       |  4 ++--
 cppcache/include/geode/Pool.hpp                    |  2 +-
 cppcache/include/geode/PoolFactory.hpp             | 22 +++++++++++-----------
 cppcache/include/geode/SystemProperties.hpp        |  2 +-
 .../src/InternalCacheTransactionManager2PCImpl.cpp |  4 ++--
 6 files changed, 20 insertions(+), 20 deletions(-)

diff --git a/clicache/src/Cache.hpp b/clicache/src/Cache.hpp
index 8766d62..495ecff 100644
--- a/clicache/src/Cache.hpp
+++ b/clicache/src/Cache.hpp
@@ -218,7 +218,7 @@ namespace Apache
         /// Returns the instance of <see cref="RegionFactory" /> to create the region
         /// </summary>
         /// <remarks>
-        /// Pass the <see cref="RegionShortcut" /> to set the deafult region attributes
+        /// Pass the <see cref="RegionShortcut" /> to set the default region attributes
         /// </remarks>
         /// <param name="regionShortcut">the regionShortcut to set the default region attributes</param>
         /// <returns>Instance of RegionFactory</returns>
@@ -228,7 +228,7 @@ namespace Apache
         /// Returns the instance of <see cref="IRegionService" /> to do the operation on Cache with different Credential.
         /// </summary>
         /// <remarks>
-        /// Deafault pool should be in multiuser mode <see cref="CacheFactory.SetMultiuserAuthentication" />
+        /// Default pool should be in multiuser mode <see cref="CacheFactory.SetMultiuserAuthentication" />
         /// </remarks>
         /// <param name="credentials">the user Credentials.</param>
         /// <returns>Instance of IRegionService</returns>
@@ -238,7 +238,7 @@ namespace Apache
         /// Returns the instance of <see cref="IRegionService" /> to do the operation on Cache with different Credential.
         /// </summary>
         /// <remarks>
-        /// Deafault pool should be in multiuser mode <see cref="CacheFactory.SetMultiuserAuthentication" />
+        /// Default pool should be in multiuser mode <see cref="CacheFactory.SetMultiuserAuthentication" />
         /// </remarks>
         /// <param name="credentials">the user Credentials.</param>
         /// <param name="poolName">Pool, which is in multiuser mode.</param>
diff --git a/clicache/src/PoolFactory.hpp b/clicache/src/PoolFactory.hpp
index f16cf54..e6f703e 100644
--- a/clicache/src/PoolFactory.hpp
+++ b/clicache/src/PoolFactory.hpp
@@ -293,7 +293,7 @@ namespace Apache
         /// By default SetPRSingleHopEnabled is true.
         /// </summary>
         /// <remarks>
-        /// The client is aware of location of partitions on servers hosting
+        /// The client is aware of the locations of partitions on servers hosting partitioned regions.
         /// Using this information, the client routes the client cache operations
         /// directly to the server which is hosting the required partition for the
         /// cache operation. 
@@ -361,7 +361,7 @@ namespace Apache
         /// for the connections but increases the number of connections the servers see.
         /// If false then connections are returned to the pool as soon
         /// as the operation being done with the connection completes. This allows
-        /// connections to be shared amonst multiple threads keeping the number of
+        /// connections to be shared among multiple threads keeping the number of
         /// connections down.
         /// </remarks>
         PoolFactory^ SetThreadLocalConnections(Boolean enabled);
diff --git a/cppcache/include/geode/Pool.hpp b/cppcache/include/geode/Pool.hpp
index 748bb43..85c11b0 100644
--- a/cppcache/include/geode/Pool.hpp
+++ b/cppcache/include/geode/Pool.hpp
@@ -182,7 +182,7 @@ class APACHE_GEODE_EXPORT Pool : public std::enable_shared_from_this<Pool> {
   bool getMultiuserAuthentication() const;
 
   /**
-   * Returns true if single-hop optimisation is enabled on this pool.
+   * Returns true if single-hop optimization is enabled on this pool.
    * @see PoolFactory#setPRSingleHopEnabled
    */
   bool getPRSingleHopEnabled() const;
diff --git a/cppcache/include/geode/PoolFactory.hpp b/cppcache/include/geode/PoolFactory.hpp
index e8510a3..4a7f416 100644
--- a/cppcache/include/geode/PoolFactory.hpp
+++ b/cppcache/include/geode/PoolFactory.hpp
@@ -108,7 +108,7 @@ class APACHE_GEODE_EXPORT PoolFactory {
   static const int DEFAULT_MAX_CONNECTIONS = -1;
 
   /**
-   * The default amount of time in to wait for a connection to become idle.
+   * The default amount of time to wait for a connection to become idle.
    * <p>Current value: <code>5s</code>.
    */
   static const std::chrono::milliseconds DEFAULT_IDLE_TIMEOUT;
@@ -121,7 +121,7 @@ class APACHE_GEODE_EXPORT PoolFactory {
   static const int DEFAULT_RETRY_ATTEMPTS = -1;
 
   /**
-   * The default frequenc, to ping servers.
+   * The default frequency, to ping servers.
    * <p>Current value: <code>10s</code>.
    */
   static const std::chrono::milliseconds DEFAULT_PING_INTERVAL;
@@ -186,7 +186,7 @@ class APACHE_GEODE_EXPORT PoolFactory {
   static constexpr bool DEFAULT_MULTIUSER_SECURE_MODE = false;
 
   /**
-   * The default value for whether to have single hop optimisations enabled.
+   * The default value for whether to have single hop optimizations enabled.
    * <p>Current value: <code>true</code>.
    */
   static constexpr bool DEFAULT_PR_SINGLE_HOP_ENABLED = true;
@@ -254,7 +254,7 @@ class APACHE_GEODE_EXPORT PoolFactory {
    * see.
    * <p>If <code>false</code> then connections are returned to the pool as soon
    * as the operation being done with the connection completes. This allows
-   * connections to be shared amonst multiple threads keeping the number of
+   * connections to be shared among multiple threads keeping the number of
    * connections down.
    *
    * @param threadLocalConnections if <code>true</code> then enable thread local
@@ -485,7 +485,7 @@ class APACHE_GEODE_EXPORT PoolFactory {
    * Sets whether Pool is in multi user secure mode.
    * If its in multiuser mode then app needs to get RegionService instance of
    * Cache.
-   * Deafult value is false.
+   * Default value is false.
    * @return a reference to <code>this</code>
    */
   PoolFactory& setMultiuserAuthentication(bool multiuserAuthentication);
@@ -510,22 +510,22 @@ class APACHE_GEODE_EXPORT PoolFactory {
   std::shared_ptr<Pool> create(std::string name);
 
   /**
-   * By default setPRSingleHopEnabled is true<br>
-   * The client is aware of location of partitions on servers hosting
-   * {@link Region}s.
-   * Using this information, the client routes the client cache operations
+   * By default setPRSingleHopEnabled is true.<br>
+   * The client is aware of the locations of partitions on servers hosting
+   * partitioned regions.
+   * Using this information, the client routes client cache operations
    * directly to the server which is hosting the required partition for the
    * cache operation.
    * If setPRSingleHopEnabled is false the client can do an extra hop on servers
    * to go to the required partition for that cache operation.
-   * The setPRSingleHopEnabled avoids extra hops only for following cache
+   * The setPRSingleHopEnabled setting avoids extra hops only for the following cache
    * operations:<br>
    * 1. {@link Region#put(Object, Object)}<br>
    * 2. {@link Region#get(Object)}<br>
    * 3. {@link Region#destroy(Object)}<br>
    * If true, works best when {@link PoolFactory#setMaxConnections(int)} is set
    * to -1.
-   * @param name is boolean whether PR Single Hop optimization is enabled or
+   * @param enabled is a boolean indicating whether PR Single Hop optimization should be enabled or
    * not.
    * @return a reference to <code>this</code>
    */
diff --git a/cppcache/include/geode/SystemProperties.hpp b/cppcache/include/geode/SystemProperties.hpp
index 2f22c2b..f00d6aa 100644
--- a/cppcache/include/geode/SystemProperties.hpp
+++ b/cppcache/include/geode/SystemProperties.hpp
@@ -269,7 +269,7 @@ class APACHE_GEODE_EXPORT SystemProperties {
 
   /**
    * Returns true if app wants to clear pdx type ids when client disconnect.
-   * deafult is false.
+   * default is false.
    */
   bool onClientDisconnectClearPdxTypeIds() const {
     return m_onClientDisconnectClearPdxTypeIds;
diff --git a/cppcache/src/InternalCacheTransactionManager2PCImpl.cpp b/cppcache/src/InternalCacheTransactionManager2PCImpl.cpp
index 98d8388..facc842 100644
--- a/cppcache/src/InternalCacheTransactionManager2PCImpl.cpp
+++ b/cppcache/src/InternalCacheTransactionManager2PCImpl.cpp
@@ -139,8 +139,8 @@ void InternalCacheTransactionManager2PCImpl::afterCompletion(int32_t status) {
     }
 
     if (!txState->isPrepared()) {
-      // Fallback to deafult 1PC commit
-      // The inherited 1PC implmentation clears the transaction state
+      // Fallback to default 1PC commit
+      // The inherited 1PC implementation clears the transaction state
       switch (status) {
         case STATUS_COMMITTED:
           CacheTransactionManagerImpl::commit();