Merge pull request #10213 from jsquyres/pr/yet-more-docs

Minor docs updates

Author: jsquyres

docs/Makefile.am

@@ -889,4 +889,13 @@ man1_MANS += \
 man3_MANS += $(OSHMEM_MAN3_BUILT)
 endif
 
+install-data-hook:
+	$(MKDIR_P) $(DESTDIR)$(docdir)
+	cp -r $(srcdir)/_build/html $(DESTDIR)$(docdir)
+	find $(DESTDIR)$(docdir) -type d -exec chmod 0755 {} \;
+	find $(DESTDIR)$(docdir) -type f -exec chmod 0644 {} \;
+
+uninstall-hook:
+	rm -rf $(DESTDIR)$(docdir)
+
 endif OPAL_INSTALL_DOCS

docs/requirements.txt

@@ -1,3 +1,4 @@
+--use-feature=2020-resolver
 sphinx>=4.2.0
 recommonmark
 docutils

docs/to-do.rst

@@ -19,13 +19,23 @@ Need to update these docs to reflect:
 * Document this new breakpoint functionality:
   https://github.com/open-mpi/ompi/commit/f97d081cf9b540c5a79e00aecee17b25e8c123ad
 
-* Document v5.0.x's ABI relationship with v4.x.  It will likely be:
+* Add that we *do* support "single dash" ``mpirun`` options, but we
+  don't want people to do that.
+
+* Document v5.0.x's backwards-compatibility relationship with v4.x
+  (including ABI and ``mpirun`` command line options).  It will likely
+  be:
 
   * C bindings are ABI compatible
+  * Fortran ``mpif.h`` *should* be ok (but probably bears checking).
+  * Fortran module ABIs may have changed.  These definitely need
+    checking (e.g., w.r.t. ``MPI_Status`` and friends...?).
   * MPI-1 deleted functions are always included in the library
 
-    * Need to check to see what the current behavior is w.r.t. the
-      prototypes in ``mpi.h``.
+    * Per Brian: the behavior is the same as Open MPI 4.x. The deleted
+      functions are not declared in mpi.h unless Open MPI was compiled
+      with ``--enable-mpi1-compatibility``.
+
 
 Other random to-do items
 ------------------------

examples/README.md

@@ -4,7 +4,7 @@ Open MPI installation is working properly.
 
 If you are looking for a comprehensive MPI tutorial, these samples are
 not enough.  [Excellent MPI tutorials are available
-here](http://www.citutor.org/login.php).
+here](http://www.hpc-training.org/).
 
 Get a free account and login; you can then browse to the list of
 available courses.  Look for the ones with "MPI" in the title.