From a8896a43939404913dcd5b7e575f164db3c448e5 Mon Sep 17 00:00:00 2001 From: Muneeb Ahmed Date: Thu, 22 Jul 2021 10:55:30 -0700 Subject: [PATCH 01/12] Update version numbers --- docs/doxygen/config.doxyfile | 2 +- manifest.yml | 2 +- source/core_mqtt.c | 2 +- source/core_mqtt_serializer.c | 2 +- source/core_mqtt_state.c | 2 +- source/include/core_mqtt.h | 4 ++-- source/include/core_mqtt_config_defaults.h | 2 +- source/include/core_mqtt_serializer.h | 2 +- source/include/core_mqtt_state.h | 2 +- source/interface/transport_interface.h | 2 +- test/cbmc/include/core_mqtt_config.h | 2 +- test/cbmc/include/event_callback_stub.h | 2 +- test/cbmc/include/get_time_stub.h | 2 +- test/cbmc/include/mqtt_cbmc_state.h | 2 +- test/cbmc/include/network_interface_stubs.h | 2 +- test/cbmc/proofs/MQTT_Connect/MQTT_Connect_harness.c | 2 +- .../proofs/MQTT_DeserializeAck/MQTT_DeserializeAck_harness.c | 2 +- .../MQTT_DeserializePublish/MQTT_DeserializePublish_harness.c | 2 +- test/cbmc/proofs/MQTT_Disconnect/MQTT_Disconnect_harness.c | 2 +- .../MQTT_GetIncomingPacketTypeAndLength_harness.c | 2 +- test/cbmc/proofs/MQTT_GetPacketId/MQTT_GetPacketId_harness.c | 2 +- .../MQTT_GetSubAckStatusCodes_harness.c | 2 +- test/cbmc/proofs/MQTT_Init/MQTT_Init_harness.c | 2 +- test/cbmc/proofs/MQTT_MatchTopic/MQTT_MatchTopic_harness.c | 2 +- test/cbmc/proofs/MQTT_Ping/MQTT_Ping_harness.c | 2 +- test/cbmc/proofs/MQTT_ProcessLoop/MQTT_ProcessLoop_harness.c | 2 +- test/cbmc/proofs/MQTT_Publish/MQTT_Publish_harness.c | 2 +- test/cbmc/proofs/MQTT_ReceiveLoop/MQTT_ReceiveLoop_harness.c | 2 +- .../cbmc/proofs/MQTT_SerializeAck/MQTT_SerializeAck_harness.c | 2 +- .../MQTT_SerializeConnect/MQTT_SerializeConnect_harness.c | 2 +- .../MQTT_SerializeDisconnect_harness.c | 2 +- .../MQTT_SerializePingreq/MQTT_SerializePingreq_harness.c | 2 +- .../MQTT_SerializePublish/MQTT_SerializePublish_harness.c | 2 +- .../MQTT_SerializePublishHeader_harness.c | 2 +- .../MQTT_SerializeSubscribe/MQTT_SerializeSubscribe_harness.c | 2 +- .../MQTT_SerializeUnsubscribe_harness.c | 2 +- test/cbmc/proofs/MQTT_Subscribe/MQTT_Subscribe_harness.c | 2 +- test/cbmc/proofs/MQTT_Unsubscribe/MQTT_Unsubscribe_harness.c | 2 +- test/cbmc/sources/mqtt_cbmc_state.c | 2 +- test/cbmc/stubs/event_callback_stub.c | 2 +- test/cbmc/stubs/get_time_stub.c | 2 +- test/cbmc/stubs/memcpy.c | 2 +- test/cbmc/stubs/network_interface_stubs.c | 2 +- test/unit-test/core_mqtt_config.h | 2 +- test/unit-test/core_mqtt_serializer_utest.c | 2 +- test/unit-test/core_mqtt_state_utest.c | 2 +- test/unit-test/core_mqtt_utest.c | 2 +- test/unit-test/logging/logging_levels.h | 2 +- test/unit-test/logging/logging_stack.h | 2 +- 49 files changed, 50 insertions(+), 50 deletions(-) diff --git a/docs/doxygen/config.doxyfile b/docs/doxygen/config.doxyfile index 66fc6c618..f6858509b 100644 --- a/docs/doxygen/config.doxyfile +++ b/docs/doxygen/config.doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = "coreMQTT" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = "v1.1.1" +PROJECT_NUMBER = "v1.1.2" # 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 index d827f6981..2fe7df7e5 100644 --- a/manifest.yml +++ b/manifest.yml @@ -1,5 +1,5 @@ name : "coreMQTT" -version: "v1.1.1" +version: "v1.1.2" 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 index ff42635c8..aab4175d1 100644 --- a/source/core_mqtt.c +++ b/source/core_mqtt.c @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/core_mqtt_serializer.c b/source/core_mqtt_serializer.c index ad598cc06..7519180fd 100644 --- a/source/core_mqtt_serializer.c +++ b/source/core_mqtt_serializer.c @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/core_mqtt_state.c b/source/core_mqtt_state.c index cc6b34342..355e6a84d 100644 --- a/source/core_mqtt_state.c +++ b/source/core_mqtt_state.c @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/core_mqtt.h b/source/include/core_mqtt.h index bd97bbcdc..dbe3e778e 100644 --- a/source/include/core_mqtt.h +++ b/source/include/core_mqtt.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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 @@ -49,7 +49,7 @@ * @cond DOXYGEN_IGNORE * The current version of this library. */ -#define MQTT_LIBRARY_VERSION "v1.1.1" +#define MQTT_LIBRARY_VERSION "v1.1.2" /** @endcond */ /** diff --git a/source/include/core_mqtt_config_defaults.h b/source/include/core_mqtt_config_defaults.h index 2ca1e490d..c7ad51b93 100644 --- a/source/include/core_mqtt_config_defaults.h +++ b/source/include/core_mqtt_config_defaults.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/core_mqtt_serializer.h b/source/include/core_mqtt_serializer.h index cca178724..71c2af4ef 100644 --- a/source/include/core_mqtt_serializer.h +++ b/source/include/core_mqtt_serializer.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/core_mqtt_state.h b/source/include/core_mqtt_state.h index 1bc7fde60..e5fb248bc 100644 --- a/source/include/core_mqtt_state.h +++ b/source/include/core_mqtt_state.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/interface/transport_interface.h b/source/interface/transport_interface.h index 9b3b23868..b1d179c60 100644 --- a/source/interface/transport_interface.h +++ b/source/interface/transport_interface.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/include/core_mqtt_config.h b/test/cbmc/include/core_mqtt_config.h index b69918c84..b7da4a14e 100644 --- a/test/cbmc/include/core_mqtt_config.h +++ b/test/cbmc/include/core_mqtt_config.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/include/event_callback_stub.h b/test/cbmc/include/event_callback_stub.h index 7aa874add..3f5aaf88b 100644 --- a/test/cbmc/include/event_callback_stub.h +++ b/test/cbmc/include/event_callback_stub.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/include/get_time_stub.h b/test/cbmc/include/get_time_stub.h index c1692bdbf..bc383cf3c 100644 --- a/test/cbmc/include/get_time_stub.h +++ b/test/cbmc/include/get_time_stub.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/include/mqtt_cbmc_state.h b/test/cbmc/include/mqtt_cbmc_state.h index c65fcc7c5..379935186 100644 --- a/test/cbmc/include/mqtt_cbmc_state.h +++ b/test/cbmc/include/mqtt_cbmc_state.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/include/network_interface_stubs.h b/test/cbmc/include/network_interface_stubs.h index 01776a283..518b2045e 100644 --- a/test/cbmc/include/network_interface_stubs.h +++ b/test/cbmc/include/network_interface_stubs.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_Connect/MQTT_Connect_harness.c b/test/cbmc/proofs/MQTT_Connect/MQTT_Connect_harness.c index f0c6a1079..59ac9d3f6 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_DeserializeAck/MQTT_DeserializeAck_harness.c b/test/cbmc/proofs/MQTT_DeserializeAck/MQTT_DeserializeAck_harness.c index 157c2b78e..31f5caaa4 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_DeserializePublish/MQTT_DeserializePublish_harness.c b/test/cbmc/proofs/MQTT_DeserializePublish/MQTT_DeserializePublish_harness.c index 29a71fe1d..ade8ae93f 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_Disconnect/MQTT_Disconnect_harness.c b/test/cbmc/proofs/MQTT_Disconnect/MQTT_Disconnect_harness.c index f1ab24386..443d2297c 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_GetIncomingPacketTypeAndLength/MQTT_GetIncomingPacketTypeAndLength_harness.c b/test/cbmc/proofs/MQTT_GetIncomingPacketTypeAndLength/MQTT_GetIncomingPacketTypeAndLength_harness.c index 868b4d457..ec0648a4a 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_GetPacketId/MQTT_GetPacketId_harness.c b/test/cbmc/proofs/MQTT_GetPacketId/MQTT_GetPacketId_harness.c index 6cdcfe013..780b98a0b 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_GetSubAckStatusCodes/MQTT_GetSubAckStatusCodes_harness.c b/test/cbmc/proofs/MQTT_GetSubAckStatusCodes/MQTT_GetSubAckStatusCodes_harness.c index 1c48a3f81..931bef463 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_Init/MQTT_Init_harness.c b/test/cbmc/proofs/MQTT_Init/MQTT_Init_harness.c index 53bcbbbe8..2ec5736a0 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_MatchTopic/MQTT_MatchTopic_harness.c b/test/cbmc/proofs/MQTT_MatchTopic/MQTT_MatchTopic_harness.c index 2f9629e4e..72d941f95 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_Ping/MQTT_Ping_harness.c b/test/cbmc/proofs/MQTT_Ping/MQTT_Ping_harness.c index 4149162a4..a78b26a38 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_ProcessLoop/MQTT_ProcessLoop_harness.c b/test/cbmc/proofs/MQTT_ProcessLoop/MQTT_ProcessLoop_harness.c index 55d715e20..c5fd482d9 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_Publish/MQTT_Publish_harness.c b/test/cbmc/proofs/MQTT_Publish/MQTT_Publish_harness.c index d96dd3d8c..9f76a0ed8 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_ReceiveLoop/MQTT_ReceiveLoop_harness.c b/test/cbmc/proofs/MQTT_ReceiveLoop/MQTT_ReceiveLoop_harness.c index 625c86bf3..9a55caa37 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_SerializeAck/MQTT_SerializeAck_harness.c b/test/cbmc/proofs/MQTT_SerializeAck/MQTT_SerializeAck_harness.c index 588fed13d..28c59ca23 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_SerializeConnect/MQTT_SerializeConnect_harness.c b/test/cbmc/proofs/MQTT_SerializeConnect/MQTT_SerializeConnect_harness.c index 2090074a7..1f97250a2 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_SerializeDisconnect/MQTT_SerializeDisconnect_harness.c b/test/cbmc/proofs/MQTT_SerializeDisconnect/MQTT_SerializeDisconnect_harness.c index bab6f3420..6efaec368 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_SerializePingreq/MQTT_SerializePingreq_harness.c b/test/cbmc/proofs/MQTT_SerializePingreq/MQTT_SerializePingreq_harness.c index db525946f..fca43f6e4 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_SerializePublish/MQTT_SerializePublish_harness.c b/test/cbmc/proofs/MQTT_SerializePublish/MQTT_SerializePublish_harness.c index 632116cd8..a12cbc027 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_SerializePublishHeader/MQTT_SerializePublishHeader_harness.c b/test/cbmc/proofs/MQTT_SerializePublishHeader/MQTT_SerializePublishHeader_harness.c index cf8470528..e71c5bf00 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_SerializeSubscribe/MQTT_SerializeSubscribe_harness.c b/test/cbmc/proofs/MQTT_SerializeSubscribe/MQTT_SerializeSubscribe_harness.c index 9913278b8..e204d5a0f 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_SerializeUnsubscribe/MQTT_SerializeUnsubscribe_harness.c b/test/cbmc/proofs/MQTT_SerializeUnsubscribe/MQTT_SerializeUnsubscribe_harness.c index ef4f7476c..0f25b6ee1 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_Subscribe/MQTT_Subscribe_harness.c b/test/cbmc/proofs/MQTT_Subscribe/MQTT_Subscribe_harness.c index 990fc72f7..010f55f0f 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/MQTT_Unsubscribe/MQTT_Unsubscribe_harness.c b/test/cbmc/proofs/MQTT_Unsubscribe/MQTT_Unsubscribe_harness.c index 82d2f6b9b..3454e9c0d 100644 --- 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 v1.1.1 + * coreMQTT v1.1.2 * 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/sources/mqtt_cbmc_state.c b/test/cbmc/sources/mqtt_cbmc_state.c index d4dfc044f..24c71335c 100644 --- a/test/cbmc/sources/mqtt_cbmc_state.c +++ b/test/cbmc/sources/mqtt_cbmc_state.c @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/stubs/event_callback_stub.c b/test/cbmc/stubs/event_callback_stub.c index e1a7e38e4..9fa0c780d 100644 --- a/test/cbmc/stubs/event_callback_stub.c +++ b/test/cbmc/stubs/event_callback_stub.c @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/stubs/get_time_stub.c b/test/cbmc/stubs/get_time_stub.c index 8128cef3e..cbf2aafdd 100644 --- a/test/cbmc/stubs/get_time_stub.c +++ b/test/cbmc/stubs/get_time_stub.c @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/stubs/memcpy.c b/test/cbmc/stubs/memcpy.c index 7c07937ab..c361a1d16 100644 --- a/test/cbmc/stubs/memcpy.c +++ b/test/cbmc/stubs/memcpy.c @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/stubs/network_interface_stubs.c b/test/cbmc/stubs/network_interface_stubs.c index 652d8e864..fefda64db 100644 --- a/test/cbmc/stubs/network_interface_stubs.c +++ b/test/cbmc/stubs/network_interface_stubs.c @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/core_mqtt_config.h b/test/unit-test/core_mqtt_config.h index d6fc2d868..7a16df51d 100644 --- a/test/unit-test/core_mqtt_config.h +++ b/test/unit-test/core_mqtt_config.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/core_mqtt_serializer_utest.c b/test/unit-test/core_mqtt_serializer_utest.c index 9cdb68e2f..f41454cd7 100644 --- a/test/unit-test/core_mqtt_serializer_utest.c +++ b/test/unit-test/core_mqtt_serializer_utest.c @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/core_mqtt_state_utest.c b/test/unit-test/core_mqtt_state_utest.c index 8a8779f90..f5fe7bc4b 100644 --- a/test/unit-test/core_mqtt_state_utest.c +++ b/test/unit-test/core_mqtt_state_utest.c @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/core_mqtt_utest.c b/test/unit-test/core_mqtt_utest.c index 1b6b4524d..eebc69e4d 100644 --- a/test/unit-test/core_mqtt_utest.c +++ b/test/unit-test/core_mqtt_utest.c @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/logging/logging_levels.h b/test/unit-test/logging/logging_levels.h index 8ca7114ee..996ad13e1 100644 --- a/test/unit-test/logging/logging_levels.h +++ b/test/unit-test/logging/logging_levels.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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/logging/logging_stack.h b/test/unit-test/logging/logging_stack.h index a36c861f6..5f04f3cd4 100644 --- a/test/unit-test/logging/logging_stack.h +++ b/test/unit-test/logging/logging_stack.h @@ -1,5 +1,5 @@ /* - * coreMQTT v1.1.1 + * coreMQTT v1.1.2 * 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 7f8501580d66d35c5840ac3eb3ed32f5635b94b4 Mon Sep 17 00:00:00 2001 From: Muneeb Ahmed Date: Thu, 22 Jul 2021 10:56:23 -0700 Subject: [PATCH 02/12] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6dabc35d2..b9fb2d1ad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog for coreMQTT Client Library -## Commits to `main` +## v1.1.2 (July 2021) ### Updates - [#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. From fbf8111b1e40dfa1d324b5f16e770a35363280cc Mon Sep 17 00:00:00 2001 From: Muneeb Ahmed Date: Thu, 22 Jul 2021 11:13:05 -0700 Subject: [PATCH 03/12] Add guards for C++ linkage --- source/include/core_mqtt.h | 12 ++++++++++++ source/include/core_mqtt_serializer.h | 12 ++++++++++++ source/include/core_mqtt_state.h | 12 ++++++++++++ source/interface/transport_interface.h | 12 ++++++++++++ 4 files changed, 48 insertions(+) diff --git a/source/include/core_mqtt.h b/source/include/core_mqtt.h index dbe3e778e..553449b0d 100644 --- a/source/include/core_mqtt.h +++ b/source/include/core_mqtt.h @@ -27,6 +27,12 @@ #ifndef CORE_MQTT_H #define CORE_MQTT_H +/* *INDENT-OFF* */ +#ifdef __cplusplus +extern "C" { +#endif +/* *INDENT-ON* */ + /* MQTT_DO_NOT_USE_CUSTOM_CONFIG allows building the MQTT library * without a custom config. If a custom config is provided, the * MQTT_DO_NOT_USE_CUSTOM_CONFIG macro should not be defined. */ @@ -887,4 +893,10 @@ MQTTStatus_t MQTT_GetSubAckStatusCodes( const MQTTPacketInfo_t * pSubackPacket, const char * MQTT_Status_strerror( MQTTStatus_t status ); /* @[declare_mqtt_status_strerror] */ +/* *INDENT-OFF* */ +#ifdef __cplusplus +} +#endif +/* *INDENT-ON* */ + #endif /* ifndef CORE_MQTT_H */ diff --git a/source/include/core_mqtt_serializer.h b/source/include/core_mqtt_serializer.h index 71c2af4ef..e32776df8 100644 --- a/source/include/core_mqtt_serializer.h +++ b/source/include/core_mqtt_serializer.h @@ -34,6 +34,12 @@ #include #include +/* *INDENT-OFF* */ +#ifdef __cplusplus +extern "C" { +#endif +/* *INDENT-ON */ + /* MQTT_DO_NOT_USE_CUSTOM_CONFIG allows building the MQTT library * without a custom config. If a custom config is provided, the * MQTT_DO_NOT_USE_CUSTOM_CONFIG macro should not be defined. */ @@ -1171,4 +1177,10 @@ MQTTStatus_t MQTT_GetIncomingPacketTypeAndLength( TransportRecv_t readFunc, MQTTPacketInfo_t * pIncomingPacket ); /* @[declare_mqtt_getincomingpackettypeandlength] */ +/* *INDENT-OFF* */ +#ifdef __cplusplus +} +#endif +/* *INDENT-ON* */ + #endif /* ifndef CORE_MQTT_SERIALIZER_H */ diff --git a/source/include/core_mqtt_state.h b/source/include/core_mqtt_state.h index e5fb248bc..fa206baa3 100644 --- a/source/include/core_mqtt_state.h +++ b/source/include/core_mqtt_state.h @@ -27,6 +27,12 @@ #ifndef CORE_MQTT_STATE_H #define CORE_MQTT_STATE_H +/* *INDENT-OFF* */ +#ifdef __cplusplus +extern "C" { +#endif +/* *INDENT-ON* */ + #include "core_mqtt.h" /** @@ -275,4 +281,10 @@ uint16_t MQTT_PublishToResend( const MQTTContext_t * pMqttContext, const char * MQTT_State_strerror( MQTTPublishState_t state ); /** @endcond */ +/* *INDENT-OFF* */ +#ifdef __cplusplus +} +#endif +/* *INDENT-ON* */ + #endif /* ifndef CORE_MQTT_STATE_H */ diff --git a/source/interface/transport_interface.h b/source/interface/transport_interface.h index b1d179c60..eb48f4cfa 100644 --- a/source/interface/transport_interface.h +++ b/source/interface/transport_interface.h @@ -28,6 +28,12 @@ #ifndef TRANSPORT_INTERFACE_H_ #define TRANSPORT_INTERFACE_H_ +/* *INDENT-OFF* */ +#ifdef __cplusplus +extern "C" { +#endif +/* *INDENT-ON* */ + #include #include @@ -250,4 +256,10 @@ typedef struct TransportInterface } TransportInterface_t; /* @[define_transportinterface] */ +/* *INDENT-OFF* */ +#ifdef __cplusplus +} +#endif +/* *INDENT-ON* */ + #endif /* ifndef TRANSPORT_INTERFACE_H_ */ From b676038da3a7654ba2e9fa9b47621e87013a88e7 Mon Sep 17 00:00:00 2001 From: Muneeb Ahmed Date: Thu, 22 Jul 2021 11:28:17 -0700 Subject: [PATCH 04/12] Add Memory estimates markdown --- README.md | 9 ++++++++- docs/MEMORY_ESTIMATES.md | 41 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 docs/MEMORY_ESTIMATES.md diff --git a/README.md b/README.md index 6f76b2384..eb065b9c4 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repository contains the coreMQTT library that has been optimized for a low 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/). -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). +See memory requirements for this library [here](./docs/MEMORY_ESTIMATES.md). **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.** @@ -122,6 +122,13 @@ Please refer to the demos of the MQTT client library in the following locations ## Generating documentation +Note: For pre-generated documentation, please see the documentation linked in the above repositories: + +| 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/coreMQTT/docs/doxygen/output/html/index.html) | + 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/MEMORY_ESTIMATES.md b/docs/MEMORY_ESTIMATES.md new file mode 100644 index 000000000..16664af4e --- /dev/null +++ b/docs/MEMORY_ESTIMATES.md @@ -0,0 +1,41 @@ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Code Size of coreMQTT (example generated with GCC for ARM Cortex-M)
File +With -O1 Optimization +With -Os Optimization
core_mqtt.c3.0K2.6K
core_mqtt_state.c1.4K1.1K
core_mqtt_serializer.c2.5K2.0K
Total estimates +6.9K +5.7K
From ede2d62576478ed776e23c0b1fcdf8bf5b781d7e Mon Sep 17 00:00:00 2001 From: Muneeb Ahmed Date: Thu, 22 Jul 2021 11:34:23 -0700 Subject: [PATCH 05/12] Make MEMORY_ESTIMATES.md identical --- docs/MEMORY_ESTIMATES.md | 67 +++++++++++++++++----------------------- 1 file changed, 28 insertions(+), 39 deletions(-) diff --git a/docs/MEMORY_ESTIMATES.md b/docs/MEMORY_ESTIMATES.md index 16664af4e..e86dfbc50 100644 --- a/docs/MEMORY_ESTIMATES.md +++ b/docs/MEMORY_ESTIMATES.md @@ -1,41 +1,30 @@ ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Code Size of coreMQTT (example generated with GCC for ARM Cortex-M)
File -With -O1 Optimization -With -Os Optimization
core_mqtt.c3.0K2.6K
core_mqtt_state.c1.4K1.1K
core_mqtt_serializer.c2.5K2.0K
Total estimates -6.9K -5.7K
Code Size of coreMQTT (example generated with GCC for ARM Cortex-M)
File
With -O1 Optimization
With -Os Optimization
core_mqtt.c
3.0K
2.6K
core_mqtt_state.c
1.4K
1.1K
core_mqtt_serializer.c
2.5K
2.0K
Total estimates
6.9K
5.7K
From 632504090a38d6259a9a51161a8dce05cb2545b5 Mon Sep 17 00:00:00 2001 From: Muneeb Ahmed Date: Thu, 22 Jul 2021 11:38:00 -0700 Subject: [PATCH 06/12] Use only one size table --- .github/workflows/ci.yml | 2 +- .github/workflows/memory_statistics.yml | 2 +- README.md | 2 +- docs/doxygen/include/size_table.html | 30 ------------------- .../include/size_table.md} | 0 docs/doxygen/pages.dox | 2 +- lexicon.txt | 1 + 7 files changed, 5 insertions(+), 34 deletions(-) delete mode 100644 docs/doxygen/include/size_table.html rename docs/{MEMORY_ESTIMATES.md => doxygen/include/size_table.md} (100%) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6ad858fdd..af276bf71 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -115,4 +115,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 499d205bd..9c778c763 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/README.md b/README.md index eb065b9c4..9864bbc9e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repository contains the coreMQTT library that has been optimized for a low 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/). -See memory requirements for this library [here](./docs/MEMORY_ESTIMATES.md). +See memory requirements for this library [here](./docs/doxygen/include/size_table.md). **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.** diff --git a/docs/doxygen/include/size_table.html b/docs/doxygen/include/size_table.html deleted file mode 100644 index e86dfbc50..000000000 --- a/docs/doxygen/include/size_table.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Code Size of coreMQTT (example generated with GCC for ARM Cortex-M)
File
With -O1 Optimization
With -Os Optimization
core_mqtt.c
3.0K
2.6K
core_mqtt_state.c
1.4K
1.1K
core_mqtt_serializer.c
2.5K
2.0K
Total estimates
6.9K
5.7K
diff --git a/docs/MEMORY_ESTIMATES.md b/docs/doxygen/include/size_table.md similarity index 100% rename from docs/MEMORY_ESTIMATES.md rename to docs/doxygen/include/size_table.md diff --git a/docs/doxygen/pages.dox b/docs/doxygen/pages.dox index 0ed80d5aa..03f508b1d 100644 --- a/docs/doxygen/pages.dox +++ b/docs/doxygen/pages.dox @@ -16,7 +16,7 @@ Please see https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/ @section mqtt_memory_requirements Memory Requirements @brief Memory requirements of the MQTT library. -@include{doc} size_table.html +@include{doc} size_table.md */ /** diff --git a/lexicon.txt b/lexicon.txt index 1908f6d0a..74901c9ba 100644 --- a/lexicon.txt +++ b/lexicon.txt @@ -129,6 +129,7 @@ mainpage malloc managekeepalive matchtopic +md mdash memcpy memset From f62a622ec84792bada4bb3a7d4e847f8cdf100be Mon Sep 17 00:00:00 2001 From: Muneeb Ahmed Date: Thu, 22 Jul 2021 12:03:43 -0700 Subject: [PATCH 07/12] Address review comments --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9864bbc9e..38f2c4bcb 100644 --- a/README.md +++ b/README.md @@ -120,15 +120,21 @@ Please refer to the demos of the MQTT client library in the following locations | FreeRTOS | [FreeRTOS AWS Reference Integrations](https://github.com/aws/amazon-freertos/tree/master/demos/coreMQTT) | Based on Secure Sockets Abstraction | -## Generating documentation +## Documentation -Note: For pre-generated documentation, please see the documentation linked in the above repositories: +### Existing Documentation + +For pre-generated documentation, please see the documentation linked in the above repositories: | 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/coreMQTT/docs/doxygen/output/html/index.html) | +Note that the latest included version of coreMQTT may differ across repositories. The Embedded C SDK includes the current version of coreMQTT. + +### 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: From a5e6524afb1f67ba1e56d8113e882b732f26e112 Mon Sep 17 00:00:00 2001 From: Muneeb Ahmed Date: Thu, 22 Jul 2021 12:07:35 -0700 Subject: [PATCH 08/12] Review comments again --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38f2c4bcb..5783adbf6 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ Please refer to the demos of the MQTT client library in the following locations ### Existing Documentation -For pre-generated documentation, please see the documentation linked in the above repositories: +For pre-generated documentation, please see the documentation linked in the locations below: | Location | | :-: | From 3d653fe6227c484d75a8ac5e5048306d42d79ce2 Mon Sep 17 00:00:00 2001 From: Muneeb Ahmed Date: Thu, 22 Jul 2021 12:12:13 -0700 Subject: [PATCH 09/12] Review comments again --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5783adbf6..461068fdc 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,7 @@ For pre-generated documentation, please see the documentation linked in the loca | [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/coreMQTT/docs/doxygen/output/html/index.html) | -Note that the latest included version of coreMQTT may differ across repositories. The Embedded C SDK includes the current version of coreMQTT. +Note that the latest included version of coreMQTT may differ across repositories. ### Generating Documentation From 148ca0597589a8377b6f8ed116b95d27f796e610 Mon Sep 17 00:00:00 2001 From: Muneeb Ahmed Date: Thu, 22 Jul 2021 12:37:24 -0700 Subject: [PATCH 10/12] Make possible to override CMake C Standard --- test/CMakeLists.txt | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt index bf45f0e9e..48f5da29c 100644 --- a/test/CMakeLists.txt +++ b/test/CMakeLists.txt @@ -6,9 +6,13 @@ project ( "CoreMQTT unit test" # Allow the project to be organized into folders. set_property( GLOBAL PROPERTY USE_FOLDERS ON ) -# Use C90. -set( CMAKE_C_STANDARD 90 ) -set( CMAKE_C_STANDARD_REQUIRED ON ) +# Use C90 if not specified. +if( NOT DEFINED CMAKE_C_STANDARD ) + set( CMAKE_C_STANDARD 90 ) +endif() +if( NOT DEFINED CMAKE_C_STANDARD_REQUIRED ) + set( CMAKE_C_STANDARD_REQUIRED ON ) +endif() # Do not allow in-source build. if( ${PROJECT_SOURCE_DIR} STREQUAL ${PROJECT_BINARY_DIR} ) From 70f578a2f139333dc758f9d7df38ee548ff94816 Mon Sep 17 00:00:00 2001 From: Muneeb Ahmed Date: Thu, 22 Jul 2021 13:45:47 -0700 Subject: [PATCH 11/12] Add indentation and update changelog --- CHANGELOG.md | 1 + source/include/core_mqtt.h | 4 ++-- source/include/core_mqtt_config_defaults.h | 12 ++++++++++++ source/include/core_mqtt_serializer.h | 4 ++-- source/include/core_mqtt_state.h | 4 ++-- source/interface/transport_interface.h | 4 ++-- 6 files changed, 21 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b9fb2d1ad..0c1d317af 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## v1.1.2 (July 2021) ### Updates + - [#168](https://github.com/FreeRTOS/coreMQTT/pull/168) Add header guards for C++ linkage. - [#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. - [#159](https://github.com/FreeRTOS/coreMQTT/pull/159) Add more checks for malformed packets when deserializing acknowledgments. diff --git a/source/include/core_mqtt.h b/source/include/core_mqtt.h index 553449b0d..6b479bb74 100644 --- a/source/include/core_mqtt.h +++ b/source/include/core_mqtt.h @@ -29,7 +29,7 @@ /* *INDENT-OFF* */ #ifdef __cplusplus -extern "C" { + extern "C" { #endif /* *INDENT-ON* */ @@ -895,7 +895,7 @@ const char * MQTT_Status_strerror( MQTTStatus_t status ); /* *INDENT-OFF* */ #ifdef __cplusplus -} + } #endif /* *INDENT-ON* */ diff --git a/source/include/core_mqtt_config_defaults.h b/source/include/core_mqtt_config_defaults.h index c7ad51b93..0179e9a10 100644 --- a/source/include/core_mqtt_config_defaults.h +++ b/source/include/core_mqtt_config_defaults.h @@ -35,6 +35,12 @@ #ifndef CORE_MQTT_CONFIG_DEFAULTS_H_ #define CORE_MQTT_CONFIG_DEFAULTS_H_ +/* *INDENT-OFF* */ +#ifdef __cplusplus + extern "C" { +#endif +/* *INDENT-ON* */ + /* The macro definition for MQTT_DO_NOT_USE_CUSTOM_CONFIG is for Doxygen * documentation only. */ @@ -247,4 +253,10 @@ #define LogDebug( message ) #endif +/* *INDENT-OFF* */ +#ifdef __cplusplus + } +#endif +/* *INDENT-ON* */ + #endif /* ifndef CORE_MQTT_CONFIG_DEFAULTS_H_ */ diff --git a/source/include/core_mqtt_serializer.h b/source/include/core_mqtt_serializer.h index e32776df8..812880dba 100644 --- a/source/include/core_mqtt_serializer.h +++ b/source/include/core_mqtt_serializer.h @@ -36,7 +36,7 @@ /* *INDENT-OFF* */ #ifdef __cplusplus -extern "C" { + extern "C" { #endif /* *INDENT-ON */ @@ -1179,7 +1179,7 @@ MQTTStatus_t MQTT_GetIncomingPacketTypeAndLength( TransportRecv_t readFunc, /* *INDENT-OFF* */ #ifdef __cplusplus -} + } #endif /* *INDENT-ON* */ diff --git a/source/include/core_mqtt_state.h b/source/include/core_mqtt_state.h index fa206baa3..e05b50a4b 100644 --- a/source/include/core_mqtt_state.h +++ b/source/include/core_mqtt_state.h @@ -29,7 +29,7 @@ /* *INDENT-OFF* */ #ifdef __cplusplus -extern "C" { + extern "C" { #endif /* *INDENT-ON* */ @@ -283,7 +283,7 @@ const char * MQTT_State_strerror( MQTTPublishState_t state ); /* *INDENT-OFF* */ #ifdef __cplusplus -} + } #endif /* *INDENT-ON* */ diff --git a/source/interface/transport_interface.h b/source/interface/transport_interface.h index eb48f4cfa..ff5f3d29c 100644 --- a/source/interface/transport_interface.h +++ b/source/interface/transport_interface.h @@ -30,7 +30,7 @@ /* *INDENT-OFF* */ #ifdef __cplusplus -extern "C" { + extern "C" { #endif /* *INDENT-ON* */ @@ -258,7 +258,7 @@ typedef struct TransportInterface /* *INDENT-OFF* */ #ifdef __cplusplus -} + } #endif /* *INDENT-ON* */ From 6c506e40793418c525db1183fd9bb54e32e322c5 Mon Sep 17 00:00:00 2001 From: Muneeb Ahmed Date: Thu, 22 Jul 2021 14:18:24 -0700 Subject: [PATCH 12/12] Move extern C after other includes --- source/interface/transport_interface.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/interface/transport_interface.h b/source/interface/transport_interface.h index ff5f3d29c..d3e8ab633 100644 --- a/source/interface/transport_interface.h +++ b/source/interface/transport_interface.h @@ -28,15 +28,15 @@ #ifndef TRANSPORT_INTERFACE_H_ #define TRANSPORT_INTERFACE_H_ +#include +#include + /* *INDENT-OFF* */ #ifdef __cplusplus extern "C" { #endif /* *INDENT-ON* */ -#include -#include - /** * @transportpage * @brief The transport interface definition.