ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added text to explain the output of ctest -V a bit more

Browse Source
This commit is contained in:
Trung Nguyen
2023-12-18 15:52:30 -06:00
parent 188e1090e9
commit af222711ae
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/src/Developer_unittest.rst
View File

@ -569,6 +569,10 @@ For example, the following output snippet shows the failed unit test
Expected: (err) <= (epsilon) Expected: (err) <= (epsilon)
Actual: 0.00022892713393549854 vs 0.0001 Actual: 0.00022892713393549854 vs 0.0001
The failed assertions provide line numbers in the test source
(e.g. ``test_main.cpp:56``), from which one can understand what
specific assertion failed.
Note that the force style engine runs one of a small number of systems Note that the force style engine runs one of a small number of systems
in a rather off-equilibrium configuration with a few atoms for a few in a rather off-equilibrium configuration with a few atoms for a few
steps, writes data and restart files, uses :doc:`the clear command steps, writes data and restart files, uses :doc:`the clear command
@ -606,15 +610,18 @@ and run the test with verbose output. For example,
env TEST_ARGS=-v ctest -R ^MolPairStyle:lj_cut_coul_long -V env TEST_ARGS=-v ctest -R ^MolPairStyle:lj_cut_coul_long -V
``ctest`` with the ``-V`` flag also shows the exact command line
of the test. One can then use ``gdb --args`` to furthere debug and
catch exceptions with the test command, for example,
.. code-block:: bash
gdb --args /path/to/lammps/build/test_pair_style "/path/to/lammps/unittest/force-styles/tests/mol-pair-lj_cut_coul_long.yaml"
It is recommended to configure the build with ``-D It is recommended to configure the build with ``-D
BUILD_SHARED_LIBS=on`` and use a custom linker to shorten the build time BUILD_SHARED_LIBS=on`` and use a custom linker to shorten the build time
during recompilation. Installing `ccache` in your development during recompilation. Installing `ccache` in your development
environment helps speed up recompilation by caching previous environment helps speed up recompilation by caching previous
compilations and detecting when the same compilation is being done compilations and detecting when the same compilation is being done
again. Please see :doc:`Build_development` for further details. again. Please see :doc:`Build_development` for further details.