Skip to content

Commit

Permalink
API: clarify the documentation of hwloc_alloc_membind_policy()
Browse files Browse the repository at this point in the history
And remove an obsolete reference to a _nodeset() variant.

Thanks to Philippe Swartvagher.

Signed-off-by: Brice Goglin <Brice.Goglin@inria.fr>
  • Loading branch information
bgoglin committed Nov 8, 2021
1 parent 2770bfe commit bf1f6bb
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions include/hwloc.h
Expand Up @@ -1726,9 +1726,12 @@ HWLOC_DECLSPEC void *hwloc_alloc_membind(hwloc_topology_t topology, size_t len,

/** \brief Allocate some memory on NUMA memory nodes specified by \p set
*
* This is similar to hwloc_alloc_membind_nodeset() except that it is allowed to change
* the current memory binding policy, thus providing more binding support, at
* the expense of changing the current state.
* First, try to allocate properly with hwloc_alloc_membind().
* On failure, the current process or thread memory binding policy
* is changed with hwloc_set_membind() before allocating memory.
* Thus this function works in more cases, at the expense of changing
* the current state (possibly affecting future allocations that
* would not specify any policy).
*
* If ::HWLOC_MEMBIND_BYNODESET is specified, set is considered a nodeset.
* Otherwise it's a cpuset.
Expand Down

0 comments on commit bf1f6bb

Please sign in to comment.