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

Consolidate documentation #11

Open
jsquyres opened this issue Jul 19, 2024 · 1 comment
Open

Consolidate documentation #11

jsquyres opened this issue Jul 19, 2024 · 1 comment
Labels
capstone24-stretch stretch goal for capstone24 class documentation Improvements or additions to documentation

Comments

@jsquyres
Copy link
Member

Background

There are 4 separate sets of PRTE docs (some of which get combined):

  1. The main PRTE docs in docs/ (as you can see in https://docs.prrte.org/)
  2. Chunks of docs text in src/docs/prrte-rst-content. This content is generally included and/or embedded in other docs (such as the docs in 1, but also the Open MPI mpirun(1) man page).
  3. "Show help" text files in src/docs/show-help-files. This content is specifically formatted displaying error messages at run time (vs. being pretty documentation that is rendered into HTML), but also includes a bunch of content from 2.
  4. A standalone file in src/mca/schizo/ompi/schizo-ompi-cli.rstxt that is specifically intended for Open MPI's mpirun(1) command documentation (man page). It also includes a bunch of content from 2.

Open MPI's docs (in its docs/ directory) copies PRTE's src/docs/prte-rst-content and the schizo-ompi-cli.rstxt to OMPI's docs/prte-rst-content/ so that it can build + render the overall OMPI docs.

Task

After moving PRTE out of a submodule and into Open MPI proper, remove the logic in Open MPI's docs/Makefile.am that copies over the prrte-rst-content RST files from the internal or external PRTE (remember: now, there will never be an external PRTE) to OMPI's docs/ dir. Instead, replace this logic with a relative sym link directly to the location of the PRTES RST source files in the OMPI git clone.

Also move the schizo ompi CLI rst file into the target location in the docs tree rather than having it live in the schizo ompi component (since the OMPI PRTE is now OMPI-specific, there is no need for the schizo framework, and we can be OMPI-specific).

Since we will always be building Open MPI against the internal PRTE, remove logic (and any additional scripts or data files) that handles the case where we were not building against any PRTE.

NOTE: This issue specifically does not cover consolidating the main PRTE docs in 1 (above). That will be a separate issue.

@rhc54
Copy link

rhc54 commented Jul 19, 2024

since the OMPI PRTE is now OMPI-specific, there is no need for the schizo framework

Pointed this out elsewhere, but might as well correct this statement here too. You must retain the schizo framework as the prted daemons require the prte personality. Removing it also means that fixes/changes made upstream are suddenly no longer portable - and that probably isn't a desirable situation.

So can it be removed? Sure, with a lot of work and plenty of risk. Might be worth some careful thought about how far to go in this direction.

@hppritcha hppritcha added the capstone24 Issues to be worked on by capstone24 class label Aug 21, 2024
@hppritcha hppritcha added the documentation Improvements or additions to documentation label Aug 21, 2024
@hppritcha hppritcha added capstone24-stretch stretch goal for capstone24 class and removed capstone24 Issues to be worked on by capstone24 class labels Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
capstone24-stretch stretch goal for capstone24 class documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

3 participants