Merge pull request kokkos#171 from dssgabriel/feature/pre-commit

cwpearson · web-flow · commit 45aa5e02d8be · 2025-09-18T11:18:28.000-06:00
diff --git a/.clang-format b/.clang-format
@@ -4,4 +4,4 @@ SortIncludes: false
 AlignConsecutiveAssignments: true
 AllowShortCaseLabelsOnASingleLine: true
 AllowShortIfStatementsOnASingleLine: true
-ColumnLimit: 120
+ColumnLimit: 120
diff --git a/.cmake-format b/.cmake-format
@@ -0,0 +1,3 @@
+line_length: 120
+list_expansion: favour-inlining
+indent: 2
diff --git a/.github/workflows/formatting.yaml b/.github/workflows/formatting.yaml
@@ -21,4 +21,4 @@ jobs:
     - name: Run clang-format style check.
       uses: DoozyX/clang-format-lint-action@v0.16.2
       with:
-        clangFormatVersion: 14
+        clangFormatVersion: 14
diff --git a/.github/workflows/snl-at2.yaml b/.github/workflows/snl-at2.yaml
@@ -1,6 +1,6 @@
 name: SNL-AT2
 
-on: 
+on:
   pull_request:
     paths-ignore:
     - 'docs/**'
diff --git a/.github/workflows/snl-h100.yaml b/.github/workflows/snl-h100.yaml
@@ -11,7 +11,7 @@ jobs:
   PR_CUDA1250_OPENMPI504:
     name: PR_CUDA1250_OPENMPI504
     runs-on: [cuda125-openmpi504-latest-latest]
-    
+
     steps:
       - name: Checkout Kokkos Comm
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,4 @@ Testing
 kokkos
 docs/_build
 .python-version
-.venv
+.venv
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,38 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    - id: trailing-whitespace
+      name: Trim trailing white space
+    - id: end-of-file-fixer
+      name: Fix EOFs
+    - id: check-yaml
+      name: Check YAML files
+    - id: check-added-large-files
+      name: Check adding large files
+
+    # C++ formatting with clang-format
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v14.0.6
+    hooks:
+    - id: clang-format
+      name: Format C++ files
+      types_or: [c++, c]
+      exclude: ^docs/ # do not format any C++ files in the documentation
+
+    # CMake formatting with gersemi
+  - repo: https://github.com/BlankSpruce/gersemi
+    rev: 0.22.2
+    hooks:
+    - id: gersemi
+      name: Format CMake files
+      args: ["--config=.cmake-format"]
+
+    # Spell-checking
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.36.2
+    hooks:
+      - id: typos
+        name: Spell-check for typos
diff --git a/.typos.toml b/.typos.toml
@@ -1,3 +1,3 @@
 [default.extend-words]
 # Don't correct these word (parts)
-arange = "arange"
+arange = "arange"
diff --git a/LICENSE b/LICENSE
@@ -1,9 +1,9 @@
  ************************************************************************
- 
+
                         Kokkos v. 4.0
        Copyright (2022) National Technology & Engineering
                Solutions of Sandia, LLC (NTESS).
- 
+
  Under the terms of Contract DE-NA0003525 with NTESS,
  the U.S. Government retains certain rights in this software.
 
@@ -231,7 +231,7 @@
  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
- Questions? Contact: 
+ Questions? Contact:
    Carl Pearson (cwpears@sandia.gov) and/or
    Jan Ciesko (jciesko@sandia.gov) and/or
    Cedric Chevalier (cedric.chevalier@cea.fr)
diff --git a/cmake/KokkosComm_config.hpp.in b/cmake/KokkosComm_config.hpp.in
@@ -26,4 +26,4 @@
 
 #if defined(KOKKOSCOMM_ENABLE_MPI) && __has_include(<mpi-ext.h>)
 #define KOKKOSCOMM_IMPL_MPIEXT_H
-#endif
+#endif
diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst
@@ -12,13 +12,51 @@ Please freely use GitHub Issues/Discussions, the Kokkos Team Slack, or emails to
 In very limited circumstances, modifications may need to be tested as branches in the repository rather than pull requests.
 Such changes should always be made in consultation with the core development team.
 
