Skip to content

Commit e6889d3

Browse files
committed
API: clarify that XML input errors are reported either in set_xml*() or load()
set_xml() when using libxml, load() when using our minimalistic parser. Refs #623 Signed-off-by: Brice Goglin <[email protected]>
1 parent 4bd8185 commit e6889d3

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

include/hwloc.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2099,6 +2099,10 @@ HWLOC_DECLSPEC int hwloc_topology_set_synthetic(hwloc_topology_t __hwloc_restric
20992099
* \note On success, the XML component replaces the previously enabled
21002100
* component (if any), but the topology is not actually modified until
21012101
* hwloc_topology_load().
2102+
*
2103+
* \note If an invalid XML input file is given, the error may be reported
2104+
* either here or later by hwloc_topology_load() depending on the XML library
2105+
* used by hwloc.
21022106
*/
21032107
HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict xmlpath);
21042108

@@ -2128,6 +2132,10 @@ HWLOC_DECLSPEC int hwloc_topology_set_xml(hwloc_topology_t __hwloc_restrict topo
21282132
* \note On success, the XML component replaces the previously enabled
21292133
* component (if any), but the topology is not actually modified until
21302134
* hwloc_topology_load().
2135+
*
2136+
* \note If an invalid XML input file is given, the error may be reported
2137+
* either here or later by hwloc_topology_load() depending on the XML library
2138+
* used by hwloc.
21312139
*/
21322140
HWLOC_DECLSPEC int hwloc_topology_set_xmlbuffer(hwloc_topology_t __hwloc_restrict topology, const char * __hwloc_restrict buffer, int size);
21332141

0 commit comments

Comments
 (0)