Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doxygen to 1.9.6 #1844

Merged
merged 10 commits into from
Jul 5, 2023
Merged
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -222,19 +222,19 @@ jobs:
exit 0
fi
doxygen:
runs-on: ubuntu-20.04
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
submodules: recursive
- name: Install Doxygen
run: |
wget -qO- "https://sourceforge.net/projects/doxygen/files/rel-1.9.2/doxygen-1.9.2.linux.bin.tar.gz/download" | sudo tar --strip-components=1 -xz -C /usr/local
sudo apt-get install -y libclang-9-dev libclang-cpp9 graphviz
wget -qO- "https://sourceforge.net/projects/doxygen/files/rel-1.9.6/doxygen-1.9.6.linux.bin.tar.gz/download" | sudo tar --strip-components=1 -xz -C /usr/local
sudo apt-get install -y libclang-11-dev libclang-cpp11 graphviz
- name: Install Python3
uses: actions/setup-python@v2
with:
python-version: '3.7.10'
python-version: '3.11.0'
- name: Generate doxygen output
run: |
if [[ "$GITHUB_REF" == "refs/heads/main" ]]; then
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/doxygen-generation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
workflow_dispatch:
jobs:
doxygen-generation:
runs-on: ubuntu-20.04
runs-on: ubuntu-latest
steps:
- name: Doxygen generation
uses: FreeRTOS/CI-CD-Github-Actions/doxygen-generation@main
Expand Down
1,025 changes: 738 additions & 287 deletions docs/doxygen/config.doxyfile

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion libraries/aws/ota-for-aws-iot-embedded-sdk
2 changes: 1 addition & 1 deletion libraries/standard/coreHTTP
Submodule coreHTTP updated 27 files
+21 −0 .github/pull_request_template.md
+19 −3 .github/workflows/ci.yml
+179 −121 docs/doxygen/config.doxyfile
+0 −40 sbom.spdx
+2 −0 test/cbmc/proofs/HTTPClient_AddHeader/Makefile
+2 −0 test/cbmc/proofs/HTTPClient_AddRangeHeader/Makefile
+2 −0 test/cbmc/proofs/HTTPClient_InitializeRequestHeaders/Makefile
+0 −1 test/cbmc/proofs/HTTPClient_InitializeRequestHeaders/cbmc-proof.txt
+2 −0 test/cbmc/proofs/HTTPClient_ReadHeader/Makefile
+2 −0 test/cbmc/proofs/HTTPClient_Send/Makefile
+2 −0 test/cbmc/proofs/HTTPClient_strerror/Makefile
+151 −167 test/cbmc/proofs/Makefile.common
+2 −0 test/cbmc/proofs/findHeaderFieldParserCallback/Makefile
+2 −0 test/cbmc/proofs/findHeaderOnHeaderCompleteCallback/Makefile
+2 −0 test/cbmc/proofs/findHeaderValueParserCallback/Makefile
+2 −0 test/cbmc/proofs/httpParserOnBodyCallback/Makefile
+0 −1 test/cbmc/proofs/httpParserOnBodyCallback/cbmc-proof.txt
+2 −0 test/cbmc/proofs/httpParserOnHeaderFieldCallback/Makefile
+2 −0 test/cbmc/proofs/httpParserOnHeaderValueCallback/Makefile
+2 −0 test/cbmc/proofs/httpParserOnHeadersCompleteCallback/Makefile
+2 −0 test/cbmc/proofs/httpParserOnMessageBeginCallback/Makefile
+2 −0 test/cbmc/proofs/httpParserOnMessageCompleteCallback/Makefile
+2 −0 test/cbmc/proofs/httpParserOnStatusCallback/Makefile
+74 −0 test/cbmc/proofs/lib/print_tool_versions.py
+57 −6 test/cbmc/proofs/lib/summarize.py
+17 −7 test/cbmc/proofs/run-cbmc-proofs.py
+4 −4 test/cbmc/stubs/strncpy.c
2 changes: 1 addition & 1 deletion libraries/standard/coreJSON
Submodule coreJSON updated 92 files
+38 −0 .github/CODEOWNERS
+21 −0 .github/pull_request_template.md
+16 −3 .github/workflows/ci.yml
+6 −0 .gitignore
+179 −121 docs/doxygen/config.doxyfile
+4 −0 lexicon.txt
+0 −29 sbom.spdx
+0 −33 test/cbmc/include/core_json_annex.h
+307 −0 test/cbmc/include/core_json_contracts.h
+0 −51 test/cbmc/include/skipGeneric.h
+5 −45 test/cbmc/proofs/JSON_Iterate/JSON_Iterate_harness.c
+10 −14 test/cbmc/proofs/JSON_Iterate/Makefile
+11 −16 test/cbmc/proofs/JSON_Iterate/README.md
+0 −78 test/cbmc/proofs/JSON_Search/JSON_Search_harness.c
+0 −35 test/cbmc/proofs/JSON_Search/Makefile
+0 −30 test/cbmc/proofs/JSON_Search/README.md
+15 −10 test/cbmc/proofs/JSON_SearchConst/JSON_SearchConst_harness.c
+29 −0 test/cbmc/proofs/JSON_SearchConst/Makefile
+18 −0 test/cbmc/proofs/JSON_SearchConst/README.md
+0 −0 test/cbmc/proofs/JSON_SearchConst/cbmc-proof.txt
+1 −1 test/cbmc/proofs/JSON_SearchConst/cbmc-viewer.json
+3 −15 test/cbmc/proofs/JSON_Validate/JSON_Validate_harness.c
+11 −12 test/cbmc/proofs/JSON_Validate/Makefile
+9 −14 test/cbmc/proofs/JSON_Validate/README.md
+8 −0 test/cbmc/proofs/Makefile-json.common
+177 −175 test/cbmc/proofs/Makefile.common
+23 −0 test/cbmc/proofs/arraySearch/Makefile
+17 −0 test/cbmc/proofs/arraySearch/README.md
+13 −10 test/cbmc/proofs/arraySearch/arraySearch_harness.c
+0 −0 test/cbmc/proofs/arraySearch/cbmc-proof.txt
+2 −2 test/cbmc/proofs/arraySearch/cbmc-viewer.json
+74 −0 test/cbmc/proofs/lib/print_tool_versions.py
+57 −6 test/cbmc/proofs/lib/summarize.py
+28 −0 test/cbmc/proofs/objectSearch/Makefile
+18 −0 test/cbmc/proofs/objectSearch/README.md
+0 −0 test/cbmc/proofs/objectSearch/cbmc-proof.txt
+7 −0 test/cbmc/proofs/objectSearch/cbmc-viewer.json
+14 −10 test/cbmc/proofs/objectSearch/objectSearch_harness.c
+28 −4 test/cbmc/proofs/run-cbmc-proofs.py
+0 −16 test/cbmc/proofs/skipAnyLiteral/README.md
+0 −58 test/cbmc/proofs/skipAnyLiteral/skipAnyLiteral_harness.c
+8 −7 test/cbmc/proofs/skipAnyScalar/Makefile
+15 −0 test/cbmc/proofs/skipAnyScalar/README.md
+0 −0 test/cbmc/proofs/skipAnyScalar/cbmc-proof.txt
+0 −0 test/cbmc/proofs/skipAnyScalar/cbmc-viewer.json
+11 −10 test/cbmc/proofs/skipAnyScalar/skipAnyScalar_harness.c
+9 −15 test/cbmc/proofs/skipCollection/Makefile
+9 −19 test/cbmc/proofs/skipCollection/README.md
+4 −23 test/cbmc/proofs/skipCollection/skipCollection_harness.c
+16 −0 test/cbmc/proofs/skipDigits/Makefile
+11 −0 test/cbmc/proofs/skipDigits/README.md
+1 −0 test/cbmc/proofs/skipDigits/cbmc-proof.txt
+1 −1 test/cbmc/proofs/skipDigits/cbmc-viewer.json
+12 −10 test/cbmc/proofs/skipDigits/skipDigits_harness.c
+3 −6 test/cbmc/proofs/skipEscape/Makefile
+6 −12 test/cbmc/proofs/skipEscape/README.md
+4 −23 test/cbmc/proofs/skipEscape/skipEscape_harness.c
+0 −20 test/cbmc/proofs/skipNumber/Makefile
+0 −20 test/cbmc/proofs/skipNumber/README.md
+0 −72 test/cbmc/proofs/skipNumber/skipNumber_harness.c
+26 −0 test/cbmc/proofs/skipObjectScalars/Makefile
+17 −0 test/cbmc/proofs/skipObjectScalars/README.md
+1 −0 test/cbmc/proofs/skipObjectScalars/cbmc-proof.txt
+7 −0 test/cbmc/proofs/skipObjectScalars/cbmc-viewer.json
+39 −0 test/cbmc/proofs/skipObjectScalars/skipObjectScalars_harness.c
+25 −0 test/cbmc/proofs/skipScalars/Makefile
+17 −0 test/cbmc/proofs/skipScalars/README.md
+1 −0 test/cbmc/proofs/skipScalars/cbmc-proof.txt
+7 −0 test/cbmc/proofs/skipScalars/cbmc-viewer.json
+40 −0 test/cbmc/proofs/skipScalars/skipScalars_harness.c
+3 −4 test/cbmc/proofs/skipSpace/Makefile
+6 −9 test/cbmc/proofs/skipSpace/README.md
+4 −20 test/cbmc/proofs/skipSpace/skipSpace_harness.c
+0 −18 test/cbmc/proofs/skipSpaceAndComma/Makefile
+0 −14 test/cbmc/proofs/skipSpaceAndComma/README.md
+0 −58 test/cbmc/proofs/skipSpaceAndComma/skipSpaceAndComma_harness.c
+10 −8 test/cbmc/proofs/skipString/Makefile
+9 −10 test/cbmc/proofs/skipString/README.md
+4 −23 test/cbmc/proofs/skipString/skipString_harness.c
+4 −6 test/cbmc/proofs/skipUTF8/Makefile
+6 −12 test/cbmc/proofs/skipUTF8/README.md
+4 −23 test/cbmc/proofs/skipUTF8/skipUTF8_harness.c
+255 −0 test/cbmc/sources/core_json_contracts.c
+0 −6 test/cbmc/stubs/README.md
+0 −46 test/cbmc/stubs/skipAnyScalar.c
+0 −42 test/cbmc/stubs/skipCollection.c
+0 −50 test/cbmc/stubs/skipDigits.c
+0 −39 test/cbmc/stubs/skipEscape.c
+0 −61 test/cbmc/stubs/skipGeneric.c
+0 −40 test/cbmc/stubs/skipSpaceAndComma.c
+1 −1 test/unit-test/catch_assert.h
+0 −1 test/unit-test/core_json_utest.c
2 changes: 1 addition & 1 deletion libraries/standard/coreMQTT
Submodule coreMQTT updated 59 files
+21 −0 .github/pull_request_template.md
+12 −3 .github/workflows/ci.yml
+0 −6 CHANGELOG.md
+4 −4 README.md
+182 −84 docs/doxygen/config.doxyfile
+2 −2 docs/doxygen/include/size_table.md
+1 −1 lexicon.txt
+1 −1 manifest.yml
+0 −43 sbom.spdx
+120 −46 source/core_mqtt.c
+1 −3 source/core_mqtt_serializer.c
+1 −1 source/core_mqtt_state.c
+2 −2 source/include/core_mqtt.h
+1 −1 source/include/core_mqtt_config_defaults.h
+1 −1 source/include/core_mqtt_default_logging.h
+1 −1 source/include/core_mqtt_serializer.h
+1 −1 source/include/core_mqtt_state.h
+1 −1 source/interface/transport_interface.h
+1 −1 test/cbmc/include/core_mqtt_config.h
+1 −1 test/cbmc/include/event_callback_stub.h
+1 −1 test/cbmc/include/get_time_stub.h
+1 −1 test/cbmc/include/mqtt_cbmc_state.h
+1 −1 test/cbmc/include/network_interface_stubs.h
+1 −1 test/cbmc/proofs/MQTT_Connect/MQTT_Connect_harness.c
+1 −1 test/cbmc/proofs/MQTT_DeserializeAck/MQTT_DeserializeAck_harness.c
+1 −1 test/cbmc/proofs/MQTT_DeserializePublish/MQTT_DeserializePublish_harness.c
+1 −1 test/cbmc/proofs/MQTT_Disconnect/MQTT_Disconnect_harness.c
+1 −1 test/cbmc/proofs/MQTT_GetIncomingPacketTypeAndLength/MQTT_GetIncomingPacketTypeAndLength_harness.c
+1 −1 test/cbmc/proofs/MQTT_GetPacketId/MQTT_GetPacketId_harness.c
+1 −1 test/cbmc/proofs/MQTT_GetSubAckStatusCodes/MQTT_GetSubAckStatusCodes_harness.c
+1 −1 test/cbmc/proofs/MQTT_Init/MQTT_Init_harness.c
+1 −1 test/cbmc/proofs/MQTT_MatchTopic/MQTT_MatchTopic_harness.c
+1 −1 test/cbmc/proofs/MQTT_Ping/MQTT_Ping_harness.c
+1 −1 test/cbmc/proofs/MQTT_ProcessLoop/MQTT_ProcessLoop_harness.c
+1 −1 test/cbmc/proofs/MQTT_Publish/MQTT_Publish_harness.c
+1 −1 test/cbmc/proofs/MQTT_ReceiveLoop/MQTT_ReceiveLoop_harness.c
+1 −1 test/cbmc/proofs/MQTT_SerializeAck/MQTT_SerializeAck_harness.c
+1 −1 test/cbmc/proofs/MQTT_SerializeConnect/MQTT_SerializeConnect_harness.c
+1 −1 test/cbmc/proofs/MQTT_SerializeDisconnect/MQTT_SerializeDisconnect_harness.c
+1 −1 test/cbmc/proofs/MQTT_SerializePingreq/MQTT_SerializePingreq_harness.c
+1 −1 test/cbmc/proofs/MQTT_SerializePublish/MQTT_SerializePublish_harness.c
+1 −1 test/cbmc/proofs/MQTT_SerializePublishHeader/MQTT_SerializePublishHeader_harness.c
+1 −1 test/cbmc/proofs/MQTT_SerializeSubscribe/MQTT_SerializeSubscribe_harness.c
+1 −1 test/cbmc/proofs/MQTT_SerializeUnsubscribe/MQTT_SerializeUnsubscribe_harness.c
+1 −1 test/cbmc/proofs/MQTT_Subscribe/MQTT_Subscribe_harness.c
+1 −1 test/cbmc/proofs/MQTT_Unsubscribe/MQTT_Unsubscribe_harness.c
+74 −0 test/cbmc/proofs/lib/print_tool_versions.py
+57 −6 test/cbmc/proofs/lib/summarize.py
+1 −1 test/cbmc/sources/mqtt_cbmc_state.c
+1 −1 test/cbmc/stubs/event_callback_stub.c
+1 −1 test/cbmc/stubs/get_time_stub.c
+1 −1 test/cbmc/stubs/memmove.c
+1 −1 test/cbmc/stubs/network_interface_stubs.c
+3 −1 test/unit-test/core_mqtt_config.h
+6 −6 test/unit-test/core_mqtt_serializer_utest.c
+6 −6 test/unit-test/core_mqtt_state_utest.c
+123 −2 test/unit-test/core_mqtt_utest.c
+1 −1 test/unit-test/logging/logging_levels.h
+1 −1 test/unit-test/logging/logging_stack.h
2 changes: 1 addition & 1 deletion libraries/standard/corePKCS11
Submodule corePKCS11 updated 38 files
+21 −0 .github/pull_request_template.md
+85 −33 .github/workflows/ci.yml
+0 −5 .gitmodules
+179 −121 docs/doxygen/config.doxyfile
+0 −94 sbom.spdx
+0 −1 source/dependency/3rdparty/mbedtls
+39 −31 source/portable/mbedtls/core_pkcs11_mbedtls.c
+30 −20 test/CMakeLists.txt
+1 −1 test/cbmc/proofs/C_CloseSession/Makefile
+1 −1 test/cbmc/proofs/C_CreateObject/Makefile
+1 −1 test/cbmc/proofs/C_DestroyObject/Makefile
+1 −1 test/cbmc/proofs/C_DigestFinal/Makefile
+1 −1 test/cbmc/proofs/C_DigestInit/Makefile
+1 −1 test/cbmc/proofs/C_DigestUpdate/Makefile
+1 −1 test/cbmc/proofs/C_Finalize/Makefile
+1 −1 test/cbmc/proofs/C_FindObjects/Makefile
+1 −1 test/cbmc/proofs/C_FindObjectsFinal/Makefile
+1 −1 test/cbmc/proofs/C_FindObjectsInit/Makefile
+1 −1 test/cbmc/proofs/C_GenerateKeyPair/Makefile
+1 −1 test/cbmc/proofs/C_GenerateRandom/Makefile
+1 −1 test/cbmc/proofs/C_GetAttributeValue/Makefile
+1 −1 test/cbmc/proofs/C_GetFunctionList/Makefile
+1 −1 test/cbmc/proofs/C_GetMechanismInfo/Makefile
+1 −1 test/cbmc/proofs/C_GetSlotList/Makefile
+1 −1 test/cbmc/proofs/C_Initialize/Makefile
+1 −1 test/cbmc/proofs/C_OpenSession/Makefile
+1 −1 test/cbmc/proofs/C_Sign/Makefile
+1 −1 test/cbmc/proofs/C_SignInit/Makefile
+1 −1 test/cbmc/proofs/C_Verify/Makefile
+1 −1 test/cbmc/proofs/C_VerifyInit/Makefile
+74 −0 test/cbmc/proofs/lib/print_tool_versions.py
+57 −6 test/cbmc/proofs/lib/summarize.py
+0 −2 test/mbedtls_integration/CMakeLists.txt
+336 −53 test/pkcs11_mbedtls_utest/core_pkcs11_mbedtls_utest.c
+0 −47 tools/0001-Fix-missing-prototype-warning-when-MBEDTLS_DEPRECATE.patch
+5 −6 tools/mbedtls.cmake
+2 −0 tools/mbedtls_configure.sh
+0 −28 tools/mbedtls_patch.sh
22 changes: 11 additions & 11 deletions manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,67 +8,67 @@ description: |-
See dependencies for included libraries."
dependencies:
- name: "coreMQTT"
version: "v2.1.1"
version: "000a574c0eb7dcaa68caf3e70f06b32d8568c1d1"
repository:
type: "git"
url: "https://github.com/FreeRTOS/coreMQTT"
path: "libraries/standard/coreMQTT"
- name: "coreJSON"
version: "v3.2.0"
version: "8d216b5876ba6953e8b60a20d32eae62992d09fe"
repository:
type: "git"
url: "https://github.com/FreeRTOS/coreJSON"
path: "libraries/standard/coreJSON"
- name: "Device-Shadow-for-AWS-IoT-embedded-sdk"
version: "v1.3.0"
version: "0c17830735d83fe1e399af056820de0f4666f43c"
repository:
type: "git"
url: "https://github.com/aws/Device-Shadow-for-AWS-IoT-embedded-sdk"
path: "libraries/aws/device-shadow-for-aws-iot-embedded-sdk"
- name: "coreHTTP"
version: "v3.0.0"
version: "48ccceb4bc048a36012ff33a0adbb49bc891045f"
repository:
type: "git"
url: "https://github.com/FreeRTOS/coreHTTP"
path: "libraries/standard/coreHTTP"
- name: "Device-Defender-for-AWS-IoT-embedded-sdk"
version: "v1.3.0"
version: "747ae050e1d22682c8c757fff48dba2760094505"
repository:
type: "git"
url: "https://github.com/aws/Device-Defender-for-AWS-IoT-embedded-sdk"
path: "libraries/aws/device-defender-for-aws-iot-embedded-sdk"
- name: "Jobs-for-AWS-IoT-embedded-sdk"
version: "v1.3.0"
version: "3e33c6a0eeaebb820a445a3d4b1a02896b3e557d"
repository:
type: "git"
url: "https://github.com/aws/Jobs-for-AWS-IoT-embedded-sdk"
path: "libraries/aws/jobs-for-aws-iot-embedded-sdk"
- name: "OTA-for-AWS-IoT-embedded-sdk"
version: "v3.4.0"
version: "406415ef38d9f0fbabd69735623008fd090043b3"
repository:
type: "git"
url: "https://github.com/aws/ota-for-aws-iot-embedded-sdk"
path: "libraries/aws/ota-for-aws-iot-embedded-sdk"
- name: "backoffAlgorithm"
version: "v1.3.0"
version: "f4b3fcfe92002a3a7609e511fd05361b9e812021"
repository:
type: "git"
url: "https://github.com/FreeRTOS/backoffAlgorithm"
path: "libraries/standard/backoffAlgorithm"
- name: "corePKCS11"
version: "v3.5.0"
version: "db05642c6c1f97055128f17c7962d7daf725d3c5"
repository:
type: "git"
url: "https://github.com/FreeRTOS/corePKCS11"
path: "libraries/standard/corePKCS11"
- name: "Fleet-Provisioning-for-AWS-IoT-embedded-sdk"
version: "v1.1.0"
version: "8ce2b28325efb917c2e357aed2361e3fa6162ecf"
repository:
type: "git"
url: "https://github.com/aws/Fleet-Provisioning-for-AWS-IoT-embedded-sdk"
path: "libraries/aws/fleet-provisioning-for-aws-iot-embedded-sdk"
- name: "sigv4-for-AWS-IoT-embedded-sdk"
version: "v1.2.0"
version: "df863270afba4de9d013ae62063b2bfd0aa89039"
repository:
type: "git"
url: "https://github.com/aws/SigV4-for-AWS-IoT-embedded-sdk"
Expand Down