API: clarify in filter doc that MemCaches are ignored by default

bgoglin · bgoglin · commit 6d5e0368d441 · 2023-10-09T18:33:44.000+02:00
It was specified in the object type definition, not in the filter API def. Refs #622. Signed-off-by: Brice Goglin <Brice.Goglin@inria.fr>
diff --git a/include/hwloc.h b/include/hwloc.h
@@ -2520,7 +2520,7 @@ HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(h
 /** \brief Type filtering flags.
  *
  * By default, most objects are kept (::HWLOC_TYPE_FILTER_KEEP_ALL).
- * Instruction caches, I/O and Misc objects are ignored by default (::HWLOC_TYPE_FILTER_KEEP_NONE).
+ * Instruction caches, memory-side caches, I/O and Misc objects are ignored by default (::HWLOC_TYPE_FILTER_KEEP_NONE).
  * Die and Group levels are ignored unless they bring structure (::HWLOC_TYPE_FILTER_KEEP_STRUCTURE).
  *
  * Note that group objects are also ignored individually (without the entire level)

Original file line number	Diff line number	Diff line change
`@@ -2520,7 +2520,7 @@ HWLOC_DECLSPEC const struct hwloc_topology_support *hwloc_topology_get_support(h`
`2520`	`2520`	`/** \brief Type filtering flags.`
`2521`	`2521`	`*`
`2522`	`2522`	`* By default, most objects are kept (::HWLOC_TYPE_FILTER_KEEP_ALL).`
`2523`		`- * Instruction caches, I/O and Misc objects are ignored by default (::HWLOC_TYPE_FILTER_KEEP_NONE).`
	`2523`	`+ * Instruction caches, memory-side caches, I/O and Misc objects are ignored by default (::HWLOC_TYPE_FILTER_KEEP_NONE).`
`2524`	`2524`	`* Die and Group levels are ignored unless they bring structure (::HWLOC_TYPE_FILTER_KEEP_STRUCTURE).`
`2525`	`2525`	`*`
`2526`	`2526`	`* Note that group objects are also ignored individually (without the entire level)`