Skip to content

Commit

Permalink
Mention missing catch_user_config.hpp in FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
horenmar committed Aug 11, 2023
1 parent a94bee7 commit 9538d16
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
[Does Catch2 support running tests in parallel?](#does-catch2-support-running-tests-in-parallel)<br>
[Can I compile Catch2 into a dynamic library?](#can-i-compile-catch2-into-a-dynamic-library)<br>
[What repeatability guarantees does Catch2 provide?](#what-repeatability-guarantees-does-catch2-provide)<br>
[My build cannot find `catch2/catch_user_config.hpp`, how can I fix it?](#my-build-cannot-find-catch2catch_user_confighpp-how-can-i-fix-it)<br>


## How do I run global setup/teardown only if tests will be run?
Expand Down Expand Up @@ -89,6 +90,19 @@ above what your platform does. **Important: `<random>`'s distributions
are not specified to be repeatable across different platforms.**


## My build cannot find `catch2/catch_user_config.hpp`, how can I fix it?

`catch2/catch_user_config.hpp` is a generated header that contains user
compile time configuration. It is generated by CMake/Meson/Bazel during
build. If you are not using either of these, your three options are to

1) Build Catch2 separately using build tool that will generate the header
2) Use the amalgamated files to build Catch2
3) Use CMake to configure a build. This will generate the header and you
can copy it into your own checkout of Catch2.



---

[Home](Readme.md#top)

0 comments on commit 9538d16

Please sign in to comment.