Skip to content

Commit 9f7c9bb

Browse files
zerothizerothi
committed
doc: cleaned section locations
Moved error codes to a respective MPI_Errors file. Perhaps this should be moved to a more appropriately named file such as Constants_Errors to disentangle it from the mpi functions. Also moved man5 to man7. Signed-off-by: Nick Papior <[email protected]>
1 parent b2ec1b7 commit 9f7c9bb

File tree

8 files changed

+91
-80
lines changed

8 files changed

+91
-80
lines changed

‎docs/Makefile.am‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,7 @@ OMPI_MAN3 = \
415415
MPI_Status_set_cancelled.3 \
416416
MPI_Status_set_elements.3 \
417417
MPI_Status_set_elements_x.3 \
418+
MPI_T.3 \
418419
MPI_T_category_changed.3 \
419420
MPI_T_category_get_categories.3 \
420421
MPI_T_category_get_cvars.3 \
@@ -542,9 +543,8 @@ OMPI_MAN3 = \
542543
MPIX_Query_rocm_support.3 \
543544
OMPI_Affinity_str.3
544545

545-
OMPI_MAN5 = \
546-
MPI_T.5 \
547-
Open-MPI.5
546+
OMPI_MAN7 = \
547+
Open-MPI.7
548548

549549
OSHMEM_MAN1 = \
550550
oshmem-wrapper-compiler.1 \
@@ -779,8 +779,8 @@ OMPI_MAN1_BUILT = $(OMPI_MAN1:%.1=$(MAN_OUTDIR)/%.1)
779779
OMPI_MAN3_RST = $(OMPI_MAN3:%.3=man-openmpi/man3/%.3.rst)
780780
OMPI_MAN3_BUILT = $(OMPI_MAN3:%.3=$(MAN_OUTDIR)/%.3)
781781

782-
OMPI_MAN5_RST = $(OMPI_MAN5:%.5=man-openmpi/man5/%.5.rst)
783-
OMPI_MAN5_BUILT = $(OMPI_MAN5:%.5=$(MAN_OUTDIR)/%.5)
782+
OMPI_MAN7_RST = $(OMPI_MAN7:%.7=man-openmpi/man7/%.7.rst)
783+
OMPI_MAN7_BUILT = $(OMPI_MAN7:%.7=$(MAN_OUTDIR)/%.7)
784784

785785
OSHMEM_MAN1_RST = $(OSHMEM_MAN1:%.1=man-oshmem/man1/%.1.rst)
786786
OSHMEM_MAN1_BUILT = $(OSHMEM_MAN1:%.1=$(MAN_OUTDIR)/%.1)
@@ -791,7 +791,7 @@ OSHMEM_MAN3_BUILT = $(OSHMEM_MAN3:%.3=$(MAN_OUTDIR)/%.3)
791791
EXTRA_DIST += \
792792
$(OMPI_MAN1_BUILT) \
793793
$(OMPI_MAN3_BUILT) \
794-
$(OMPI_MAN5_BUILT) \
794+
$(OMPI_MAN7_BUILT) \
795795
$(OSHMEM_MAN1_BUILT) \
796796
$(OSHMEM_MAN3_BUILT)
797797

@@ -852,7 +852,7 @@ EXTRA_DIST += \
852852
$(OUTDIR)/man
853853

854854
ALL_MAN_BUILT = \
855-
$(OMPI_MAN1_BUILT) $(OMPI_MAN3_BUILT) $(OMPI_MAN5_BUILT) \
855+
$(OMPI_MAN1_BUILT) $(OMPI_MAN3_BUILT) $(OMPI_MAN7_BUILT) \
856856
$(OSHMEM_MAN1_BUILT) $(OSHMEM_MAN_3_BUILT)
857857
$(ALL_MAN_BUILT): $(RST_SOURCE_FILES) $(IMAGE_SOURCE_FILES)
858858
$(ALL_MAN_BUILT): $(TEXT_SOURCE_FILES) $(SPHINX_CONFIG)
@@ -903,7 +903,7 @@ man1_MANS += $(OMPI_MAN1_JAVA_REDIRECTS)
903903
endif
904904

905905
man3_MANS = $(OMPI_MAN3_BUILT)
906-
man5_MANS = $(OMPI_MAN5_BUILT)
906+
man7_MANS = $(OMPI_MAN7_BUILT)
907907

