Converted 55 files from nroff to markdown #8263
Conversation
|
Can one of the admins verify this patch? |
Signed-off-by: Colton Kammes <ckammes@nd.edu>
Colton-K
force-pushed
the
pr/mpi_comm_f2c_to_mpi_file_get_view
branch
from
13f4dd9 to
cf4cdee
Compare
|
|
||
| |Key|Type|Description| | ||
| |---|---- |-----------| | ||
| |host|char *|Host on which the process should be| |
There was a problem hiding this comment.
Sorry to be picky here, but could we put all the text for one cell on one line? That would let Markdown render it in a single row with wrapped text lines. I.e.:
| |host|char *|Host on which the process should be| | |
| |host|char *|Host on which the process should be spawned. See the orte_host man page for an explanation of how this will be used.| |
There was a problem hiding this comment.
I wasn't going to do it like that because then the lines would have to be longer than the 80 character limit for the markdown render to not be confused
There was a problem hiding this comment.
Oh wow, the renderer has a limit of 80-character lines? Bummer! Ok.
There was a problem hiding this comment.
I mean the one renderer which makes it viewable in the terminal. I was just going off earlier when you told me that open-mpi sticks to the 80 character line limit. I think parsedown is capable of more if you'd like me to ignore line length though.
| #include <mpi.h> | ||
|
|
||
| int MPI_Comm_spawn_multiple(int count, char *array_of_commands[], | ||
|
|
| _ i-1 | _ i | | ||
| \ n , to | \ n | -1 | ||
| /_ j=1 i |_ /_ j=1 j \_| | ||
| ''' |
There was a problem hiding this comment.
Hmm -- somehow the epsilons are still not rendering properly in the above paragraph.
| The following keys for `info` are recognized in `"#PACKAGE_NAME#".` | ||
| (The reserved values mentioned in Section 5.3.4 of the MPI-2 standard | ||
| are not implemented.) | ||
| |Key|Type|Description| |
There was a problem hiding this comment.
This table isn't rendering properly -- perhaps because the Epsilons above aren't rendered properly, and that leads to some stray characters that confuse the markdown renderer...?
| but others are set to false (or are unset), `MPI_ERR_INFO` will be | ||
| returned. | ||
|
|
||
| Note that in `#PACKAGE_NAME#`, the first array location in |
There was a problem hiding this comment.
Ok, let's cut it out then. I.e.:
| Note that in `#PACKAGE_NAME#`, the first array location in | |
| Note that in this MPI implementation, the first array location in |
| |(0,0) |MPI_Dims_create(7, 2, dims)| (7,1)| | ||
| |(0,3,0) |MPI_Dims_create(6, 3, dims)| (2,3,1)| | ||
| |(0,3,0) |MPI_Dims_create(7, 3, dims)| erroneous call| | ||
| |-----------|---------------------------|------------------| |
There was a problem hiding this comment.
The last line in this table somehow isn't rendering correctly.
| #include <mpi.h> | ||
|
|
||
| int MPI_Exscan(const void *sendbuf, void *recvbuf, int count, | ||
|
|
There was a problem hiding this comment.
Watch these blank lines in the C bindings. I stopped noting them and didn't mark them in every man page where I saw them -- you might want to check the generated .md files for blank lines in the C bindings.
| `MPI_Comm_f2c`, `MPI_Comm_c2f`, `MPI_File_f2c`, `MPI_File_c2f`, `MPI_Info_f2c,` | ||
| `MPI_Info_c2f`, `MPI_Message_f2c`, `MPI_Message_c2f`, `MPI_Op_f2c`, `MPI_Op_c2f,` | ||
| `MPI_Request_f2c`, `MPI_Request_c2f`, `MPI_Type_f2c`, `MPI_Type_c2f,` | ||
| MPI_Win_f2c, MPI_Win_c2f - Translates a C handle into a Fortran |
There was a problem hiding this comment.
| MPI_Win_f2c, MPI_Win_c2f - Translates a C handle into a Fortran | |
| `MPI_Win_f2c`, `MPI_Win_c2f` - Translates a C handle into a Fortran |
| The MPI standard prescribes portable Fortran syntax for the `OFFSET` and | ||
| `DISP` arguments only for Fortran 90. Sun FORTRAN 77 users may use the | ||
| non-portable syntax | ||
| or |
There was a problem hiding this comment.
Was there supposed to be something different here?
There are a couple that have links that won't work, I didn't know what to do for something like socket(3SOCKET) or mpirun(1).
The links that won't work are in MPI_Comm_join.md, MPI_Comm_spawn.md, and MPI_Comm_spawn_multiple
Signed-off-by: Colton Kammes ckammes@nd.edu