Skip to content

Commit e819222

Browse files
committed
doc: document that hwloc.xmlfile unsets HWLOC_COMPONENTS
Problem: The documentation of the hwloc.xmlfile job shell option does not note that its use will also cause HWLOC_COMPONENtS to be unset. Document this in the submission command man pages as well as flux-shell(1).
1 parent 7d0f76c commit e819222

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

doc/man1/common/job-shell-options.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@
3838
nonzero exit code.
3939

4040
* - :option:`hwloc.xmlfile`
41-
- Write hwloc XML gathered by job to a file and set ``HWLOC_XMLFILE``
41+
- Write hwloc XML gathered by job to a file and set ``HWLOC_XMLFILE``.
42+
Note that this option will also unset ``HWLOC_COMPONENTS`` if set, since
43+
presence of this environment variable may cause hwloc to ignore
44+
``HWLOC_XMLFILE``.
4245

4346
* - :option:`output.limit`
4447
- Set KVS output limit to SIZE bytes, where SIZE may be a floating point

doc/man1/flux-shell.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -449,6 +449,8 @@ plugins include:
449449
.. option:: hwloc.xmlfile
450450

451451
Write the job shell's copy of hwloc XML to a file and set ``HWLOC_XMLFILE``.
452+
Note that this option will also unset ``HWLOC_COMPONENTS`` since presence
453+
of this environment variable may cause hwloc to ignore ``HWLOC_XMLFILE``.
452454

453455
.. warning::
454456
The directory referenced by :envvar:`FLUX_JOB_TMPDIR` is cleaned up when the

0 commit comments

Comments
 (0)