Skip to content

Commit 96d4afc

Browse files
committed
utils: clarify that --restrict removes PUs and/or NUMA nodes
Signed-off-by: Brice Goglin <Brice.Goglin@inria.fr>
1 parent 2fe1a19 commit 96d4afc

File tree

5 files changed

+21
-5
lines changed

5 files changed

+21
-5
lines changed

utils/hwloc/hwloc-bind.1in

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,12 @@ you should combine with hwloc-calc:
4444
.TP
4545
\fB\-\-restrict\fR <cpuset>
4646
Restrict the topology to the given cpuset.
47+
This removes some PUs and their now-child-less parents.
4748
.TP
4849
\fB\-\-restrict\fR nodeset=<nodeset>
49-
Restrict the topology to the given nodeset, unless \fB\-\-restrict\-flags\fR specifies something different.
50+
Restrict the topology to the given nodeset
51+
(unless \fB\-\-restrict\-flags\fR specifies something different).
52+
This removes some NUMA nodes and their now-child-less parents.
5053
.TP
5154
\fB\-\-restrict\-flags\fR <flags>
5255
Enforce flags when restricting the topology.

utils/hwloc/hwloc-calc.1in

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,15 @@ combine invocations:
6262
.TP
6363
\fB\-\-restrict\fR <cpuset>
6464
Restrict the topology to the given cpuset.
65+
This removes some PUs and their now-child-less parents.
66+
6567
This is useful when combining invocations to filter some objects
6668
before selecting among them.
6769
.TP
6870
\fB\-\-restrict\fR nodeset=<nodeset>
69-
Restrict the topology to the given nodeset, unless \fB\-\-restrict\-flags\fR specifies something different.
71+
Restrict the topology to the given nodeset
72+
(unless \fB\-\-restrict\-flags\fR specifies something different).
73+
This removes some NUMA nodes and their now-child-less parents.
7074
.TP
7175
\fB\-\-restrict\-flags\fR <flags>
7276
Enforce flags when restricting the topology.

utils/hwloc/hwloc-distrib.1in

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,12 @@ and singlify CPU sets by keeping the last bit (instead of the first bit).
8383
.TP
8484
\fB\-\-restrict\fR <cpuset>
8585
Restrict the topology to the given cpuset.
86+
This removes some PUs and their now-child-less parents.
8687
.TP
8788
\fB\-\-restrict\fR nodeset=<nodeset>
88-
Restrict the topology to the given nodeset, unless \fB\-\-restrict\-flags\fR specifies something different.
89+
Restrict the topology to the given nodeset
90+
(unless \fB\-\-restrict\-flags\fR specifies something different).
91+
This removes some NUMA nodes and their now-child-less parents.
8992
.TP
9093
\fB\-\-restrict\-flags\fR <flags>
9194
Enforce flags when restricting the topology.

utils/hwloc/hwloc-info.1in

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,12 @@ Include objects disallowed by administrative limitations.
128128
.TP
129129
\fB\-\-restrict\fR <cpuset>
130130
Restrict the topology to the given cpuset.
131+
This removes some PUs and their now-child-less parents.
131132
.TP
132133
\fB\-\-restrict\fR nodeset=<nodeset>
133-
Restrict the topology to the given nodeset, unless \fB\-\-restrict\-flags\fR specifies something different.
134+
Restrict the topology to the given nodeset
135+
(unless \fB\-\-restrict\-flags\fR specifies something different).
136+
This removes some NUMA nodes and their now-child-less parents.
134137
.TP
135138
\fB\-\-restrict\fR binding
136139
Restrict the topology to the current process binding.

utils/lstopo/lstopo-no-graphics.1in

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,9 +261,12 @@ and bold font may be used to display PU boxes of different kinds.
261261
.TP
262262
\fB\-\-restrict\fR <cpuset>
263263
Restrict the topology to the given cpuset.
264+
This removes some PUs and their now-child-less parents.
264265
.TP
265266
\fB\-\-restrict\fR nodeset=<nodeset>
266-
Restrict the topology to the given nodeset, unless --restrict-flags specifies something different.
267+
Restrict the topology to the given nodeset.
268+
(unless \fB\-\-restrict\-flags\fR specifies something different).
269+
This removes some NUMA nodes and their now-child-less parents.
267270
.TP
268271
\fB\-\-restrict\fR binding
269272
Restrict the topology to the current process binding.

0 commit comments

Comments
 (0)