diff --git a/.github/.cSpellWords.txt b/.github/.cSpellWords.txt new file mode 100644 index 000000000..ed49f7cd6 --- /dev/null +++ b/.github/.cSpellWords.txt @@ -0,0 +1,46 @@ +CBMC +CBOR +CMOCK +CMock +Cmock +Coverity +DCMOCK +DNDEBUG +DUNITY +FOOB +FOOBA +FOOBDA +MISRA +MQTT +Misra +OPTIMISED +Wunused +cbmc +cbor +cborvalue +cmock +coverity +ctest +deinitializing +isystem +lcov +lpthread +misra +mqdes +mqttstatus +mqueue +osstatus +otahttppage +otahttpsectionoverview +otamqttpage +otamqttsectionoverview +otaosfipage +otaosfisectionoverview +otapalpage +otapalsectionoverview +pbuffer +pclienttoken +sinclude +stringz +tinycbor +utest diff --git a/.github/.exclude-urls.txt b/.github/.exclude-urls.txt new file mode 100644 index 000000000..bce081fbd --- /dev/null +++ b/.github/.exclude-urls.txt @@ -0,0 +1,2 @@ +https://dummy-url.com/ota.bin + diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5d87bda4e..125add3a2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -15,7 +15,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Clone This Repo - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Check warnings run: | git submodule update --init --recursive --checkout --depth 1 @@ -26,20 +26,20 @@ jobs: complexity: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup run: sudo apt-get install complexity - name: Complexity uses: FreeRTOS/CI-CD-Github-Actions/complexity@main with: path: ./ - horrid_threshold: 10 + horrid_threshold: 14 unittest: runs-on: ubuntu-latest steps: - name: Clone This Repo - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Build run: | git submodule update --init --recursive --checkout --depth 1 @@ -55,7 +55,8 @@ jobs: runs-on: ubuntu-latest steps: - name: Clone This Repo - uses: actions/checkout@v2 + uses: actions/checkout@v3 + - name: Generate Build Files run: | git submodule update --init --recursive --checkout --depth 1 @@ -63,20 +64,22 @@ jobs: cmake -S test -B build \ -DCMAKE_BUILD_TYPE=Debug \ -DCMAKE_C_FLAGS='--coverage -Wall -Wextra -DNDEBUG' + - name: Run Coverage run: | cmake --build build/ --target coverage + - name: Check Coverage uses: FreeRTOS/CI-CD-Github-Actions/coverage-cop@main with: - path: ./build/coverage.info + coverage-file: ./build/coverage.info line-coverage-min: 100 branch-coverage-min: 100 doxygen: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Run doxygen build uses: FreeRTOS/CI-CD-Github-Actions/doxygen@main with: @@ -85,31 +88,17 @@ jobs: spell-check: runs-on: ubuntu-latest steps: - - name: Checkout Parent Repo - uses: actions/checkout@v2 - with: - ref: main - repository: aws/aws-iot-device-sdk-embedded-C - name: Clone This Repo - uses: actions/checkout@v2 + uses: actions/checkout@v3 + - name: Run spellings check + uses: FreeRTOS/CI-CD-Github-Actions/spellings@main with: - path: tmp - - name: Install spell - run: | - sudo apt-get install spell - sudo apt-get install util-linux - - name: Check spelling - run: | - PATH=$PATH:$PWD/tools/spell - find-unknown-comment-words --directory tmp/ --lexicon tmp/tools/lexicon.txt - if [ $? -ne "0" ]; then - exit 1 - fi + path: ./ formatting: runs-on: ubuntu-20.04 steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Check formatting uses: FreeRTOS/CI-CD-Github-Actions/formatting@main with: @@ -119,11 +108,11 @@ jobs: git-secrets: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: submodules: recursive - name: Checkout awslabs/git-secrets - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: repository: awslabs/git-secrets ref: master @@ -138,19 +127,54 @@ jobs: memory_statistics: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Clone submodules run: git submodule update --init --recursive --checkout --depth 1 - name: Install Python3 - uses: actions/setup-python@v2 + uses: actions/setup-python@v3 with: - python-version: '3.11.0' + python-version: "3.11.0" - name: Measure sizes uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main with: - config: .github/memory_statistics_config.json - check_against: docs/doxygen/include/size_table.md + config: .github/memory_statistics_config.json + check_against: docs/doxygen/include/size_table.md + + link-verifier: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Check Links + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + uses: FreeRTOS/CI-CD-Github-Actions/link-verifier@main + with: + path: ./ + allowlist-file: .github/.exclude-urls.txt + + verify-manifest: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + submodules: true + fetch-depth: 0 + + # At time of writing the gitmodules are set not to pull + # Even when using fetch submodules. Need to run this command + # To force it to grab them. + - name: Perform Recursive Clone + shell: bash + run: git submodule update --checkout --init --recursive + + - name: Run manifest verifier + uses: FreeRTOS/CI-CD-GitHub-Actions/manifest-verifier@main + with: + path: ./ + fail-on-incorrect-version: true + proof_ci: + if: ${{ github.event.pull_request }} runs-on: cbmc_ubuntu-latest_16-core steps: - name: Set up CBMC runner diff --git a/.github/workflows/formatting.yml b/.github/workflows/formatting.yml new file mode 100644 index 000000000..8257addac --- /dev/null +++ b/.github/workflows/formatting.yml @@ -0,0 +1,23 @@ +name: Format Pull Request Files + +on: + issue_comment: + types: [created] + +env: + bashPass: \033[32;1mPASSED - + bashInfo: \033[33;1mINFO - + bashFail: \033[31;1mFAILED - + bashEnd: \033[0m + +jobs: + Formatting: + name: Run Formatting Check + if: ${{ github.event.issue.pull_request }} && + ( ( github.event.comment.body == '/bot run uncrustify' ) || + ( github.event.comment.body == '/bot run formatting' ) ) + runs-on: ubuntu-20.04 + steps: + - name: Apply Formatting Fix + uses: FreeRTOS/CI-CD-Github-Actions/formatting-bot@main + id: check-formatting diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f40764161..6fb6b15ce 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -16,7 +16,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout code - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: ref: ${{ github.event.inputs.commit_id }} - name: Configure git identity @@ -53,7 +53,7 @@ jobs: - name: Install ZIP tools run: sudo apt-get install zip unzip - name: Checkout code - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: ref: ${{ github.event.inputs.commit_id }} path: ota-for-aws-iot-embedded-sdk diff --git a/MISRA.md b/MISRA.md index 9331845d3..a18ed368e 100644 --- a/MISRA.md +++ b/MISRA.md @@ -24,7 +24,7 @@ _Ref 8.13.1_ - MISRA C-2012 Rule 8.13 There are multiple functions that all use the same function header so that they can be assigned to function pointers in a seamless manner. There are a few that modify the OtaAgentContext_t that gets passed in. In order to allow convienent assignment of these function pointers - we supress this rule on this function that can't have const added. + we suppress this rule on this function that can't have const added. #### Rule 10.1 _Ref 10.1.1_ @@ -44,7 +44,7 @@ _Ref 10.8.1_ _Ref 11.8.1_ - Misra C-2012 Rule 11.8 will raise an error if certain variables are not marked as const, even if the variables do get - modified in that function. As such there are two occurences where to get around that error, we supress these. + modified in that function. As such there are two occurrences where to get around that error, we suppress these. #### Rule 19.2 _Ref 19.2.1_ diff --git a/README.md b/README.md index 245285d33..726bfaec3 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,99 @@ # AWS IoT Over-the-air Update Library -The OTA library enables you to manage the notification of a newly available update, download the update, and perform cryptographic verification of the firmware update. Using the library, you can logically separate firmware updates from the application running on your devices. The OTA library can share a network connection with the application, saving memory in resource-constrained devices. In addition, the OTA library lets you define application-specific logic for testing, committing, or rolling back a firmware update. The library supports different application protocols like Message Queuing Telemetry Transport (MQTT) and Hypertext Transfer Protocol (HTTP), and provides various configuration options you can fine tune depending on network type and conditions. This library is distributed under the [MIT Open Source License](LICENSE). - -This library has gone through code quality checks including verification that no function has a [GNU Complexity](https://www.gnu.org/software/complexity/manual/complexity.html) score over 10. This library has also undergone static code analysis from [Coverity static analysis](https://scan.coverity.com/). - -See memory requirements for this library [here](./docs/doxygen/include/size_table.md). - -**AWS IoT Over-the-air Update Library v3.4.0 [source code](https://github.com/aws/ota-for-aws-iot-embedded-sdk/tree/v3.4.0/source) is part of the [FreeRTOS 202210.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS) release.** - -**AWS IoT Over-the-air Update Library v3.3.0 [source code](https://github.com/aws/ota-for-aws-iot-embedded-sdk/tree/v3.3.0/source) is part of the [FreeRTOS 202012.01 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.01-LTS) release.** +**[API Documentation Pages for current and previous releases of this library can be found here](https://aws.github.io/ota-for-aws-iot-embedded-sdk/)** + +The OTA library enables you to manage the notification of a newly available +update, download the update, and perform cryptographic verification of the +firmware update. Using the library, you can logically separate firmware updates +from the application running on your devices. The OTA library can share a +network connection with the application, saving memory in resource-constrained +devices. In addition, the OTA library lets you define application-specific logic +for testing, committing, or rolling back a firmware update. The library supports +different application protocols like Message Queuing Telemetry Transport (MQTT) +and Hypertext Transfer Protocol (HTTP), and provides various configuration +options you can fine tune depending on network type and conditions. This library +is distributed under the [MIT Open Source License](LICENSE). + +This library has gone through code quality checks including verification that no +function has a +[GNU Complexity](https://www.gnu.org/software/complexity/manual/complexity.html) +score over 10. This library has also undergone static code analysis from +[Coverity static analysis](https://scan.coverity.com/). + +See memory requirements for this library +[here](./docs/doxygen/include/size_table.md). + +**AWS IoT Over-the-air Update Library v3.4.0 +[source code](https://github.com/aws/ota-for-aws-iot-embedded-sdk/tree/v3.4.0/source) +is part of the +[FreeRTOS 202210.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS) +release.** + +**AWS IoT Over-the-air Update Library v3.3.0 +[source code](https://github.com/aws/ota-for-aws-iot-embedded-sdk/tree/v3.3.0/source) +is part of the +[FreeRTOS 202012.01 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.01-LTS) +release.** ## AWS IoT Over-the-air Updates Config File -The AWS IoT Over-the-air Updates library exposes configuration macros that are required for building the library. A list of all the configurations and their default values are defined in [ota_config_defaults.h](source/include/ota_config_defaults.h). To provide custom values for the configuration macros, a custom config file named `ota_config.h` can be provided by the user application to the library. +The AWS IoT Over-the-air Updates library exposes configuration macros that are +required for building the library. A list of all the configurations and their +default values are defined in +[ota_config_defaults.h](source/include/ota_config_defaults.h). To provide custom +values for the configuration macros, a custom config file named `ota_config.h` +can be provided by the user application to the library. -By default, a `ota_config.h` custom config is required to build the library. To disable this requirement and build the library with default configuration values, provide `OTA_DO_NOT_USE_CUSTOM_CONFIG` as a compile time preprocessor macro. +By default, a `ota_config.h` custom config is required to build the library. To +disable this requirement and build the library with default configuration +values, provide `OTA_DO_NOT_USE_CUSTOM_CONFIG` as a compile time preprocessor +macro. ## Building the Library -The [otaFilePaths.cmake](otaFilePaths.cmake) file contains the information of all source files and the header include paths required to build the AWS IoT Over-the-air Updates library. -As mentioned in the previous section, either a custom config file (i.e. `ota_config.h`) OR the `OTA_DO_NOT_USE_CUSTOM_CONFIG` macro needs to be provided to build the AWS IoT Over-the-air Updates library. +The [otaFilePaths.cmake](otaFilePaths.cmake) file contains the information of +all source files and the header include paths required to build the AWS IoT +Over-the-air Updates library. + +As mentioned in the previous section, either a custom config file (i.e. +`ota_config.h`) OR the `OTA_DO_NOT_USE_CUSTOM_CONFIG` macro needs to be provided +to build the AWS IoT Over-the-air Updates library. -For a CMake example of building the AWS IoT Over-the-air Updates library with the `otaFilePaths.cmake` file, refer to the `coverity_analysis` library target in the [test/CMakeLists.txt](test/CMakeLists.txt) file. +For a CMake example of building the AWS IoT Over-the-air Updates library with +the `otaFilePaths.cmake` file, refer to the `coverity_analysis` library target +in the [test/CMakeLists.txt](test/CMakeLists.txt) file. ## Building Unit Tests + ### Checkout CMock Submodule -By default, the submodules in this repository are configured with `update=none` in [.gitmodules](.gitmodules) to avoid increasing clone time and disk space usage of other repositories (like [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C) that submodules this repository). -To build unit tests, the submodule dependency of CMock is required. Use the following command to clone the submodule: +By default, the submodules in this repository are configured with `update=none` +in [.gitmodules](.gitmodules) to avoid increasing clone time and disk space +usage of other repositories (like +[AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C) +that submodules this repository). + +To build unit tests, the submodule dependency of CMock is required. Use the +following command to clone the submodule: + ``` -git submodule update --checkout --init --recursive test/unit-test/CMock +git submodule update --checkout --init --recursive test/unit-test/CMock source/dependency/coreJSON ``` ### Platform Prerequisites - For building the library, **CMake 3.13.0** or later and a **C90 compiler**. -- For running unit tests, **Ruby 2.0.0** or later is additionally required for the CMock test framework (that we use). -- For running the coverage target, **gcov** and **lcov** are additionally required. +- For running unit tests, **Ruby 2.0.0** or later is additionally required for + the CMock test framework (that we use). +- For running the coverage target, **gcov** and **lcov** are additionally + required. ### Steps to build unit tests -1. Go to the root directory of this repository. (Make sure that the **CMock** submodule is cloned as described [above](#checkout-cmock-submodule).) +1. Go to the root directory of this repository. (Make sure that the **CMock** + submodule is cloned as described [above](#checkout-cmock-submodule).) -1. Run the *cmake* command: `cmake -S test -B build` +1. Run the _cmake_ command: `cmake -S test -B build` 1. Run this command to build the library and unit tests: `make -C build all` @@ -54,83 +105,110 @@ git submodule update --checkout --init --recursive test/unit-test/CMock ### How to migrate from v2.0.0 (Release Candidate) to v3.4.0 -The following table lists equivalent API function signatures in v2.0.0 (Release Candidate) and v3.4.0 declared in [ota.h](source/include/ota.h) +The following table lists equivalent API function signatures in v2.0.0 (Release +Candidate) and v3.4.0 declared in [ota.h](source/include/ota.h) -| v2.0.0 (Release Candidate) | v3.4.0 | Notes | -| :-: | :-: | :-: | +| v2.0.0 (Release Candidate) | v3.4.0 | Notes | +| :------------------------------------------------: | :-------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------: | | `OtaState_t OTA_Shutdown( uint32_t ticksToWait );` | `OtaState_t OTA_Shutdown( uint32_t ticksToWait, uint8_t unsubscribeFlag );` | `unsubscribeFlag` indicates if unsubscribe operations should be performed from the job topics when shutdown is called. Set this as 1 to unsubscribe, 0 otherwise. | ### How to migrate from version 1.0.0 to version 3.4.0 for OTA applications -Refer to [OTA Migration document](https://docs.aws.amazon.com/freertos/latest/portingguide/porting-migration-ota.html) for the summary of updates to the API. -[Migration document for OTA PAL](https://docs.aws.amazon.com/freertos/latest/portingguide/porting-migration-ota-pal.html) also provides a summary of updates required for upgrading the OTA-PAL to work with v3.4.0 of the library. +Refer to +[OTA Migration document](https://docs.aws.amazon.com/freertos/latest/portingguide/porting-migration-ota.html) +for the summary of updates to the API. +[Migration document for OTA PAL](https://docs.aws.amazon.com/freertos/latest/portingguide/porting-migration-ota-pal.html) +also provides a summary of updates required for upgrading the OTA-PAL to work +with v3.4.0 of the library. ## Porting -In order to support AWS IoT Over-the-air Updates on your device, it is necessary to provide the following components: +In order to support AWS IoT Over-the-air Updates on your device, it is necessary +to provide the following components: + 1. [Port for the OTA Portable Abstraction Layer (PAL).](https://docs.aws.amazon.com/embedded-csdk/202103.00/lib-ref/libraries/aws/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/ota_porting.html#ota_porting_pal) 1. [OS Interface](https://docs.aws.amazon.com/embedded-csdk/202103.00/lib-ref/libraries/aws/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/ota_porting.html#ota_porting_os) 1. [MQTT Interface](https://docs.aws.amazon.com/embedded-csdk/202103.00/lib-ref/libraries/aws/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/ota_porting.html#ota_porting_mqtt) -For enabling data transfer over HTTP dataplane the following component should also be provided: +For enabling data transfer over HTTP dataplane the following component should +also be provided: 1. [HTTP Interface](https://docs.aws.amazon.com/embedded-csdk/202103.00/lib-ref/libraries/aws/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/ota_porting.html#ota_porting_http) -**NOTE** When using OTA over HTTP dataplane, MQTT is required for control plane operations and should also be provided. +**NOTE** When using OTA over HTTP dataplane, MQTT is required for control plane +operations and should also be provided. ## CBMC -To learn more about CBMC and proofs specifically, review the training material [here](https://model-checking.github.io/cbmc-training). +To learn more about CBMC and proofs specifically, review the training material +[here](https://model-checking.github.io/cbmc-training). The `test/cbmc/proofs` directory contains CBMC proofs. -In order to run these proofs you will need to install CBMC and other tools by following the instructions [here](https://model-checking.github.io/cbmc-training/installation.html). +In order to run these proofs you will need to install CBMC and other tools by +following the instructions +[here](https://model-checking.github.io/cbmc-training/installation.html). ### CBMC Locally -To run a single CBMC proof locally, you can build the Makefile in any of the CBMC proofs. The Makefile is located in the `test/cbmc/proof//` directory. -Running `make` will produce a HTML-based report nearly identical to the one produced by the CI step. +To run a single CBMC proof locally, you can build the Makefile in any of the +CBMC proofs. The Makefile is located in the +`test/cbmc/proof//` directory. + +Running `make` will produce a HTML-based report nearly identical to the one +produced by the CI step. **A couple notes about CBMC Proofs** -* macOS doesn't implement POSIX message queues (`mqueue.h`); -* It is possible that macOS fails to recognize your loop unwinding identifiers for function from the C standard libraries. For this case, you'll want to use the `__builtin____chk` identifier, e.g., instead of using `memcpy` add `__builtin___memcpy_chk`. - * For example, the **requestJob_Mqtt** proof fails on macOS with the following error: + +- macOS doesn't implement POSIX message queues (`mqueue.h`); +- It is possible that macOS fails to recognize your loop unwinding identifiers + for function from the C standard libraries. For this case, you'll want to use + the `__builtin____chk` identifier, e.g., instead of using `memcpy` + add `__builtin___memcpy_chk`. + - For example, the **requestJob_Mqtt** proof fails on macOS with the following + error: ``` Loop unwinding failures [trace] __builtin___strncpy_chk.unwind.0 in line 36 in file ``` -To solve this issue, replace `strncpy` with `__builtin___strncpy_ch` on [this line](https://github.com/aws/ota-for-aws-iot-embedded-sdk/blob/main/test/cbmc/proofs/requestJob_Mqtt/Makefile#L16). +To solve this issue, replace `strncpy` with `__builtin___strncpy_ch` on +[this line](https://github.com/aws/ota-for-aws-iot-embedded-sdk/blob/main/test/cbmc/proofs/requestJob_Mqtt/Makefile#L16). ## Reference examples -Please refer to the demos of the AWS IoT Over-the-air Updates library in the following location for reference examples on POSIX and FreeRTOS: +Please refer to the demos of the AWS IoT Over-the-air Updates library in the +following location for reference examples on POSIX and FreeRTOS: -| Platform | Location | -| :-: | :-: | -| POSIX | [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/ota) | -| FreeRTOS | [FreeRTOS/FreeRTOS](https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS-Plus/Demo/AWS/Ota_Windows_Simulator) | -| FreeRTOS | [FreeRTOS AWS Reference Integrations](https://github.com/aws/amazon-freertos/tree/main/demos/ota) | +| Platform | Location | +| :------: | :--------------------------------------------------------------------------------------------------------------: | +| POSIX | [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/ota) | +| FreeRTOS | [FreeRTOS/FreeRTOS](https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS-Plus/Demo/AWS/Ota_Windows_Simulator) | +| FreeRTOS | [FreeRTOS AWS Reference Integrations](https://github.com/aws/amazon-freertos/tree/main/demos/ota) | ## Documentation ### Existing Documentation -For pre-generated documentation, please see the documentation linked in the locations below: +For pre-generated documentation, please see the documentation linked in the +locations below: -| Location | -| :-: | -| [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) | +| Location | +| :-------------------------------------------------------------------------------------------------------------------------: | +| [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) | | [FreeRTOS.org](https://freertos.org/Documentation/api-ref/ota-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html) | -Note that the latest included version of coreMQTT may differ across repositories. +Note that the latest included version of coreMQTT may differ across +repositories. + ### Generating documentation The Doxygen references were created using Doxygen version 1.9.2. To generate the -Doxygen pages, please run the following command from the root of this repository: +Doxygen pages, please run the following command from the root of this +repository: ```shell doxygen docs/doxygen/config.doxyfile @@ -138,4 +216,5 @@ doxygen docs/doxygen/config.doxyfile ## Contributing -See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for information on contributing. +See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for information on +contributing. diff --git a/cspell.config.yaml b/cspell.config.yaml new file mode 100644 index 000000000..911ce1d8f --- /dev/null +++ b/cspell.config.yaml @@ -0,0 +1,31 @@ +--- +$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json +version: '0.2' +# Allows things like stringLength +allowCompoundWords: true + +# Read files not to spell check from the git ignore +useGitignore: true + +# Language settings for C +languageSettings: + - caseSensitive: false + enabled: true + languageId: c + locale: "*" + +# Add a dictionary, and the path to the word list +dictionaryDefinitions: + - name: freertos-words + path: '.github/.cSpellWords.txt' + addWords: true + +dictionaries: + - freertos-words + +# Paths and files to ignore +ignorePaths: + - 'dependency' + - 'docs' + - 'ThirdParty' + - 'History.txt' diff --git a/docs/doxygen/pages.dox b/docs/doxygen/pages.dox index 9836a8a13..c930badbf 100644 --- a/docs/doxygen/pages.dox +++ b/docs/doxygen/pages.dox @@ -17,8 +17,8 @@ The major functions that this library’s APIs provide are – AWS services can be used with this library to manage various cloud related topics such as sending firmware updates, monitoring large numbers of devices across multiple regions, reducing the blast radius of faulty deployments, and verifying the security of updates. -> **NOTE**: **Handling OTA and custom jobs in your application** -> If your application will process both OTA and custom types of jobs from AWS IoT, we recommend using the feature support for custom jobs in OTA library through the #OtaJobEventParseCustomJob event notification in the registered #OtaAppCallback_t callback. +> **NOTE**: **Handling OTA and custom jobs in your application** +> If your application will process both OTA and custom types of jobs from AWS IoT, we recommend using the feature support for custom jobs in OTA library through the #OtaJobEventParseCustomJob event notification in the registered #OtaAppCallback_t callback. > However, if your application chooses to use the [AWS IoT Jobs library](https://github.com/aws/Jobs-for-AWS-IoT-embedded-sdk) (for handling custom jobs) and the OTA library (for handling OTA jobs) to communicate with AWS IoT through a shared MQTT connection, we suggest that you keep the application logic that uses these libraries within a single task/thread. > As the OTA agent also makes calls to the AWS IoT Jobs service, keeping the use of libraries within the same thread context will avoid complexity of synchronizing communication with AWS IoT Jobs topics between multiple tasks/threads. > However, if you choose to use different tasks/threads for calling these libraries, please be aware that the OTA library will subscribe and configurably, unsubscribe from AWS IoT Jobs topics, and also attempt to send status updates for incoming non-OTA jobs, if your application configures the OTA library to handle custom jobs. diff --git a/manifest.yml b/manifest.yml index 4d2224bf9..9d535caad 100644 --- a/manifest.yml +++ b/manifest.yml @@ -1,17 +1,39 @@ -name : "ota-for-aws-iot-embedded-sdk" +name: "ota-for-aws-iot-embedded-sdk" version: "v3.4.0" -description: "Client library for using the AWS Over-the-air Update service on embedded devices." +description: + "Client library for using the AWS Over-the-air Update service on embedded + devices." license: "MIT" + dependencies: - - name : "coreJSON" + - name: "coreJSON" version: "v3.2.0" license: "MIT" repository: type: "git" url: "https://github.com/FreeRTOS/coreJSON.git" - - name : "tinycbor" + path: source/dependency/coreJSON + + - name: "tinycbor" version: "v0.5.4" license: "MIT" repository: type: "git" url: "https://github.com/intel/tinycbor.git" + path: source/dependency/3rdparty/tinycbor + + - name: "CMock" + version: "v2.5.2" + license: "MIT" + repository: + type: "git" + url: "https://github.com/ThrowTheSwitch/CMock.git" + path: test/unit-test/CMock + + - name: "FreeRTOS-Kernel" + version: "V10.4.5" + license: "MIT" + repository: + type: "git" + path: test/cbmc/FreeRTOS-Kernel + url: "https://github.com/FreeRTOS/FreeRTOS-Kernel.git" diff --git a/otaDependenyFilePaths.cmake b/otaDependencyFilePaths.cmake similarity index 100% rename from otaDependenyFilePaths.cmake rename to otaDependencyFilePaths.cmake diff --git a/source/include/ota.h b/source/include/ota.h index 9e026222c..a60286bf1 100644 --- a/source/include/ota.h +++ b/source/include/ota.h @@ -278,7 +278,7 @@ typedef struct OtaJobDocument * OtaJobEventActivate|OtaJobDocument_t|status and reason * OtaJobEventFail|OtaJobDocument_t|status, reason and subReason * OtaJobEventStartTest|NULL|nothing - * OtaJobEventProcessed|OtaEventData_t|data buffer inputed from user by OTA_SignalEvent + * OtaJobEventProcessed|OtaEventData_t|data buffer inputted from user by OTA_SignalEvent * OtaJobEventSelfTestFailed|NULL|nothing * OtaJobEventParseCustomJob|OtaJobDocument_t|pJobId, jobIdLength, pJobDocJson, and jobDocLength * OtaJobEventReceivedJob|OtaJobDocument_t|pJobId, jobIdLength, pJobDocJson, jobDocLength, and fileTypeId diff --git a/source/include/ota_private.h b/source/include/ota_private.h index 5640238b2..6c6fcc27a 100644 --- a/source/include/ota_private.h +++ b/source/include/ota_private.h @@ -190,24 +190,24 @@ typedef enum */ typedef enum { - DocParseErrUnknown = -1, /*!< The error code has not yet been set by a logic path. */ - DocParseErrNone = 0, /*!< No error in parsing the document. */ - DocParseErrOutOfMemory, /*!< We failed to allocate enough dynamic memory for a field. */ - DocParseErrUserBufferInsuffcient, /*!< The supplied user buffer is insufficient for a field. */ - DocParseErrFieldTypeMismatch, /*!< The field type parsed does not match the document model. */ - DocParseErrBase64Decode, /*!< There was an error decoding the base64 data. */ - DocParseErrInvalidNumChar, /*!< There was an invalid character in a numeric value field. */ - DocParseErrDuplicatesNotAllowed, /*!< A duplicate parameter was found in the job document. */ - DocParseErrMalformedDoc, /*!< The document didn't fulfill the model requirements. */ - DocParseErr_InvalidJSONBuffer, /*!< When the JSON is malformed and not parsed correctly. */ - DocParseErrNullModelPointer, /*!< The pointer to the document model was NULL. */ - DocParseErrNullBodyPointer, /*!< The document model's internal body pointer was NULL. */ - DocParseErrNullDocPointer, /*!< The pointer to the JSON document was NULL. */ - DocParseErrTooManyParams, /*!< The document model has more parameters than we can handle. */ - DocParseErrParamKeyNotInModel, /*!< The document model does not include the specified parameter key. */ - DocParseErrInvalidModelParamType, /*!< The document model specified an invalid parameter type. */ - DocParseErrInvalidToken, /*!< The Jasmine token was invalid, producing a NULL pointer. */ - DocParseErrEmptyJobDoc /*!< The document is valid but does not contain all necessary fields. */ + DocParseErrUnknown = -1, /*!< The error code has not yet been set by a logic path. */ + DocParseErrNone = 0, /*!< No error in parsing the document. */ + DocParseErrOutOfMemory, /*!< We failed to allocate enough dynamic memory for a field. */ + DocParseErrUserBufferInsufficient, /*!< The supplied user buffer is insufficient for a field. */ + DocParseErrFieldTypeMismatch, /*!< The field type parsed does not match the document model. */ + DocParseErrBase64Decode, /*!< There was an error decoding the base64 data. */ + DocParseErrInvalidNumChar, /*!< There was an invalid character in a numeric value field. */ + DocParseErrDuplicatesNotAllowed, /*!< A duplicate parameter was found in the job document. */ + DocParseErrMalformedDoc, /*!< The document didn't fulfill the model requirements. */ + DocParseErr_InvalidJSONBuffer, /*!< When the JSON is malformed and not parsed correctly. */ + DocParseErrNullModelPointer, /*!< The pointer to the document model was NULL. */ + DocParseErrNullBodyPointer, /*!< The document model's internal body pointer was NULL. */ + DocParseErrNullDocPointer, /*!< The pointer to the JSON document was NULL. */ + DocParseErrTooManyParams, /*!< The document model has more parameters than we can handle. */ + DocParseErrParamKeyNotInModel, /*!< The document model does not include the specified parameter key. */ + DocParseErrInvalidModelParamType, /*!< The document model specified an invalid parameter type. */ + DocParseErrInvalidToken, /*!< The Jasmine token was invalid, producing a NULL pointer. */ + DocParseErrEmptyJobDoc /*!< The document is valid but does not contain all necessary fields. */ } DocParseErr_t; /** diff --git a/source/ota.c b/source/ota.c index 465e27e46..e76a6f999 100644 --- a/source/ota.c +++ b/source/ota.c @@ -1675,7 +1675,7 @@ static DocParseErr_t extractAndStoreArray( const char * pKey, { if( *pParamSizeAdd < ( valueLength + 1U ) ) { - err = DocParseErrUserBufferInsuffcient; + err = DocParseErrUserBufferInsufficient; LogError( ( "Insufficient user memory: " "[key: valueLength]=[%s: %lu]", @@ -2175,13 +2175,35 @@ static void handleSelfTestJobDoc( const OtaFileContext_t * pFileContext ) LogInfo( ( "In self test mode." ) ); #if ( otaconfigAllowDowngrade == 1U ) + { + LogWarn( ( "OTA Config Allow Downgrade has been set to 1, bypassing version check: Begin testing file: File ID=%d", + ( int ) otaAgent.serverFileID ) ); + + /* Downgrade is allowed so this means we're ready to start self test phase. + * Set image state accordingly and update job status with self test identifier. + */ + otaErr = setImageStateWithReason( OtaImageStateTesting, ( uint32_t ) errVersionCheck ); + + if( otaErr != OtaErrNone ) + { + LogError( ( "Failed to set image state to testing: OtaErr_t=%s", OTA_Err_strerror( otaErr ) ) ); + } + } + #else /* if ( otaconfigAllowDowngrade == 1U ) */ + { + /* Validate version of the update received.*/ + errVersionCheck = validateUpdateVersion( pFileContext ); + + if( errVersionCheck == OtaErrNone ) { - LogWarn( ( "OTA Config Allow Downgrade has been set to 1, bypassing version check: Begin testing file: File ID=%d", + LogInfo( ( "Image version is valid: Begin testing file: File ID=%d", ( int ) otaAgent.serverFileID ) ); - /* Downgrade is allowed so this means we're ready to start self test phase. + /* The running firmware version is newer than the firmware that performed + * the update so this means we're ready to start the self test phase. * Set image state accordingly and update job status with self test identifier. */ + otaErr = setImageStateWithReason( OtaImageStateTesting, ( uint32_t ) errVersionCheck ); if( otaErr != OtaErrNone ) @@ -2189,48 +2211,26 @@ static void handleSelfTestJobDoc( const OtaFileContext_t * pFileContext ) LogError( ( "Failed to set image state to testing: OtaErr_t=%s", OTA_Err_strerror( otaErr ) ) ); } } - #else /* if ( otaconfigAllowDowngrade == 1U ) */ + else { - /* Validate version of the update received.*/ - errVersionCheck = validateUpdateVersion( pFileContext ); - - if( errVersionCheck == OtaErrNone ) - { - LogInfo( ( "Image version is valid: Begin testing file: File ID=%d", - ( int ) otaAgent.serverFileID ) ); + LogWarn( ( "New image is being rejected: Application version of the new image is invalid: " + "OtaErr_t=%s", OTA_Err_strerror( errVersionCheck ) ) ); - /* The running firmware version is newer than the firmware that performed - * the update so this means we're ready to start the self test phase. - * Set image state accordingly and update job status with self test identifier. - */ + otaErr = setImageStateWithReason( OtaImageStateRejected, ( uint32_t ) errVersionCheck ); - otaErr = setImageStateWithReason( OtaImageStateTesting, ( uint32_t ) errVersionCheck ); - - if( otaErr != OtaErrNone ) - { - LogError( ( "Failed to set image state to testing: OtaErr_t=%s", OTA_Err_strerror( otaErr ) ) ); - } - } - else + if( otaErr != OtaErrNone ) { - LogWarn( ( "New image is being rejected: Application version of the new image is invalid: " - "OtaErr_t=%s", OTA_Err_strerror( errVersionCheck ) ) ); - - otaErr = setImageStateWithReason( OtaImageStateRejected, ( uint32_t ) errVersionCheck ); - - if( otaErr != OtaErrNone ) - { - LogError( ( "Failed to set image state to rejected: OtaErr_t=%s", OTA_Err_strerror( otaErr ) ) ); - } + LogError( ( "Failed to set image state to rejected: OtaErr_t=%s", OTA_Err_strerror( otaErr ) ) ); + } - /* Application callback for self-test failure.*/ - callOtaCallback( OtaJobEventSelfTestFailed, NULL ); + /* Application callback for self-test failure.*/ + callOtaCallback( OtaJobEventSelfTestFailed, NULL ); - /* Handle self-test failure in the platform specific implementation, - * example, reset the device in case of firmware upgrade. */ - ( void ) otaAgent.pOtaInterface->pal.reset( &( otaAgent.fileContext ) ); - } + /* Handle self-test failure in the platform specific implementation, + * example, reset the device in case of firmware upgrade. */ + ( void ) otaAgent.pOtaInterface->pal.reset( &( otaAgent.fileContext ) ); } + } #endif /* if ( otaconfigAllowDowngrade == 1U ) */ } @@ -2998,7 +2998,7 @@ static void executeHandler( uint32_t index, } else if( err == OtaErrEmptyJobDocument ) { - LogInfo( ( "Empty job docuemnt found for event=[%s]", pOtaEventStrings[ pEventMsg->eventId ] ) ); + LogInfo( ( "Empty job document found for event=[%s]", pOtaEventStrings[ pEventMsg->eventId ] ) ); } else { diff --git a/source/ota_base64.c b/source/ota_base64.c index b5e38bef1..154ba9591 100644 --- a/source/ota_base64.c +++ b/source/ota_base64.c @@ -119,7 +119,7 @@ * This table assumes that the padding symbol is the Ascii character '=' * * Valid Base64 symbols will have an index ranging from 0-63. The Base64 digits being used - * are "ABCDEFGHIJKLMNOPQRSTUVWXYabcdefghijklmnopqrstuvwxyz0123456789+/" where 'A' is the + * are "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/" where 'A' is the * 0th index of the Base64 symbols and '/' is the 63rd index. * * Outside of the numbers 0-63, there are magic numbers in this table: diff --git a/source/ota_http.c b/source/ota_http.c index 75f929003..1f169bbd8 100644 --- a/source/ota_http.c +++ b/source/ota_http.c @@ -66,7 +66,7 @@ OtaErr_t initFileTransfer_Http( const OtaAgentContext_t * pAgentCtx ) if( httpStatus != OtaHttpSuccess ) { - LogError( ( "Error occured while initializing http:" + LogError( ( "Error occurred while initializing http:" "OtaHttpStatus_t=%s" , OTA_HTTP_strerror( httpStatus ) ) ); } @@ -112,7 +112,7 @@ OtaErr_t requestDataBlock_Http( OtaAgentContext_t * pAgentCtx ) if( httpStatus != OtaHttpSuccess ) { - LogError( ( "Error occured while requesting data block:" + LogError( ( "Error occurred while requesting data block:" "OtaHttpStatus_t=%s" , OTA_HTTP_strerror( httpStatus ) ) ); } diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt index d584c0d37..d999d3ae4 100644 --- a/test/CMakeLists.txt +++ b/test/CMakeLists.txt @@ -37,7 +37,7 @@ set( CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib ) # Include filepaths for source and include. include( ${MODULE_ROOT_DIR}/otaFilePaths.cmake ) -include( ${MODULE_ROOT_DIR}/otaDependenyFilePaths.cmake ) +include( ${MODULE_ROOT_DIR}/otaDependencyFilePaths.cmake ) # Target for Coverity analysis that builds the library. add_library( coverity_analysis diff --git a/test/cbmc/include/FreeRTOSConfig.h b/test/cbmc/include/FreeRTOSConfig.h index 7e5ff2049..3e9d4d48e 100644 --- a/test/cbmc/include/FreeRTOSConfig.h +++ b/test/cbmc/include/FreeRTOSConfig.h @@ -173,7 +173,7 @@ extern void vLoggingPrint( const char * pcMessage ); /* The address of an echo server that will be used by the two demo echo client * tasks: - * http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_Echo_Clients.html, + * http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_Echo_Clients.html * http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/UDP_Echo_Clients.html. */ #define configECHO_SERVER_ADDR0 192 #define configECHO_SERVER_ADDR1 168 diff --git a/test/cbmc/proofs/Free_FreeRTOS/README.md b/test/cbmc/proofs/Free_FreeRTOS/README.md index 46ae8beb3..c749f0399 100644 --- a/test/cbmc/proofs/Free_FreeRTOS/README.md +++ b/test/cbmc/proofs/Free_FreeRTOS/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/Malloc_FreeRTOS/README.md b/test/cbmc/proofs/Malloc_FreeRTOS/README.md index 584f1c718..9fa14c806 100644 --- a/test/cbmc/proofs/Malloc_FreeRTOS/README.md +++ b/test/cbmc/proofs/Malloc_FreeRTOS/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_ActivateNewImage/README.md b/test/cbmc/proofs/OTA_ActivateNewImage/README.md index 54da45a97..ee1c858a0 100644 --- a/test/cbmc/proofs/OTA_ActivateNewImage/README.md +++ b/test/cbmc/proofs/OTA_ActivateNewImage/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_CBOR_Decode_GetStreamResponseMessage/README.md b/test/cbmc/proofs/OTA_CBOR_Decode_GetStreamResponseMessage/README.md index 3fa8603bf..80d72e088 100644 --- a/test/cbmc/proofs/OTA_CBOR_Decode_GetStreamResponseMessage/README.md +++ b/test/cbmc/proofs/OTA_CBOR_Decode_GetStreamResponseMessage/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_CBOR_Encode_GetStreamRequestMessage/README.md b/test/cbmc/proofs/OTA_CBOR_Encode_GetStreamRequestMessage/README.md index 24485c724..b92b548b3 100644 --- a/test/cbmc/proofs/OTA_CBOR_Encode_GetStreamRequestMessage/README.md +++ b/test/cbmc/proofs/OTA_CBOR_Encode_GetStreamRequestMessage/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_CheckForUpdate/README.md b/test/cbmc/proofs/OTA_CheckForUpdate/README.md index b167d205d..987049720 100644 --- a/test/cbmc/proofs/OTA_CheckForUpdate/README.md +++ b/test/cbmc/proofs/OTA_CheckForUpdate/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_Err_strerror/README.md b/test/cbmc/proofs/OTA_Err_strerror/README.md index db73f1f73..e8d968c81 100644 --- a/test/cbmc/proofs/OTA_Err_strerror/README.md +++ b/test/cbmc/proofs/OTA_Err_strerror/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_EventProcess/README.md b/test/cbmc/proofs/OTA_EventProcess/README.md index ad8e72da3..5eaa929e7 100644 --- a/test/cbmc/proofs/OTA_EventProcess/README.md +++ b/test/cbmc/proofs/OTA_EventProcess/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_EventProcessingTask/README.md b/test/cbmc/proofs/OTA_EventProcessingTask/README.md index 983036d7d..7e51790fe 100644 --- a/test/cbmc/proofs/OTA_EventProcessingTask/README.md +++ b/test/cbmc/proofs/OTA_EventProcessingTask/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_GetImageState/README.md b/test/cbmc/proofs/OTA_GetImageState/README.md index 4385f5eaa..dee4c92e6 100644 --- a/test/cbmc/proofs/OTA_GetImageState/README.md +++ b/test/cbmc/proofs/OTA_GetImageState/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_GetState/README.md b/test/cbmc/proofs/OTA_GetState/README.md index 02b4cd13a..fa4bf6f6c 100644 --- a/test/cbmc/proofs/OTA_GetState/README.md +++ b/test/cbmc/proofs/OTA_GetState/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_GetStatistics/README.md b/test/cbmc/proofs/OTA_GetStatistics/README.md index 672325121..7919e0de6 100644 --- a/test/cbmc/proofs/OTA_GetStatistics/README.md +++ b/test/cbmc/proofs/OTA_GetStatistics/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_HTTP_strerror/README.md b/test/cbmc/proofs/OTA_HTTP_strerror/README.md index 11353c7dd..182b15eaa 100644 --- a/test/cbmc/proofs/OTA_HTTP_strerror/README.md +++ b/test/cbmc/proofs/OTA_HTTP_strerror/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_Init/README.md b/test/cbmc/proofs/OTA_Init/README.md index 79f398f28..51c4595cc 100644 --- a/test/cbmc/proofs/OTA_Init/README.md +++ b/test/cbmc/proofs/OTA_Init/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_JobParse_strerror/README.md b/test/cbmc/proofs/OTA_JobParse_strerror/README.md index 287a81e58..8a9448d02 100644 --- a/test/cbmc/proofs/OTA_JobParse_strerror/README.md +++ b/test/cbmc/proofs/OTA_JobParse_strerror/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_MQTT_strerror/README.md b/test/cbmc/proofs/OTA_MQTT_strerror/README.md index fcbe70d66..20347cbfe 100644 --- a/test/cbmc/proofs/OTA_MQTT_strerror/README.md +++ b/test/cbmc/proofs/OTA_MQTT_strerror/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_OsStatus_strerror/README.md b/test/cbmc/proofs/OTA_OsStatus_strerror/README.md index 66aa7f527..5a60604f5 100644 --- a/test/cbmc/proofs/OTA_OsStatus_strerror/README.md +++ b/test/cbmc/proofs/OTA_OsStatus_strerror/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_PalStatus_strerror/README.md b/test/cbmc/proofs/OTA_PalStatus_strerror/README.md index 287a81e58..8a9448d02 100644 --- a/test/cbmc/proofs/OTA_PalStatus_strerror/README.md +++ b/test/cbmc/proofs/OTA_PalStatus_strerror/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_Resume/README.md b/test/cbmc/proofs/OTA_Resume/README.md index bb05c1f26..a15ec8f69 100644 --- a/test/cbmc/proofs/OTA_Resume/README.md +++ b/test/cbmc/proofs/OTA_Resume/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_SetImageState/README.md b/test/cbmc/proofs/OTA_SetImageState/README.md index c3601de1b..030463113 100644 --- a/test/cbmc/proofs/OTA_SetImageState/README.md +++ b/test/cbmc/proofs/OTA_SetImageState/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_Shutdown/README.md b/test/cbmc/proofs/OTA_Shutdown/README.md index 566e9f479..c49876f2d 100644 --- a/test/cbmc/proofs/OTA_Shutdown/README.md +++ b/test/cbmc/proofs/OTA_Shutdown/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_SignalEvent/README.md b/test/cbmc/proofs/OTA_SignalEvent/README.md index 983036d7d..7e51790fe 100644 --- a/test/cbmc/proofs/OTA_SignalEvent/README.md +++ b/test/cbmc/proofs/OTA_SignalEvent/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OTA_Suspend/README.md b/test/cbmc/proofs/OTA_Suspend/README.md index 428e06bbc..d29d7737c 100644 --- a/test/cbmc/proofs/OTA_Suspend/README.md +++ b/test/cbmc/proofs/OTA_Suspend/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OtaDeinitEvent_FreeRTOS/README.md b/test/cbmc/proofs/OtaDeinitEvent_FreeRTOS/README.md index 7e72d2da0..b1b3012d8 100644 --- a/test/cbmc/proofs/OtaDeinitEvent_FreeRTOS/README.md +++ b/test/cbmc/proofs/OtaDeinitEvent_FreeRTOS/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OtaDeleteTimer_FreeRTOS/README.md b/test/cbmc/proofs/OtaDeleteTimer_FreeRTOS/README.md index 5051b7406..488650d53 100644 --- a/test/cbmc/proofs/OtaDeleteTimer_FreeRTOS/README.md +++ b/test/cbmc/proofs/OtaDeleteTimer_FreeRTOS/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OtaInitEvent_FreeRTOS/README.md b/test/cbmc/proofs/OtaInitEvent_FreeRTOS/README.md index 8fb0b6716..984e6b452 100644 --- a/test/cbmc/proofs/OtaInitEvent_FreeRTOS/README.md +++ b/test/cbmc/proofs/OtaInitEvent_FreeRTOS/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OtaReceiveEvent_FreeRTOS/README.md b/test/cbmc/proofs/OtaReceiveEvent_FreeRTOS/README.md index 5804ec0ba..e0556fc45 100644 --- a/test/cbmc/proofs/OtaReceiveEvent_FreeRTOS/README.md +++ b/test/cbmc/proofs/OtaReceiveEvent_FreeRTOS/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OtaSendEvent_FreeRTOS/OtaSendEvent_FreeRTOS_harness.c b/test/cbmc/proofs/OtaSendEvent_FreeRTOS/OtaSendEvent_FreeRTOS_harness.c index c4e2f619f..c18fbee75 100644 --- a/test/cbmc/proofs/OtaSendEvent_FreeRTOS/OtaSendEvent_FreeRTOS_harness.c +++ b/test/cbmc/proofs/OtaSendEvent_FreeRTOS/OtaSendEvent_FreeRTOS_harness.c @@ -44,5 +44,5 @@ void OtaSendEvent_FreeRTOS_harness() osStatus = OtaSendEvent_FreeRTOS( pEventCtx, pEventMsg, timeout ); __CPROVER_assert( osStatus == OtaOsSuccess || osStatus == OtaOsEventQueueSendFailed, - "Invalid return value:osStatus should either be OtaOsSuccess or OtaOsEventeQueueSendFailed." ); + "Invalid return value:osStatus should either be OtaOsSuccess or OtaOsEventQueueSendFailed." ); } diff --git a/test/cbmc/proofs/OtaSendEvent_FreeRTOS/README.md b/test/cbmc/proofs/OtaSendEvent_FreeRTOS/README.md index 0e98e6f4f..13eaf27ca 100644 --- a/test/cbmc/proofs/OtaSendEvent_FreeRTOS/README.md +++ b/test/cbmc/proofs/OtaSendEvent_FreeRTOS/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OtaStartTimer_FreeRTOS/OtaStartTimer_FreeRTOS_harness.c b/test/cbmc/proofs/OtaStartTimer_FreeRTOS/OtaStartTimer_FreeRTOS_harness.c index 71dcc26c1..fb458fd28 100644 --- a/test/cbmc/proofs/OtaStartTimer_FreeRTOS/OtaStartTimer_FreeRTOS_harness.c +++ b/test/cbmc/proofs/OtaStartTimer_FreeRTOS/OtaStartTimer_FreeRTOS_harness.c @@ -53,7 +53,7 @@ void OtaStartTimer_FreeRTOS_harness() __CPROVER_assume( pTimerName != NULL ); /* callback is statically defined in ota.c before passing it to - * OtaStartTiemr_FreeRTOS. */ + * OtaStartTimer_FreeRTOS. */ __CPROVER_assume( callback != NULL ); /* To avoid pdMS_TO_TICKS from integer overflow. */ diff --git a/test/cbmc/proofs/OtaStartTimer_FreeRTOS/README.md b/test/cbmc/proofs/OtaStartTimer_FreeRTOS/README.md index df0aff2b6..9ec612f2d 100644 --- a/test/cbmc/proofs/OtaStartTimer_FreeRTOS/README.md +++ b/test/cbmc/proofs/OtaStartTimer_FreeRTOS/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/OtaStopTimer_FreeRTOS/README.md b/test/cbmc/proofs/OtaStopTimer_FreeRTOS/README.md index 275c209f8..e1a49d9a9 100644 --- a/test/cbmc/proofs/OtaStopTimer_FreeRTOS/README.md +++ b/test/cbmc/proofs/OtaStopTimer_FreeRTOS/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/Posix_OtaDeinitEvent/README.md b/test/cbmc/proofs/Posix_OtaDeinitEvent/README.md index 81c48027a..0f31f1d9d 100644 --- a/test/cbmc/proofs/Posix_OtaDeinitEvent/README.md +++ b/test/cbmc/proofs/Posix_OtaDeinitEvent/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/Posix_OtaDeleteTimer/README.md b/test/cbmc/proofs/Posix_OtaDeleteTimer/README.md index 67b5bdaf3..259485081 100644 --- a/test/cbmc/proofs/Posix_OtaDeleteTimer/README.md +++ b/test/cbmc/proofs/Posix_OtaDeleteTimer/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/Posix_OtaInitEvent/README.md b/test/cbmc/proofs/Posix_OtaInitEvent/README.md index c5a27efb0..d21f083f9 100644 --- a/test/cbmc/proofs/Posix_OtaInitEvent/README.md +++ b/test/cbmc/proofs/Posix_OtaInitEvent/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/Posix_OtaReceiveEvent/README.md b/test/cbmc/proofs/Posix_OtaReceiveEvent/README.md index 2a146fb8e..03f06af1f 100644 --- a/test/cbmc/proofs/Posix_OtaReceiveEvent/README.md +++ b/test/cbmc/proofs/Posix_OtaReceiveEvent/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/Posix_OtaSendEvent/README.md b/test/cbmc/proofs/Posix_OtaSendEvent/README.md index bc7d4eae2..96034e573 100644 --- a/test/cbmc/proofs/Posix_OtaSendEvent/README.md +++ b/test/cbmc/proofs/Posix_OtaSendEvent/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/Posix_OtaStartTimer/README.md b/test/cbmc/proofs/Posix_OtaStartTimer/README.md index e48f0baf7..7d58e2245 100644 --- a/test/cbmc/proofs/Posix_OtaStartTimer/README.md +++ b/test/cbmc/proofs/Posix_OtaStartTimer/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/Posix_OtaStopTimer/README.md b/test/cbmc/proofs/Posix_OtaStopTimer/README.md index a89af4e24..f0edd667a 100644 --- a/test/cbmc/proofs/Posix_OtaStopTimer/README.md +++ b/test/cbmc/proofs/Posix_OtaStopTimer/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/Posix_RequestTimerCallback/README.md b/test/cbmc/proofs/Posix_RequestTimerCallback/README.md index 5957ba24f..b60c284a8 100644 --- a/test/cbmc/proofs/Posix_RequestTimerCallback/README.md +++ b/test/cbmc/proofs/Posix_RequestTimerCallback/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/Posix_selfTestTimerCallback/README.md b/test/cbmc/proofs/Posix_selfTestTimerCallback/README.md index 825cae8d4..8c25fc162 100644 --- a/test/cbmc/proofs/Posix_selfTestTimerCallback/README.md +++ b/test/cbmc/proofs/Posix_selfTestTimerCallback/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/STDC_FREE/README.md b/test/cbmc/proofs/STDC_FREE/README.md index 37b67a072..79b6ff6e3 100644 --- a/test/cbmc/proofs/STDC_FREE/README.md +++ b/test/cbmc/proofs/STDC_FREE/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/STDC_Malloc/README.md b/test/cbmc/proofs/STDC_Malloc/README.md index f2f82411a..dee315d25 100644 --- a/test/cbmc/proofs/STDC_Malloc/README.md +++ b/test/cbmc/proofs/STDC_Malloc/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/agentShutdownCleanup/README.md b/test/cbmc/proofs/agentShutdownCleanup/README.md index 88d6b0fa8..a88d1ab29 100644 --- a/test/cbmc/proofs/agentShutdownCleanup/README.md +++ b/test/cbmc/proofs/agentShutdownCleanup/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/base64Decode/README.md b/test/cbmc/proofs/base64Decode/README.md index e63cbbbbc..f6b09e4cb 100644 --- a/test/cbmc/proofs/base64Decode/README.md +++ b/test/cbmc/proofs/base64Decode/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/buildStatusMessageReceiving/README.md b/test/cbmc/proofs/buildStatusMessageReceiving/README.md index 566e1e3e0..836f24627 100644 --- a/test/cbmc/proofs/buildStatusMessageReceiving/README.md +++ b/test/cbmc/proofs/buildStatusMessageReceiving/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/checkDataType/README.md b/test/cbmc/proofs/checkDataType/README.md index 7c4720744..76dcd78ab 100644 --- a/test/cbmc/proofs/checkDataType/README.md +++ b/test/cbmc/proofs/checkDataType/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/cleanupControl_Mqtt/README.md b/test/cbmc/proofs/cleanupControl_Mqtt/README.md index 32b9d7384..b163f2502 100644 --- a/test/cbmc/proofs/cleanupControl_Mqtt/README.md +++ b/test/cbmc/proofs/cleanupControl_Mqtt/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/cleanupData_Http/README.md b/test/cbmc/proofs/cleanupData_Http/README.md index 9437fdbde..2ec6f9277 100644 --- a/test/cbmc/proofs/cleanupData_Http/README.md +++ b/test/cbmc/proofs/cleanupData_Http/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/cleanupData_Mqtt/README.md b/test/cbmc/proofs/cleanupData_Mqtt/README.md index 3bd67d9a4..8a4747e25 100644 --- a/test/cbmc/proofs/cleanupData_Mqtt/README.md +++ b/test/cbmc/proofs/cleanupData_Mqtt/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/closeFileHandler/README.md b/test/cbmc/proofs/closeFileHandler/README.md index c377a55d3..dcc4d112a 100644 --- a/test/cbmc/proofs/closeFileHandler/README.md +++ b/test/cbmc/proofs/closeFileHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/dataHandlerCleanup/README.md b/test/cbmc/proofs/dataHandlerCleanup/README.md index 68dd63f40..b88deaf85 100644 --- a/test/cbmc/proofs/dataHandlerCleanup/README.md +++ b/test/cbmc/proofs/dataHandlerCleanup/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/decodeAndStoreDataBlock/README.md b/test/cbmc/proofs/decodeAndStoreDataBlock/README.md index ab08e19b0..0b89ad54e 100644 --- a/test/cbmc/proofs/decodeAndStoreDataBlock/README.md +++ b/test/cbmc/proofs/decodeAndStoreDataBlock/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/decodeAndStoreKey/README.md b/test/cbmc/proofs/decodeAndStoreKey/README.md index 62c82a954..02daff4a4 100644 --- a/test/cbmc/proofs/decodeAndStoreKey/README.md +++ b/test/cbmc/proofs/decodeAndStoreKey/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/decodeBase64IndexBuffer/README.md b/test/cbmc/proofs/decodeBase64IndexBuffer/README.md index 57ddefb5e..32bee2847 100644 --- a/test/cbmc/proofs/decodeBase64IndexBuffer/README.md +++ b/test/cbmc/proofs/decodeBase64IndexBuffer/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/decodeFileBlock_Http/README.md b/test/cbmc/proofs/decodeFileBlock_Http/README.md index 0b498dad8..e1eeec33a 100644 --- a/test/cbmc/proofs/decodeFileBlock_Http/README.md +++ b/test/cbmc/proofs/decodeFileBlock_Http/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/decodeFileBlock_Mqtt/README.md b/test/cbmc/proofs/decodeFileBlock_Mqtt/README.md index 53d48cbc3..36e8e23fe 100644 --- a/test/cbmc/proofs/decodeFileBlock_Mqtt/README.md +++ b/test/cbmc/proofs/decodeFileBlock_Mqtt/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/executeHandler/README.md b/test/cbmc/proofs/executeHandler/README.md index 533bf0744..3c0f26e28 100644 --- a/test/cbmc/proofs/executeHandler/README.md +++ b/test/cbmc/proofs/executeHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/extractAndStoreArray/README.md b/test/cbmc/proofs/extractAndStoreArray/README.md index 2db4e0319..ad76f4890 100644 --- a/test/cbmc/proofs/extractAndStoreArray/README.md +++ b/test/cbmc/proofs/extractAndStoreArray/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/extractAndStoreArray/extractAndStoreArray_harness.c b/test/cbmc/proofs/extractAndStoreArray/extractAndStoreArray_harness.c index a6f654413..880609ca9 100644 --- a/test/cbmc/proofs/extractAndStoreArray/extractAndStoreArray_harness.c +++ b/test/cbmc/proofs/extractAndStoreArray/extractAndStoreArray_harness.c @@ -77,7 +77,7 @@ void extractAndStoreArray_harness() /* The maximum returned by extractAndStoreArray is the length of the otaTransitionTable which * is defined by TRANSITION_TABLE_LEN in the Makefile. */ __CPROVER_assert( ( err == DocParseErrNone ) || ( err == DocParseErrOutOfMemory ) || - ( err == DocParseErrUserBufferInsuffcient ), + ( err == DocParseErrUserBufferInsufficient ), "Error: Return value from processValidFileContext should follow values of OtaErr_t enum." ); free( pParamAdd ); diff --git a/test/cbmc/proofs/extractParameter/README.md b/test/cbmc/proofs/extractParameter/README.md index c12975dfe..28ba63669 100644 --- a/test/cbmc/proofs/extractParameter/README.md +++ b/test/cbmc/proofs/extractParameter/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/freeFileContextMem/README.md b/test/cbmc/proofs/freeFileContextMem/README.md index 730c15feb..a79029481 100644 --- a/test/cbmc/proofs/freeFileContextMem/README.md +++ b/test/cbmc/proofs/freeFileContextMem/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/getFileContextFromJob/README.md b/test/cbmc/proofs/getFileContextFromJob/README.md index 16fd14e71..0770ae7b6 100644 --- a/test/cbmc/proofs/getFileContextFromJob/README.md +++ b/test/cbmc/proofs/getFileContextFromJob/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/handleCustomJob/README.md b/test/cbmc/proofs/handleCustomJob/README.md index fac862cee..be8ee007b 100644 --- a/test/cbmc/proofs/handleCustomJob/README.md +++ b/test/cbmc/proofs/handleCustomJob/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/handleJobParsingError/README.md b/test/cbmc/proofs/handleJobParsingError/README.md index f79b2c199..4608e2e2f 100644 --- a/test/cbmc/proofs/handleJobParsingError/README.md +++ b/test/cbmc/proofs/handleJobParsingError/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/handleSelfTestJobDoc/README.md b/test/cbmc/proofs/handleSelfTestJobDoc/README.md index d77cae628..2795cf07e 100644 --- a/test/cbmc/proofs/handleSelfTestJobDoc/README.md +++ b/test/cbmc/proofs/handleSelfTestJobDoc/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/handleUnexpectedEvents/README.md b/test/cbmc/proofs/handleUnexpectedEvents/README.md index 0cad0e9c3..5de794c55 100644 --- a/test/cbmc/proofs/handleUnexpectedEvents/README.md +++ b/test/cbmc/proofs/handleUnexpectedEvents/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/inSelfTestHandler/README.md b/test/cbmc/proofs/inSelfTestHandler/README.md index 79faa3eb4..d672ee64f 100644 --- a/test/cbmc/proofs/inSelfTestHandler/README.md +++ b/test/cbmc/proofs/inSelfTestHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/ingestDataBlock/README.md b/test/cbmc/proofs/ingestDataBlock/README.md index cd2619a52..2b7da2e64 100644 --- a/test/cbmc/proofs/ingestDataBlock/README.md +++ b/test/cbmc/proofs/ingestDataBlock/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/ingestDataBlockCleanup/README.md b/test/cbmc/proofs/ingestDataBlockCleanup/README.md index 0830ce252..8822e0303 100644 --- a/test/cbmc/proofs/ingestDataBlockCleanup/README.md +++ b/test/cbmc/proofs/ingestDataBlockCleanup/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/initDocModel/README.md b/test/cbmc/proofs/initDocModel/README.md index da8392542..98c55ec80 100644 --- a/test/cbmc/proofs/initDocModel/README.md +++ b/test/cbmc/proofs/initDocModel/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/initFileHandler/README.md b/test/cbmc/proofs/initFileHandler/README.md index 12d458652..f5eb4ba7f 100644 --- a/test/cbmc/proofs/initFileHandler/README.md +++ b/test/cbmc/proofs/initFileHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/initFileTransfer_Http/README.md b/test/cbmc/proofs/initFileTransfer_Http/README.md index d5f9890a8..0233454e4 100644 --- a/test/cbmc/proofs/initFileTransfer_Http/README.md +++ b/test/cbmc/proofs/initFileTransfer_Http/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/initFileTransfer_Mqtt/README.md b/test/cbmc/proofs/initFileTransfer_Mqtt/README.md index eb42c15c2..c5c108985 100644 --- a/test/cbmc/proofs/initFileTransfer_Mqtt/README.md +++ b/test/cbmc/proofs/initFileTransfer_Mqtt/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/initializeAppBuffers/README.md b/test/cbmc/proofs/initializeAppBuffers/README.md index 567d51182..22aa3ec9e 100644 --- a/test/cbmc/proofs/initializeAppBuffers/README.md +++ b/test/cbmc/proofs/initializeAppBuffers/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/initializeLocalBuffers/README.md b/test/cbmc/proofs/initializeLocalBuffers/README.md index 6a413bc10..046b5c1ec 100644 --- a/test/cbmc/proofs/initializeLocalBuffers/README.md +++ b/test/cbmc/proofs/initializeLocalBuffers/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/jobNotificationHandler/README.md b/test/cbmc/proofs/jobNotificationHandler/README.md index 832fc91be..779db7f70 100644 --- a/test/cbmc/proofs/jobNotificationHandler/README.md +++ b/test/cbmc/proofs/jobNotificationHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/otaClose/README.md b/test/cbmc/proofs/otaClose/README.md index 6ba2f200a..c25233620 100644 --- a/test/cbmc/proofs/otaClose/README.md +++ b/test/cbmc/proofs/otaClose/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/otaTimerCallback/README.md b/test/cbmc/proofs/otaTimerCallback/README.md index fe3173e48..3efbd27ab 100644 --- a/test/cbmc/proofs/otaTimerCallback/README.md +++ b/test/cbmc/proofs/otaTimerCallback/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/parseJSONbyModel/README.md b/test/cbmc/proofs/parseJSONbyModel/README.md index 1642e6879..fec182ef7 100644 --- a/test/cbmc/proofs/parseJSONbyModel/README.md +++ b/test/cbmc/proofs/parseJSONbyModel/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/parseJobDoc/README.md b/test/cbmc/proofs/parseJobDoc/README.md index 426b44767..89de333d1 100644 --- a/test/cbmc/proofs/parseJobDoc/README.md +++ b/test/cbmc/proofs/parseJobDoc/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/platformInSelftest/README.md b/test/cbmc/proofs/platformInSelftest/README.md index 9cc02bbd7..526314952 100644 --- a/test/cbmc/proofs/platformInSelftest/README.md +++ b/test/cbmc/proofs/platformInSelftest/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/preprocessBase64Index/README.md b/test/cbmc/proofs/preprocessBase64Index/README.md index 025445dae..af143cfab 100644 --- a/test/cbmc/proofs/preprocessBase64Index/README.md +++ b/test/cbmc/proofs/preprocessBase64Index/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/processDataBlock/README.md b/test/cbmc/proofs/processDataBlock/README.md index ab3512ef1..25731a088 100644 --- a/test/cbmc/proofs/processDataBlock/README.md +++ b/test/cbmc/proofs/processDataBlock/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/processDataHandler/README.md b/test/cbmc/proofs/processDataHandler/README.md index 7af7ba1c1..6e3c7c35b 100644 --- a/test/cbmc/proofs/processDataHandler/README.md +++ b/test/cbmc/proofs/processDataHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/processJobHandler/README.md b/test/cbmc/proofs/processJobHandler/README.md index 0a13b3131..8b56cda7c 100644 --- a/test/cbmc/proofs/processJobHandler/README.md +++ b/test/cbmc/proofs/processJobHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/processNullFileContext/README.md b/test/cbmc/proofs/processNullFileContext/README.md index fbd4c1ad1..c7b1f8810 100644 --- a/test/cbmc/proofs/processNullFileContext/README.md +++ b/test/cbmc/proofs/processNullFileContext/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/processValidFileContext/README.md b/test/cbmc/proofs/processValidFileContext/README.md index b2d0b184e..553945983 100644 --- a/test/cbmc/proofs/processValidFileContext/README.md +++ b/test/cbmc/proofs/processValidFileContext/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/prvBuildStatusMessageFinish/README.md b/test/cbmc/proofs/prvBuildStatusMessageFinish/README.md index be3ec328f..06670cf6c 100644 --- a/test/cbmc/proofs/prvBuildStatusMessageFinish/README.md +++ b/test/cbmc/proofs/prvBuildStatusMessageFinish/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/prvBuildStatusMessageSelfTest/README.md b/test/cbmc/proofs/prvBuildStatusMessageSelfTest/README.md index 8987a2158..dd1ed1aef 100644 --- a/test/cbmc/proofs/prvBuildStatusMessageSelfTest/README.md +++ b/test/cbmc/proofs/prvBuildStatusMessageSelfTest/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/publishStatusMessage/README.md b/test/cbmc/proofs/publishStatusMessage/README.md index acdc2cec8..4b0dcc23a 100644 --- a/test/cbmc/proofs/publishStatusMessage/README.md +++ b/test/cbmc/proofs/publishStatusMessage/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/receiveAndProcessOtaEvent/README.md b/test/cbmc/proofs/receiveAndProcessOtaEvent/README.md index 7ef0a69cc..5a84bce7d 100644 --- a/test/cbmc/proofs/receiveAndProcessOtaEvent/README.md +++ b/test/cbmc/proofs/receiveAndProcessOtaEvent/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/requestDataBlock_Http/README.md b/test/cbmc/proofs/requestDataBlock_Http/README.md index eda7955a1..f6783b8f3 100644 --- a/test/cbmc/proofs/requestDataBlock_Http/README.md +++ b/test/cbmc/proofs/requestDataBlock_Http/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/requestDataHandler/README.md b/test/cbmc/proofs/requestDataHandler/README.md index c82f76448..890a4b8db 100644 --- a/test/cbmc/proofs/requestDataHandler/README.md +++ b/test/cbmc/proofs/requestDataHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/requestFileBlock_Mqtt/README.md b/test/cbmc/proofs/requestFileBlock_Mqtt/README.md index 7986e9edf..0b9d7924f 100644 --- a/test/cbmc/proofs/requestFileBlock_Mqtt/README.md +++ b/test/cbmc/proofs/requestFileBlock_Mqtt/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/requestJobHandler/README.md b/test/cbmc/proofs/requestJobHandler/README.md index 8981a866a..0553170e2 100644 --- a/test/cbmc/proofs/requestJobHandler/README.md +++ b/test/cbmc/proofs/requestJobHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/requestJob_Mqtt/README.md b/test/cbmc/proofs/requestJob_Mqtt/README.md index b561067dc..c3327a678 100644 --- a/test/cbmc/proofs/requestJob_Mqtt/README.md +++ b/test/cbmc/proofs/requestJob_Mqtt/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/requestTimerCallback/README.md b/test/cbmc/proofs/requestTimerCallback/README.md index 5957ba24f..b60c284a8 100644 --- a/test/cbmc/proofs/requestTimerCallback/README.md +++ b/test/cbmc/proofs/requestTimerCallback/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/resetEventQueue/README.md b/test/cbmc/proofs/resetEventQueue/README.md index 8e4e49fd4..db267dbad 100644 --- a/test/cbmc/proofs/resetEventQueue/README.md +++ b/test/cbmc/proofs/resetEventQueue/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/resumeHandler/README.md b/test/cbmc/proofs/resumeHandler/README.md index 7043ad9bf..5f625cf8f 100644 --- a/test/cbmc/proofs/resumeHandler/README.md +++ b/test/cbmc/proofs/resumeHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/searchTransition/README.md b/test/cbmc/proofs/searchTransition/README.md index 2536571b9..40edb4be4 100644 --- a/test/cbmc/proofs/searchTransition/README.md +++ b/test/cbmc/proofs/searchTransition/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/selfTestTimerCallback/README.md b/test/cbmc/proofs/selfTestTimerCallback/README.md index 825cae8d4..8c25fc162 100644 --- a/test/cbmc/proofs/selfTestTimerCallback/README.md +++ b/test/cbmc/proofs/selfTestTimerCallback/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/setControlInterface/README.md b/test/cbmc/proofs/setControlInterface/README.md index 367930992..c124f0c26 100644 --- a/test/cbmc/proofs/setControlInterface/README.md +++ b/test/cbmc/proofs/setControlInterface/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/setDataInterface/README.md b/test/cbmc/proofs/setDataInterface/README.md index 48169f993..febabba4a 100644 --- a/test/cbmc/proofs/setDataInterface/README.md +++ b/test/cbmc/proofs/setDataInterface/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/setImageStateWithReason/README.md b/test/cbmc/proofs/setImageStateWithReason/README.md index 5003406b7..acda13a4e 100644 --- a/test/cbmc/proofs/setImageStateWithReason/README.md +++ b/test/cbmc/proofs/setImageStateWithReason/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/shutdownHandler/README.md b/test/cbmc/proofs/shutdownHandler/README.md index 8c5cc25a8..a2c434102 100644 --- a/test/cbmc/proofs/shutdownHandler/README.md +++ b/test/cbmc/proofs/shutdownHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/startHandler/README.md b/test/cbmc/proofs/startHandler/README.md index 5f1abacc9..b1bbe291a 100644 --- a/test/cbmc/proofs/startHandler/README.md +++ b/test/cbmc/proofs/startHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/stringBuilder/README.md b/test/cbmc/proofs/stringBuilder/README.md index a3f94c8a2..d788a4ea5 100644 --- a/test/cbmc/proofs/stringBuilder/README.md +++ b/test/cbmc/proofs/stringBuilder/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/stringBuilderUInt32Decimal/README.md b/test/cbmc/proofs/stringBuilderUInt32Decimal/README.md index 0bf3518f5..3bda6af8a 100644 --- a/test/cbmc/proofs/stringBuilderUInt32Decimal/README.md +++ b/test/cbmc/proofs/stringBuilderUInt32Decimal/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/stringBuilderUInt32Hex/README.md b/test/cbmc/proofs/stringBuilderUInt32Hex/README.md index 79871a26e..a5174f327 100644 --- a/test/cbmc/proofs/stringBuilderUInt32Hex/README.md +++ b/test/cbmc/proofs/stringBuilderUInt32Hex/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/subscribeToJobNotificationTopics/README.md b/test/cbmc/proofs/subscribeToJobNotificationTopics/README.md index 3a5c1d513..a7a0b3c93 100644 --- a/test/cbmc/proofs/subscribeToJobNotificationTopics/README.md +++ b/test/cbmc/proofs/subscribeToJobNotificationTopics/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/suspendHandler/README.md b/test/cbmc/proofs/suspendHandler/README.md index a7f88ead0..c58c77464 100644 --- a/test/cbmc/proofs/suspendHandler/README.md +++ b/test/cbmc/proofs/suspendHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/unsubscribeFromDataStream/README.md b/test/cbmc/proofs/unsubscribeFromDataStream/README.md index 7d53356f7..45a9308af 100644 --- a/test/cbmc/proofs/unsubscribeFromDataStream/README.md +++ b/test/cbmc/proofs/unsubscribeFromDataStream/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/unsubscribeFromJobNotificationTopic/README.md b/test/cbmc/proofs/unsubscribeFromJobNotificationTopic/README.md index 940da9926..66e03b424 100644 --- a/test/cbmc/proofs/unsubscribeFromJobNotificationTopic/README.md +++ b/test/cbmc/proofs/unsubscribeFromJobNotificationTopic/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/updateBase64DecodingBuffer/README.md b/test/cbmc/proofs/updateBase64DecodingBuffer/README.md index 09e6b9db3..5561a9583 100644 --- a/test/cbmc/proofs/updateBase64DecodingBuffer/README.md +++ b/test/cbmc/proofs/updateBase64DecodingBuffer/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/updateJobStatusFromImageState/README.md b/test/cbmc/proofs/updateJobStatusFromImageState/README.md index f5d53797a..e142c8d7d 100644 --- a/test/cbmc/proofs/updateJobStatusFromImageState/README.md +++ b/test/cbmc/proofs/updateJobStatusFromImageState/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/updateJobStatus_Mqtt/README.md b/test/cbmc/proofs/updateJobStatus_Mqtt/README.md index 3a4235625..39cb1389e 100644 --- a/test/cbmc/proofs/updateJobStatus_Mqtt/README.md +++ b/test/cbmc/proofs/updateJobStatus_Mqtt/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/userAbortHandler/README.md b/test/cbmc/proofs/userAbortHandler/README.md index 82d561389..a07c507c2 100644 --- a/test/cbmc/proofs/userAbortHandler/README.md +++ b/test/cbmc/proofs/userAbortHandler/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/validateAndStartJob/README.md b/test/cbmc/proofs/validateAndStartJob/README.md index aa91256ce..86e9de970 100644 --- a/test/cbmc/proofs/validateAndStartJob/README.md +++ b/test/cbmc/proofs/validateAndStartJob/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/validateDataBlock/README.md b/test/cbmc/proofs/validateDataBlock/README.md index 7cb6baf04..8bf3ab6e2 100644 --- a/test/cbmc/proofs/validateDataBlock/README.md +++ b/test/cbmc/proofs/validateDataBlock/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/validateJSON/README.md b/test/cbmc/proofs/validateJSON/README.md index a09d67ec9..a57d602e2 100644 --- a/test/cbmc/proofs/validateJSON/README.md +++ b/test/cbmc/proofs/validateJSON/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/validateUpdateVersion/README.md b/test/cbmc/proofs/validateUpdateVersion/README.md index c3ce4967f..faa64aeda 100644 --- a/test/cbmc/proofs/validateUpdateVersion/README.md +++ b/test/cbmc/proofs/validateUpdateVersion/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/verifyActiveJobStatus/README.md b/test/cbmc/proofs/verifyActiveJobStatus/README.md index f0e1d4863..b74bb3353 100644 --- a/test/cbmc/proofs/verifyActiveJobStatus/README.md +++ b/test/cbmc/proofs/verifyActiveJobStatus/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/cbmc/proofs/verifyRequiredParamsExtracted/README.md b/test/cbmc/proofs/verifyRequiredParamsExtracted/README.md index c376ce84f..591d66785 100644 --- a/test/cbmc/proofs/verifyRequiredParamsExtracted/README.md +++ b/test/cbmc/proofs/verifyRequiredParamsExtracted/README.md @@ -11,7 +11,7 @@ To run the proof. * Run `make`. * Open html/index.html in a web browser. -To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles. +To use [`arpa`](https://awslabs.github.io/aws-proof-build-assistant) to simplify writing Makefiles. ------------- * Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof. diff --git a/test/unit-test/CMakeLists.txt b/test/unit-test/CMakeLists.txt index 835972a62..d1423c652 100644 --- a/test/unit-test/CMakeLists.txt +++ b/test/unit-test/CMakeLists.txt @@ -1,6 +1,6 @@ # Include filepaths for source and include. include( ${MODULE_ROOT_DIR}/otaFilePaths.cmake ) -include( ${MODULE_ROOT_DIR}/otaDependenyFilePaths.cmake ) +include( ${MODULE_ROOT_DIR}/otaDependencyFilePaths.cmake ) # ==================== Define your project name (edit) ======================== set(project_name "aws_ota") diff --git a/test/unit-test/ota_os_posix_utest.c b/test/unit-test/ota_os_posix_utest.c index 66caec044..62f6c71f2 100644 --- a/test/unit-test/ota_os_posix_utest.c +++ b/test/unit-test/ota_os_posix_utest.c @@ -45,11 +45,11 @@ static OtaTimerInterface_t timer; static OtaEventInterface_t event; static OtaEventContext_t * pEventContext = NULL; -static bool timerCallbackInovked = false; +static bool timerCallbackInvoked = false; static void timerCallback() { - timerCallbackInovked = true; + timerCallbackInvoked = true; } /* ============================ UNITY FIXTURES ============================ */ @@ -68,7 +68,7 @@ void setUp( void ) void tearDown( void ) { - timerCallbackInovked = false; + timerCallbackInvoked = false; } /* ========================================================================== */ @@ -123,14 +123,14 @@ void timerCreateAndStop( OtaTimerId_t timer_id ) TEST_ASSERT_EQUAL( OtaOsSuccess, result ); /* Wait for the timer callback to be invoked. */ - while( timerCallbackInovked == false && wait > 0 ) + while( timerCallbackInvoked == false && wait > 0 ) { /* Sleep 1 ms. */ usleep( 1000 ); --wait; } - TEST_ASSERT_EQUAL( true, timerCallbackInovked ); + TEST_ASSERT_EQUAL( true, timerCallbackInvoked ); result = timer.stop( timer_id ); TEST_ASSERT_EQUAL( OtaOsSuccess, result ); diff --git a/test/unit-test/ota_utest.c b/test/unit-test/ota_utest.c index ae7677155..67c36cf94 100644 --- a/test/unit-test/ota_utest.c +++ b/test/unit-test/ota_utest.c @@ -469,11 +469,11 @@ static OtaMqttStatus_t stubMqttPublish( const char * const unused_1, return OtaMqttSuccess; } -static OtaMqttStatus_t stubMqttPublishOnlySuccedsTopicIsCorrect( const char * const topic, - uint16_t topicLength, - const char * unused_1, - uint32_t unused_2, - uint8_t unused_3 ) +static OtaMqttStatus_t stubMqttPublishOnlySucceedsTopicIsCorrect( const char * const topic, + uint16_t topicLength, + const char * unused_1, + uint32_t unused_2, + uint8_t unused_3 ) { ( void ) unused_1; ( void ) unused_2; @@ -494,11 +494,11 @@ static OtaMqttStatus_t stubMqttPublishOnlySuccedsTopicIsCorrect( const char * co return OtaMqttSuccess; } -static OtaMqttStatus_t stubMqttPublishOnlySuccedsIfTruncatedValue( const char * const unused_1, - uint16_t unused_2, - const char * msg, - uint32_t msgSize, - uint8_t unused_3 ) +static OtaMqttStatus_t stubMqttPublishOnlySucceedsIfTruncatedValue( const char * const unused_1, + uint16_t unused_2, + const char * msg, + uint32_t msgSize, + uint8_t unused_3 ) { ( void ) unused_1; ( void ) unused_2; @@ -1536,7 +1536,7 @@ void test_OTA_ImageStateAbortUpdateStatusFail() TEST_ASSERT_EQUAL( OtaImageStateAborted, OTA_GetImageState() ); } -void test_OTA_ImageStateRjectWithActiveJob() +void test_OTA_ImageStateRejectWithActiveJob() { otaGoToState( OtaAgentStateWaitingForFileBlock ); @@ -1544,7 +1544,7 @@ void test_OTA_ImageStateRjectWithActiveJob() TEST_ASSERT_EQUAL( OtaImageStateRejected, OTA_GetImageState() ); } -void test_OTA_ImageStateRjectWithNoJob() +void test_OTA_ImageStateRejectWithNoJob() { otaGoToState( OtaAgentStateReady ); TEST_ASSERT_EQUAL( OtaAgentStateReady, OTA_GetState() ); @@ -2865,7 +2865,7 @@ void test_OTA_MQTT_PublishesToCorrectTopic() otaInitDefault(); otaInterfaces.mqtt.subscribe = stubMqttSubscribe; - otaInterfaces.mqtt.publish = stubMqttPublishOnlySuccedsTopicIsCorrect; + otaInterfaces.mqtt.publish = stubMqttPublishOnlySucceedsTopicIsCorrect; err = requestJob_Mqtt( &otaAgent ); @@ -2879,7 +2879,7 @@ void test_OTA_MQTT_ThingNameTruncated() otaInit( longestThingname, mockAppCallback ); otaInterfaces.mqtt.subscribe = stubMqttSubscribe; - otaInterfaces.mqtt.publish = stubMqttPublishOnlySuccedsIfTruncatedValue; + otaInterfaces.mqtt.publish = stubMqttPublishOnlySucceedsIfTruncatedValue; err = requestJob_Mqtt( &otaAgent ); @@ -3823,7 +3823,7 @@ void test_OTA_jobIdMaxLength() /* Enlarge job name and size in doc param to simulate if the size of pJobNameBuffer in ota.c * and pActiveJobName in OtaAgentContext_t is different. */ -void test_OTA_jobBufferLargerThanpActiveJobName() +void test_OTA_jobBufferLargerThanActiveJobName() { pOtaJobDoc = JOB_DOC_INVALID_JOB_ID_LEN_MAX; diff --git a/tools/lexicon.txt b/tools/lexicon.txt deleted file mode 100644 index 67a48b261..000000000 --- a/tools/lexicon.txt +++ /dev/null @@ -1,920 +0,0 @@ -123456789 -abcdefghijklmnopqrstuvwxyz -abortupdate -activatenewimage -activejobname -addrinfo -addtogroup -afr -agentshutdowncleanup -allocateaddrinfolinkedlist -alpn -alpnprotoslen -api -apis -app -appfirmwareversion -ascii -asciidigits -attemptsdone -attr -auth -authscheme -authschememaxsize -authschemesize -aws -backoff -backoffdelay -basedefs -bitmaplen -bitmask -blockbitmapmaxsize -blockbitmapsize -blockid -blockindex -blockindex -blockoffset -blocksize -blocksremaining -bodylen -bool -bootloader -br -buf -buffersizebytes -bufferused -buildstatusmessagereceiving -bytesreceived -bytessent -bytestorecv -bytestosend -byteswritten -c89 -c90 -ca -cbmc -cbor -cborarray -cborerror -cbormap -cbormaptype -cborstring -cborvalue -cborwork -certfile -certfilepath -certfilepathmaxsize -certfilepathsize -checkdatatype -checkforupdate -cli -clienttoken -clienttokensize -closefile -closefilehandler -closeresult -cmock -co -colspan -com -completecallback -cond -config -configassert -configpagestyle -configprintf -configs -configurably -connectsuccessindex -const -constantspage -container -contextbase -contextbaseaddr -contextsize -copydoc -corejson -coremqtt -couldn -coverity -cpu -cr -createfile -createfileforrx -crt -crypto -csdk -css -currblock -currentstate -cwd -datablock -datacallback -datahandlercleanup -datalength -decodeandstoredatablock -decodeandstorekey -decodefileblock -decodemem -decodememmaxsize -decodememorysize -deduplicate -defaultotacompletecallback -defaultotacompletecallback -defgroup -deinit -deinitialize -deinitializing -deletetimer -destlen -destoffset -developerguide -didn -div -dns -docmodel -docparam -docparseerrduplicatesnotallowed -docparseerremptyjobdoc -docparseerrfieldtypemismatch -docparseerrinvalidmodelparamtype -docparseerrinvalidnumchar -docparseerrinvalidtoken -docparseerrmalformeddoc -docparseerrnone -docparseerrnullbodypointer -docparseerrnulldocpointer -docparseerrnullmodelpointer -docparseerroutofmemory -docparseerrparamkeynotinmodel -docparseerrtoomanyparams -docparseerrunknown -docparseerruserbufferinsuffcient -doesn't -doxygen -eagain -ecdsa -eevent -encodedlen -encodedsize -endcode -endcond -enddot -endian -endif -enum -enums -errno -errornumber -establishconnection -ethernet -eventdata -eventid -eventmsg -ewouldblock -executehandler -executionnumber -expectedstatus -expectedtype -extractandstorearray -extractparameter -failedwithval -faqmem -fclose -fd -fileattributes -filebitmapsize -fileblock -filecontext -filehandle -fileid -fileindex -filelabel -fileparameters -filepath -filepathmaxsize -filepaths -filesize -filetype -filetypeid -fillcolor -fixme -fontname -fontsize -fopen -freefilecontextmem -freertos -freertosipconfig -freertos.org -functionname -functionpage -functionpointers -functionspage -functiontofail -gcc -generater -getaddrinfo -getagentstate -getcwd -getfilecontextfromjob -getimagestate -getpacketsdropped -getpacketsprocessed -getpacketsqueued -getpacketsreceived -getplatformimagestate -github -handlecustomjob -handledatafromhttpservice -handlejobparsingerror -handlenetworkerrors -handlereconnect -handleselftestjobdoc -handleunexpectedevents -helvetica -hostnamelength -html -http -httpdeinit -httpinit -httpinterface -httprequest -https -iblocksize -ifndef -imagestate -implemenation -inc -ingestdatablock -ingestdatablockcleanup -ingestresultbaddata -ingestresultbadfilehandle -ingestresultblockoutofrange -ingestresultfileclosefail -ingestresultfilecomplete -ingestresultfilecomplete -ingestresultnodecodememory -ingestresultnullcontext -ingestresultnullinput -ingestresultnullresultpointer -ingestresultsigcheckfail -ingestresultunexpectedblock -ingestresultuninitialized -ingestresultwriteblockfailed -ingroup -init -initdocmodel -initfilehandler -initfiletransfer -initializeappbuffers -initializelocalbuffers -inout -inprogress -inselftesthandler -int -intel -ioffset -iot -iotcore -ip -ip -isinselftest -iso -isotainterfaceinited -jobcallback -jobdoc -jobdoclength -jobdocument -jobid -jobidlength -jobname -jobnamemaxsize -jobnotificationhandler -jobreasonaborted -jobreasonaccepted -jobreasonreceiving -jobreasonrejected -jobreasonselftestactive -jobreasonsigcheckpassed -jobstatusfailedwithval -jobstatusinprogress -jobstatusrejected -json -jsondoc -lastbyte -lastupdatedat -len -lf -li -linux -logdebug -logerror -loginfo -logpath -logwarn -longjmp -mainpage -malloc -mac -maxattempts -maxfragmentlength -maxlen -mcu -md -mem -memcpy -messagebuffersize -messagelength -messagelevel -messagesize -mfln -min -misra -mit -mockoseventsendthenstop -modelparams -modelparamtype -modelparamtypestringindoc -mqtt -mqttinterface -mqttpublish -mqttsubscribe -mqttunsubscribe -msec -msgbuffersize -msgsize -msgtailsize -msgvalidity -mutexhandle -mynetworkrecvimplementation -mynetworksendimplementation -mytcpsocketcontext -mythreadsleepfunction -mytime -mytimefunction -mytlscontext -nan -nano -nanosleep -netmask -networkcontext -newversion -nextjittermax -nextstate -noninfringement -numblocks -numblocksrequest -numjobparams -numjobstatusmappings -nummodelparams -numofblocksrequested -numofblockstoreceive -numpadding -numstrings -numwhitespace -ok -onlinepubs -opendns -opengroup -openssl -openssl_invalid_parameter -org -os -ota -ota_mqtt_component -otaagent -otaagenteventclosefile -otaagenteventcreatefile -otaagenteventcreatefile -otaagenteventmax -otaagenteventreceivedfileblock -otaagenteventreceivedjobdocument -otaagenteventrequestfileblock -otaagenteventrequestjobdocument -otaagenteventrequesttimer -otaagenteventresume -otaagenteventshutdown -otaagenteventstart -otaagenteventstartselftest -otaagenteventsuspend -otaagenteventuserabort -otaagentstatecreatingfile -otaagentstatenotready -otaagentstatenotready -otaagentstateready -otaagentstateshuttingdown -otaagentstatestopped -otaagentstatestopped -otaagentstatesuspended -otaagentstatewaitingforjob -otaagentstubs -otaappcallback -otabuffer -otacallback -otaclose -otaconfigallowdowngrade -otacontrolinterface -otaerr -otaerractivatefailed -otaerragentstopped -otaerrcleanupcontrolfailed -otaerrcleanupdatafailed -otaerrdowngradenotallowed -otaerremptyjobdocument -otaerrfailedtodecodecbor -otaerrfailedtoencodecbor -otaerrfilesizeoverflow -otaerrimagestatemismatch -otaerrinitfiletransferfailed -otaerrinvalidarg -otaerrinvaliddataprotocol -otaerrjobparsererror -otaerrmomentumabort -otaerrnoactivejob -otaerrnone -otaerrpanic -otaerrrequestfileblockfailed -otaerrrequestjobfailed -otaerrsamefirmwareversion -otaerrsignaleventfailed -otaerruninitialized -otaerrupdatejobstatusfailed -otaerruserabort -otaeventbufferget -otaeventbufferget -otaeventtorecv -otaeventtosend -otahttpdeinit -otahttpdeinitfailed -otahttpinitfailed -otahttppage -otahttprequestfailed -otahttpsectionoverview -otahttpsuccess -otaimagestateaborted -otaimagestateaccepted -otaimagestaterejected -otaimagestatetesting -otaimagestateunknown -otainterface -otainterfaces -otajobdocmodelparamstructure -otajobeventactivate -otajobeventfail -otajobeventnoactivejob -otajobeventparsecustomjob -otajobeventprocessed -otajobeventreceivedjob -otajobeventselftestfailed -otajobeventstarttest -otajobeventupdatecomplete -otajobparseerrbadmodelinitparams -otajobparseerrnoactivejobs -otajobparseerrnocontextavailable -otajobparseerrnonconformingjobdoc -otajobparseerrnone -otajobparseerrnulljob -otajobparseerrunknown -otajobparseerrupdatecurrentjob -otajobparseerrzerofilesize -otalastimagestate -otamqttpage -otamqttpublishfailed -otamqttsectionoverview -otamqttsubscribefailed -otamqttsuccess -otamqttunsubscribefailed -otanumoftimers -otaoseventqueuecreatefailed -otaoseventqueuedeletefailed -otaoseventqueuereceivefailed -otaoseventqueuesendfailed -otaosfipage -otaosfisectionoverview -otaossuccess -otaostimercreatefailed -otaostimerdeletefailed -otaostimerrestartfailed -otaostimerstartfailed -otaostimerstopfailed -otapacketsdropped -otapacketsprocessed -otapacketsqueued -otapacketsreceived -otapalabortfailed -otapalactivatefailed -otapalbadimagestate -otapalbadsignercert -otapalbootinfocreatefailed -otapalcommitfailed -otapalfileabort -otapalfileclose -otapalimagestateinvalid -otapalimagestatependingcommit -otapalimagestateunknown -otapalimagestatevalid -otapalnullfilecontext -otapaloutofmemory -otapalpage -otapalrejectfailed -otapalrxfilecreatefailed -otapalrxfiletoolarge -otapalsectionoverview -otapalsignaturecheckfailed -otapalsuberr -otapalsuccess -otapaluninitialized -otarequesttimer -otaselftesttimer -otastarttimer -otastatistics -otatimer -otatimercallback -otatimerid -otatransitiontable -outputlen -pacdata -pactivejobname -pactopic -paddrinfo -pagentctx -palcallbacks -paldefaultactivatenewimage -paldefaultactivatenewimage -paldefaultgetplatformimagestate -paldefaultgetplatformimagestate -paldefaultresetdevice -paldefaultresetdevice -paldefaultsetplatformimagestate -paldefaultsetplatformimagestate -palerr -palpnprotos -param -paramaddr -paramindex -params -paramsreceivedbitmap -paramsrequiredbitmap -parseerr -parsejobdoc -parsejsonbymodel -pauthscheme -pblockbitmap -pblockid -pblockindex -pblocksize -pbody -pbodydef -pbuffer -pc -pcallbacks -pcertfilepath -pcjobtopic -pcjson -pclientcertpath -pclientidentifier -pclienttoken -pclienttokenfromjob -pcloseresult -pcmsg -pcmsgbuffer -pconnection -pconnectioncontext -pcontextbase -pcontrolinterface -pctimername -pctopicbuffer -pcur -pdata -pdatainterface -pdecodemem -pdecodememory -pdest -pdestoffset -pdestsizeoffset -pdocmodel -pdocmodel -pem -pencodeddata -pencodedmessage -pencodedmessagesize -peventcontext -peventctx -peventdata -peventmsg -pfile -pfilebitmap -pfilecontext -pfileid -pfilepath -pfinalfile -pformat -phostname -phttp -pjobdocjson -pjobid -pjobname -pjobnamebuffer -pjobtopic -pjobtopicgetnext -pjobtopicnotifynext -pjson -pjsondoc -pjsonexpectedparams -pjsonsize -pkey -plaintext -platforminselftest -platfrom -plblockid -plblocksize -plisthead -pmessagebuffer -pmodelparam -pmsg -pmsgbuffer -pnetworkcontext -png -pnumdatainbuffer -pnumpadding -pnumwhitespace -pollin -pollout -popensslcredentials -portsleep -posix -potaagentstatestrings -potabuffer -potaeventstrings -potafilectx -potafiles -potafiles -potagetnextjobmsgtemplate -potagetstreamtopictemplate -potahttpinterface -potainterface -potainterfaces -potajobsgetnextacceptedtopictemplate -potajobsgetnexttopictemplate -potajobsnotifynexttopictemplate -potajobstatusreasonstrtemplate -potajobstatusreasonvaltemplate -potajobstatusreceivedetailstemplate -potajobstatusselftestdetailstemplate -potajobstatusstatustemplate -potajobstatussucceededstrtemplate -potajobstatustopictemplate -potamqttinterface -potaosctx -potarxstreamtopic -potasingletonactivejobname -potastreamdatatopictemplate -potastringfailed -potastringinprogress -potastringreceive -potastringrejected -potastringsucceeded -poutputlen -pparam -pparamadd -pparamsizeadd -ppayload -ppayloadparts -ppayloadsize -pprivatekeypath -pprotocol -pprotocolbuffer -pprotocols -ppucpayload -pquerykey -prawmsg -pre -presigned -presponse -presultlen -pretryparams -previousversion -printf -processdatablock -processdatahandler -processjobhandler -processvalidfilecontext -processnullfilecontext -prootcapath -protocolmaxsize -prvbuildstatusmessagefinish -prvbuildstatusmessageselftest -prvpal -prxblockbitmap -prxstreamtopic -pserverinfo -psig -psignature -psrckey -pssl -psslcontext -pstreamname -ptcpsocket -pthingname -ptimercallback -ptimerctx -ptimername -ptopicbuffer -ptopicfilter -ptr -publishstatusmessage -punused -pupdatefile -pupdatefilepath -pupdatejob -pupdateurlpath -pvalueinjson -pvcallback -pvportmalloc -pxconnection -pxcontrolinterface -pxdatainterface -qos -querykeylength -queuedat -ramdom -rand -rangeend -rangestart -rdy -reasontoset -receiveandprocessotaevent -reconnectparam -receiveandprocessotaevent -recv -recvtimeout -recvtimeoutms -repo -requestdata -requestdatahandler -requestfileblock -requestjob -requestjobhandler -requestmomentum -requesttimercallback -resetdevice -reseteventqueue -resumehandler -retryutilsretriesexhausted -retryutilssuccess -returnstatus -returnvalue -retvalue -rm -rollout -rsa -rtos -rx -rxstreamtopicbuffersize -sd -sdk -searchtransition -selftest -selftesttimercallback -sendtimeout -sendtimeoutms -serverfileid -serverinfo -servicequotas -setcontrolinterface -setdatainterface -setimagestate -setimagestatewithreason -setplatformimagestate -shutdownhandler -sig -sigalrm -sigbuffer -sizeof -sleeptimems -sni -snihostname -sockaddr -sockets_invalid_parameter -socketstatus -spdx -sprintf -srand -src -ssl -stacksize -starthandler -startselftesttimer -startselftimer -statetoset -statuscode -statusdetails -stddef -stdlib -str -streamname -streamnamemaxsize -streamnamesize -strerror -stringsize -stringbuilder -stringsize -strlength -stringbuilder -stringsize -strnlen -struct -structs -sublicense -subreason -subscribetojobnotificationtopics -suspendhandler -suspendtimeout -sys -tcp -tcpsocket -tcpsocketcontext -td -testclient -thingname -thisisaclienttoken -tickstowait -timeinseconds -timerhandle -timespec -timestampfromjob -tinycbor -tls -tlscontext -tlsrecv -tlssend -todo -toolchain -topicfilter -topicfilterlength -topiclen -tq -tr -transportcallback -transportinterface -transportpage -transportsectionimplementation -transportsectionoverview -transportstruct -ttimer -typecasted -twe -typecasted -uart -ublockindex -ublocksize -ucqos -udp -ul -ulblockindex -ulblocksize -ulmsglen -ulmsgsize -uloffset -ulreceived -ultopiclen -unhandled -uniqueclientid -unistd -unsignedversion32 -unsubscribeflag -unsubscribefromjobnotificationtopic -unsubscribeonshutdown -unsubscribefromjobnotificationtopic -unsubscribefromdatastream -updatedby -updatefilepath -updatefilepathsize -updatejobstatus -updatejobstatusfromimagestate -updaterversion -updateurl -updateurlmaxsize -url -urlsize -useraborthandler -ustopiclen -utils -uxtaskgetsystemstate -validateandstartjob -validatedatablock -validatejson -validateupdateversion -valuecopy -valuelength -verifyactivejobstatus -verifyrequiredparamsextracted -versionnumber -vportfree -vtasklist -wifi -writeblock -www -xaa -xyz -zg diff --git a/tools/uncrustify.cfg b/tools/uncrustify.cfg deleted file mode 100644 index 0cb7d3fbd..000000000 --- a/tools/uncrustify.cfg +++ /dev/null @@ -1,160 +0,0 @@ -# Uncrustify-0.67 -input_tab_size = 4 # unsigned number -output_tab_size = 4 # unsigned number -sp_arith = force # ignore/add/remove/force -sp_assign = force # ignore/add/remove/force -sp_assign_default = force # ignore/add/remove/force -sp_before_assign = force # ignore/add/remove/force -sp_after_assign = force # ignore/add/remove/force -sp_enum_assign = force # ignore/add/remove/force -sp_enum_before_assign = force # ignore/add/remove/force -sp_enum_after_assign = force # ignore/add/remove/force -sp_pp_stringify = add # ignore/add/remove/force -sp_bool = force # ignore/add/remove/force -sp_compare = force # ignore/add/remove/force -sp_inside_paren = force # ignore/add/remove/force -sp_paren_paren = force # ignore/add/remove/force -sp_paren_brace = force # ignore/add/remove/force -sp_before_ptr_star = force # ignore/add/remove/force -sp_before_unnamed_ptr_star = force # ignore/add/remove/force -sp_between_ptr_star = remove # ignore/add/remove/force -sp_after_ptr_star = force # ignore/add/remove/force -sp_before_byref = force # ignore/add/remove/force -sp_after_byref = remove # ignore/add/remove/force -sp_after_byref_func = remove # ignore/add/remove/force -sp_before_angle = remove # ignore/add/remove/force -sp_inside_angle = remove # ignore/add/remove/force -sp_after_angle = force # ignore/add/remove/force -sp_before_sparen = remove # ignore/add/remove/force -sp_inside_sparen = force # ignore/add/remove/force -sp_after_sparen = force # ignore/add/remove/force -sp_sparen_brace = force # ignore/add/remove/force -sp_before_semi_for = remove # ignore/add/remove/force -sp_before_semi_for_empty = add # ignore/add/remove/force -sp_after_semi_for_empty = force # ignore/add/remove/force -sp_before_square = remove # ignore/add/remove/force -sp_before_squares = remove # ignore/add/remove/force -sp_inside_square = force # ignore/add/remove/force -sp_after_comma = force # ignore/add/remove/force -sp_after_cast = force # ignore/add/remove/force -sp_inside_paren_cast = force # ignore/add/remove/force -sp_sizeof_paren = remove # ignore/add/remove/force -sp_inside_braces_enum = force # ignore/add/remove/force -sp_inside_braces_struct = force # ignore/add/remove/force -sp_inside_braces = force # ignore/add/remove/force -sp_inside_braces_empty = remove # ignore/add/remove/force -sp_type_func = force # ignore/add/remove/force -sp_func_proto_paren = remove # ignore/add/remove/force -sp_func_def_paren = remove # ignore/add/remove/force -sp_inside_fparens = remove # ignore/add/remove/force -sp_inside_fparen = force # ignore/add/remove/force -sp_fparen_brace = add # ignore/add/remove/force -sp_func_call_paren = remove # ignore/add/remove/force -sp_func_class_paren = remove # ignore/add/remove/force -sp_return_paren = remove # ignore/add/remove/force -sp_attribute_paren = remove # ignore/add/remove/force -sp_defined_paren = remove # ignore/add/remove/force -sp_macro = force # ignore/add/remove/force -sp_macro_func = force # ignore/add/remove/force -sp_brace_typedef = force # ignore/add/remove/force -sp_before_dc = remove # ignore/add/remove/force -sp_after_dc = remove # ignore/add/remove/force -sp_cond_colon = force # ignore/add/remove/force -sp_cond_question = force # ignore/add/remove/force -sp_case_label = force # ignore/add/remove/force -sp_endif_cmt = force # ignore/add/remove/force -sp_before_tr_emb_cmt = force # ignore/add/remove/force -sp_num_before_tr_emb_cmt = 1 # unsigned number -indent_columns = 4 # unsigned number -indent_with_tabs = 0 # unsigned number -indent_align_string = true # false/true -indent_class = true # false/true -indent_class_colon = true # false/true -indent_member = 3 # unsigned number -indent_switch_case = 4 # unsigned number -indent_case_brace = 3 # number -nl_assign_leave_one_liners = true # false/true -nl_class_leave_one_liners = true # false/true -nl_start_of_file = remove # ignore/add/remove/force -nl_end_of_file = force # ignore/add/remove/force -nl_end_of_file_min = 1 # unsigned number -nl_assign_brace = add # ignore/add/remove/force -nl_func_var_def_blk = 1 # unsigned number -nl_fcall_brace = add # ignore/add/remove/force -nl_enum_brace = force # ignore/add/remove/force -nl_struct_brace = force # ignore/add/remove/force -nl_union_brace = force # ignore/add/remove/force -nl_if_brace = add # ignore/add/remove/force -nl_brace_else = add # ignore/add/remove/force -nl_else_brace = add # ignore/add/remove/force -nl_getset_brace = force # ignore/add/remove/force -nl_for_brace = add # ignore/add/remove/force -nl_while_brace = add # ignore/add/remove/force -nl_do_brace = add # ignore/add/remove/force -nl_switch_brace = add # ignore/add/remove/force -nl_multi_line_define = true # false/true -nl_before_case = true # false/true -nl_after_case = true # false/true -nl_func_type_name = remove # ignore/add/remove/force -nl_func_proto_type_name = remove # ignore/add/remove/force -nl_func_paren = remove # ignore/add/remove/force -nl_func_def_paren = remove # ignore/add/remove/force -nl_func_decl_start = remove # ignore/add/remove/force -nl_func_def_start = remove # ignore/add/remove/force -nl_func_decl_args = add # ignore/add/remove/force -nl_func_def_args = add # ignore/add/remove/force -nl_func_decl_end = remove # ignore/add/remove/force -nl_func_def_end = remove # ignore/add/remove/force -nl_fdef_brace = add # ignore/add/remove/force -nl_after_semicolon = true # false/true -nl_after_brace_open = true # false/true -nl_after_brace_close = true # false/true -nl_squeeze_ifdef = true # false/true -nl_before_if = force # ignore/add/remove/force -nl_after_if = force # ignore/add/remove/force -nl_before_for = force # ignore/add/remove/force -nl_after_for = force # ignore/add/remove/force -nl_before_while = force # ignore/add/remove/force -nl_after_while = force # ignore/add/remove/force -nl_before_switch = force # ignore/add/remove/force -nl_after_switch = force # ignore/add/remove/force -nl_before_do = force # ignore/add/remove/force -nl_after_do = force # ignore/add/remove/force -nl_max = 4 # unsigned number -nl_after_func_proto_group = 1 # unsigned number -nl_after_func_body_class = 2 # unsigned number -nl_before_block_comment = 2 # unsigned number -eat_blanks_after_open_brace = true # false/true -eat_blanks_before_close_brace = true # false/true -nl_after_return = true # false/true -pos_bool = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force -align_var_def_amp_style = 1 # unsigned number -align_var_def_thresh = 16 # unsigned number -align_assign_thresh = 12 # unsigned number -align_struct_init_span = 3 # unsigned number -align_typedef_gap = 3 # unsigned number -align_typedef_span = 5 # unsigned number -align_typedef_star_style = 1 # unsigned number -align_typedef_amp_style = 1 # unsigned number -align_right_cmt_span = 3 # unsigned number -align_nl_cont = true # false/true -align_pp_define_gap = 4 # unsigned number -align_pp_define_span = 3 # unsigned number -cmt_cpp_to_c = true # false/true -cmt_star_cont = true # false/true -mod_full_brace_do = add # ignore/add/remove/force -mod_full_brace_for = add # ignore/add/remove/force -mod_full_brace_if = add # ignore/add/remove/force -mod_full_brace_while = add # ignore/add/remove/force -mod_full_paren_if_bool = true # false/true -mod_remove_extra_semicolon = true # false/true -mod_add_long_ifdef_endif_comment = 10 # unsigned number -mod_add_long_ifdef_else_comment = 10 # unsigned number -mod_case_brace = remove # ignore/add/remove/force -mod_remove_empty_return = true # false/true -pp_indent = force # ignore/add/remove/force -pp_indent_at_level = true # false/true -pp_indent_count = 4 # unsigned number -pp_space = remove # ignore/add/remove/force -pp_if_indent_code = true # false/true -# option(s) with 'not default' value: 158