Skip to content

Commit

Permalink
Fix use of Knowledge Base in documentation
Browse files Browse the repository at this point in the history
Made the use of 'Knowledge Base' consistent in the CONTRIBUTING.md and
README.md files.
  • Loading branch information
simonbutcher committed Jul 23, 2018
1 parent 5a5d03f commit 6965f77
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -68,7 +68,7 @@ As mentioned, tests that show the correctness of the feature or bug fix should b

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.

[A knowledgebase article describing how to add additional tests is available on the Mbed TLS website](https://tls.mbed.org/kb/development/test_suites).
[A Knowledge Base article describing how to add additional tests is available on the Mbed TLS website](https://tls.mbed.org/kb/development/test_suites).

A test script `tests/scripts/basic-build-test.sh` is available to show test
coverage of the library. New code contributions should provide a similar level
Expand Down
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -82,7 +82,7 @@ Please note that setting `CFLAGS` overrides its default value of `-O2` and setti

Depending on your platform, you might run into some issues. Please check the Makefiles in `library/`, `programs/` and `tests/` for options to manually add or remove for specific platforms. You can also check [the Mbed TLS Knowledge Base](https://tls.mbed.org/kb) for articles on your platform or issue.

In case you find that you need to do something else as well, please let us know what, so we can add it to the [Mbed TLS knowledge base](https://tls.mbed.org/kb).
In case you find that you need to do something else as well, please let us know what, so we can add it to the [Mbed TLS Knowledge Base](https://tls.mbed.org/kb).

### CMake

Expand Down Expand Up @@ -192,7 +192,7 @@ We provide some non-standard configurations focused on specific use cases in the
Porting Mbed TLS
----------------

Mbed TLS can be ported to many different architectures, OS's and platforms. Before starting a port, you may find the following knowledge base articles useful:
Mbed TLS can be ported to many different architectures, OS's and platforms. Before starting a port, you may find the following Knowledge Base articles useful:

- [Porting Mbed TLS to a new environment or OS](https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS)
- [What external dependencies does Mbed TLS rely on?](https://tls.mbed.org/kb/development/what-external-dependencies-does-mbedtls-rely-on)
Expand Down

0 comments on commit 6965f77

Please sign in to comment.