Skip to content

Commit 3717ef2

Browse files
author
Kirill Zhuchkov
authored
Correct the spelling (#816)
The in-memory and on-disk is a tautology. Elswhere, the term in-memory used seldomly and the term on-disk almost mever used. Relates-To: OAM-221 Signed-off-by: Kirill Zhuchkov <[email protected]>
1 parent d5630ed commit 3717ef2

File tree

11 files changed

+17
-17
lines changed

11 files changed

+17
-17
lines changed

docs/OverallArchitecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following diagram shows an overview of the SDK components and their relation
2626

2727
The core module offers the following platform-independent functionality:
2828

29-
* **cache** - on-disk and in-memory cache
29+
* **cache** - disk and memory cache
3030
* **client** - generic HTTP client that performs communication with the HERE Open Location Platform (OLP)
3131
* **geo** - geo utilities
3232
* **logging** - logging to file, console or any customer-defined logger

docs/dataservice-cache-example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ To create the `OlpClientSettings` object:
109109
110110
3. [Authenticate](#authenticate-to-here-olp-using-client-credentials) to OLP.
111111

112-
4. Set up the `OlpClientSettings` object with the path to the needed cache settings properties (disk space, the limit of runtime memory, maximum file size, in-memory data cache size, options, paths).
112+
4. Set up the `OlpClientSettings` object with the path to the needed cache settings properties (the limit of runtime memory, disk space, maximum file size, memory data cache size, options, and paths).
113113
For instructions on how to get the path to the cache settings, see the [Build and Run on Linux](#build) section.
114114
> **Note:** Perform the first call with the valid mutable cache path, and the second call – with the protected cache path.
115115

olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationSettings.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ struct AUTHENTICATION_API AuthenticationSettings {
7474

7575
/**
7676
* @brief The maximum number of tokens that can be stored in LRU
77-
* in-memory cache.
77+
* memory cache.
7878
*/
7979
size_t token_cache_limit{100u};
8080

olp-cpp-sdk-core/include/olp/core/cache/CacheSettings.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,17 @@ enum class EvictionPolicy : unsigned char {
4646
};
4747

4848
/**
49-
* @brief Settings for in-memory and on-disk caching.
49+
* @brief Settings for memory and disk caching.
5050
*/
5151
struct CORE_API CacheSettings {
5252
/**
53-
* @brief The path to the mutable (read-write) on-disk cache where
53+
* @brief The path to the mutable (read-write) disk cache where
5454
* the SDK caches and lookups the content.
5555
*
5656
* You should have write permissions.
5757
*
5858
* If this parameter is not set, the downloaded data is stored
59-
* only in the in-memory cache that is limited by `#max_memory_cache_size`.
59+
* only in the memory cache that is limited by `#max_memory_cache_size`.
6060
*/
6161
boost::optional<std::string> disk_path_mutable = boost::none;
6262

@@ -92,9 +92,9 @@ struct CORE_API CacheSettings {
9292
size_t max_file_size = 1024u * 1024u * 2u;
9393

9494
/**
95-
* @brief Sets the upper limit of the in-memory data cache size (in bytes).
95+
* @brief Sets the upper limit of the memory data cache size (in bytes).
9696
*
97-
* If set to `0`, the in-memory cache is not used. The default value is 1 MB.
97+
* If set to `0`, the memory cache is not used. The default value is 1 MB.
9898
*/
9999
size_t max_memory_cache_size = 1024u * 1024u;
100100

olp-cpp-sdk-core/include/olp/core/cache/DefaultCache.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ namespace cache {
3131
class DefaultCacheImpl;
3232

3333
/**
34-
* @brief A default cache that provides an in-memory LRU cache and persistence
34+
* @brief A default cache that provides a memory LRU cache and persistence
3535
* of cached key-value pairs.
3636
*
3737
* @note By default, the downloaded data is cached only in memory.
@@ -47,7 +47,7 @@ class DefaultCacheImpl;
4747
* limitation, the default cache can be accessed only by one process
4848
* exclusively.
4949
*
50-
* By default, the maximum size of the in-memory cache is 1MB. To change it,
50+
* By default, the maximum size of the memory cache is 1MB. To change it,
5151
* set `olp::cache::CacheSettings::max_memory_cache_size` to the desired value.
5252
*/
5353
class CORE_API DefaultCache : public KeyValueCache {

olp-cpp-sdk-core/include/olp/core/client/OlpClientSettings.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ struct CORE_API OlpClientSettings {
255255
* results such as metadata, partition data, URLs from the API Lookup Service,
256256
* and others.
257257
*
258-
* To only use the in-memory LRU cache with limited size, set to `nullptr`.
258+
* To only use the memory LRU cache with limited size, set to `nullptr`.
259259
*/
260260
std::shared_ptr<cache::KeyValueCache> cache = nullptr;
261261
};

olp-cpp-sdk-core/include/olp/core/client/OlpClientSettingsFactory.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ class CORE_API OlpClientSettingsFactory final {
7676

7777
/**
7878
* @brief Creates the `KeyValueCache` instance that includes both a small
79-
* in-memory LRU cache and a larger persistent database cache.
79+
* memory LRU cache and a larger persistent database cache.
8080
*
8181
* The returned cache instance is initialized, opened, and ready to be used.
8282
*

olp-cpp-sdk-core/src/cache/DiskCache.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ struct StorageSettings {
7373
};
7474

7575
/**
76-
* @brief Class which abstracts the on-disk database engine.
76+
* @brief Abstracts the disk database engine.
7777
*/
7878
class DiskCache {
7979
public:

olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/CatalogClient.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ class CatalogClientImpl;
5757
* You can set the default implementation
5858
* (`olp::client::OlpClientSettingsFactory::CreateDefaultNetworkRequestHandler`)
5959
* or pass a custom network implementation to the `CatalogClient` object.
60-
* * The on-disk cache.
60+
* * The disk cache.
6161
* By default, the `CatalogClient` object uses the default implementation
6262
* of `olp::cache::DefaultCache`.
6363
*/

tests/integration/olp-cpp-sdk-dataservice-read/VersionedLayerClientCacheTest.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ TEST_P(VersionedLayerClientCacheTest, GetDataWithPartitionIdDifferentVersions) {
208208

209209
// Test with this parameter is not relevant anymore for cache type none since
210210
// we cannot query 2 versions from one instance of versioned layer client and
211-
// we cannot share default in-memory created cache between 2 instances.
211+
// we cannot share default memory created cache between 2 instances.
212212
if (GetParam() == CacheType::NONE) {
213213
return;
214214
}

0 commit comments

Comments
 (0)