API: the non-printable character warning applies to info key names too

bgoglin · bgoglin · commit 8285b0612e29 · 2023-07-25T11:48:53.000+02:00
Signed-off-by: Brice Goglin &lt;Brice.Goglin@inria.fr&gt;
diff --git a/include/hwloc.h b/include/hwloc.h
@@ -1151,7 +1151,7 @@ hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_
  * graphical output by using "lstopoStyle" as a name and "Background=#rrggbb"
  * as a value. See CUSTOM COLORS in the lstopo(1) manpage for details.
  *
- * \note If \p value contains some non-printable characters, they will
+ * \note If \p name or \p value contain some non-printable characters, they will
  * be dropped when exporting to XML, see hwloc_topology_export_xml() in hwloc/export.h.
  */
 HWLOC_DECLSPEC int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);

Original file line number	Diff line number	Diff line change
`@@ -1151,7 +1151,7 @@ hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name) __hwloc_attribute_`
`1151`	`1151`	`* graphical output by using "lstopoStyle" as a name and "Background=#rrggbb"`
`1152`	`1152`	`* as a value. See CUSTOM COLORS in the lstopo(1) manpage for details.`
`1153`	`1153`	`*`
`1154`		`- * \note If \p value contains some non-printable characters, they will`
	`1154`	`+ * \note If \p name or \p value contain some non-printable characters, they will`
`1155`	`1155`	`* be dropped when exporting to XML, see hwloc_topology_export_xml() in hwloc/export.h.`
`1156`	`1156`	`*/`
`1157`	`1157`	`HWLOC_DECLSPEC int hwloc_obj_add_info(hwloc_obj_t obj, const char name, const char value);`