Release cleanup (#48)

aws · Jul 23, 2021 · 8caa3de · 8caa3de
1 parent 77eaaf4
commit 8caa3de
Show file tree

Hide file tree

Showing 15 changed files with 46 additions and 16 deletions.
diff --git 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
@@ -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
@@ -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 parentheses from key name macros to enable concatenating them with other string literals.
+
 ## v1.1.0 (March 2021)
 
 ### Updates

diff --git 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
@@ -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 → docs/doxygen/include/size_table.md b/docs/doxygen/include/size_table.html → docs/doxygen/include/size_table.md
diff --git 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
@@ -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
+xa
diff --git 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
@@ -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
@@ -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
@@ -31,6 +31,12 @@
 /* Standard includes. */
 #include <stdint.h>
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    extern "C" {
+#endif
+/* *INDENT-ON* */
+
 /* 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.
@@ -788,4 +794,10 @@ DefenderStatus_t Defender_MatchTopic( const char * pTopic,
 
 /*-----------------------------------------------------------*/
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    }
+#endif
+/* *INDENT-ON* */
+
 #endif /* DEFENDER_H_ */
diff --git 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

diff --git 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
@@ -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
@@ -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