From 721f711333707f7278e6aa167bca991c3903c85b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20P=C3=A9gouri=C3=A9-Gonnard?= Date: Thu, 13 Aug 2015 15:52:35 +0200 Subject: [PATCH] Use development for repo links Avoids broken links while the targets are not yet in master --- README.rst | 2 +- yotta/data/README.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 2389fee86..08e25d27b 100644 --- a/README.rst +++ b/README.rst @@ -52,7 +52,7 @@ from the mbed TLS root directory. This will create the yotta module in the *yott In any case, you'll probably want to set the yotta target before building unless it's already set globally; for more information on using yotta, please consult the `yotta documentation `. -The yotta edition of mbed TLS includes a few example programs, some of which demonstrate integration with mbed OS; for more details, please consult the `Readme of mbed TLS, yotta edition `. +The yotta edition of mbed TLS includes a few example programs, some of which demonstrate integration with mbed OS; for more details, please consult the `Readme at the root of the yotta module `. Make ---- diff --git a/yotta/data/README.md b/yotta/data/README.md index 9e3618e55..6ef856261 100644 --- a/yotta/data/README.md +++ b/yotta/data/README.md @@ -8,23 +8,23 @@ The Beta release of mbed TLS is an integration of mbed TLS in mbed OS. It is a t This release includes the following examples: -1. [**TLS client:**](https://github.com/ARMmbed/mbedtls/tree/master/yotta/data/example-tls-client) downloads a file from an HTTPS server (mbed.org) and looks for a specific string in that file. +1. [**TLS client:**](https://github.com/ARMmbed/mbedtls/tree/development/yotta/data/example-tls-client) downloads a file from an HTTPS server (mbed.org) and looks for a specific string in that file. -2. [**Self test:**](https://github.com/ARMmbed/mbedtls/tree/master/yotta/data/example-selftest) tests different mbed TLS base functionalities. +2. [**Self test:**](https://github.com/ARMmbed/mbedtls/tree/development/yotta/data/example-selftest) tests different mbed TLS base functionalities. -3. [**Benchmark:**](https://github.com/ARMmbed/mbedtls/tree/master/yotta/data/example-benchmark) tests the time required to perform TLS base crypto functions. +3. [**Benchmark:**](https://github.com/ARMmbed/mbedtls/tree/development/yotta/data/example-benchmark) tests the time required to perform TLS base crypto functions. These examples are integrated as yotta tests so that they are build automatically when you build mbed TLS. You'll find other examples in the various `tests/example-*` directories. ## Running TLS -Please follow the instructions in the [TLS client sample](https://github.com/ARMmbed/mbedtls/tree/master/yotta/data/example-tls-client). These include a list of prerequisites and an explanation of building mbed TLS with yotta. +Please follow the instructions in the [TLS client sample](https://github.com/ARMmbed/mbedtls/tree/development/yotta/data/example-tls-client). These include a list of prerequisites and an explanation of building mbed TLS with yotta. ## Configuring mbed TLS features **Warning:** This is only a preview of a future feature that will require support from yotta; as of yotta 0.5.2 this is not supported yet. -mbed TLS makes it easy to disable during the compilation any feature that is not needed for a particular project. The default configuration enables all modern and widely-used features, which should meet the need of any new project; it disables all features that are either older or less mainstrem, in order to keep the footprint low. The list of available compile flags is available in the fully documented [config.h file](https://github.com/ARMmbed/mbedtls/blob/master/include/mbedtls/config.h), present in the `mbedtls` directory of the yotta module. +mbed TLS makes it easy to disable during the compilation any feature that is not needed for a particular project. The default configuration enables all modern and widely-used features, which should meet the need of any new project; it disables all features that are either older or less mainstrem, in order to keep the footprint low. The list of available compile flags is available in the fully documented [config.h file](https://github.com/ARMmbed/mbedtls/blob/development/include/mbedtls/config.h), present in the `mbedtls` directory of the yotta module. Should you need to adjust those flags, you can provide your own configuration file with the suitable `#define` and `#undef` statements, to be included between the default definitions and the sanity checks. This file should be in your application's include directory and can be named freely; you just need to let mbed TLS know the name of the file, by using yotta's [configuration system](http://docs.yottabuild.org/reference/config.html). This name should go in your `config.json`, under mbedtls, as the key `user-config-file`, for example: