KAWASHIMA Takahiro
092cf1937d
man: Correct markup of MPI_Neighbor_allgather
...
Signed-off-by: KAWASHIMA Takahiro <t-kawashima@jp.fujitsu.com>
(cherry picked from commit 994b345253
)
2018-10-05 09:43:39 +09:00
Jeff Squyres
c83b30755a
Fix script abstraction break: mv make_manpage.pl to config
...
Having the "make_manpage.pl" script in the ompi/ tree broke
"./autogen.pl --no-ompi" (specifically: "make distcheck" of --no-ompi
builds would break).
(cherry picked from commit 89773c41
)
Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
2018-09-22 15:11:06 -05:00
Benoît Legat
709c4f6646
Remove brackets for ndims for c++ doc of Cart_create
...
Signed-off-by: Benoît Legat <benoit.legat@gmail.com>
2018-05-01 12:00:55 +02:00
Jeff Squyres
fc8ebbb0e0
MPI_Comm_spawn_multiple.3in: update Fortran string array notes
...
Per 0ab6b201fe
, note in the MPI_Comm_spawn_multiple.3in man page that
the array_of_commands does not need to be terminated -- it just need
to have exactly "count" entries. In the Fortran binding, at least,
this is different than in prior released versions of Open MPI (it's
not a backwards incompatibility, since prior versions of Open MPI
required array_of_commands to be blank-string-terminated in Fortran --
this change makes Open MPI be *less* restrictive, and therefore still
backwards compatible).
Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
2018-04-05 06:52:46 -07:00
Benoît Legat
00600c7cbb
Fix typo in MPI_Cart_shift doc
...
Signed-off-by: Benoît Legat <benoit.legat@gmail.com>
2018-03-13 15:25:42 +01:00
Gilles Gouaillardet
cb5dfbe5b1
man: fix indentation of MPI_Comm_spawn[_multiple]
...
no code change.
Signed-off-by: Gilles Gouaillardet <gilles@rist.or.jp>
2018-01-15 11:29:15 +09:00
Jed Brown
533800070e
MPI_Attr_get: doc fix: MPI_Comm_create_attr -> MPI_Comm_get_attr
...
MPI_Comm_create_attr does not exist.
Signed-off-by: Jed Brown <jed@jedbrown.org>
2017-12-17 07:44:22 -07:00
Nathan Hjelm
db2204f2f3
ompi: add support for new communicator info assertions
...
This commit adds code to allow support for the info assertions added
by mpi-forum/mpi-issues#11 . The assertions added are:
mpi_assert_no_any_tag, mpi_assert_no_any_source,
mpi_assert_exact_length, and mpi_assert_allow_overtaking.
This commit also adds support for the mpi_assert_no_any_source and
mpi_assert_allow_overtaking info keys to the ob1 pml.
Signed-off-by: Nathan Hjelm <hjelmn@lanl.gov>
2017-06-08 15:52:12 -06:00
KAWASHIMA Takahiro
c3bbd7dfec
man: Remove unnecessary empty lines
...
All other man pages don't have an empty line after
the "! or the older form: INCLUDE 'mpif.h'" line
Signed-off-by: KAWASHIMA Takahiro <t-kawashima@jp.fujitsu.com>
2017-05-26 11:17:59 +09:00
KAWASHIMA Takahiro
e57ab611cd
man: Fix roff markup of variable names
...
These typos are found by running `grep -r '\\f[^IBRP]' ompi/mpi/man/`.
Signed-off-by: KAWASHIMA Takahiro <t-kawashima@jp.fujitsu.com>
2017-05-26 11:17:23 +09:00
Jeff Squyres
dc53cd5f74
MPI_Wtick: may return a higher resolution than 10e-6 these days
...
Thanks to Mark Dixon (@ccaamad) for reporting the error.
Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
2017-03-02 10:39:28 -05:00
Gilles Gouaillardet
6f2ca5809b
man: fix a typo in MPI_Win_get_name()
...
Thanks Nicolas Joly for the report
Fixes open-mpi/ompi#2782
Signed-off-by: Gilles Gouaillardet <gilles@rist.or.jp>
2017-01-24 09:08:13 +09:00
Ralph Castain
1e2019ce2a
Revert "Update to sync with OMPI master and cleanup to build"
...
This reverts commit cb55c88a8b
.
2016-11-22 15:03:20 -08:00
Ralph Castain
cb55c88a8b
Update to sync with OMPI master and cleanup to build
...
Signed-off-by: Ralph Castain <rhc@open-mpi.org>
2016-11-22 14:24:54 -08:00
Howard Pritchard
3923bf8151
fix minor type in MPI_Comm_connect man page
...
Signed-off-by: Howard Pritchard <howardp@lanl.gov>
2016-11-14 05:52:45 -07:00
Gilles Gouaillardet
98f62690f1
man: fix typos in MPI_Info_get_{nkeys,nthkey}
...
Thanks Nicolas Joly for the patch
2016-10-24 09:04:29 +09:00
KAWASHIMA Takahiro
e3b3e52fdd
man: Fix typos in man
2016-09-15 17:25:16 +09:00
Rainer Keller
0fb0913cd4
In case, we do not build Fortran, Fortran 2008 or CXX, the regexp in make_manpage.pl will delete all
...
lines up to the next ".fi" -- which for functions that do not implement the corresponding interface
as code will have all eliminated.
Change to delete the man page's content up to the next section header ".SH"
Also in case of make V=1, we'd like to see the command line, too.
Amend OMPI_Affinity_str according to the other man-pages definitions.
2016-05-17 14:21:35 +02:00
Nathan Hjelm
b9d100929b
man: fix typo in MPI_Win_allocate_shared
...
Signed-off-by: Nathan Hjelm <hjelmn@lanl.gov>
2016-03-16 14:47:40 -06:00
Gilles Gouaillardet
0da1374f22
man: fix typo in MPI_File related man pages
2016-03-11 14:16:21 +09:00
Gilles Gouaillardet
47ab2fcb89
man: fix MPI_Neighbor_alltoall{v,w} prototypes
...
Thanks Willem Vermin for bringing this to our attention
2015-12-28 09:39:33 +09:00
Jeff Squyres
0adcb5b5cd
MPI_Testsome.3in: wrap some long lines
...
Wrap some long lines; no other text or semantics changes.
2015-12-03 17:06:43 -05:00
Jeff Squyres
11c571b568
MPI_Testsome.3in: add explicit verbiage about return values
...
Instead of solely relying on the out value definitions in
MPI_Waitsome.3, explicitly copy this text here.
Note that the original text in this man page was copied verbatim from
the MPI spec; we've now added a bit more text (copied from
MPI_Waitsome.3in) that explains the out values so that users don't
have to cross-reference to another man page.
Thanks to Eric Schnetter for the suggestion.
Fixes open-mpi/ompi#1153
2015-12-03 17:06:22 -05:00
Jeff Squyres
86270e7613
MPI_File_open: add note about allowable chars in filenames
...
Thanks to @nasailja for the original text suggestion.
2015-10-22 11:56:53 -07:00
Gilles Gouaillardet
9b31530d5c
man: misc fix of revamp of MPI_File_* and MPI_Register_datarep man pages
...
that fixes commit open-mpi/ompi@b17c89c1e6 :
- remove unnecessary empty lines
- add USE mpi in MPI_Register_datarep
Thanks Jeff for noticing this
2015-10-21 09:41:01 +09:00
Jeff Squyres
630d6bf800
Merge pull request #1038 from kawashima-fj/pr/man-correction
...
man: Various manpage corrections
2015-10-20 06:40:05 -04:00
KAWASHIMA Takahiro
7ab464fbb4
Revert "man: Remove unnecessary spaces in front of parameters."
...
This reverts commit 3253a30ab2
.
Because Gilles' b17c89c1
committed a few hours ago has the same change,
my RP branch had a conflict.
2015-10-20 15:32:45 +09:00
KAWASHIMA Takahiro
373a94a3f1
man: Revert my MPI_File_iwrite_shared manpage change.
...
This reverts commit 2226cdb3da
and d9c93c9f5d
.
Because Gilles' b17c89c1
committed a few hours ago has the same change,
my RP branch had a conflict.
2015-10-20 14:41:22 +09:00
Gilles Gouaillardet
b17c89c1e6
man: revamp MPI_File_* and MPI_Register_datarep man pages
...
- suggest USE mpi instead of INCLUDE 'mpif.h'
- fix indentation
Thanks Jeff for pointing this issue.
2015-10-20 13:12:12 +09:00
KAWASHIMA Takahiro
d9c93c9f5d
man: Add const
that is removed accidentally in 2226cdb
.
2015-10-20 08:49:10 +09:00
KAWASHIMA Takahiro
7fef70c9b8
man: Add MPI_DIST_GRAPH
in MPI_TOPO_TEST
manpage.
...
`MPI_DIST_GRAPH` was added in MPI-2.2.
2015-10-19 15:24:12 +09:00
KAWASHIMA Takahiro
d3a29e364c
man: Change 'MPI ADDRESS KIND' to 'MPI_ADDRESS_KIND'.
...
(underscores instead of spaces)
2015-10-19 15:11:06 +09:00
KAWASHIMA Takahiro
dcd14103d5
man: Remove unnecessary spaces in Fortran syntax.
...
Similar lines of other routines have no space.
2015-10-19 15:04:50 +09:00
KAWASHIMA Takahiro
34c3b5d74d
man: Correct the kind of ADDRESS
parameter of MPI_GET_ADDRESS
.
2015-10-19 15:01:30 +09:00
KAWASHIMA Takahiro
3253a30ab2
man: Remove unnecessary spaces in front of parameters.
2015-10-19 14:48:23 +09:00
KAWASHIMA Takahiro
2226cdb3da
man: Correct the routine name of MPI_FILE_IWRITE_SHARED
.
2015-10-19 14:44:49 +09:00
KAWASHIMA Takahiro
bffc7b6c8f
man: Add man of MPI_Message_{c2f,f2c}
and MPI_Op_commutative
.
...
These routines were added in MPI-2.2 but were missing in OMPI man pages.
2015-10-19 13:49:40 +09:00
KAWASHIMA Takahiro
9942d5a933
man: MPI_IBARRIER has two output parameters.
2015-10-19 13:46:03 +09:00
KAWASHIMA Takahiro
953c95e9bb
man: Update description of MPI_IN_PLACE of MPI_Exscan.
...
MPI-2.2 added MPI_IN_PLACE support for MPI_Exscan.
2015-10-19 13:46:03 +09:00
KAWASHIMA Takahiro
5a3b8b34cd
man: Remove outdated description. MPI-2.2 is ratified.
2015-10-19 13:46:03 +09:00
KAWASHIMA Takahiro
1261b115e4
man: Fix incorrect nroff markups.
2015-10-19 13:46:03 +09:00
KAWASHIMA Takahiro
9b96209ac5
man: Fix incorrect C++ binding descriptions.
2015-10-19 13:46:03 +09:00
KAWASHIMA Takahiro
ffce87328d
man: MPI_Get_version now returns 3.1 instead of 2.1.
2015-10-19 13:46:03 +09:00
KAWASHIMA Takahiro
80a0b30be8
man: Correct wrong argument order.
2015-10-19 13:46:03 +09:00
KAWASHIMA Takahiro
4bbe86b171
man: Fix a typo of an argument.
2015-10-19 13:46:03 +09:00
KAWASHIMA Takahiro
519ddd9ae9
man: Insert missing error classes & Fix incorrect error codes.
2015-10-19 13:46:02 +09:00
Jeff Squyres
338257a2f4
man: update man pages for Init*/Finalize*
...
Update language surrounding initialization and finalization in
MPI_Init[_thread], MPI_Initialized, MPI_Finalize, and MPI_Finalized.
2015-10-15 12:39:16 -04:00
Gilles Gouaillardet
3e469662ad
trim man pages if no c++/f08/fortran
2015-10-13 10:21:42 +09:00
Gilles Gouaillardet
66c30b2721
Add Fortran 2008 syntax to the manpages
2015-10-13 09:21:45 +09:00
Nathan Hjelm
fbaa79835f
ompi/man: fix typos in formatting
...
Signed-off-by: Nathan Hjelm <hjelmn@me.com>
2015-09-29 23:32:44 -06:00