Skip to content

Commit

Permalink
Merge pull request #1210 from LLNL/task/white238/guard_missed_test
Browse files Browse the repository at this point in the history
Guard missed test and document how to style
  • Loading branch information
white238 authored Aug 13, 2024
2 parents 19476f2 + 56248a1 commit 4ccc602
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
3 changes: 2 additions & 1 deletion examples/simple_conduction/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 )
Expand Down
18 changes: 18 additions & 0 deletions src/docs/sphinx/dev_guide/style_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,24 @@ 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 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
$ ./config-build.py host-configs/[email protected]
$ cd [email protected]
$ 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
-------------

Expand Down

0 comments on commit 4ccc602

Please sign in to comment.