Merge pull request #472 from dalg24/abort_header

Document the new header `<Kokkos_Abort.hpp>`
kokkos · Dec 6, 2023 · 896246a · 896246a
2 parents f8f5783 + c2bf257
commit 896246a
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/source/API/core/utilities/abort.rst b/docs/source/API/core/utilities/abort.rst
@@ -11,3 +11,12 @@ Defined in header ``<Kokkos_Core.hpp>``
     KOKKOS_FUNCTION void abort(const char *const msg);
 
 Causes abnormal program termination with error explanatory string being printed.
+
+Notes
+-----
+
+.. _KokkosAbort: https://github.com/kokkos/kokkos/blob/4.2.00/core/src/Kokkos_Abort.hpp
+
+.. |KokkosAbort| replace:: ``<Kokkos_Abort.hpp>``
+
+* Since version 4.2, one may include |KokkosAbort|_ instead of ``<Kokkos_Core.hpp>``.