Skip to content

Commit c5fdcc0

Browse files
zerothijsquyres
authored andcommitted
doc: codified the MPI_SEEK constants
Signed-off-by: Nick Papior <nickpapior@gmail.com>
1 parent cffffdd commit c5fdcc0

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ DESCRIPTION
6666
:ref:`MPI_File_seek` updates the individual file pointer according to *whence,*
6767
which could have the following possible values:
6868

69-
* MPI_SEEK_SET - The pointer is set to *offset.*
70-
* MPI_SEEK_CUR - The pointer is set to the current pointer position plus *offset.*
71-
* MPI_SEEK_END - The pointer is set to the end of the file plus *offset.*
69+
* ``MPI_SEEK_SET`` - The pointer is set to *offset.*
70+
* ``MPI_SEEK_CUR`` - The pointer is set to the current pointer position plus *offset.*
71+
* ``MPI_SEEK_END`` - The pointer is set to the end of the file plus *offset.*
7272

7373
The *offset* can be negative, which allows seeking backwards. It is
7474
erroneous to seek to a negative position in the file. The end of the

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ DESCRIPTION
6767
:ref:`MPI_File_seek_shared` updates the shared file pointer according to
6868
*whence,* which could have the following possible values:
6969

70-
* MPI_SEEK_SET - The pointer is set to *offset.*
71-
* MPI_SEEK_CUR - The pointer is set to the current pointer position plus *offset.*
72-
* MPI_SEEK_END - The pointer is set to the end of the file plus *offset.*
70+
* ``MPI_SEEK_SET`` - The pointer is set to *offset.*
71+
* ``MPI_SEEK_CUR`` - The pointer is set to the current pointer position plus *offset.*
72+
* ``MPI_SEEK_END`` - The pointer is set to the end of the file plus *offset.*
7373

7474
:ref:`MPI_File_seek_shared` is collective; all the processes in the
7575
communicator group associated with the file handle *fh* must call

0 commit comments

Comments
 (0)