Skip to content

Commit

Permalink
Fix broken links and correct spelling mistakes, update the manifest.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
Skptak committed Aug 25, 2023
1 parent 540d584 commit 8eac75a
Show file tree
Hide file tree
Showing 136 changed files with 184 additions and 1,066 deletions.
38 changes: 38 additions & 0 deletions .github/.cSpellWords.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,46 @@
ABCDEFGHIJKLMNOPQRSTUVWXY
CBMC
CBOR
CMOCK
CMock
Cmock
Coverity
DCMOCK
DNDEBUG
DUNITY
FOOBDA
MISRA
MQTT
Misra
OPTIMISED
Wunused
cbmc
cbor
cborvalue
cmock
coverity
ctest
deinitializing
isystem
lcov
misra
mqdes
mqttstatus
mqueue
osstatus
otahttppage
otahttpsectionoverview
otamqttpage
otamqttsectionoverview
otaosfipage
otaosfisectionoverview
otapalpage
otpalsectionoverview
pbuffer
pclienttoken
sinclude
stringz
tinycbor
utest
lpthread
FOOBA
4 changes: 2 additions & 2 deletions MISRA.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_
Expand All @@ -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_
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion source/include/ota.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/include/ota_private.h
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ 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. */
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. */
Expand Down
4 changes: 2 additions & 2 deletions source/ota.c
Original file line number Diff line number Diff line change
Expand Up @@ -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]",
Expand Down Expand Up @@ -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
{
Expand Down
4 changes: 2 additions & 2 deletions source/ota_http.c
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) ) );
}
Expand Down Expand Up @@ -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 ) ) );
}
Expand Down
2 changes: 1 addition & 1 deletion test/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/Free_FreeRTOS/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/Malloc_FreeRTOS/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_ActivateNewImage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_CheckForUpdate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_Err_strerror/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_EventProcess/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_EventProcessingTask/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_GetImageState/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_GetState/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_GetStatistics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_HTTP_strerror/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_Init/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_JobParse_strerror/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_MQTT_strerror/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_OsStatus_strerror/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_PalStatus_strerror/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_Resume/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_SetImageState/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_Shutdown/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_SignalEvent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OTA_Suspend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OtaDeinitEvent_FreeRTOS/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OtaDeleteTimer_FreeRTOS/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OtaInitEvent_FreeRTOS/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OtaReceiveEvent_FreeRTOS/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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." );
}
2 changes: 1 addition & 1 deletion test/cbmc/proofs/OtaSendEvent_FreeRTOS/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. */
Expand Down
Loading

0 comments on commit 8eac75a

Please sign in to comment.