From ffc4f560457d2dc7a61cb9b40bce327844d89c3c Mon Sep 17 00:00:00 2001 From: john bowen Date: Fri, 13 Dec 2024 09:30:56 -0800 Subject: [PATCH] Update docs --- docs/sphinx/dev_guide/contributing.rst | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/sphinx/dev_guide/contributing.rst b/docs/sphinx/dev_guide/contributing.rst index 72ad393ffa..d3370e341d 100644 --- a/docs/sphinx/dev_guide/contributing.rst +++ b/docs/sphinx/dev_guide/contributing.rst @@ -197,8 +197,8 @@ likely the develop branch. Style ----------------------------------- RAJA enforces style within the ``src`` and ``include`` directories using clang-format, -major version 14. Formatting will be enforced on pull requests through CI, and it -is up to the contributor to guarantee that their code is in compliance with the +major version 14. Formatting will be enforced on pull requests through CI. +The contributor must guarantee that their code is in compliance with the clang-format settings specified within ``.clang-format``. To make this easy, RAJA has provided two options for applying clang-format: @@ -209,9 +209,16 @@ RAJA has provided two options for applying clang-format: the CMake variable ``CLANGFORMAT_EXECUTABLE`` to that executable's path. * If an invalid version exists in the ``PATH``, or no ``clang-format`` version is specified in the path, the ``CLANGFORMAT_EXECUTABLE`` variable must be set by the - user in order to properly configure the make `style` target. This can be done by - passing ``-DCLANGFORMAT_EXECUTABLE=`` to ``cmake`` during - build configuration. + user. This can be done by passing ``-DCLANGFORMAT_EXECUTABLE=`` + to ``cmake`` during build configuration. For example on Linux, this would look like + + .. code-block:: bash + + mkdir build + cd build + cmake ../ -DCLANGFORMAT_EXECUTABLE= + + * If an invalid version of ``clang-format`` is supplied, the following error will be emitted at build config time: