Skip to content

Commit cbba41d

Browse files
committed
doxy: random improvements in the component page
Signed-off-by: Brice Goglin <[email protected]>
1 parent c15bc81 commit cbba41d

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

doc/hwloc.doxy

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3004,11 +3004,14 @@ objects.
30043004
Depending on the topology configuration, some components will be used
30053005
(once enabled, they create a <b>backend</b>),
30063006
some will be ignored.
3007+
30073008
The usual default is to enable the native operating system component,
30083009
(e.g. <tt>linux</tt> or <tt>solaris</tt>) and the
3009-
<tt>pci</tt> miscellaneous component.
3010+
<tt>pci</tt> one.
30103011
If available, an architecture-specific component (such as <tt>x86</tt>)
30113012
may also improve the topology detection.
3013+
Finally, some hardware-specific components (such as <tt>cuda</tt> or <tt>rsmi</tt>)
3014+
may add information about GPUs, accelerators, etc.
30123015

30133016
If a XML topology is loaded, the <tt>xml</tt> discovery component
30143017
will be used instead of all other components.
@@ -3058,13 +3061,13 @@ priorities) that does not conflict.
30583061
Certain components that manage a virtual topology, for instance XML
30593062
topology import or synthetic topology description,
30603063
conflict with all other components.
3061-
Therefore, one of them may only be loaded
3064+
Therefore, they may only be loaded
30623065
(e.g. with <tt>hwloc_topology_set_xml()</tt>)
30633066
if no other component is enabled.
30643067

30653068
The environment variable <tt>HWLOC_COMPONENTS_VERBOSE</tt>
3066-
may be set to get verbose messages about component registration
3067-
(including their priority) and enabling.
3069+
may be set to get verbose messages about available components
3070+
(including their priority) and enabling as backends.
30683071

30693072

30703073
\htmlonly
@@ -3098,13 +3101,14 @@ name with <tt>-</tt> in the list. For instance <tt>x86,-pci</tt> will load the
30983101
<tt>x86</tt> component, then let hwloc load all the usual components except
30993102
<tt>pci</tt>.
31003103
A single component phase may also be blacklisted, for instance with <tt>-linux:io</tt>.
3101-
hwloc_topology_set_components() may also be used inside the program
3102-
to prevent the loading of a specific component (or phases) for the target topology.
31033104

31043105
It is possible to prevent all remaining components from being loaded
31053106
by placing <tt>stop</tt> in the environment variable.
31063107
Only the components listed before this keyword will be enabled.
31073108

3109+
hwloc_topology_set_components() may also be used inside the program
3110+
to prevent the loading of a specific component (or phases) for the target topology.
3111+
31083112

31093113
\htmlonly
31103114
</div><div class="section" id="plugins_load">
@@ -3176,7 +3180,7 @@ environment variable (see \ref envvar).
31763180
</dd>
31773181
<dt>pci</dt>
31783182
<dd>
3179-
PCI object discovery uses the external pciaccess library (aka libpciaccess);
3183+
PCI object discovery uses the external libpciaccess library;
31803184
see \ref iodevices. It may also annotate existing PCI devices with vendor
31813185
and device names.
31823186
<b>It may be built as a plugin</b>.

0 commit comments

Comments
 (0)