908908
if PROJECT_OSHMEM
909909
man1_MANS += \

‎docs/man-openmpi/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ Open MPI man pages, by section:
1919

2020
man1/index
2121
man3/index
22-
man5/index
22+
man7/index

‎docs/man-openmpi/man5/Open-MPI.5.rst‎ renamed to ‎docs/man-openmpi/man3/MPI_Errors.3.rst‎

Lines changed: 7 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,11 @@
1-
.. _open-mpi:
2-
.. _mpi:
1+
.. _mpi_errors:
2+
.. _open-mpi-errors:
33

4-
Open-MPI
5-
========
4+
MPI Errors
5+
==========
66

77
.. include_body
88
9-
Open MPI - General information
10-
11-
OPEN MPI
12-
--------
13-
14-
Open MPI is an open source implementation of MPI (message-passing
15-
interface), the industry-standard specification for writing
16-
message-passing programs. Message passing is a programming model that
17-
gives the programmer explicit control over interprocess communication.
18-
19-
The MPI specification was developed by the MPI Forum, a group of
20-
software developers, computer vendors, academics, and computer-science
21-
researchers whose goal was to develop a standard for writing
22-
message-passing programs that would be efficient, flexible, and
23-
portable.
24-
25-
The outcome, known as the MPI Standard, was first published in 1993; its
26-
most recent version (MPI-4.0) was published in June 2021. Open MPI
27-
includes all MPI |mpi_standard_version|.|mpi_standard_subversion|-compliant routines.
28-
29-
For more information about Open MPI, see https://www.open-mpi.org.
30-
31-
The MPI standards are available at https://www.mpi-forum.org.
32-
33-
MAN PAGE SYNTAX
34-
---------------
35-
36-
Man pages for Open MPI and Open MPI I/O routines are named according to
37-
C syntax, that is, they begin with the prefix ``MPI_``, all in
38-
uppercase, and the first letter following the ``MPI_`` prefix is also
39-
uppercase. The rest of the letters in the routine are all lowercase, for
40-
example, :ref:`MPI_Comm_get_attr`.
41-
42-
ENVIRONMENT
43-
-----------
44-
45-
To fine-tune your Open MPI environment, you can either use arguments
46-
to the :ref:`mpirun <man1-mpirun>` or :ref:`mpiexec <man1-mpiexec>`
47-
commands, or you can use MCA parameters.
48-
49-
For more information on arguments, see the :ref:`mpirun(1)
50-
<man1-mpirun>` man page.
51-
52-
For a complete listing of MCA parameters and their descriptions, issue
53-
the command ``ompi_info --all``. See :ref:`ompi_info(1)
54-
<man1-ompi_info>` for more information.
55-
56-
57-
.. _open-mpi-errors:
58-
59-
ERRORS
60-
------
619
6210
All MPI routines (except :ref:`MPI_Wtime` and :ref:`MPI_Wtick`) return an
6311
error value; C routines as the value of the function and Fortran
@@ -193,7 +141,7 @@ Standard error return classes for Open MPI:
193141
- 27
194142
- Conversion functions could not be registered because a data
195143
representation identifier that was already defined was passed
196-
to :ref:`MPI_Register_datarep(3) <MPI_Register_datarep>`.
144+
to :ref:`MPI_Register_datarep`.
197145

198146
* - MPI_ERR_FILE_EXISTS
199147
- 28
@@ -297,8 +245,7 @@ Standard error return classes for Open MPI:
297245

298246
* - MPI_ERR_UNSUPPORTED_DATAREP
299247
- 51
300-
- Unsupported datarep passed to :ref:`MPI_File_set_view(3)
301-
<MPI_File_set_view>`.
248+
- Unsupported datarep passed to :ref:`MPI_File_set_view`.
302249

303250
* - MPI_ERR_UNSUPPORTED_OPERATION
304251
- 52
@@ -368,8 +315,7 @@ Standard error return classes for Open MPI:
368315
* - MPI_ERR_RMA_RANGE
369316
- 68
370317
- Target memory is not part of the window (in the case of a
371-
window created with :ref:`MPI_Win_create_dynamic(3)
372-
<MPI_Win_create_dynamic>`, target memory is not attached.
318+
window created with :ref:`MPI_Win_create_dynamic`, target memory is not attached.
373319

374320
* - MPI_ERR_RMA_ATTACH
375321
- 69

‎docs/man-openmpi/man5/MPI_T.5.rst‎ renamed to ‎docs/man-openmpi/man3/MPI_T.3.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,4 +122,5 @@ Open MPI's MPI_T categories are organized hierarchically:
122122
framework in the opal layer.
123123

124124

125-
.. seealso:: :ref:`MPI_T_init_thread(3) <mpi_t_init_thread>`
125+
.. seealso::
126+
* :ref:`MPI_T_init_thread`

‎docs/man-openmpi/man3/index.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ MPI API manual pages (section 3)
9595
MPI_Errhandler_free.3.rst
9696
MPI_Errhandler_get.3.rst
9797
MPI_Errhandler_set.3.rst
98+
MPI_Errors.3.rst
9899
MPI_Error_class.3.rst
99100
MPI_Error_string.3.rst
100101
MPI_Exscan.3.rst
@@ -346,6 +347,7 @@ MPI API manual pages (section 3)
346347
MPI_Status_set_cancelled.3.rst
347348
MPI_Status_set_elements.3.rst
348349
MPI_Status_set_elements_x.3.rst
350+
MPI_T.3.rst
349351
MPI_T_category_changed.3.rst
350352
MPI_T_category_get_categories.3.rst
351353
MPI_T_category_get_cvars.3.rst

‎docs/man-openmpi/man5/index.rst‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎docs/man-openmpi/man7/Open-MPI.7.rst‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
.. _open-mpi:
2+
.. _mpi:
3+
4+
Open MPI
5+
========
6+
7+
.. include_body
8+
9+
Open MPI - General information
10+
11+
OPEN MPI
12+
--------
13+
14+
Open MPI is an open source implementation of MPI (message-passing
15+
interface), the industry-standard specification for writing
16+
message-passing programs. Message passing is a programming model that
17+
gives the programmer explicit control over interprocess communication.
18+
19+
The MPI specification was developed by the MPI Forum, a group of
20+
software developers, computer vendors, academics, and computer-science
21+
researchers whose goal was to develop a standard for writing
22+
message-passing programs that would be efficient, flexible, and
23+
portable.
24+
25+
The outcome, known as the MPI Standard, was first published in 1993; its
26+
most recent version (MPI-4.0) was published in June 2021. Open MPI
27+
includes all MPI |mpi_standard_version|.|mpi_standard_subversion|-compliant routines.
28+
29+
For more information about Open MPI, see https://www.open-mpi.org.
30+
31+
The MPI standards are available at https://www.mpi-forum.org.
32+
33+
MAN PAGE SYNTAX
34+
---------------
35+
36+
Man pages for Open MPI and Open MPI I/O routines are named according to
37+
C syntax, that is, they begin with the prefix ``MPI_``, all in
38+
uppercase, and the first letter following the ``MPI_`` prefix is also
39+
uppercase. The rest of the letters in the routine are all lowercase, for
40+
example, :ref:`MPI_Comm_get_attr`.
41+
42+
ENVIRONMENT
43+
-----------
44+
45+
To fine-tune your Open MPI environment, you can either use arguments
46+
to the :ref:`mpirun <man1-mpirun>` or :ref:`mpiexec <man1-mpiexec>`
47+
commands, or you can use MCA parameters.
48+
49+
For more information on arguments, see the :ref:`mpirun(1)
50+
<man1-mpirun>` man page.
51+
52+
For a complete listing of MCA parameters and their descriptions, issue
53+
the command ``ompi_info --all``. See :ref:`ompi_info(1)
54+
<man1-ompi_info>` for more information.
55+
56+
57+
ERRORS
58+
------
59+
60+
See :ref:`MPI_Errors` for details about error values.
61+
62+
63+
.. seealso:: :ref:`MPI_T` :ref:`mpirun(1) <man1-mpirun>` :ref:`mpiexec(1)
64+
<man1-mpiexec>` :ref:`ompi_info(1) <man1-ompi_info>`

‎docs/man-openmpi/man7/index.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
General information manual pages (section 7)
2+
============================================
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
Open-MPI.7.rst

0 commit comments

Comments
 (0)