Skip to content

Commit 51c8067

Browse files
Update version and add C++ guards (#168)
* Update version numbers * Update CHANGELOG.md * Add guards for C++ linkage * Link to Memory estimates markdown from README * Make possible to override CMake C Standard for tests
1 parent a108af5 commit 51c8067

File tree

57 files changed

+138
-59
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+138
-59
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,4 +115,4 @@ jobs:
115115
uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main
116116
with:
117117
config: .github/memory_statistics_config.json
118-
check_against: docs/doxygen/include/size_table.html
118+
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: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Changelog for coreMQTT Client Library
22

3-
## Commits to `main`
3+
## v1.1.2 (July 2021)
44

55
### Updates
6+
- [#168](https://github.com/FreeRTOS/coreMQTT/pull/168) Add header guards for C++ linkage.
67
- [#163](https://github.com/FreeRTOS/coreMQTT/pull/163) Fix bug to check for ping responses within `MQTT_PINGRESP_TIMEOUT_MS` instead of the entire keep alive interval.
78
- [#159](https://github.com/FreeRTOS/coreMQTT/pull/159) Add more checks for malformed packets when deserializing acknowledgments.
89

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This repository contains the coreMQTT library that has been optimized for a low
44

55
This library has gone through code quality checks including verification that no function has a [GNU Complexity](https://www.gnu.org/software/complexity/manual/complexity.html) score over 8, and checks against deviations from mandatory rules in the [MISRA coding standard](https://www.misra.org.uk). Deviations from the MISRA C:2012 guidelines are documented under [MISRA Deviations](MISRA.md). This library has also undergone both static code analysis from [Coverity static analysis](https://scan.coverity.com/), and validation of memory safety through the [CBMC automated reasoning tool](https://www.cprover.org/cbmc/).
66

7-
See memory requirements for this library [here](https://docs.aws.amazon.com/embedded-csdk/202103.00/lib-ref/libraries/standard/coreMQTT/docs/doxygen/output/html/index.html#mqtt_memory_requirements).
7+
See memory requirements for this library [here](./docs/doxygen/include/size_table.md).
88

99
**coreMQTT v1.1.0 [source code](https://github.com/FreeRTOS/coreMQTT/tree/v1.1.0/source) is part of the [FreeRTOS 202012.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.00-LTS) release.**
1010

@@ -120,7 +120,20 @@ Please refer to the demos of the MQTT client library in the following locations
120120
| FreeRTOS | [FreeRTOS AWS Reference Integrations](https://github.com/aws/amazon-freertos/tree/master/demos/coreMQTT) | Based on Secure Sockets Abstraction |
121121

122122

123-
## Generating documentation
123+
## Documentation
124+
125+
### Existing Documentation
126+
127+
For pre-generated documentation, please see the documentation linked in the locations below:
128+
129+
| Location |
130+
| :-: |
131+
| [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) |
132+
| [FreeRTOS.org](https://freertos.org/Documentation/api-ref/coreMQTT/docs/doxygen/output/html/index.html) |
133+
134+
Note that the latest included version of coreMQTT may differ across repositories.
135+
136+
### Generating Documentation
124137

125138
The Doxygen references were created using Doxygen version 1.8.20. To generate the
126139
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 = "coreMQTT"
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = "v1.1.1"
41+
PROJECT_NUMBER = "v1.1.2"
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
File renamed without changes.

docs/doxygen/pages.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Please see https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/
1616
@section mqtt_memory_requirements Memory Requirements
1717
@brief Memory requirements of the MQTT library.
1818

19-
@include{doc} size_table.html
19+
@include{doc} size_table.md
2020
*/
2121

2222
/**

lexicon.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ mainpage
129129
malloc
130130
managekeepalive
131131
matchtopic
132+
md
132133
mdash
133134
memcpy
134135
memset

manifest.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name : "coreMQTT"
2-
version: "v1.1.1"
2+
version: "v1.1.2"
33
description: |
44
"Client implementation of the MQTT 3.1.1 specification for embedded devices.\n"
55
license: "MIT"

source/core_mqtt.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* coreMQTT v1.1.1
2+
* coreMQTT v1.1.2
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)