-For a more detailed overview of what is expected of a "good" PR, please refer to `this section <https://kokkos.org/kokkos-core-wiki/developer-guides/prs-and-reviews.html>`_ of the Kokkos documentation.
+For a more detailed overview of what is expected of a "good" PR, please refer to `the related section <https://kokkos.org/kokkos-core-wiki/developer-guides/prs-and-reviews.html>`_ in the Kokkos documentation.
+
+
+Pre-commit hooks
+================
+
+KokkosComm provides a pre-commit configuration to allow contributors to easily check that their changes will pass CI with regards to code formatting, spell-checking, etc.
+
+To enable it on your machine, run the following commands (or check `the pre-commit docs <https://pre-commit.com/>`):
+
+.. code-block:: console
+
+    $ pip install pre-commit
+    $ pre-commit install
+
+Then, you can either manually run the pre-commit hooks with:
+
+.. code-block:: console
+
+    $ pre-commit run [--all-files]
+
+Or let Git run them automatically when committing.
+
+KokkosComm pre-commits perform the following checks:
+
+* Correct code formatting in C++ files (using ``clang-format``)
+
+* Correct formatting in CMake files (using ``gersemi``)
+
+* Correctness of YAML files (mainly CI config)
+
+* Trim trailing white space
+
+* Fix missing new line in EOF
+
+* Correct spelling and fixing typos
+
+* Large files haven't been inadvertently added
 
 
 Code formatting
 ===============
 
-All code shall be formatted with clang-format 14:
+All code shall be formatted with ``clang-format`` v14.x.
+If not using the provided pre-commit hooks, one can format the files using the following command:
 
 .. code-block:: console
 
diff --git a/docs/api/mpi.rst b/docs/api/mpi.rst
@@ -110,7 +110,7 @@ Point-to-point
 
 
 .. cpp:function:: template <KokkosExecutionSpace ExecSpace, KokkosView RecvView> \
-                  auto recv(const ExecSpace &space, RecvView &rv, int src, int tag, MPI_Comm comm) -> void 
+                  auto recv(const ExecSpace &space, RecvView &rv, int src, int tag, MPI_Comm comm) -> void
 
     Initiates a blocking receive operation with a specified execution space.
 
@@ -144,7 +144,7 @@ Collectives
 ===========
 
 .. cpp:function:: template <KokkosView SendView, KokkosView RecvView> \
-                  auto allgather(const SendView &sv, const RecvView &rv, MPI_Comm comm) -> void 
+                  auto allgather(const SendView &sv, const RecvView &rv, MPI_Comm comm) -> void
 
     Performs an allgather operation, gathering data from all processes and distributing it to all processes.
 
@@ -159,7 +159,7 @@ Collectives
 
 
 .. cpp:function:: template <KokkosView RecvView> \
-                  auto allgather(const RecvView &rv, MPI_Comm comm) -> void 
+                  auto allgather(const RecvView &rv, MPI_Comm comm) -> void
 
     Performs an in-place allgather operation, gathering data from all processes and distributing it to all processes.
 
@@ -170,7 +170,7 @@ Collectives
 
 
 .. cpp:function:: template <KokkosExecutionSpace ExecSpace, KokkosView SendView, KokkosView RecvView> \
-                  auto allgather(const ExecSpace &space, const SendView &sv, const RecvView &rv, MPI_Comm comm) -> void 
+                  auto allgather(const ExecSpace &space, const SendView &sv, const RecvView &rv, MPI_Comm comm) -> void
 
     Performs an allgather operation with a specified execution space, gathering data from all processes and distributing it to all processes.
 
@@ -185,7 +185,7 @@ Collectives
 
 
 .. cpp:function:: template <KokkosView SendView, KokkosView RecvView> \
-                  auto reduce(const SendView &sv, const RecvView &rv, MPI_Op op, int root, MPI_Comm comm) -> void 
+                  auto reduce(const SendView &sv, const RecvView &rv, MPI_Op op, int root, MPI_Comm comm) -> void
 
     Performs a reduction operation, combining data from all processes and distributing the result to the root process.
 
@@ -200,7 +200,7 @@ Collectives
 
 
 .. cpp:function:: template <KokkosExecutionSpace ExecSpace, KokkosView SendView, KokkosView RecvView> \
-                  auto reduce(const ExecSpace &space, const SendView &sv, const RecvView &rv, MPI_Op op, int root, MPI_Comm comm) -> void 
+                  auto reduce(const ExecSpace &space, const SendView &sv, const RecvView &rv, MPI_Op op, int root, MPI_Comm comm) -> void
 
     Performs a reduction operation with a specified execution space, combining data from all processes and distributing the result to the root process.
 
diff --git a/docs/api/packing.rst b/docs/api/packing.rst
@@ -35,7 +35,7 @@ MPI
 
     .. cpp:function:: template <KokkosExecutionSpace ExecSpace> \
                       static auto allocate_packed_for(const ExecSpace &space, const std::string &label, const View &src)-> args_type
-        
+
         Allocates  contiguous Kokkos view large enough to hold all the data in ``src``.
 
         :param space: The execution space to operate in.
