From 9bbfd8ac9256782000a51738bb34b42d60200bf4 Mon Sep 17 00:00:00 2001 From: Monika Singh Date: Wed, 9 Aug 2023 06:33:19 +0000 Subject: [PATCH 1/3] Update getting started --- GettingStarted_4.0.0-rc3.md => GettingStarted_4.0.0.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) rename GettingStarted_4.0.0-rc3.md => GettingStarted_4.0.0.md (94%) diff --git a/GettingStarted_4.0.0-rc3.md b/GettingStarted_4.0.0.md similarity index 94% rename from GettingStarted_4.0.0-rc3.md rename to GettingStarted_4.0.0.md index f8f7b5e122..27ee2fea62 100644 --- a/GettingStarted_4.0.0-rc3.md +++ b/GettingStarted_4.0.0.md @@ -1,16 +1,16 @@ -Moving to 4.0.0-rc1/rc2/rc3 from 3.x.x: +Moving to 4.0.0/rc1/rc2/rc3 from 3.x.x: -------------------------------- -Version 4.0.0-rc1/rc2/rc3 adds new files to support IPv6 functionality, breaking each file into logically separated IPv4 and IPv6 files. The folder structure of FreeRTOS-Plus-TCP remains unchanged. Build separation is added to make the library modular, enabling users to compile and create a low-footprint binary with only the required functionalities. For more details on supported build combinations, see [History.txt](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/History.txt) . +Version 4.0.0/rc1/rc2/rc3 adds new files to support IPv6 functionality, breaking each file into logically separated IPv4 and IPv6 files. The folder structure of FreeRTOS-Plus-TCP remains unchanged. Build separation is added to make the library modular, enabling users to compile and create a low-footprint binary with only the required functionalities. For more details on supported build combinations, see [History.txt](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/History.txt) . Some of the APIs have changed which is illustrated in the section below. However, there is a backward compatibility mode provided as well. Backward Compatibility Mode: --------------------------- - If you are moving your code from V3.x.x to V4.0.0-rc1/rc2/rc3, then set the "ipconfigIPv4_BACKWARD_COMPATIBLE" macro to 1 in “FreeRTOSIPConfigDefaults.h” to run the code in backward compatible mode. + If you are moving your code from V3.x.x to V4.0.0/rc1/rc2/rc3, then set the "ipconfigIPv4_BACKWARD_COMPATIBLE" macro to 1 in “FreeRTOSIPConfigDefaults.h” to run the code in backward compatible mode. The "Existing API's" defined in all the API changes below work only when the backward compatibility mode is enabled. -API changes in 4.0.0-rc1/rc2/rc3: +API changes in 4.0.0/rc1/rc2/rc3: ---------------------- The changes mentioned below uses ipconfigIPv4_BACKWARD_COMPATIBLE flag to differentiate between old API and new API. From 20e7efd6feff5c5111629943d7edf855e4843dad Mon Sep 17 00:00:00 2001 From: Monika Singh Date: Wed, 9 Aug 2023 10:44:24 +0000 Subject: [PATCH 2/3] Rename getting started --- GettingStarted_4.0.0.md => GettingStarted.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename GettingStarted_4.0.0.md => GettingStarted.md (100%) diff --git a/GettingStarted_4.0.0.md b/GettingStarted.md similarity index 100% rename from GettingStarted_4.0.0.md rename to GettingStarted.md From 786fa398c011391bf6d1ff1f43aae67e18acfa3f Mon Sep 17 00:00:00 2001 From: Monika Singh Date: Wed, 9 Aug 2023 11:02:50 +0000 Subject: [PATCH 3/3] Remove rc reference --- GettingStarted.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/GettingStarted.md b/GettingStarted.md index 27ee2fea62..76ab87448f 100644 --- a/GettingStarted.md +++ b/GettingStarted.md @@ -1,16 +1,16 @@ -Moving to 4.0.0/rc1/rc2/rc3 from 3.x.x: +Moving to 4.0.0 from 3.x.x: -------------------------------- -Version 4.0.0/rc1/rc2/rc3 adds new files to support IPv6 functionality, breaking each file into logically separated IPv4 and IPv6 files. The folder structure of FreeRTOS-Plus-TCP remains unchanged. Build separation is added to make the library modular, enabling users to compile and create a low-footprint binary with only the required functionalities. For more details on supported build combinations, see [History.txt](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/History.txt) . +Version 4.0.0 adds new files to support IPv6 functionality, breaking each file into logically separated IPv4 and IPv6 files. The folder structure of FreeRTOS-Plus-TCP remains unchanged. Build separation is added to make the library modular, enabling users to compile and create a low-footprint binary with only the required functionalities. For more details on supported build combinations, see [History.txt](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/History.txt) . Some of the APIs have changed which is illustrated in the section below. However, there is a backward compatibility mode provided as well. Backward Compatibility Mode: --------------------------- - If you are moving your code from V3.x.x to V4.0.0/rc1/rc2/rc3, then set the "ipconfigIPv4_BACKWARD_COMPATIBLE" macro to 1 in “FreeRTOSIPConfigDefaults.h” to run the code in backward compatible mode. + If you are moving your code from V3.x.x to V4.0.0, then set the "ipconfigIPv4_BACKWARD_COMPATIBLE" macro to 1 in “FreeRTOSIPConfigDefaults.h” to run the code in backward compatible mode. The "Existing API's" defined in all the API changes below work only when the backward compatibility mode is enabled. -API changes in 4.0.0/rc1/rc2/rc3: +API changes in 4.0.0: ---------------------- The changes mentioned below uses ipconfigIPv4_BACKWARD_COMPATIBLE flag to differentiate between old API and new API.