[V2.3.0] Update changelog, version numbers and .md files for release (#291)

chinglee-iot · web-flow · commit a2459c631707 · 2024-06-07T17:18:53.000+08:00
* Update changelog for version v2.3.0
* Update version tag in .md files and manifest files
* Update version tag in source files
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog for coreMQTT Client Library
 
+## v2.3.0 (June 2024)
+
+### Changes
+
+- [#288](https://github.com/FreeRTOS/coreMQTT/pull/288) Fix time comparison overflow.
+
 ## v2.2.0 (April 2024)
 
 ### Changes
diff --git a/README.md b/README.md
@@ -87,18 +87,18 @@ Example
 
 - Actual_Username = “iotuser”, OS_Name = FreeRTOS, OS_Version = V10.4.3,
   Hardware_Platform_Name = WinSim, MQTT_Library_Name = coremqtt,
-  MQTT_Library_version = 2.2.0. If username is not used, then “iotuser” can be
+  MQTT_Library_version = 2.3.0. If username is not used, then “iotuser” can be
   removed.
 
 ```
 /* Username string:
- * iotuser?SDK=FreeRTOS&Version=v10.4.3&Platform=WinSim&MQTTLib=coremqtt@2.2.0
+ * iotuser?SDK=FreeRTOS&Version=v10.4.3&Platform=WinSim&MQTTLib=coremqtt@2.3.0
  */
 
 #define OS_NAME                   "FreeRTOS"
 #define OS_VERSION                "V10.4.3"
 #define HARDWARE_PLATFORM_NAME    "WinSim"
-#define MQTT_LIB                  "coremqtt@2.2.0"
+#define MQTT_LIB                  "coremqtt@2.3.0"
 
 #define USERNAME_STRING           "iotuser?SDK=" OS_NAME "&Version=" OS_VERSION "&Platform=" HARDWARE_PLATFORM_NAME "&MQTTLib=" MQTT_LIB
 #define USERNAME_STRING_LENGTH    ( ( uint16_t ) ( sizeof( USERNAME_STRING ) - 1 ) )
diff --git a/docs/doxygen/config.doxyfile b/docs/doxygen/config.doxyfile
@@ -48,7 +48,7 @@ PROJECT_NAME           = coreMQTT
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = v2.2.0
+PROJECT_NUMBER         = v2.3.0
 
 # 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/manifest.yml b/manifest.yml
@@ -1,5 +1,5 @@
 name : "coreMQTT"
-version: "v2.2.0"
+version: "v2.3.0"
 description: |
   "Client implementation of the MQTT 3.1.1 specification for embedded devices.\n"
 license: "MIT"
diff --git a/source/core_mqtt.c b/source/core_mqtt.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/source/core_mqtt_serializer.c b/source/core_mqtt_serializer.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/source/core_mqtt_state.c b/source/core_mqtt_state.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/source/include/core_mqtt.h b/source/include/core_mqtt.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/source/include/core_mqtt_config_defaults.h b/source/include/core_mqtt_config_defaults.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/source/include/core_mqtt_serializer.h b/source/include/core_mqtt_serializer.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/source/include/core_mqtt_state.h b/source/include/core_mqtt_state.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/source/interface/transport_interface.h b/source/interface/transport_interface.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -1,6 +1,6 @@
 cmake_minimum_required ( VERSION 3.22.0 )
 project ( "CoreMQTT tests"
-          VERSION 2.1.0
+          VERSION 2.3.0
           LANGUAGES C )
 
 # Allow the project to be organized into folders.
diff --git a/test/cbmc/include/core_mqtt_config.h b/test/cbmc/include/core_mqtt_config.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/include/event_callback_stub.h b/test/cbmc/include/event_callback_stub.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/include/get_time_stub.h b/test/cbmc/include/get_time_stub.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/include/mqtt_cbmc_state.h b/test/cbmc/include/mqtt_cbmc_state.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/include/network_interface_stubs.h b/test/cbmc/include/network_interface_stubs.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_Connect/MQTT_Connect_harness.c b/test/cbmc/proofs/MQTT_Connect/MQTT_Connect_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_DeserializeAck/MQTT_DeserializeAck_harness.c b/test/cbmc/proofs/MQTT_DeserializeAck/MQTT_DeserializeAck_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_DeserializePublish/MQTT_DeserializePublish_harness.c b/test/cbmc/proofs/MQTT_DeserializePublish/MQTT_DeserializePublish_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_Disconnect/MQTT_Disconnect_harness.c b/test/cbmc/proofs/MQTT_Disconnect/MQTT_Disconnect_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_GetIncomingPacketTypeAndLength/MQTT_GetIncomingPacketTypeAndLength_harness.c b/test/cbmc/proofs/MQTT_GetIncomingPacketTypeAndLength/MQTT_GetIncomingPacketTypeAndLength_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_GetPacketId/MQTT_GetPacketId_harness.c b/test/cbmc/proofs/MQTT_GetPacketId/MQTT_GetPacketId_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_GetSubAckStatusCodes/MQTT_GetSubAckStatusCodes_harness.c b/test/cbmc/proofs/MQTT_GetSubAckStatusCodes/MQTT_GetSubAckStatusCodes_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_Init/MQTT_Init_harness.c b/test/cbmc/proofs/MQTT_Init/MQTT_Init_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_MatchTopic/MQTT_MatchTopic_harness.c b/test/cbmc/proofs/MQTT_MatchTopic/MQTT_MatchTopic_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_Ping/MQTT_Ping_harness.c b/test/cbmc/proofs/MQTT_Ping/MQTT_Ping_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_ProcessLoop/MQTT_ProcessLoop_harness.c b/test/cbmc/proofs/MQTT_ProcessLoop/MQTT_ProcessLoop_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_Publish/MQTT_Publish_harness.c b/test/cbmc/proofs/MQTT_Publish/MQTT_Publish_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_ReceiveLoop/MQTT_ReceiveLoop_harness.c b/test/cbmc/proofs/MQTT_ReceiveLoop/MQTT_ReceiveLoop_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_SerializeAck/MQTT_SerializeAck_harness.c b/test/cbmc/proofs/MQTT_SerializeAck/MQTT_SerializeAck_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_SerializeConnect/MQTT_SerializeConnect_harness.c b/test/cbmc/proofs/MQTT_SerializeConnect/MQTT_SerializeConnect_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_SerializeDisconnect/MQTT_SerializeDisconnect_harness.c b/test/cbmc/proofs/MQTT_SerializeDisconnect/MQTT_SerializeDisconnect_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_SerializePingreq/MQTT_SerializePingreq_harness.c b/test/cbmc/proofs/MQTT_SerializePingreq/MQTT_SerializePingreq_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_SerializePublish/MQTT_SerializePublish_harness.c b/test/cbmc/proofs/MQTT_SerializePublish/MQTT_SerializePublish_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_SerializePublishHeader/MQTT_SerializePublishHeader_harness.c b/test/cbmc/proofs/MQTT_SerializePublishHeader/MQTT_SerializePublishHeader_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_SerializeSubscribe/MQTT_SerializeSubscribe_harness.c b/test/cbmc/proofs/MQTT_SerializeSubscribe/MQTT_SerializeSubscribe_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_SerializeUnsubscribe/MQTT_SerializeUnsubscribe_harness.c b/test/cbmc/proofs/MQTT_SerializeUnsubscribe/MQTT_SerializeUnsubscribe_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_Subscribe/MQTT_Subscribe_harness.c b/test/cbmc/proofs/MQTT_Subscribe/MQTT_Subscribe_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/proofs/MQTT_Unsubscribe/MQTT_Unsubscribe_harness.c b/test/cbmc/proofs/MQTT_Unsubscribe/MQTT_Unsubscribe_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/sources/mqtt_cbmc_state.c b/test/cbmc/sources/mqtt_cbmc_state.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/stubs/event_callback_stub.c b/test/cbmc/stubs/event_callback_stub.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/stubs/get_time_stub.c b/test/cbmc/stubs/get_time_stub.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/stubs/memmove.c b/test/cbmc/stubs/memmove.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/cbmc/stubs/network_interface_stubs.c b/test/cbmc/stubs/network_interface_stubs.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/unit-test/cmock_opaque_types.h b/test/unit-test/cmock_opaque_types.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/unit-test/core_mqtt_config.h b/test/unit-test/core_mqtt_config.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/unit-test/core_mqtt_serializer_utest.c b/test/unit-test/core_mqtt_serializer_utest.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/unit-test/core_mqtt_state_utest.c b/test/unit-test/core_mqtt_state_utest.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/unit-test/core_mqtt_utest.c b/test/unit-test/core_mqtt_utest.c
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/unit-test/logging/logging_levels.h b/test/unit-test/logging/logging_levels.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT
diff --git a/test/unit-test/logging/logging_stack.h b/test/unit-test/logging/logging_stack.h
@@ -1,5 +1,5 @@
 /*
- * coreMQTT v2.2.0
+ * coreMQTT v2.3.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * SPDX-License-Identifier: MIT

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * coreMQTT v2.2.0`
	`2`	`+ * coreMQTT v2.3.0`
`3`	`3`	`* Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.`
`4`	`4`	`*`
`5`	`5`	`* SPDX-License-Identifier: MIT`