Update version to v2.0.0 and add Changelog section. (#85)

* Update version v1.0.0 to v2.0.0 in all files. * Add changelog for v2.0.0. * Update the memory estimates to point to 202012.00.
FreeRTOS · Dec 12, 2020 · 6a65b30 · 6a65b30
1 parent c55199a
commit 6a65b30
Show file tree

Hide file tree

Showing 42 changed files with 55 additions and 41 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # Changelog for coreHTTP Client Library
 
+## v2.0.0 (December 2020)
+
+### Updates
+
+ - [#83](https://github.com/FreeRTOS/coreHTTP/pull/83) Implement transport send and receive timeouts in coreHTTP. Previously, a zero returned form the transport receive stopped the library from trying to receive more data. Now, the library can optionally retry transport receives, when zero is returned, up to a configured timeout. Also previously, the library had the potential to loop forever if the transport send returned zero indefinitely. Now, the library can optionally retry transport sends, when zero is returned, up to a configured timeout; if no timeout is configured, then sending will stop at the first zero returned. This change adds an optional callback to get the current timestamp in milliseconds. This change also adds configuration macros to set the timeout in milliseconds, for retrying the transport send and receive.
+ - [#79](https://github.com/FreeRTOS/coreHTTP/pull/79), [#82](https://github.com/FreeRTOS/coreHTTP/pull/82) transport_interface.h documentation updates.
+ - [#75](https://github.com/FreeRTOS/coreHTTP/pull/75) Small fix to cast logging arguments to types matching the format specifiers.
+
+### Other
+ - [#70](https://github.com/FreeRTOS/coreHTTP/pull/70), [#72](https://github.com/FreeRTOS/coreHTTP/pull/72), [#78](https://github.com/FreeRTOS/coreHTTP/pull/78) Github actions updates.
+ - [#73](https://github.com/FreeRTOS/coreHTTP/pull/73), [#76](https://github.com/FreeRTOS/coreHTTP/pull/76) Github repo chores.
+ - [#71](https://github.com/FreeRTOS/coreHTTP/pull/71) CBMC automation chore.
+ - [#81](https://github.com/FreeRTOS/coreHTTP/pull/81), [#84](https://github.com/FreeRTOS/coreHTTP/pull/84) Doxygen memory estimates table update.
+
 ## v1.0.0 November 2020
 
 This is the first release of the coreHTTP client library in this repository.

diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ score over 8. This library has also undergone both static code analysis from
 safety and data structure invariance 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/202011.00/lib-ref/libraries/standard/coreHTTP/docs/doxygen/output/html/index.html#http_memory_requirements).
+See memory requirements for this library [here](https://docs.aws.amazon.com/embedded-csdk/202012.00/lib-ref/libraries/standard/coreHTTP/docs/doxygen/output/html/index.html#http_memory_requirements).
 
 ## coreHTTP Config File
 

diff --git a/docs/doxygen/config.doxyfile b/docs/doxygen/config.doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = "coreHTTP"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "v1.0.0"
+PROJECT_NUMBER         = "v2.0.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 : "coreHTTP"
-version: "v1.0.0"
+version: "v2.0.0"
 description: |
   "Client implementation of the HTTP/1.1 specification for embedded devices.\n"
 dependencies:

diff --git a/source/core_http_client.c b/source/core_http_client.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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_http_client.h b/source/include/core_http_client.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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_http_client_private.h b/source/include/core_http_client_private.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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_http_config_defaults.h b/source/include/core_http_config_defaults.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/callback_stubs.h b/test/cbmc/include/callback_stubs.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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_http_config.h b/test/cbmc/include/core_http_config.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/http_cbmc_state.h b/test/cbmc/include/http_cbmc_state.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/transport_interface_stubs.h b/test/cbmc/include/transport_interface_stubs.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/HTTPClient_AddHeader/HTTPClient_AddHeader_harness.c b/test/cbmc/proofs/HTTPClient_AddHeader/HTTPClient_AddHeader_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/HTTPClient_AddRangeHeader/HTTPClient_AddRangeHeader_harness.c b/test/cbmc/proofs/HTTPClient_AddRangeHeader/HTTPClient_AddRangeHeader_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/.../proofs/HTTPClient_InitializeRequestHeaders/HTTPClient_InitializeRequestHeaders_harness.c b/.../proofs/HTTPClient_InitializeRequestHeaders/HTTPClient_InitializeRequestHeaders_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/HTTPClient_ReadHeader/HTTPClient_ReadHeader_harness.c b/test/cbmc/proofs/HTTPClient_ReadHeader/HTTPClient_ReadHeader_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/HTTPClient_Send/HTTPClient_Send_harness.c b/test/cbmc/proofs/HTTPClient_Send/HTTPClient_Send_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/HTTPClient_strerror/HTTPClient_strerror_harness.c b/test/cbmc/proofs/HTTPClient_strerror/HTTPClient_strerror_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/findHeaderFieldParserCallback/findHeaderFieldParserCallback_harness.c b/test/cbmc/proofs/findHeaderFieldParserCallback/findHeaderFieldParserCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/...mc/proofs/findHeaderOnHeaderCompleteCallback/findHeaderOnHeaderCompleteCallback_harness.c b/...mc/proofs/findHeaderOnHeaderCompleteCallback/findHeaderOnHeaderCompleteCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/findHeaderValueParserCallback/findHeaderValueParserCallback_harness.c b/test/cbmc/proofs/findHeaderValueParserCallback/findHeaderValueParserCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/httpParserOnBodyCallback/httpParserOnBodyCallback_harness.c b/test/cbmc/proofs/httpParserOnBodyCallback/httpParserOnBodyCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/httpParserOnHeaderFieldCallback/httpParserOnHeaderFieldCallback_harness.c b/test/cbmc/proofs/httpParserOnHeaderFieldCallback/httpParserOnHeaderFieldCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/httpParserOnHeaderValueCallback/httpParserOnHeaderValueCallback_harness.c b/test/cbmc/proofs/httpParserOnHeaderValueCallback/httpParserOnHeaderValueCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/.../proofs/httpParserOnHeadersCompleteCallback/httpParserOnHeadersCompleteCallback_harness.c b/.../proofs/httpParserOnHeadersCompleteCallback/httpParserOnHeadersCompleteCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/httpParserOnMessageBeginCallback/httpParserOnMessageBeginCallback_harness.c b/test/cbmc/proofs/httpParserOnMessageBeginCallback/httpParserOnMessageBeginCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/.../proofs/httpParserOnMessageCompleteCallback/httpParserOnMessageCompleteCallback_harness.c b/.../proofs/httpParserOnMessageCompleteCallback/httpParserOnMessageCompleteCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/httpParserOnStatusCallback/httpParserOnStatusCallback_harness.c b/test/cbmc/proofs/httpParserOnStatusCallback/httpParserOnStatusCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/http_cbmc_state.c b/test/cbmc/sources/http_cbmc_state.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/HTTPClient_ReadHeader_http_parser_execute.c b/test/cbmc/stubs/HTTPClient_ReadHeader_http_parser_execute.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/HTTPClient_Send_http_parser_execute.c b/test/cbmc/stubs/HTTPClient_Send_http_parser_execute.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/callback_stubs.c b/test/cbmc/stubs/callback_stubs.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/httpHeaderStrncpy.c b/test/cbmc/stubs/httpHeaderStrncpy.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/memmove.c b/test/cbmc/stubs/memmove.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/strncpy.c b/test/cbmc/stubs/strncpy.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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/transport_interface_stubs.c b/test/cbmc/stubs/transport_interface_stubs.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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_http_config.h b/test/unit-test/core_http_config.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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_http_send_utest.c b/test/unit-test/core_http_send_utest.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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_http_utest.c b/test/unit-test/core_http_utest.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v1.0.0
+ * coreHTTP v2.0.0
  * 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