1
1
openmpi/ompi/contrib/README.md
Jeff Squyres c960d292ec Convert all README files to Markdown
A mindless task for a lazy weekend: convert all the README and
README.txt files to Markdown.  Paired with the slow conversion of all
of our man pages to Markdown, this gives a uniform language to the
Open MPI docs.

This commit moved a bunch of copyright headers out of the top-level
README.txt file, so I updated the relevant copyright header years in
the top-level LICENSE file to match what was removed from README.txt.

Additionally, this commit did (very) little to update the actual
content of the README files.  A very small number of updates were made
for topics that I found blatently obvious while Markdown-izing the
content, but in general, I did not update content during this commit.
For example, there's still quite a bit of text about ORTE that was not
meaningfully updated.

Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
Co-authored-by: Josh Hursey <jhursey@us.ibm.com>
2020-11-10 13:52:29 -05:00

20 строки
966 B
Markdown

This is the OMPI contrib system. It is (far) less functional and
flexible than the OMPI MCA framework/component system.
Each contrib package must have a `configure.m4`. It may optionally also
have an `autogen.subdirs` file.
If it has a `configure.m4` file, it must specify its own relevant
files to `AC_CONFIG_FILES` to create during `AC_OUTPUT` -- just like
MCA components (at a minimum, usually its own `Makefile`). The
`configure.m4` file will be slurped up into the main `configure`
script, just like other MCA components. Note that there is currently
no "no configure" option for contrib packages -- you *must* have a
`configure.m4` (even if all it does it call `$1`). Feel free to fix
this situation if you want -- it probably won't not be too difficult
to extend `autogen.pl` to support this scenario, similar to how it is
done for MCA components. :smile:
If it has an `autogen.subdirs` file, then it needs to be a
subdirectory that is autogen-able.