From 9868ffb6be9f35505959f505953f48a93f86bdb6 Mon Sep 17 00:00:00 2001 From: Chris White Date: Mon, 12 Aug 2024 14:09:11 -0700 Subject: [PATCH 1/4] guard test with project specific option --- examples/simple_conduction/CMakeLists.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/examples/simple_conduction/CMakeLists.txt b/examples/simple_conduction/CMakeLists.txt index a53ffb6698..6c58adbf11 100644 --- a/examples/simple_conduction/CMakeLists.txt +++ b/examples/simple_conduction/CMakeLists.txt @@ -9,7 +9,8 @@ blt_add_executable( NAME simple_conduction_without_input_file OUTPUT_DIR ${EXAMPLE_OUTPUT_DIRECTORY} DEPENDS_ON serac_physics serac_mesh serac_functional ) -if(ENABLE_TESTS) + +if(SERAC_ENABLE_TESTS) blt_add_test(NAME simple_conduction_without_input_file COMMAND simple_conduction_without_input_file NUM_MPI_TASKS 1 ) From c6d71ccf7abf3a4c6b4f1286fd882f684688e1a4 Mon Sep 17 00:00:00 2001 From: Chris White Date: Mon, 12 Aug 2024 14:24:08 -0700 Subject: [PATCH 2/4] document how to style --- src/docs/sphinx/dev_guide/style_guide.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/docs/sphinx/dev_guide/style_guide.rst b/src/docs/sphinx/dev_guide/style_guide.rst index 6a5900f93c..b09bd5ff5b 100644 --- a/src/docs/sphinx/dev_guide/style_guide.rst +++ b/src/docs/sphinx/dev_guide/style_guide.rst @@ -32,6 +32,23 @@ to one of ``A``'s instance variables ``Foo f``, ``B`` should store a non-owning either ``Foo&`` or ``Foo*``. This should be ``const`` if at all possible. In this case, shared ownership is not required because the lifetime of ``B`` is entirely dependent on the lifetime of ``A``. +How to style your code +---------------------- + +We have two methods of enabling styling your code via ClangFormat. The first is to use the `style` build +target on a configuration with the correct version of ClangFormat enabled. Here is an example on how to do +it on LC's Ruby machine: + +.. code-block:: bash + + $ ./config-build.py host-configs/ruby-toss_4_x86_64_ib-clang@14.0.6.cmake + $ cd build-ruby-toss_4_x86_64_ib-clang@14.0.6-debug + $ make style + +The second method is to make a comment of `/style` on your open GitHub pull request. This will trigger +a GitHub Action that will automatically style your code and commit it to your branch. You will need to +`git pull` after it is finished to continue to work on that branch. + Documentation ------------- From e131269549fe72ab7814f4c5bc3db34c26aae237 Mon Sep 17 00:00:00 2001 From: Chris White Date: Mon, 12 Aug 2024 14:25:46 -0700 Subject: [PATCH 3/4] document how to style --- src/docs/sphinx/dev_guide/style_guide.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/docs/sphinx/dev_guide/style_guide.rst b/src/docs/sphinx/dev_guide/style_guide.rst index b09bd5ff5b..e9fa5d3758 100644 --- a/src/docs/sphinx/dev_guide/style_guide.rst +++ b/src/docs/sphinx/dev_guide/style_guide.rst @@ -35,9 +35,10 @@ is not required because the lifetime of ``B`` is entirely dependent on the lifet How to style your code ---------------------- -We have two methods of enabling styling your code via ClangFormat. The first is to use the `style` build -target on a configuration with the correct version of ClangFormat enabled. Here is an example on how to do -it on LC's Ruby machine: +We have two methods of enabling styling your code via ClangFormat. + +The first method is to use the `style` build target on a configuration with the correct version of +ClangFormat enabled. Here is an example on how to do it on LC's Ruby machine: .. code-block:: bash From 56248a1e6f1deaac860eda37e3ee63aeadf50863 Mon Sep 17 00:00:00 2001 From: Chris White Date: Mon, 12 Aug 2024 14:30:12 -0700 Subject: [PATCH 4/4] fix syntax --- src/docs/sphinx/dev_guide/style_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/sphinx/dev_guide/style_guide.rst b/src/docs/sphinx/dev_guide/style_guide.rst index e9fa5d3758..8c80a7f720 100644 --- a/src/docs/sphinx/dev_guide/style_guide.rst +++ b/src/docs/sphinx/dev_guide/style_guide.rst @@ -46,7 +46,7 @@ ClangFormat enabled. Here is an example on how to do it on LC's Ruby machine: $ cd build-ruby-toss_4_x86_64_ib-clang@14.0.6-debug $ make style -The second method is to make a comment of `/style` on your open GitHub pull request. This will trigger +The second method is to make a comment of ``/style`` on your open GitHub pull request. This will trigger a GitHub Action that will automatically style your code and commit it to your branch. You will need to `git pull` after it is finished to continue to work on that branch.