@@ -47,20 +47,20 @@ MPI
 
     .. cpp:function:: template <KokkosExecutionSpace ExecSpace> \
                       static auto pack(const ExecSpace &space, const View &src) -> args_type
-    
+
         Uses ``allocate_packed_for`` and ``Kokkos::deep_copy`` to pack the data in ``src``.
 
         :param space: The execution space to operate in.
         :param src: A Kokkos view produced by ``allocate_packed_for``.
 
         :return: A packed Kokkos view of the data in ``src``.
-    
+
 
     .. cpp:function:: template <KokkosExecutionSpace ExecSpace> \
                       static auto unpack_into(const ExecSpace &space, const View &dst, const non_const_packed_view_type &src) -> void
-    
+
         Uses ``Kokkos::deep_copy`` to fill ``dst`` with an unpacked view of the data in ``src``.
-    
+
         :param space: The execution space to operate in.
         :param src: A Kokkos view produced by ``allocate_packed_for``.
         :param dst: A corresponding unpacked Kokkos view.
@@ -83,7 +83,7 @@ MPI
             * the ``src``;
             * an ``MPI_Datatype`` describing the possibly-non-contiguous data in that Kokkos::View, and;
             * a count equal to 1.
-    
+
         :param space: The execution space to operate in.
         :param label: Identification label for the allocation.
         :param src: A Kokkos view produced by ``allocate_packed_for``.
diff --git a/docs/dev/mpi.rst b/docs/dev/mpi.rst
@@ -30,12 +30,12 @@ This was observed to work with CUDA 12.2.
 It was necessary to use both ``--with-cuda`` and ``--with-cuda-libdir``, otherwise it would not detect the CUDA library.
 
 .. code-block:: bash
-    
+
     OPENMPI_SRC="$PWD"/openmpi-5.0.6
     MPI_INSTALL="$PWD"/openmpi-5.0.6-install
     wget --continue https://download.open-mpi.org/release/open-mpi/v5.0/openmpi-5.0.6.tar.gz
     tar -xf openmpi-5.0.6.tar.gz
     rm -rf "$OPENMPI_INSTALL"
     (cd $OPENMPI_SRC; ./configure --prefix="$OPENMPI_INSTALL" --enable-mpi-ext=cuda --with-cuda=/usr/local/cuda --with-cuda-libdir=/usr/local/cuda/lib64/stubs)
     (cd $OPENMPI_SRC; make -j $(nproc))
-    (cd $OPENMPI_SRC; make install)
+    (cd $OPENMPI_SRC; make install)
diff --git a/docs/getting_started/perf_tests.rst b/docs/getting_started/perf_tests.rst
@@ -21,4 +21,4 @@ Available benchmarks:
       - ping-pong between ranks 0 and 1
 
 
-To build and run the benchmarks, see the `dedicated page on testing <../dev/testing.html>`_: 
+To build and run the benchmarks, see the `dedicated page on testing <../dev/testing.html>`_:
diff --git a/perf_tests/mpi/test_2dhalo.cpp b/perf_tests/mpi/test_2dhalo.cpp
@@ -99,7 +99,7 @@ void benchmark_2dhalo(benchmark::State &state) {
   state.counters["nx"]           = nx;
   // clang-format off
   state.SetBytesProcessed(
-      sizeof(Scalar) 
+      sizeof(Scalar)
     * rs * rs // active ranks
     * state.iterations()
     * nprops
diff --git a/src/KokkosComm/CMakeLists.txt b/src/KokkosComm/CMakeLists.txt
@@ -77,11 +77,11 @@ if(KOKKOSCOMM_ENABLE_MPI)
       FILE_SET kokkoscomm_mpi_impl_headers
       TYPE HEADERS
       BASE_DIRS ${PROJECT_SOURCE_DIR}/src
-      FILES 
-        mpi/impl/pack_traits.hpp 
-        mpi/impl/packer.hpp 
-        mpi/impl/tags.hpp 
-        mpi/impl/types.hpp 
+      FILES
+        mpi/impl/pack_traits.hpp
+        mpi/impl/packer.hpp
+        mpi/impl/tags.hpp
+        mpi/impl/types.hpp
         mpi/impl/error_handling.hpp
   )
 endif()
diff --git a/unit_tests/mpi/test_mpi.cpp b/unit_tests/mpi/test_mpi.cpp
@@ -27,4 +27,4 @@ int main(int argc, char *argv[]) {
   MPI_Barrier(MPI_COMM_WORLD);
   MPI_Finalize();
   return 0;
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+line_length: 120`
	`2`	`+list_expansion: favour-inlining`
	`3`	`+indent: 2`