1
1
openmpi/ompi
Jeff Squyres 7ace873b50 Add MPI_T.5 man page for Open MPI-specific info
Also added infrastructure to have developers write man pages in
Markdown (vs. nroff).  Pandoc >=v1.12 is used to convert those
Markdown files into actual nroff man pages.

Dist tarballs will contain generated nroff man pages; we don't want to
require users to have Pandoc installed.  Anyone who builds Open MPI
from a git clone will need to have Pandoc installed (similar to how we
treat Flex).  You can opt out of Open MPI's Pandoc-generated man pages
by configuring Open MPI with --disable-man-pages.  This will also
disable "make dist" (i.e., "make dist" will error if you configured
with --disable-man-pages).

Also removed the stuff to re-generate man pages.

This commit also:

1. Includes a new man page, written in Markdown
   (ompi/mpi/man/man5/MPI_T.5.md) that contains Open MPI-specific
   information about MPI_T.
2. Includes a converted ompi/mpi/man/man3/MPI_T_init_thread.3.md (from
   MPI_T_init_thread.3in -- i.e., nroff) just to show that Markdown
   can be used throughout the Open MPI code base for man pages.
3. Made the Makefiles in ompi/mpi/man/man?/ be full-fledged
   Makefile.am's (vs. Makefile.extras that are designed to be included
   in ompi/Makefile.am).  It is more convenient to test generation /
   installation of man pages when you can "make" and "make install" in
   their respective directories (vs. doing a build / install for the
   entire ompi project).
4. Removed logic from ompi/Makefile.am that re-generated man pages if
   opal_config.h changes.

Other man pages -- hopefully all of them! -- will be converted to
Markdown over time.

Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
2020-05-02 12:45:31 -07:00
..
attribute Add threads framework 2020-03-27 10:15:45 -06:00
class Revert "Update to sync with OMPI master and cleanup to build" 2016-11-22 15:03:20 -08:00
communicator Fix intercomm operations 2020-04-15 17:04:22 -07:00
contrib ompitrace: MPI_Address -> MPI_Get_address 2018-05-01 15:20:02 -06:00
datatype Mark predefined empty datatype contiguous. 2019-09-07 14:40:21 +10:00
debuggers Remove ORTE project 2020-02-07 18:20:06 -08:00
dpm Update dpm to handle deprecation of MPI_Info keys 2020-04-29 14:56:38 -07:00
errhandler Merge pull request #7323 from bosilca/fix/7320 2020-02-27 06:28:44 -05:00
etc Upgrade all www.open-mpi.org URLs to https 2020-04-02 10:43:50 -04:00
file Add threads framework 2020-03-27 10:15:45 -06:00
group opal: add types for atomic variables 2018-09-14 10:48:55 -06:00
include Some memchecker cleanup and others. 2020-03-05 16:44:18 -05:00
info Update dpm to handle deprecation of MPI_Info keys 2020-04-29 14:56:38 -07:00
interlib Fix singletons and ensure adequate PMIx version 2020-03-23 10:29:42 -07:00
mca OPAL/UCX: enabling new API provided by UCX 2020-05-01 17:58:29 +03:00
message predefined MPI object padding: set to fixed number of bytes (#3634) 2017-06-01 15:28:23 -04:00
mpi Add MPI_T.5 man page for Open MPI-specific info 2020-05-02 12:45:31 -07:00
mpiext Some memchecker cleanup and others. 2020-03-05 16:44:18 -05:00
op Move from the use of regex to compression 2019-02-08 11:11:14 -08:00
patterns Remove ORTE project 2020-02-07 18:20:06 -08:00
peruse mpi/finalized: revamp INITIALIZED/FINALIZED 2018-06-01 13:36:29 -07:00
proc Cleanup heterogeneous builds 2020-04-22 12:46:27 -07:00
request Merge pull request #6578 from hppritcha/topic/thread_framework2 2020-03-27 15:55:48 -06:00
runtime Remove references to numa_rank 2020-05-01 13:32:29 -07:00
tools Upgrade all www.open-mpi.org URLs to https 2020-04-02 10:43:50 -04:00
util timings: Fix timings when 'prefix' is used 2020-03-07 09:36:43 -08:00
win ompi: cleanup various string operations 2018-10-14 16:10:20 -07:00
Makefile.am Add MPI_T.5 man page for Open MPI-specific info 2020-05-02 12:45:31 -07:00