Skip to content

Commit ebfce06

Browse files
committed
make atomic deprecations cross-referenced
1 parent 080df9d commit ebfce06

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

docs/source/deprecations.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Deprecated in Kokkos 4.6
1818

1919
* Makefile support
2020
* replacement: CMake
21-
* reducing maintenance burden for a little-used build system
21+
* reducing maintenance burden for a little-used build system
2222

2323
* Direct access to ``d_view`` and ``h_view`` members in ``DualView``
2424
* replacement: ``view_host()`` and ``view_device()``
@@ -43,20 +43,20 @@ Deprecated in Kokkos 4.5
4343
* replacement: none
4444
* no known use case
4545

46-
* ``atomic_assign``
47-
* replacement: ``atomic_store``
46+
* :cpp:func:`atomic_assign`
47+
* replacement: :cpp:func:`atomic_store`
4848
* duplicated functionality
4949

50-
* ``atomic_increment``
51-
* replacement: ``atomic_inc``
50+
* :cpp:func:`atomic_increment`
51+
* replacement: :cpp:func:`atomic_inc`
5252
* duplicated functionality
5353

54-
* ``atomic_decremnent``
55-
* replacement: ``atomic_dec``
54+
* :cpp:func:`atomic_decrement`
55+
* replacement: :cpp:func:`atomic_dec`
5656
* duplicated functionality
5757

58-
* ``atomic_compare_exchange_strong``
59-
* replacement: ``atomic_compare_exchange``
58+
* :cpp:func:`atomic_compare_exchange_strong`
59+
* replacement: :cpp:func:`atomic_compare_exchange`
6060
* duplicated functionality
6161

6262
Deprecated in Kokkos 4.4
@@ -128,7 +128,7 @@ Deprecated in Kokkos 4.3
128128

129129
* ``RangePolicy::set(ChunkSize chunksize)``
130130
* replacement: ``RangePolicy::set_chunk_size(int chunk_size)``
131-
* ``ChunkSize`` was the only extra parameter usable with ``RangePolicy::set()``
131+
* ``ChunkSize`` was the only extra parameter usable with ``RangePolicy::set()``
132132

133133
* ``InitializationSettings::set_num_devices``, ``InitializationSettings::has_num_devices``, ``InitializationSettings::get_num_devices``
134134
* replacement: ``num_devices``
@@ -145,22 +145,22 @@ Deprecated in Kokkos 4.2
145145
* ``Cuda::Cuda(cudaStream_t stream, bool manage_stream)``
146146
* replacement: ``Cuda::Cuda(cudaStream_t stream)``
147147
* constructing a Cuda execution space instance should always use an externally managed ``cudaStream`` object
148-
148+
149149
* ``HIP::HIP(hipStream_t stream, bool manage_stream)``
150150
* replacement ``HIP::HIP(hipStream_t stream)``
151151
* constructing a HIP execution space instance should always use an externally managed ``hipStream`` object
152-
152+
153153
* ``vector``
154154
* replacement: none
155-
* non-standard behavior, doesn't work well with Kokkos concepts
155+
* non-standard behavior, doesn't work well with Kokkos concepts
156156

157157
* ``HostSpace::HostSpace(AllocationMechanism)``
158158
* replacement: ``HostSpace::HostSpace()``
159159
* ``AllocationMechanism`` is unused, ``operator new`` with alignment is used unconditionally
160160

161161
* SIMD math functions in the ``Kokkos::Experimental`` namespace
162162
* replacement: SIMD math function in the ``Kokkos`` namespace
163-
* issues with ADL, consistency with other math function overloads
163+
* issues with ADL, consistency with other math function overloads
164164

165165

166166
Deprecated in Kokkos 4.1
@@ -218,14 +218,14 @@ Macros deprecated in Kokkos-3.7
218218
Free-functions deprecated in Kokkos-3.7
219219
---------------------------------------
220220

221-
.. list-table::
221+
.. list-table::
222222
:widths: 30 70
223223
:header-rows: 1
224224

225-
* - Name
225+
* - Name
226226
- Where
227227

228-
* - .. code-block:: cpp
228+
* - .. code-block:: cpp
229229

230230
std::vector<OpenMP> OpenMP::partition(...)
231231

@@ -267,7 +267,7 @@ Free-functions deprecated in Kokkos-3.7
267267
Member functions deprecated in Kokkos-3.7
268268
------------------------------------------
269269

270-
.. list-table::
270+
.. list-table::
271271
:widths: 70 30
272272
:header-rows: 1
273273

@@ -301,18 +301,18 @@ Member functions deprecated in Kokkos-3.7
301301
* - ``static int CudaUVMSpace::number_of_allocations();``
302302
- ``class CudaUVMSpace`` (Kokkos_CudaSpace.hpp)
303303

304-
* - ``HPX::partition(...), HPX::partition_master()``
304+
* - ``HPX::partition(...), HPX::partition_master()``
305305
- ``class HPX`` (Kokkos_HPX.hpp)
306306

307307

308308
Classes deprecated in Kokkos-3.7
309309
--------------------------------
310310

311-
.. list-table::
311+
.. list-table::
312312
:widths: auto
313313
:header-rows: 1
314314

315-
* -
315+
* -
316316

317317
* - ``class MasterLock<OpenMP>``
318318

@@ -322,13 +322,13 @@ Classes deprecated in Kokkos-3.7
322322
Namespace updates
323323
----------------------
324324

325-
.. list-table::
325+
.. list-table::
326326
:widths: 40 60
327327
:header-rows: 1
328328

329329
* - Previous
330330
- You should now use
331-
331+
332332
* - ``Kokkos::Experimental::aMathFunction``
333333
- ``Kokkos::aMathFunction``
334334

@@ -348,7 +348,7 @@ Namespace updates
348348
Other deprecations
349349
------------------
350350

351-
.. list-table::
351+
.. list-table::
352352
:widths: auto
353353
:header-rows: 1
354354

@@ -399,7 +399,7 @@ Other deprecations
399399
- ``Kokkos::parallel_*("KokkosViewLabel", policy, f);``
400400

401401

402-
Public Headers in Kokkos-3.7
402+
Public Headers in Kokkos-3.7
403403
----------------------------
404404

405405
From Kokkos-3.7, the following are *public* headers:
@@ -414,4 +414,4 @@ Algorithms
414414

415415
Containers
416416
~~~~~~~~~~~~~~~~~~
417-
``Kokkos_Bit.hpp``, ``Kokkos_DualView.hpp``, ``Kokkos_DynRankView.hpp``, ``Kokkos_ErrorReporter.hpp``, ``Kokkos_Functional.hpp``, ``Kokkos_OffsetView.hpp``, ``Kokkos_ScatterView.hpp``, ``Kokkos_StaticCrsGraph.hpp``, ``Kokkos_UnorderedMap.hpp``, ``Kokkos_Vector.hpp``
417+
``Kokkos_Bit.hpp``, ``Kokkos_DualView.hpp``, ``Kokkos_DynRankView.hpp``, ``Kokkos_ErrorReporter.hpp``, ``Kokkos_Functional.hpp``, ``Kokkos_OffsetView.hpp``, ``Kokkos_ScatterView.hpp``, ``Kokkos_StaticCrsGraph.hpp``, ``Kokkos_UnorderedMap.hpp``, ``Kokkos_Vector.hpp``

0 commit comments

Comments
 (0)