From 74db06199bde41e0de0b6f5b7653aeb8d670159f Mon Sep 17 00:00:00 2001 From: Kin Numaru Date: Tue, 10 Aug 2021 10:26:55 +0200 Subject: [PATCH] Rename contrib/ to extras/ in the docs The directory has been renamed in 918aa32 but the doc was not updated yet. --- docs/ci-and-misc.md | 2 +- docs/cmake-integration.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/ci-and-misc.md b/docs/ci-and-misc.md index 40b7cec9..0d016618 100644 --- a/docs/ci-and-misc.md +++ b/docs/ci-and-misc.md @@ -95,7 +95,7 @@ can use `pkg-config` to get its include path: `pkg-config --cflags catch2`. ### gdb and lldb scripts -Catch2's `contrib` folder also contains two simple debugger scripts, +Catch2's `extras` folder also contains two simple debugger scripts, `gdbinit` for `gdb` and `lldbinit` for `lldb`. If loaded into their respective debugger, these will tell it to step over Catch2's internals when stepping through code. diff --git a/docs/cmake-integration.md b/docs/cmake-integration.md index 1d261189..e872dcee 100644 --- a/docs/cmake-integration.md +++ b/docs/cmake-integration.md @@ -96,13 +96,13 @@ catch_discover_tests(foo) ``` When using `FetchContent`, `include(Catch)` will fail unless -`CMAKE_MODULE_PATH` is explicitly updated to include the contrib +`CMAKE_MODULE_PATH` is explicitly updated to include the extras directory. ```cmake # ... FetchContent ... # -list(APPEND CMAKE_MODULE_PATH ${catch2_SOURCE_DIR}/contrib) +list(APPEND CMAKE_MODULE_PATH ${catch2_SOURCE_DIR}/extras) include(CTest) include(Catch) catch_discover_tests() @@ -265,7 +265,7 @@ that consume it. These are: Catch2's test binary will be built. Defaults to `ON`. * `CATCH_INSTALL_DOCS` -- When `ON`, Catch2's documentation will be included in the installation. Defaults to `ON`. -* `CATCH_INSTALL_HELPERS` -- When `ON`, Catch2's contrib folder will be +* `CATCH_INSTALL_HELPERS` -- When `ON`, Catch2's extras folder will be included in the installation. Defaults to `ON`. * `CATCH_DEVELOPMENT_BUILD` -- When `ON`, configures the build for development of Catch2. This means enabling test projects, warnings and so on.