Skip to content

Commit

Permalink
backticks
Browse files Browse the repository at this point in the history
  • Loading branch information
sloriot committed Jan 21, 2025
1 parent f32adf7 commit 298b1bf
Showing 1 changed file with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Before submitting a change for integration into \cgal it is good style
to run the testsuite of the modified package and all packages that
could be impacted.

All examples and tests in CGAL are now compatible with ctest. So to test all examples or all tests
of a package, you simply need to configure with cmake the examples/tests of the package you want to
All examples and tests in CGAL are now compatible with `ctest`. So to test all examples or all tests
of a package, you simply need to configure with `cmake` the examples/tests of the package you want to
test, adding the option `CGAL_ENABLE_TESTING` and setting its value to `ON`. In order to report more
warnings, it is recommended to also add the option `CGAL_DEV_MODE` and to set it to `ON`.
Then a call to the command `ctest` will compile and run the tests/examples.
Expand All @@ -20,11 +20,11 @@ Then a call to the command `ctest` will compile and run the tests/examples.
We describe here how to proceed to the testing of a full copy of `master` or any branch by creating a <i>flat release</i>
(that is having a layout similar to a release rather than a branch layout with header files gathered by packages).

The creation of the flat release is done using the cmake script `cgal_create_release_with_cmake.cmake` located in the directory `Scripts/developer_scripts`.
You can run it using the option `-P` of cmake: `cmake -P cgal_create_release_with_cmake.cmake`.
The creation of the flat release is done using the `cmake` script `cgal_create_release_with_cmake.cmake` located in the directory `Scripts/developer_scripts`.
You can run it using the option `-P` of `cmake`: `cmake -P cgal_create_release_with_cmake.cmake`.
For an up-to-date documentation of available options, check the comments at the beginning of the script.

Then for testing all examples, tests, and demos, in a build directory call cmake on the created release
Then for testing all examples, tests, and demos, in a build directory call `cmake` on the created release
(the path is given by the script if not manually specified)

`cmake -DBUILD_TESTING=ON -DWITH_examples=ON -DWITH_tests=ON -DWITH_demos=ON ../CGAL-X.XX/`
Expand Down

0 comments on commit 298b1bf

Please sign in to comment.