Skip to content

Commit f2fd88b

Browse files
committed
doxy: improve the text about keep structure in the new "disable" faq entry
Signed-off-by: Brice Goglin <Brice.Goglin@inria.fr>
1 parent cc26c0f commit f2fd88b

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

doc/hwloc.doxy

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3517,15 +3517,13 @@ hwloc_topology_load(topology);
35173517

35183518
However, one should remember that filtering such objects out removes
35193519
locality information from the hwloc tree.
3520-
For instance, we do not know anymore which PU is close to which NUMA
3520+
For instance, we may not know anymore which PU is close to which NUMA
35213521
node.
35223522
This would be useful to applications that explicitly want to
35233523
place specific memory buffers close to specific tasks.
3524-
Those applications should also tell hwloc to keep Group objects that
3525-
bring structure information:
3526-
\verbatim
3527-
hwloc_topology_set_type_filter(topology, HWLOC_OBJ_GROUP, HWLOC_TYPE_FILTER_KEEP_STRUCTURE);
3528-
\endverbatim
3524+
To ignore useless objects but keep those that bring locality/hierarchy
3525+
information, applications may replace ::HWLOC_TYPE_FILTER_KEEP_NONE
3526+
with ::HWLOC_TYPE_FILTER_KEEP_STRUCTURE above.
35293527

35303528
<br/>
35313529
Starting with hwloc 2.8, it is also possible to ignore distances

0 commit comments

Comments
 (0)