aboutsummaryrefslogtreecommitdiff
path: root/docs/unit_testing.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/unit_testing.md')
-rw-r--r--docs/unit_testing.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/unit_testing.md b/docs/unit_testing.md
index 7310da8d0..47a105579 100644
--- a/docs/unit_testing.md
+++ b/docs/unit_testing.md
@@ -20,12 +20,12 @@ One thing to remember, is that you have to append `extern "C"` around all of you
20 20
21## Adding Tests for New or Existing Features 21## Adding Tests for New or Existing Features
22 22
23If you want to unit test some feature, then take a look at the existing serial_link tests, in the `quantum/serial_link/tests folder`, and follow the steps below to create a similar structure. 23If you want to unit test a feature, take a look at some of the existing tests, for example those in the `quantum/sequencer/tests` folder. Then follow the steps below to create a similar structure.
24 24
251. If it doesn't already exist, add a test subfolder to the folder containing the feature. 251. If it doesn't already exist, add a test subfolder to the folder containing the feature.
262. Create a `testlist.mk` and a `rules.mk` file in that folder. 262. Create a `testlist.mk` and a `rules.mk` file in that folder.
273. Include those files from the root folder `testlist.mk`and `build_test.mk` respectively. 273. Include those files from the root folder `testlist.mk`and `build_test.mk` respectively.
284. Add a new name for your testgroup to the `testlist.mk` file. Each group defined there will be a separate executable. And that's how you can support mocking out different parts. Note that it's worth adding some common prefix, just like it's done for the serial_link tests. The reason for that is that the make command allows substring filtering, so this way you can easily run a subset of the tests. 284. Add a new name for your testgroup to the `testlist.mk` file. Each group defined there will be a separate executable. And that's how you can support mocking out different parts. Note that it's worth adding some common prefix, just like it's done for the existing tests. The reason for that is that the make command allows substring filtering, so this way you can easily run a subset of the tests.
295. Define the source files and required options in the `rules.mk` file. 295. Define the source files and required options in the `rules.mk` file.
30 * `_SRC` for source files 30 * `_SRC` for source files
31 * `_DEFS` for additional defines 31 * `_DEFS` for additional defines