Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 349985

Summary: Use Open MPI man pages for updated MPI help
Product: [Tools] PTP Reporter: Greg Watson <g.watson>
Component: PLDTAssignee: Greg Watson <g.watson>
Status: RESOLVED FIXED QA Contact:
Severity: enhancement    
Priority: P3 CC: beth, com-eclipse-dot-org
Version: 5.0   
Target Milestone: ---   
Hardware: Macintosh   
OS: Mac OS X   
Whiteboard:
Bug Depends on:    
Bug Blocks: 362593, 362608    
Attachments:
Description Flags
man pages
none
Man pages converted to HTML
none
HTML man pages with hyperlinks, allIndex.html, allMPIapis.c
none
HTML man pages with hyperlinks, allIndex.html, allMPIapis.c (1.5.3) none

Description Greg Watson CLA 2011-06-21 15:41:19 EDT
We would like to use the Open MPI man pages to update the MPI help provided by PLDT.
Comment 1 Greg Watson CLA 2011-06-21 15:43:05 EDT
Created attachment 198360 [details]
man pages
Comment 2 Greg Watson CLA 2011-07-27 17:41:16 EDT
CQ 5416 has been opened for this bug.
Comment 3 Jeffrey Overbey CLA 2011-08-25 17:48:19 EDT
Created attachment 202186 [details]
Man pages converted to HTML

The attached zip file contains the OpenMPI pages converted to HTML.  It also contains the shell script (Man2HTML.sh) which shows the commands used to do the conversion.

Some of the man pages contain Open MPI-specific material -- e.g., do a 'grep "Open MPI" *.html' and 'grep ompi *.html' -- so we might want to edit this out manually.
Comment 4 Greg Watson CLA 2011-08-25 18:07:25 EDT
This has been approved.
Comment 5 Jeffrey Overbey CLA 2011-08-26 11:30:43 EDT
Created attachment 202242 [details]
HTML man pages with hyperlinks, allIndex.html, allMPIapis.c

This attachment contains:

(1) the HTML man pages from the preceding attachment, except with hyperlinks added to the "See Also" sections

(2) a file called allIndex.html with a list of hyperlinks to MPI_*.html files

(3) a file called allMPIapis.c with a list of C function prototypes

(4) the shell scripts used to convert the man pages to HTML, as well as to create the above files from the converted HTML
Comment 6 Jeffrey Overbey CLA 2011-08-26 11:35:44 EDT
By the way, the most recent attachment excludes the information from the MPI_*f2c* and MPI_*c2f* man pages since those cover groups of commands, and my sed scripts are virtually unreadable even for the simpler case.  So, if the APIs from those files are important, they will need to be added manually.
Comment 7 Jeffrey Overbey CLA 2011-08-26 11:50:34 EDT
Created attachment 202244 [details]
HTML man pages with hyperlinks, allIndex.html, allMPIapis.c (1.5.3)