doc: document hwloc.xmlfile job shell option

grondo · grondo · commit 999efbfa73db · 2024-02-05T18:58:04.000-08:00
Problem: The hwloc.xmlfile job shell option is undocumented.

Add it to flux-shell(1) as well as the common job shell options shared
by submission command man pages.

Update spelling dictionary.
diff --git a/doc/man1/common/job-shell-options.rst b/doc/man1/common/job-shell-options.rst
@@ -36,3 +36,6 @@
    * - :option:`exit-on-error`
      - Raise a fatal job exception immediately if first task exits with
        nonzero exit code.
+
+   * - :option:`hwloc.xmlfile`
+     - Write hwloc XML gathered by job to a file and set ``HWLOC_XMLFILE``
diff --git a/doc/man1/flux-shell.rst b/doc/man1/flux-shell.rst
@@ -438,6 +438,10 @@ plugins include:
 
   Send signal :option:`signal.signum` *TIME* seconds before job expiration.
 
+.. option:: hwloc.xmlfile
+
+  Write the job shell's copy of hwloc XML to a file and set ``HWLOC_XMLFILE``.
+
 .. warning::
   The directory referenced by :envvar:`FLUX_JOB_TMPDIR` is cleaned up when the
   job ends, is guaranteed to be unique, and is generally on fast local storage
diff --git a/doc/test/spell.en.pws b/doc/test/spell.en.pws
@@ -823,3 +823,4 @@ aspirational
 infeasible
 login
 workflow
+xmlfile
