Skip to content

Commit 8caa3de

Browse files
archiguparchigup
authored
Release cleanup (#48)
1 parent 77eaaf4 commit 8caa3de

File tree

15 files changed

+46
-16
lines changed

15 files changed

+46
-16
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,4 @@ jobs:
9898
uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main
9999
with:
100100
config: .github/memory_statistics_config.json
101-
check_against: docs/doxygen/include/size_table.html
101+
check_against: docs/doxygen/include/size_table.md

‎.github/workflows/memory_statistics.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ jobs:
1919
uses: actions/upload-artifact@v2
2020
with:
2121
name: size_table
22-
path: size_table.html
22+
path: size_table.md

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog for AWS IoT Device Defender Library
22

3+
## v1.1.1 (July 2021)
4+
5+
### Updates
6+
- [#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.
7+
38
## v1.1.0 (March 2021)
49

510
### Updates

‎README.md‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Deviations from the MISRA C:2012 guidelines are documented under [MISRA Deviatio
1414
This library has also undergone static code analysis using [Coverity static analysis](https://scan.coverity.com/),
1515
and validation of memory safety through the [CBMC automated reasoning tool](https://www.cprover.org/cbmc/).
1616

17-
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).
17+
See memory requirements for this library [here](./docs/doxygen/include/size_table.md).
1818

1919
**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.**
2020

@@ -83,7 +83,19 @@ The AWS IoT Embedded C-SDK repository contains a demo showing the use of AWS IoT
8383
Device Defender Client Library [here](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/defender/defender_demo_json)
8484
on a POSIX platform.
8585

86-
## Generating documentation
86+
## Documentation
87+
88+
### Existing documentation
89+
For pre-generated documentation, please see the documentation linked in the locations below:
90+
91+
| Location |
92+
| :-: |
93+
| [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) |
94+
| [FreeRTOS.org](https://freertos.org/Documentation/api-ref/device-defender-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html) |
95+
96+
Note that the latest included version of the AWS IoT Device Defender library may differ across repositories.
97+
98+
### Generating documentation
8799

88100
The Doxygen references were created using Doxygen version 1.8.20. To generate the
89101
Doxygen pages, please run the following command from the root of this repository:

‎docs/doxygen/config.doxyfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = "AWS IoT Device Defender"
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = "v1.1.0"
41+
PROJECT_NUMBER = "v1.1.1"
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

‎docs/doxygen/include/size_table.html‎ renamed to ‎docs/doxygen/include/size_table.md‎

File renamed without changes.

‎docs/doxygen/pages.dox‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ AWS IoT Device Defender lets you continuously monitor security metrics from devi
1515
@section defender_memory_requirements Memory Requirements
1616
@brief Memory requirements of the AWS IoT Device Defender Client Library.
1717

18-
@include{doc} size_table.html
18+
@include{doc} size_table.md
1919
*/
2020

2121
/**

‎lexicon.txt‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ getdeviceserialnumber
4343
gettopic
4444
github
4545
hed
46-
https
4746
html
47+
https
4848
inc
4949
ingroup
5050
iot
@@ -57,6 +57,7 @@ logwarn
5757
mainpage
5858
matchapi
5959
matchtopic
60+
md
6061
mdash
6162
memcpy
6263
misra
@@ -77,8 +78,8 @@ pre
7778
premainingtopic
7879
pthingname
7980
ptopic
80-
remediate
8181
remainingtopiclength
82+
remediate
8283
rm
8384
sdk
8485
strlen
@@ -94,4 +95,4 @@ tr
9495
udp
9596
uint
9697
utest
97-
xa
98+
xa

‎manifest.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name : "Device-Defender-for-AWS-IoT-embedded-sdk"
2-
version: "v1.1.0"
2+
version: "v1.1.1"
33
description: |
44
"Client library for using the AWS IoT Device Defender service on embedded devices.\n"
55
license: "MIT"

‎source/defender.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* AWS IoT Device Defender Client v1.1.0
2+
* AWS IoT Device Defender Client v1.1.1
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of

0 commit comments

Comments
 (0)