search

open-mpi / ompi

Open MPI main development repository
https://www.open-mpi.org
Other
2.07k stars 844 forks source link

5.0.3: hostfile help file is misnamed #12633

Closed pawsey-kbuckley closed 2 weeks ago

pawsey-kbuckley commented 2 weeks ago

Hi again: been quite a while, but, no matter:

just tried to run an OpenMPI 5.0.3 mpirun for some noddy testing, and was told:

Sorry!  You were supposed to get help about:
    hostfile:extra-node-not-found
But I couldn't open the help file:
    /path/to/openmpi/5.0.3/share/prte/help-hostfile.txt: No such file or directory.  Sorry!

and it's correct about the "No such file or directory", however, I can see that

/path/to/openmpi/5.0.3/share/prte/help-hostfiles.txt

(note the extra "s")

does exist.

So is OpenMPI looking for the correct file ?

Taking a look in the source

$ grep -r help-hostfile .
./3rd-party/prrte/src/util/hostfile/hostfile.c:        pmix_show_help("help-hostfile.txt", "parse_error_string", true, cur_hostfile_name,
./3rd-party/prrte/src/util/hostfile/hostfile.c:        pmix_show_help("help-hostfile.txt", "parse_error_int", true, cur_hostfile_name,
./3rd-party/prrte/src/util/hostfile/hostfile.c:        pmix_show_help("help-hostfile.txt", "parse_error", true, cur_hostfile_name,
./3rd-party/prrte/src/util/hostfile/hostfile.c:                pmix_show_help("help-hostfile.txt", "port", true, cur_hostfile_name, rc);
./3rd-party/prrte/src/util/hostfile/hostfile.c:                pmix_show_help("help-hostfile.txt", "slots", true, cur_hostfile_name, rc);
./3rd-party/prrte/src/util/hostfile/hostfile.c:                pmix_show_help("help-hostfile.txt", "slots-given", true, cur_hostfile_name,
./3rd-party/prrte/src/util/hostfile/hostfile.c:                pmix_show_help("help-hostfile.txt", "max_slots", true, cur_hostfile_name,
./3rd-party/prrte/src/util/hostfile/hostfile.c:                pmix_show_help("help-hostfile.txt", "max_slots_lt", true, cur_hostfile_name,
./3rd-party/prrte/src/util/hostfile/hostfile.c:            pmix_show_help("help-hostfile.txt", "no-hostfile", true, hostfile);
./3rd-party/prrte/src/util/hostfile/hostfile.c:            pmix_show_help("help-hostfile.txt", "no-hostfile", true, hostfile);
./3rd-party/prrte/src/util/hostfile/hostfile.c:            pmix_show_help("help-hostfile.txt", "hostfile:relative-syntax", true, node->name);
./3rd-party/prrte/src/util/hostfile/hostfile.c:                    pmix_show_help("help-hostfile.txt", "hostfile:not-enough-empty", true,
./3rd-party/prrte/src/util/hostfile/hostfile.c:                    pmix_show_help("help-hostfile.txt", "hostfile:relative-node-not-found", true,
./3rd-party/prrte/src/util/hostfile/hostfile.c:                pmix_show_help("help-hostfile.txt", "hostfile:invalid-relative-node-syntax", true,
./3rd-party/prrte/src/util/hostfile/hostfile.c:                pmix_show_help("help-hostfile.txt", "hostfile:extra-node-not-found", true, hostfile,
./3rd-party/prrte/src/util/hostfile/hostfile.c:        pmix_show_help("help-hostfile.txt", "not-all-mapped-alloc", true, hostfile);
./3rd-party/prrte/src/util/hostfile/hostfile.c:                pmix_show_help("help-hostfile.txt", "hostfile:not-enough-empty", true, num_empty);
./3rd-party/prrte/src/util/hostfile/hostfile.c:                pmix_show_help("help-hostfile.txt", "hostfile:relative-node-not-found", true,
./3rd-party/prrte/src/util/hostfile/hostfile.c:            pmix_show_help("help-hostfile.txt", "hostfile:invalid-relative-node-syntax", true,
./3rd-party/prrte/src/docs/show-help-files/Makefile.in:        $(srcdir)/help-hostfiles.rst \
./3rd-party/prrte/src/docs/show-help-files/Makefile.in:        $(TXT_OUTDIR)/help-hostfiles.txt \
./3rd-party/prrte/src/docs/show-help-files/Makefile:        $(srcdir)/help-hostfiles.rst \
./3rd-party/prrte/src/docs/show-help-files/Makefile:        $(TXT_OUTDIR)/help-hostfiles.txt \
./3rd-party/prrte/src/docs/show-help-files/index.rst:   Hostfiles <help-hostfiles>
./3rd-party/prrte/src/docs/show-help-files/Makefile.am:        $(srcdir)/help-hostfiles.rst \
./3rd-party/prrte/src/docs/show-help-files/Makefile.am:        $(TXT_OUTDIR)/help-hostfiles.txt \

does suggest that a mixture of

help-hostfile.txt

and

help-hostfiles.txt

with the `s', has crept in there.

Easy enough to "fix up in post-production", just by linking the "missing" name into existence, but presumably also easy to fx up in the source?

Though about offering a patch, but thought it best to leave you to decide if you want the singular or the plural in there.

rhc54 commented 2 weeks ago

Sigh - problem is that someone modified the docs section to interface it to OMPI, and unfortunately added an 's' to the end of the filename. Rest of the code uses the non-s version, which is historically correct. As noted, it is a trivial fix.

rhc54 commented 2 weeks ago

Actually, it appears to have already been fixed! Just not in the OMPI release.

pawsey-kbuckley commented 2 weeks ago

What can I tell you, Ralph,

I am no longer "doing enough" with OpenMPI to have a working copy of the repo to inspect, hence looking at the source from the specific tarball.

Apologies for the noise, Kevin