@@ -3,7 +3,7 @@ Error: One or more tests failed | |||
This error message is printed when a project's tests encounter a failure | |||
condition. The exact behavior of tests is determined by a project's | |||
``Test-Driver``. | |||
``test_driver``. | |||
If you see this error, it is most likely that you have an issue in the tests of | |||
your project. |
@@ -1,8 +1,8 @@ | |||
Error: Unknown ``Test-Driver`` | |||
Error: Unknown ``test_driver`` | |||
############################## | |||
``dds`` has a set of known ``Test-Driver``s built-in, and they may be specified | |||
with the ``Test-Driver`` key. Receiving this error indicates that the specified | |||
``Test-Driver`` was not recognized by ``dds``. Check your spelling, and check | |||
``dds`` has a set of known ``test_driver``s built-in, and they may be specified | |||
with the ``test_driver`` key. Receiving this error indicates that the specified | |||
``test_driver`` was not recognized by ``dds``. Check your spelling, and check | |||
that the driver you want to use is supported by ``dds``. Refer to the | |||
:doc:`/guide/packages` page. |
@@ -88,7 +88,7 @@ executable. | |||
A *test* source file is a source file whose file stem ends with ``.test``. Like | |||
application sources, a *test* source file is omitted from the main library, and | |||
it will be used to generate tests. The exact behavior of tests is determined by | |||
the ``Test-Driver`` setting for the package, but the default is that each test | |||
the ``test_driver`` setting for the package, but the default is that each test | |||
source file will generate a single test executable that is executed by ``dds`` | |||
when running unit tests. | |||
@@ -48,7 +48,7 @@ will already know the problem, but wouldn't it be better if we had better test | |||
diagnostics? | |||
A ``Test-Driver``: Using *Catch2* | |||
A ``test_driver``: Using *Catch2* | |||
********************************* | |||
``dds`` ships with built-in support for the `Catch2`_ C and C++ testing | |||
@@ -70,7 +70,7 @@ To make use of Catch as our test driver, we simply declare this intent in the | |||
} | |||
If you now run ``dds build``, we will get a linker error for a multiply-defined | |||
``main`` function. When setting the ``Test-Driver`` to ``Catch-Main``, ``dds`` | |||
``main`` function. When setting the ``test_driver`` to ``Catch-Main``, ``dds`` | |||
will compile an entrypoint separately from any particular test, and the tests | |||
will link against that entrypoint. This means we cannot provide our own | |||
``main`` function, and should instead use Catch's ``TEST_CASE`` macro to |
@@ -307,7 +307,7 @@ std::string_view dds::default_error_string(dds::errc ec) noexcept { | |||
return "The source ditsribution already exists at the destination <- (Seeing this " | |||
"text is a `dds` bug. Please report it.)"; | |||
case errc::unknown_test_driver: | |||
return "The specified Test-Driver is not known to `dds`"; | |||
return "The specified test_driver is not known to `dds`"; | |||
case errc::dependency_resolve_failure: | |||
return "`dds` was unable to find a solution for the package dependencies given."; | |||
case errc::dup_lib_name: |
@@ -9,9 +9,9 @@ | |||
namespace dds { | |||
/** | |||
* Represents the contents of a `library.dds`. This is somewhat a stripped-down | |||
* Represents the contents of a `library.json5`. This is somewhat a stripped-down | |||
* version of lm::library, to only represent exactly the parts that we want to | |||
* offer via `library.dds`. | |||
* offer via `library.json5`. | |||
*/ | |||
struct library_manifest { | |||
/// The name of the library |
@@ -51,7 +51,7 @@ package_manifest package_manifest::load_from_dds_file(const fs::path& fpath) { | |||
} else { | |||
auto dym = *did_you_mean(test_driver_str, {"Catch-Main", "Catch"}); | |||
throw_user_error< | |||
errc::unknown_test_driver>("Unknown 'Test-Driver' '{}' (Did you mean '{}'?)", | |||
errc::unknown_test_driver>("Unknown 'test_driver' '{}' (Did you mean '{}'?)", | |||
test_driver_str, | |||
dym); | |||
} | |||
@@ -126,7 +126,7 @@ package_manifest package_manifest::load_from_file(const fs::path& fpath) { | |||
} else { | |||
auto dym = *did_you_mean(test_driver, {"Catch-Main", "Catch"}); | |||
throw_user_error<errc::unknown_test_driver>( | |||
"Unknown 'Test-Driver' '{}' (Did you mean '{}'?)", | |||
"Unknown 'test_driver' '{}' (Did you mean '{}'?)", | |||
test_driver, | |||
dym); | |||
} |
@@ -26,7 +26,7 @@ struct package_manifest { | |||
package_id pkg_id; | |||
/// The declared `Namespace` of the package. This directly corresponds with the libman Namespace | |||
std::string namespace_; | |||
/// The `Test-Driver` that this package declares, or `nullopt` if absent. | |||
/// The `test_driver` that this package declares, or `nullopt` if absent. | |||
std::optional<test_lib> test_driver; | |||
/// The dependencies declared with the `Depends` fields, if any. | |||
std::vector<dependency> dependencies; |