Mercurial > hg > ucx / changeset

     1.1 --- a/docs/src/modules-ucx2.md	Tue Jun 20 19:04:07 2023 +0200
     1.2 +++ b/docs/src/modules-ucx2.md	Tue Jun 20 19:13:31 2023 +0200
     1.3 @@ -3,12 +3,12 @@
     1.4  ---
     1.5  
     1.6  UCX 2.1 provided several modules for data structures and algorithms.
     1.7 -You may choose to use specific modules by inclueding the corresponding header
     1.8 +You may choose to use specific modules by including the corresponding header
     1.9  file.
    1.10  Please note, that some modules make use of other UCX 2.1 modules.
    1.11  For instance, the [Allocator](#allocator) module is used by many other modules
    1.12  to allow flexible memory allocation.
    1.13 -By default the header files are placed into an `ucx` directory within your
    1.14 +By default, the header files are placed into an `ucx` directory within your
    1.15  systems include directory. In this case you can use a module by including it
    1.16  via `#include <ucx/MODULENAME.h>`.
    1.17  Required modules are included automatically.
    1.18 @@ -522,9 +522,9 @@
    1.19  ```
    1.20  Be aware, that your destructor function should not free any memory, that is
    1.21  also managed by the pool.
    1.22 -Otherwise you might be risking a double-free.
    1.23 +Otherwise, you might be risking a double-free.
    1.24  More precisely, a destructor function set with `ucx_mempool_set_destr()` MUST
    1.25 -NOT call `free()` on the specified pointer whereas a desructor function
    1.26 +NOT call `free()` on the specified pointer whereas a destructor function
    1.27  registered with `ucx_mempool_reg_destr()` MAY (and in most cases will) call
    1.28  `free()`.
    1.29  
    1.30 @@ -681,7 +681,7 @@
    1.31  the first occurrence of the specified character.
    1.32  Since this substring points to the memory of the argument string, it does not
    1.33  accept `scstr_t` as input argument, because the return type would break the
    1.34 -constness.
    1.35 +const-ness.
    1.36  
    1.37  
    1.38  ### Finding the position of a substring
    1.39 @@ -785,7 +785,7 @@
    1.40  ```
    1.41  If you want to use the `UCX_TEST_ASSERT()` macro in a function, you are
    1.42  *required* to use a `UCX_TEST_SUBROUTINE`.
    1.43 -Otherwise the testing framework does not know where to jump, when the assertion
    1.44 +Otherwise, the testing framework does not know where to jump, when the assertion
    1.45  fails.
    1.46  
    1.47  After implementing the tests, you can easily build a test suite and execute it: