Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

'OpenMPI with UCX' doc missing git submodule flag #9804

Open
TysonRayJones opened this issue Apr 8, 2024 · 2 comments
Open

'OpenMPI with UCX' doc missing git submodule flag #9804

TysonRayJones opened this issue Apr 8, 2024 · 2 comments
Labels

Comments

@TysonRayJones
Copy link

Describe the bug

The OpenMPI with UCX section of the doc instructs to clone OpenMPI via:

git clone https://github.com/open-mpi/ompi.git
cd ompi
./autogen.pl

However, invocation of ./autogen.pl will throw an error:

The submodule "config/oac" is missing

This is corrected by using the --recurse-submodules option to git, replacing the initial line above with:

git clone --recurse-submodules https://github.com/open-mpi/ompi.git

Steps to Reproduce

  • Follow verbatim the current instructions on this page of the doc.
  • UCX version used: 1.17.0.
  • Output of ucx_info -v is:
    # Library version: 1.17.0
    # Library path: /lib/libucs.so.0
    # API headers version: 1.17.0
    # Git branch 'master', revision ab5fa33
    # Configured with: --disable-logging --disable-debug --disable-assertions --disable- params-check
    
- Git version: `2.25.1`
@TysonRayJones
Copy link
Author

If you make a revision to that doc page, it may be useful to point at:

  • all the step numbers are "1" as I highlight here in yellow:
    Screenshot 2024-04-08 at 16 50 25
  • running OpenMPI's configure script required sudo. So the below line in Sec. 'Building'
     ../configure --prefix=<ompi-install-path> --with-ucx=<ucx-install-path>
    should be prefixed with sudo
  • installing openmpi from source, as that doc page instructs, requires that flex is installed. It might be useful to point this out. So the first step of this section (before the user runs OpenMPI's configure script) could include step:
    sudo apt-get install flex

@TysonRayJones
Copy link
Author

Just realised I can PR this myself to running.md, which I may do after getting the build working

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant