doc: added deprecated short-hand

zerothi · zerothi · commit b2ec1b717ffe · 2023-02-27T22:07:30.000+01:00
Makes it easier to change exact wording.

Signed-off-by: Nick Papior &lt;nickpapior@gmail.com&gt;
diff --git a/docs/conf.py b/docs/conf.py
@@ -221,5 +221,6 @@ def _doit(topdir):
 .. |flex_min_version| replace:: {flex_min_version}
 .. |mpi_standard_version| replace:: {mpi_standard_version}
 .. |mpi_standard_subversion| replace:: {mpi_standard_subversion}
+.. |deprecated_favor| replace:: this routine is deprecated in favor of
 
 """
diff --git a/docs/man-openmpi/man3/MPI_Address.3.rst b/docs/man-openmpi/man3/MPI_Address.3.rst
@@ -6,8 +6,7 @@ MPI_Address
 
 .. include_body
 
-:ref:`MPI_Address` - Gets the address of a location in memory -- use of
-this routine is deprecated.
+:ref:`MPI_Address` - Gets the address of a location in memory -- |deprecated_favor| :ref:`MPI_Get_address`.
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Attr_delete.3.rst b/docs/man-openmpi/man3/MPI_Attr_delete.3.rst
@@ -6,8 +6,7 @@ MPI_Attr_delete
 
 .. include_body
 
-:ref:`MPI_Attr_delete` - Deletes attribute value associated with a key --
-use of this routine is deprecated.
+:ref:`MPI_Attr_delete` - Deletes attribute value associated with a key -- |deprecated_favor| :ref:`MPI_Comm_delete_attr`.
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Attr_get.3.rst b/docs/man-openmpi/man3/MPI_Attr_get.3.rst
@@ -6,8 +6,7 @@ MPI_Attr_get
 
 .. include_body
 
-:ref:`MPI_Attr_get` - Retrieves attribute value by key -- use of this
-routine is deprecated.
+:ref:`MPI_Attr_get` - Retrieves attribute value by key -- |deprecated_favor| :ref:`MPI_Comm_get_attr`.
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Attr_put.3.rst b/docs/man-openmpi/man3/MPI_Attr_put.3.rst
@@ -6,8 +6,8 @@ MPI_Attr_put
 
 .. include_body
 
-:ref:`MPI_Attr_put` - Stores attribute value associated with a key -- use
-of this routine is deprecated.
+:ref:`MPI_Attr_put` - Stores attribute value associated with a key -- |deprecated_favor| :ref:`MPI_Comm_set_attr`.
+
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst
@@ -6,8 +6,8 @@ MPI_Errhandler_create
 
 .. include_body
 
-:ref:`MPI_Errhandler_create` - Creates an MPI-style error handler -- use of
-this routine is deprecated.
+:ref:`MPI_Errhandler_create` - Creates an MPI-style error handler -- |deprecated_favor| :ref:`MPI_Comm_create_errhandler`.
+
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst
@@ -6,8 +6,7 @@ MPI_Errhandler_get
 
 .. include_body
 
-:ref:`MPI_Errhandler_get` - Gets the error handler for a communicator --
-use of this routine is deprecated.
+:ref:`MPI_Errhandler_get` - Gets the error handler for a communicator -- |deprecated_favor| :ref:`MPI_Comm_get_errhandler`.
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst
@@ -6,8 +6,7 @@ MPI_Errhandler_set
 
 .. include_body
 
-:ref:`MPI_Errhandler_set` - Sets the error handler for a communicator --
-use of this routine is deprecated.
+:ref:`MPI_Errhandler_set` - Sets the error handler for a communicator -- |deprecated_favor| :ref:`MPI_Comm_set_errhandler`.
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Keyval_create.3.rst b/docs/man-openmpi/man3/MPI_Keyval_create.3.rst
@@ -6,8 +6,7 @@ MPI_Keyval_create
 
 .. include_body
 
-:ref:`MPI_Keyval_create` - Generates a new attribute key -- use of this
-routine is deprecated.
+:ref:`MPI_Keyval_create` - Generates a new attribute key -- |deprecated_favor| :ref:`MPI_Comm_create_keyval`.
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Keyval_free.3.rst b/docs/man-openmpi/man3/MPI_Keyval_free.3.rst
@@ -6,9 +6,7 @@ MPI_Keyval_free
 
 .. include_body
 
-:ref:`MPI_Keyval_free` - Frees attribute key for communicator cache
-attribute -- use of this routine is deprecated.
-
+:ref:`MPI_Keyval_free` - Frees attribute key for communicator cache attribute -- |deprecated_favor| :ref:`MPI_Comm_free_keyval`.
 
 SYNTAX
 ------
diff --git a/docs/man-openmpi/man3/MPI_Type_extent.3.rst b/docs/man-openmpi/man3/MPI_Type_extent.3.rst
@@ -6,9 +6,7 @@ MPI_Type_extent
 
 .. include_body
 
-:ref:`MPI_Type_extent` - Returns the extent of a data type, the difference
-between the upper and lower bounds of the data type -- use of this
-routine is deprecated.
+:ref:`MPI_Type_extent` - Returns the extent of a data type -- |deprecated_favor| :ref:`MPI_Type_get_extent`.
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst b/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst
@@ -6,8 +6,7 @@ MPI_Type_hindexed
 
 .. include_body
 
-:ref:`MPI_Type_hindexed` - Creates an indexed datatype with offsets in
-bytes -- use of this routine is deprecated.
+:ref:`MPI_Type_hindexed` - Creates an indexed datatype with offsets in bytes -- |deprecated_favor| :ref:`MPI_Type_create_hindexed`.
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Type_hvector.3.rst b/docs/man-openmpi/man3/MPI_Type_hvector.3.rst
@@ -6,8 +6,7 @@ MPI_Type_hvector
 
 .. include_body
 
-:ref:`MPI_Type_hvector` - Creates a vector (strided) datatype with offset
-in bytes -- use of this routine is deprecated.
+:ref:`MPI_Type_hvector` - Creates a vector (strided) datatype with offset in bytes -- |deprecated_favor| :ref:`MPI_Type_create_hvector`.
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Type_lb.3.rst b/docs/man-openmpi/man3/MPI_Type_lb.3.rst
@@ -6,8 +6,7 @@ MPI_Type_lb
 
 .. include_body
 
-:ref:`MPI_Type_lb` - Returns the lower bound of a data type -- use of this
-routine is deprecated.
+:ref:`MPI_Type_lb` - Returns the lower bound of a data type -- |deprecated_favor| :ref:`MPI_Type_get_extent`.
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Type_struct.3.rst b/docs/man-openmpi/man3/MPI_Type_struct.3.rst
@@ -6,8 +6,7 @@ MPI_Type_struct
 
 .. include_body
 
-:ref:`MPI_Type_struct` - Creates a *struct* data type -- use of this
-routine is deprecated (use :ref:`MPI_Type_create_struct`).
+:ref:`MPI_Type_struct` - Creates a *struct* data type -- |deprecated_favor| :ref:`MPI_Type_create_struct`.
 
 
 SYNTAX
diff --git a/docs/man-openmpi/man3/MPI_Type_ub.3.rst b/docs/man-openmpi/man3/MPI_Type_ub.3.rst
@@ -6,8 +6,7 @@ MPI_Type_ub
 
 .. include_body
 
-:ref:`MPI_Type_ub` - Returns the upper bound of a datatype -- use of this
-routine is deprecated.
+:ref:`MPI_Type_ub` - Returns the upper bound of a datatype -- |deprecated_favor| :ref:`MPI_Type_get_extent`.
 
 
 SYNTAX
