Skip to content

Commit

Permalink
Update coverity links (#516)
Browse files Browse the repository at this point in the history
* Update coverity links

* Fix spell check

* Fix spell check

* Fix spell check
  • Loading branch information
tony-josi-aws authored Dec 16, 2024
1 parent 57d3efa commit 222cc4e
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 6 deletions.
1 change: 1 addition & 0 deletions .github/.cSpellWords.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ FOOB
FOOBA
FOOBDA
getpacketid
isOtaInterfaceInited
isystem
itimerspec
lcov
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,6 @@ 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) |

Expand Down
5 changes: 1 addition & 4 deletions source/include/ota.h
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ typedef struct OtaAgentContext
* <b>Example</b>
* @code{c}
* // Application callback when the OTA agent has completed the job
* // or is in self test mode. For example see [demos](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/ota)
* // or is in self test mode.
* void otaAppCallback( OtaJobEvent_t event,
* const void * pData );
*
Expand All @@ -402,7 +402,6 @@ typedef struct OtaAgentContext
*
* // OTA interface context required for library interface functions
* // The functions set by these interfaces are assumed to be defined
* // For more information see [demos](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/ota)
* OtaInterfaces_t pOtaInterfaces =
* {
* // Initialize OTA library OS Interface.
Expand Down Expand Up @@ -711,8 +710,6 @@ OtaErr_t OTA_Resume( void );
* This can be a function pointer that executes as the first routine when the
* event loop starts.
*
* For a Posix based reference of creating a thread with this task,
* please see the [demos in AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/ota).
*/
/* @[declare_ota_eventprocessingtask] */
void OTA_EventProcessingTask( const void * pUnused );
Expand Down
2 changes: 1 addition & 1 deletion tools/coverity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ see the [MISRA.md](https://github.com/aws/ota-for-aws-iot-embedded-sdk/blob/main

## Getting Started
### Prerequisites
You can run this on a platform supported by Coverity. The list and other details can be found [here](https://sig-docs.synopsys.com/polaris/topics/c_coverity-compatible-platforms.html).
You can run this on a platform supported by Coverity. The list and other details can be found [here](https://documentation.blackduck.com/bundle/coverity-docs-2024.9/page/deploy-install-guide/topics/supported_platforms_for_coverity_analysis.html).
To compile and run the Coverity target successfully, you must have the following:

1. CMake version > 3.13.0 (You can check whether you have this by typing `cmake --version`)
Expand Down

0 comments on commit 222cc4e

Please sign in to comment.