Merge pull request #893 from lukaszstolarczuk/minor-docs

Minor docs changes

Author: lukaszstolarczuk

README.md

@@ -241,6 +241,8 @@ This memory pool is distributed as part of libumf. It forwards all requests to t
 memory provider. Currently umfPoolRealloc, umfPoolCalloc and umfPoolMallocUsableSize functions
 are not supported by the proxy pool.
 
+To enable this feature, the `UMF_BUILD_SHARED_LIBRARY` option needs to be turned `ON`.
+
 #### Disjoint pool
 
 TODO: Add a description

scripts/docs_config/api.rst

@@ -148,7 +148,7 @@ Mempolicy
 Memtarget
 ==========================================
 
-TODO: Add general information about memtarges.
+TODO: Add general information about memtargets.
 
 Memtarget
 ------------------------------------------

scripts/docs_config/introduction.rst

@@ -99,7 +99,7 @@ defined pool allocators if they implement the UMF interface.
 Memory Pools
 ============
 
-A memory pool consists of a pool allocator and a memory provider instancies 
+A memory pool consists of a pool allocator and a memory provider instances
 along with their properties and allocation policies. Memory pools are used by 
 the :ref:`allocation API <allocation API>` as a first argument. There is also a possibility to 
 retrieve a memory pool from an existing memory pointer that points to a memory 

src/ipc.c

@@ -109,7 +109,7 @@ umf_result_t umfPutIPCHandle(umf_ipc_handle_t umfIPCHandle) {
     //       implementation does nothing in Put function. Tracking memory
     //       provider relies on IPC cache and actually Put IPC handle back
     //       to upstream memory provider when umfMemoryProviderFree is called.
-    //       To support incapsulation we should not take into account
+    //       To support encapsulation we should not take into account
     //       implementation details of tracking memory provider and find the
     //       appropriate pool, get memory provider of that pool and call
     //       umfMemoryProviderPutIPCHandle(hProvider,

src/pool/pool_disjoint.cpp

@@ -237,7 +237,7 @@ class Bucket {
     // When a slab becomes entirely free we have to decide whether to return it
     // to the provider or keep it allocated. A simple check for size of the
     // Available list is not sufficient to check whether any slab has been
-    // pooled yet.We would have to traverse the entire Available listand check
+    // pooled yet. We would have to traverse the entire Available list and check
     // if any of them is entirely free. Instead we keep a counter of entirely
     // empty slabs within the Available list to speed up the process of checking
     // if a slab in this bucket is already pooled.

src/pool/pool_jemalloc.c

@@ -203,7 +203,7 @@ static bool arena_extent_decommit(extent_hooks_t *extent_hooks, void *addr,
 // physical pages within the virtual memory mapping associated with an extent at given addr and size
 // at offset bytes, extending for length on behalf of arena arena_ind. A lazy extent purge function
 // (e.g. implemented via madvise(...MADV_FREE)) can delay purging indefinitely and leave the pages
-// within the purged virtual memory range in an indeterminite state, whereas a forced extent purge
+// within the purged virtual memory range in an indeterminate state, whereas a forced extent purge
 // function immediately purges, and the pages within the virtual memory range will be zero-filled
 // the next time they are accessed. If the function returns true, this indicates failure to purge.
 // (from https://jemalloc.net/jemalloc.3.html)

src/pool/pool_scalable.c

@@ -183,7 +183,7 @@ umfScalablePoolParamsCreate(umf_scalable_pool_params_handle_t *params) {
     umf_scalable_pool_params_t *params_data =
         umf_ba_global_alloc(sizeof(umf_scalable_pool_params_t));
     if (!params_data) {
-        LOG_ERR("cannot allocate memory for scalable poolparams");
+        LOG_ERR("cannot allocate memory for scalable pool params");
         return UMF_RESULT_ERROR_OUT_OF_HOST_MEMORY;
     }