3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2025-02-18 12:23:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2269 from numaru/feature/rename-contrib-in-docs

Browse Source 
Rename contrib/ to extras/ in the docs
This commit is contained in:
Martin Hořeňovský 2021-08-11 00:26:38 +02:00 committed by GitHub
commit 7d0770adf2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/ci-and-misc.md
View File

@ -95,7 +95,7 @@ can use `pkg-config` to get its include path: `pkg-config --cflags catch2`.
### gdb and lldb scripts ### 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 `gdbinit` for `gdb` and `lldbinit` for `lldb`. If loaded into their
respective debugger, these will tell it to step over Catch2's internals respective debugger, these will tell it to step over Catch2's internals
when stepping through code. when stepping through code.

6
docs/cmake-integration.md
View File

@ -96,13 +96,13 @@ catch_discover_tests(foo)
``` ```
When using `FetchContent`, `include(Catch)` will fail unless 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. directory.
```cmake ```cmake
# ... FetchContent ... # ... FetchContent ...
# #
list(APPEND CMAKE_MODULE_PATH ${catch2_SOURCE_DIR}/contrib) list(APPEND CMAKE_MODULE_PATH ${catch2_SOURCE_DIR}/extras)
include(CTest) include(CTest)
include(Catch) include(Catch)
catch_discover_tests() catch_discover_tests()
@ -265,7 +265,7 @@ that consume it. These are:
Catch2's test binary will be built. Defaults to `ON`. Catch2's test binary will be built. Defaults to `ON`.
* `CATCH_INSTALL_DOCS` -- When `ON`, Catch2's documentation will be * `CATCH_INSTALL_DOCS` -- When `ON`, Catch2's documentation will be
included in the installation. Defaults to `ON`. 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`. included in the installation. Defaults to `ON`.
* `CATCH_DEVELOPMENT_BUILD` -- When `ON`, configures the build for development * `CATCH_DEVELOPMENT_BUILD` -- When `ON`, configures the build for development
of Catch2. This means enabling test projects, warnings and so on. of Catch2. This means enabling test projects, warnings and so on.