aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorGilles Peskine <Gilles.Peskine@arm.com>2022-10-21 18:56:47 +0200
committerGilles Peskine <Gilles.Peskine@arm.com>2022-10-21 18:56:47 +0200
commit42832bd406a35326a219913d72603f0913002bea (patch)
tree6d6394f7a20fd8332eaa06ad39e4c3201d5c3c04 /CONTRIBUTING.md
parentce220662119bff13da53ef5606ebf233e049ee54 (diff)
downloadmbedtls-42832bd406a35326a219913d72603f0913002bea.zip
mbedtls-42832bd406a35326a219913d72603f0913002bea.tar.gz
mbedtls-42832bd406a35326a219913d72603f0913002bea.tar.bz2
Don't use test_suite_mpi as an example
It just got renamed, and it's also not the most canonical example since it's a somewhat deprecated interface. Make a different module the example. Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 66fe5f1..0e2cf49 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -54,7 +54,7 @@ Tests
-----
As mentioned, tests that show the correctness of the feature or bug fix should be added to the pull request, if no such tests exist.
-Mbed TLS includes a comprehensive set of test suites in the `tests/` directory that are dynamically generated to produce the actual test source files (e.g. `test_suite_mpi.c`). These files are generated from a `function file` (e.g. `suites/test_suite_mpi.function`) and a `data file` (e.g. `suites/test_suite_mpi.data`). The function file contains the test functions. The data file contains the test cases, specified as parameters that will be passed to the test function.
+Mbed TLS includes a comprehensive set of test suites in the `tests/` directory that are dynamically generated to produce the actual test source files (e.g. `test_suite_rsa.c`). These files are generated from a `function file` (e.g. `suites/test_suite_rsa.function`) and a `data file` (e.g. `suites/test_suite_rsa.data`). The function file contains the test functions. The data file contains the test cases, specified as parameters that will be passed to the test function.
[A Knowledge Base article describing how to add additional tests is available on the Mbed TLS website](https://mbed-tls.readthedocs.io/en/latest/kb/development/test_suites/).