Skip to content

Commit 7681bb1

Browse files
moninom1shubnil
andauthored
Update Getting Started Guide Doc (FreeRTOS#995)
* Update getting started * Rename getting started * Remove rc reference --------- Co-authored-by: shubnil <[email protected]>
1 parent f1aa0a0 commit 7681bb1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

GettingStarted_4.0.0-rc3.md renamed to GettingStarted.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
Moving to 4.0.0-rc1/rc2/rc3 from 3.x.x:
1+
Moving to 4.0.0 from 3.x.x:
22
--------------------------------
33

4-
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) .
4+
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) .
55

66
Some of the APIs have changed which is illustrated in the section below. However, there is a backward compatibility mode provided as well.
77

88
Backward Compatibility Mode:
99
---------------------------
10-
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.
10+
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.
1111
The "Existing API's" defined in all the API changes below work only when the backward compatibility mode is enabled.
1212

13-
API changes in 4.0.0-rc1/rc2/rc3:
13+
API changes in 4.0.0:
1414
----------------------
1515

1616
The changes mentioned below uses ipconfigIPv4_BACKWARD_COMPATIBLE flag to differentiate between old API and new API.

0 commit comments

Comments
 (0)