Skip to content

Commit 7c1a621

Browse files
committed
doc: removed all fortran 77 notes
Also clarified get_address fortran sample code with the kind-specification for the argument. Signed-off-by: Nick Papior <nickpapior@gmail.com>
1 parent 5c15147 commit 7c1a621

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+99
-837
lines changed

docs/man-openmpi/man3/MPI_Accumulate.3.rst

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ C Syntax
3333
MPI_Request *request)
3434
3535
36-
Fortran Syntax (see FORTRAN 77 NOTES)
37-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
36+
Fortran Syntax
37+
^^^^^^^^^^^^^^
3838

3939
.. code-block:: fortran
4040
@@ -138,21 +138,6 @@ indicates that the *origin_addr* buffer is free to be updated. It does
138138
not indicate that the operation has completed at the target window.
139139

140140

141-
FORTRAN 77 NOTES
142-
----------------
143-
144-
The MPI standard prescribes portable Fortran syntax for the
145-
*TARGET_DISP* argument only for Fortran 90. FORTRAN 77 users may use the
146-
non-portable syntax
147-
148-
.. code-block:: fortran
149-
150-
INTEGER*MPI_ADDRESS_KIND TARGET_DISP
151-
152-
where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the
153-
length of the declared integer in bytes.
154-
155-
156141
NOTES
157142
-----
158143

docs/man-openmpi/man3/MPI_Alloc_mem.3.rst

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ C Syntax
2323
int MPI_Alloc_mem(MPI_Aint size, MPI_Info info, void *baseptr)
2424
2525
26-
Fortran Syntax (see FORTRAN NOTES)
27-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
26+
Fortran Syntax
27+
^^^^^^^^^^^^^^
2828

2929
.. code-block:: fortran
3030
@@ -74,42 +74,6 @@ pointer object for this parameter. The provided argument should be a
7474
pointer to a pointer of arbitrary type (e.g., ``void **``).
7575

7676

77-
FORTRAN NOTES
78-
-------------
79-
80-
There is no portable FORTRAN 77 syntax for using :ref:`MPI_Alloc_mem`. There is
81-
no portable Fortran syntax for using pointers returned from
82-
:ref:`MPI_Alloc_mem`. However, :ref:`MPI_Alloc_mem` can be used with Sun Fortran
83-
compilers.
84-
85-
From FORTRAN 77, you can use the following non-standard declarations for
86-
the SIZE and BASEPTR arguments:
87-
88-
.. code-block:: fortran
89-
90-
INCLUDE "mpif.h"
91-
INTEGER*MPI_ADDRESS_KIND SIZE, BASEPTR
92-
93-
94-
From either FORTRAN 77 or Fortran 90, you can use "Cray pointers" for
95-
the BASEPTR argument. Cray pointers are described further in the Fortran
96-
User's Guide and are supported by many Fortran compilers. For example,
97-
98-
.. code-block:: fortran
99-
100-
INCLUDE "mpif.h"
101-
REAL*4 A(100,100)
102-
POINTER (BASEPTR, A)
103-
INTEGER*MPI_ADDRESS_KIND SIZE
104-
105-
SIZE = 4 * 100 * 100
106-
CALL MPI_ALLOC_MEM(SIZE,MPI_INFO_NULL,BASEPTR,IERR)
107-
108-
! use A
109-
110-
CALL MPI_FREE_MEM(A, IERR)
111-
112-
11377
ERRORS
11478
------
11579

docs/man-openmpi/man3/MPI_Comm_create_keyval.3.rst

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ C Syntax
2222
*comm_delete_attr_fn, int *comm_keyval,
2323
void *extra_state)
2424
25-
Fortran Syntax (See Fortran 77 Notes)
26-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
25+
Fortran Syntax
26+
^^^^^^^^^^^^^^
2727

