Skip to content

Commit 4d0a4a5

Browse files
committed
Update docs for the basic example
1 parent d8015b3 commit 4d0a4a5

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

scripts/docs_config/examples.rst

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,31 @@ the OS Memory Provider API::
3131

3232
#include "umf/providers/provider_os_memory.h"
3333

34-
Get a pointer to the OS memory provider operations struct and
35-
a copy of default parameters::
34+
Get a pointer to the OS memory provider operations struct::
3635

3736
umf_memory_provider_ops_t *provider_ops = umfOsMemoryProviderOps();
38-
umf_os_memory_provider_params_t params = umfOsMemoryProviderParamsDefault();
37+
38+
Get a default memory provider parameters. The handle to the parameters object
39+
is returned by the :any:`umfOsMemoryProviderParamsCreate` function::
40+
41+
umf_os_memory_provider_params_handle_t params = NULL;
42+
43+
res = umfOsMemoryProviderParamsCreate(&params);
44+
if (res != UMF_RESULT_SUCCESS) {
45+
printf("Failed to create OS memory provider params!\n");
46+
return -1;
47+
}
3948

4049
The handle to created memory ``provider`` object is returned as the last argument
4150
of :any:`umfMemoryProviderCreate`::
4251

4352
umf_memory_provider_handle_t provider;
4453
umfMemoryProviderCreate(provider_ops, &params, &provider);
4554

46-
With this handle we can allocate a chunk of memory, call :any:`umfMemoryProviderAlloc`::
55+
The ``params`` object can be destroyed after the provider is created::
56+
umfOsMemoryProviderParamsDestroy(params);
57+
58+
With the ``provider`` handle we can allocate a chunk of memory, call :any:`umfMemoryProviderAlloc`::
4759

4860
size_t alloc_size = 5000;
4961
size_t alignment = 0;

0 commit comments

Comments
 (0)