Skip to content

Minor docs changes #893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion scripts/docs_config/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Mempolicy
Memtarget
==========================================

TODO: Add general information about memtarges.
TODO: Add general information about memtargets.

Memtarget
------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion scripts/docs_config/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/ipc.c
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion src/pool/pool_disjoint.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/pool/pool_jemalloc.c
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion src/pool/pool_scalable.c
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
Loading