Skip to content

Commit

Permalink
Update Getting Started Guide Doc (#942)
Browse files Browse the repository at this point in the history
* Update Getting Started Guide Doc

* Update

* Update

* Update comment

* Remove space

* Update GettingStarted_4.0.0-rc3.md
  • Loading branch information
moninom1 authored Jun 30, 2023
1 parent c6b1cd6 commit 400df79
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions GettingStarted_4.0.0-rc2.md → GettingStarted_4.0.0-rc3.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Moving to 4.0.0-rc1/rc2 from 3.x.x:
Moving to 4.0.0-rc1/rc2/rc3 from 3.x.x:
--------------------------------

In version 4.0.0-rc1, new files have been added to support IPv6 functionality and each file has been broken down into logically separated IPv4 and IPv6 files. The folder structure of FreeRTOS-Plus-TCP has not changed.
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/dev/IPv6_integration/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.

Expand All @@ -10,7 +10,7 @@ Backward Compatibility Mode:
If you are moving your code from V3.x.x to V4.0.0-rc1, 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:
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.
Expand Down

0 comments on commit 400df79

Please sign in to comment.