API: document that group alloc/insert must use the same topology

bgoglin · bgoglin · commit 98893601b445 · 2023-09-18T11:57:47.000+02:00
Signed-off-by: Brice Goglin &lt;Brice.Goglin@inria.fr&gt;
diff --git a/include/hwloc.h b/include/hwloc.h
@@ -2840,6 +2840,9 @@ HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_alloc_group_object(hwloc_topology_t to
  *
  * \note If the insertion fails, the input group object is freed.
  *
+ * \note \p topology must be the same as the one previously passed
+ * to hwloc_topology_alloc_group_object().
+ *
  * \return The inserted object if it was properly inserted.
  *
  * \return An existing object if the Group was merged or discarded

Original file line number	Diff line number	Diff line change
`@@ -2840,6 +2840,9 @@ HWLOC_DECLSPEC hwloc_obj_t hwloc_topology_alloc_group_object(hwloc_topology_t to`
`2840`	`2840`	`*`
`2841`	`2841`	`* \note If the insertion fails, the input group object is freed.`
`2842`	`2842`	`*`
	`2843`	`+ * \note \p topology must be the same as the one previously passed`
	`2844`	`+ * to hwloc_topology_alloc_group_object().`
	`2845`	`+ *`
`2843`	`2846`	`* \return The inserted object if it was properly inserted.`
`2844`	`2847`	`*`
`2845`	`2848`	`* \return An existing object if the Group was merged or discarded`