2828
.. code-block:: fortran
2929
@@ -112,19 +112,6 @@ names are deprecated. The two Fortran callback functions are:
112112
113113
INTEGER(KIND=MPI_ADDRESS_KIND) ATTRIBUTE_VAL, EXTRA_STATE
114114
115-
FORTRAN 77 NOTES
116-
^^^^^^^^^^^^^^^^
117-
118-
The MPI standard prescribes portable Fortran syntax for the
119-
``EXTRA_STATE`` argument only for Fortran 90. FORTRAN 77 users may use
120-
the non-portable syntax
121-
122-
.. code-block:: fortran
123-
124-
INTEGER*MPI_ADDRESS_KIND EXTRA_STATE
125-
126-
where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the
127-
length of the declared integer in bytes.
128115
129116
ERRORS
130117
------

docs/man-openmpi/man3/MPI_Comm_get_attr.3.rst

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ C Syntax
2424
void *attribute_val, int *flag)
2525
2626
27-
Fortran Syntax (see FORTRAN 77 NOTES)
28-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
27+
Fortran Syntax
28+
^^^^^^^^^^^^^^
2929

3030
.. code-block:: fortran
3131
@@ -76,21 +76,6 @@ C binding is identical. The Fortran binding differs in that
7676
*attribute_val* is an address-sized integer.
7777

7878

79-
FORTRAN 77 NOTES
80-
----------------
81-
82-
The MPI standard prescribes portable Fortran syntax for the
83-
*ATTRIBUTE_VAL* argument only for Fortran 90. Sun FORTRAN 77 users may
84-
use the non-portable syntax
85-
86-
.. code-block:: fortran
87-
88-
INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL
89-
90-
where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the
91-
length of the declared integer in bytes.
92-
93-
9479
ERRORS
9580
------
9681

docs/man-openmpi/man3/MPI_Comm_set_attr.3.rst

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ C Syntax
2323
int MPI_Comm_set_attr(MPI_Comm comm, int comm_keyval, void *attribute_val)
2424
2525
26-
Fortran Syntax (see FORTRAN 77 NOTES)
27-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
26+
Fortran Syntax
27+
^^^^^^^^^^^^^^
2828

2929
.. code-block:: fortran
3030
@@ -78,21 +78,6 @@ C binding is identical. The Fortran binding differs in that
7878
*attribute_val* is an address-sized integer.
7979

8080

81-
FORTRAN 77 NOTES
82-
----------------
83-
84-
The MPI standard prescribes portable Fortran syntax for the
85-
*ATTRIBUTE_VAL* argument only for Fortran 90. Sun FORTRAN 77 users may
86-
use the non-portable syntax
87-
88-
.. code-block:: fortran
89-
90-
INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL
91-
92-
where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the
93-
length of the declared integer in bytes.
94-
95-
9681
NOTES
9782
-----
9883

docs/man-openmpi/man3/MPI_Compare_and_swap.3.rst

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ C Syntax
2525
MPI_Aint target_disp, MPI_Win win)
2626
2727
28-
Fortran Syntax (see FORTRAN 77 NOTES)
29-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
28+
Fortran Syntax
29+
^^^^^^^^^^^^^^
3030

3131
.. code-block:: fortran
3232
@@ -87,21 +87,6 @@ The origin and result buffers (*origin_addr* and *result_addr*) must be
8787
disjoint.
8888

8989

90-
FORTRAN 77 NOTES
91-
----------------
92-
93-
The MPI standard prescribes portable Fortran syntax for the
94-
*TARGET_DISP* argument only for Fortran 90. FORTRAN 77 users may use the
95-
non-portable syntax
96-
97-
.. code-block:: fortran
98-
99-
INTEGER*MPI_ADDRESS_KIND TARGET_DISP
100-
101-
where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the
102-
length of the declared integer in bytes.
103-
104-
10590
NOTES
10691
-----
10792

docs/man-openmpi/man3/MPI_Fetch_and_op.3.rst

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ C Syntax
2626
MPI_Op op, MPI_Win win)
2727
2828
29-
Fortran Syntax (see FORTRAN 77 NOTES)
30-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
29+
Fortran Syntax
30+
^^^^^^^^^^^^^^
3131

