From e31949069699bfa1d8be192b0f9d0dea3d9556a2 Mon Sep 17 00:00:00 2001 From: Archit Gupta Date: Thu, 22 Jul 2021 17:23:50 -0700 Subject: [PATCH 1/2] Release cleanup --- .github/workflows/ci.yml | 2 +- .github/workflows/memory_statistics.yml | 2 +- CHANGELOG.md | 5 +++++ README.md | 16 ++++++++++++++-- docs/doxygen/config.doxyfile | 2 +- .../include/{size_table.html => size_table.md} | 0 docs/doxygen/pages.dox | 2 +- lexicon.txt | 7 ++++--- manifest.yml | 2 +- source/defender.c | 2 +- source/include/defender.h | 14 +++++++++++++- .../Defender_GetTopic_harness.c | 2 +- .../Defender_MatchTopic_harness.c | 2 +- test/unit-test/defender_utest.c | 2 +- 14 files changed, 45 insertions(+), 15 deletions(-) rename docs/doxygen/include/{size_table.html => size_table.md} (100%) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d06b32a..0e97ad1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -98,4 +98,4 @@ jobs: uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main with: config: .github/memory_statistics_config.json - check_against: docs/doxygen/include/size_table.html + check_against: docs/doxygen/include/size_table.md diff --git a/.github/workflows/memory_statistics.yml b/.github/workflows/memory_statistics.yml index 499d205..9c778c7 100644 --- a/.github/workflows/memory_statistics.yml +++ b/.github/workflows/memory_statistics.yml @@ -19,4 +19,4 @@ jobs: uses: actions/upload-artifact@v2 with: name: size_table - path: size_table.html + path: size_table.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 5979b92..3b3bc0e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog for AWS IoT Device Defender Library +## v1.1.1 (July 2021) + +### Updates + - [#45](https://github.com/aws/Device-Defender-for-AWS-IoT-embedded-sdk/pull/45) Remove parenthesis from key name macros to enable concatinating them with other string literals. + ## v1.1.0 (March 2021) ### Updates diff --git a/README.md b/README.md index b30d47a..c5ed368 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Deviations from the MISRA C:2012 guidelines are documented under [MISRA Deviatio This library has also undergone static code analysis using [Coverity static analysis](https://scan.coverity.com/), and validation of memory safety through the [CBMC automated reasoning tool](https://www.cprover.org/cbmc/). -See memory requirements for this library [here](https://docs.aws.amazon.com/embedded-csdk/202103.00/lib-ref/libraries/aws/device-defender-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html#defender_memory_requirements). +See memory requirements for this library [here](./docs/doxygen/include/size_table.md). **AWS IoT Device Defender v1.1.0 [source code](https://github.com/aws/Device-Defender-for-AWS-IoT-embedded-sdk/tree/v1.1.0/source) is part of the [FreeRTOS 202012.01 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.01-LTS) release.** @@ -83,7 +83,19 @@ The AWS IoT Embedded C-SDK repository contains a demo showing the use of AWS IoT Device Defender Client Library [here](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/defender/defender_demo_json) on a POSIX platform. -## Generating documentation +## Documentation + +### Existing documentation +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) | +| [FreeRTOS.org](https://freertos.org/Documentation/api-ref/device-defender-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html) | + +Note that the latest included version of the AWS IoT Device Defender library may differ across repositories. + +### Generating documentation The Doxygen references were created using Doxygen version 1.8.20. To generate the Doxygen pages, please run the following command from the root of this repository: diff --git a/docs/doxygen/config.doxyfile b/docs/doxygen/config.doxyfile index e602ed2..e382b4f 100644 --- a/docs/doxygen/config.doxyfile +++ b/docs/doxygen/config.doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = "AWS IoT Device Defender" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = "v1.1.0" +PROJECT_NUMBER = "v1.1.1" # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/docs/doxygen/include/size_table.html b/docs/doxygen/include/size_table.md similarity index 100% rename from docs/doxygen/include/size_table.html rename to docs/doxygen/include/size_table.md diff --git a/docs/doxygen/pages.dox b/docs/doxygen/pages.dox index 622f112..f7dcad2 100644 --- a/docs/doxygen/pages.dox +++ b/docs/doxygen/pages.dox @@ -15,7 +15,7 @@ AWS IoT Device Defender lets you continuously monitor security metrics from devi @section defender_memory_requirements Memory Requirements @brief Memory requirements of the AWS IoT Device Defender Client Library. -@include{doc} size_table.html +@include{doc} size_table.md */ /** diff --git a/lexicon.txt b/lexicon.txt index af68ec2..dddc6b7 100644 --- a/lexicon.txt +++ b/lexicon.txt @@ -43,8 +43,8 @@ getdeviceserialnumber gettopic github hed -https html +https inc ingroup iot @@ -57,6 +57,7 @@ logwarn mainpage matchapi matchtopic +md mdash memcpy misra @@ -77,8 +78,8 @@ pre premainingtopic pthingname ptopic -remediate remainingtopiclength +remediate rm sdk strlen @@ -94,4 +95,4 @@ tr udp uint utest -xa \ No newline at end of file +xa diff --git a/manifest.yml b/manifest.yml index 6041311..fdcd4db 100644 --- a/manifest.yml +++ b/manifest.yml @@ -1,5 +1,5 @@ name : "Device-Defender-for-AWS-IoT-embedded-sdk" -version: "v1.1.0" +version: "v1.1.1" description: | "Client library for using the AWS IoT Device Defender service on embedded devices.\n" license: "MIT" diff --git a/source/defender.c b/source/defender.c index e241911..ab97521 100644 --- a/source/defender.c +++ b/source/defender.c @@ -1,5 +1,5 @@ /* - * AWS IoT Device Defender Client v1.1.0 + * AWS IoT Device Defender Client v1.1.1 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a copy of diff --git a/source/include/defender.h b/source/include/defender.h index 6f4e089..45a2f5f 100644 --- a/source/include/defender.h +++ b/source/include/defender.h @@ -1,5 +1,5 @@ /* - * AWS IoT Device Defender Client v1.1.0 + * AWS IoT Device Defender Client v1.1.1 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a copy of @@ -28,6 +28,12 @@ #ifndef DEFENDER_H_ #define DEFENDER_H_ +/* *INDENT-OFF* */ +#ifdef __cplusplus + extern "C" { +#endif +/* *INDENT-ON* */ + /* Standard includes. */ #include @@ -788,4 +794,10 @@ DefenderStatus_t Defender_MatchTopic( const char * pTopic, /*-----------------------------------------------------------*/ +/* *INDENT-OFF* */ +#ifdef __cplusplus + } +#endif +/* *INDENT-ON* */ + #endif /* DEFENDER_H_ */ diff --git a/test/cbmc/proofs/Defender_GetTopic/Defender_GetTopic_harness.c b/test/cbmc/proofs/Defender_GetTopic/Defender_GetTopic_harness.c index 8bafdb2..006b4e6 100644 --- a/test/cbmc/proofs/Defender_GetTopic/Defender_GetTopic_harness.c +++ b/test/cbmc/proofs/Defender_GetTopic/Defender_GetTopic_harness.c @@ -1,5 +1,5 @@ /* - * AWS IoT Device Defender Client v1.1.0 + * AWS IoT Device Defender Client v1.1.1 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a copy of diff --git a/test/cbmc/proofs/Defender_MatchTopic/Defender_MatchTopic_harness.c b/test/cbmc/proofs/Defender_MatchTopic/Defender_MatchTopic_harness.c index 1181120..173a7b2 100644 --- a/test/cbmc/proofs/Defender_MatchTopic/Defender_MatchTopic_harness.c +++ b/test/cbmc/proofs/Defender_MatchTopic/Defender_MatchTopic_harness.c @@ -1,5 +1,5 @@ /* - * AWS IoT Device Defender Client v1.1.0 + * AWS IoT Device Defender Client v1.1.1 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a copy of diff --git a/test/unit-test/defender_utest.c b/test/unit-test/defender_utest.c index 37caa7d..c934d60 100644 --- a/test/unit-test/defender_utest.c +++ b/test/unit-test/defender_utest.c @@ -1,5 +1,5 @@ /* - * AWS IoT Device Defender Client v1.1.0 + * AWS IoT Device Defender Client v1.1.1 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a copy of From 2a7a3b9c7599e9645fb0b19e75574125bb4d0abf Mon Sep 17 00:00:00 2001 From: Archit Gupta Date: Thu, 22 Jul 2021 17:46:50 -0700 Subject: [PATCH 2/2] Apply feedback --- CHANGELOG.md | 2 +- source/include/defender.h | 6 +++--- source/include/defender_config_defaults.h | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3b3bc0e..b701977 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ ## v1.1.1 (July 2021) ### Updates - - [#45](https://github.com/aws/Device-Defender-for-AWS-IoT-embedded-sdk/pull/45) Remove parenthesis from key name macros to enable concatinating them with other string literals. + - [#45](https://github.com/aws/Device-Defender-for-AWS-IoT-embedded-sdk/pull/45) Remove parentheses from key name macros to enable concatenating them with other string literals. ## v1.1.0 (March 2021) diff --git a/source/include/defender.h b/source/include/defender.h index 45a2f5f..c3c60bc 100644 --- a/source/include/defender.h +++ b/source/include/defender.h @@ -28,15 +28,15 @@ #ifndef DEFENDER_H_ #define DEFENDER_H_ +/* Standard includes. */ +#include + /* *INDENT-OFF* */ #ifdef __cplusplus extern "C" { #endif /* *INDENT-ON* */ -/* Standard includes. */ -#include - /* DEFENDER_DO_NOT_USE_CUSTOM_CONFIG allows building the Device Defender library * without a config file. If a config file is provided, DEFENDER_DO_NOT_USE_CUSTOM_CONFIG * macro must not be defined. diff --git a/source/include/defender_config_defaults.h b/source/include/defender_config_defaults.h index d2f2a0f..5ce1baf 100644 --- a/source/include/defender_config_defaults.h +++ b/source/include/defender_config_defaults.h @@ -1,5 +1,5 @@ /* - * AWS IoT Device Defender Client v1.1.0 + * AWS IoT Device Defender Client v1.1.1 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a copy of