3232
.. code-block:: fortran
3333
@@ -97,21 +97,6 @@ target memory is returned in the result buffer at the origin and no
9797
operation is performed on the target buffer.
9898

9999

100-
FORTRAN 77 NOTES
101-
----------------
102-
103-
The MPI standard prescribes portable Fortran syntax for the
104-
*TARGET_DISP* argument only for Fortran 90. FORTRAN 77 users may use the
105-
non-portable syntax
106-
107-
.. code-block:: fortran
108-
109-
INTEGER*MPI_ADDRESS_KIND TARGET_DISP
110-
111-
where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the
112-
length of the declared integer in bytes.
113-
114-
115100
NOTES
116101
-----
117102

docs/man-openmpi/man3/MPI_File_get_byte_offset.3.rst

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ C Syntax
2626
MPI_Offset *disp)
2727
2828
29-
Fortran Syntax (see FORTRAN 77 NOTES)
30-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
29+
Fortran Syntax
30+
^^^^^^^^^^^^^^
3131

3232
.. code-block:: fortran
3333
@@ -70,21 +70,6 @@ from the beginning of the file. The absolute byte position of *offset*
7070
relative to the current view of *fh* is returned in *disp*.
7171

7272

73-
FORTRAN 77 NOTES
74-
----------------
75-
76-
The MPI standard prescribes portable Fortran syntax for the *OFFSET* and
77-
*DISP* arguments only for Fortran 90. Sun FORTRAN 77 users may use the
78-
non-portable syntax
79-
80-
.. code-block:: fortran
81-
82-
INTEGER*MPI_OFFSET_KIND OFFSET, DISP
83-
84-
where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the
85-
length of the declared integer in bytes.
86-
87-
8873
ERRORS
8974
------
9075

docs/man-openmpi/man3/MPI_File_get_position.3.rst

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ C Syntax
2525
int MPI_File_get_position(MPI_File fh, MPI_Offset *offset)
2626
2727
28-
Fortran Syntax (see FORTRAN 77 NOTES)
29-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
28+
Fortran Syntax
29+
^^^^^^^^^^^^^^
3030

3131
.. code-block:: fortran
3232
@@ -66,21 +66,6 @@ individual file pointer in *etype* units relative to the current
6666
displacement and file type.
6767

6868

69-
FORTRAN 77 NOTES
70-
----------------
71-
72-
The MPI standard prescribes portable Fortran syntax for the *OFFSET*
73-
argument only for Fortran 90. Sun FORTRAN 77 users may use the
74-
non-portable syntax
75-
76-
.. code-block:: fortran
77-
78-
INTEGER*MPI_OFFSET_KIND OFFSET
79-
80-
where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the
81-
length of the declared integer in bytes.
82-
83-
8469
ERRORS
8570
------
8671

docs/man-openmpi/man3/MPI_File_get_position_shared.3.rst

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ C Syntax
2525
int MPI_File_get_position_shared(MPI_File fh, MPI_Offset *offset)
2626
2727
28-
Fortran Syntax (see FORTRAN 77 NOTES)
29-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
28+
Fortran Syntax
29+
^^^^^^^^^^^^^^
3030

3131
.. code-block:: fortran
3232
@@ -66,21 +66,6 @@ of the shared file pointer in *etype* units relative to the current
6666
displacement and file type.
6767

6868

69-
FORTRAN 77 NOTES
70-
----------------
71-
72-
The MPI standard prescribes portable Fortran syntax for the *OFFSET*
73-
argument only for Fortran 90. Sun FORTRAN 77 users may use the
74-
non-portable syntax
75-
76-
.. code-block:: fortran
77-
78-
INTEGER*MPI_OFFSET_KIND OFFSET
79-
80-
where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the
81-
length of the declared integer in bytes.
82-
83-
8469
ERRORS
8570
------
8671

0 commit comments

Comments
 (0)