Merge remote-tracking branch 'origin/doc-fixes' into integration_2022_wk10

README.md

@@ -21,28 +21,14 @@
 
 # OpenAirInterface License #
 
-### Included Fixes: ###
-- Ease of use of gprof and address sanitizer for debugging purposes
-- Updated json files to allow for GDB, real-time debugging capabilities
-- Updated logging features to minimally log only key connection milestones. This imroves scalability of multiple UEs.
-- Updated logging to include time stamp for timing analysis
-- Updated memory allocation procedures to correct size requirements
-- Added debugging features to handle signal terminations
-- nfapi.c pullarray8 fix invalid pointer math
-- Overlapping destination and source memory in memcpy, so updated to memmove to check for this bug
-- Advanced error checking mechanisms in critical pack and unpack functions
-- Created option for CPU assignment to UE to improve scalability
-- Added EPC integration to allow multiple individual UE entities to each have their USIM information parced by the executables
-- Updated random value seeds to minimize probability of error in generation of random values
-- Enables capability round robin scheduler if desired
-- Enables capability real time scheduler if desired
-- Added new standalone functions to the UE phy-layer (phy_stub_ue.c) to incorporate individual UE entities
-- Updated sending and packing functions in UE (lte_ue.c) to incorporate new standalone changes
-- Incorporated semaphores to control timing of incoming downlink packets
-- Implemented new queuing system to handle message exchange from UE to eNB and vice versa
-- Updated global value in nFAPI for size of subframe
-- Updated global value to increase scalability in system
+ *  [OAI License Model](http://www.openairinterface.org/?page_id=101)
+ *  [OAI License v1.1 on our website](http://www.openairinterface.org/?page_id=698)
 
+It is distributed under **OAI Public License V1.1**.
+
+The license information is distributed under [LICENSE](LICENSE) file in the same directory.
+
+Please see [NOTICE](NOTICE.md) file for third party software that is included in the sources.
 
 # Where to Start #
 

doc/L2NFAPI.md

@@ -18,6 +18,10 @@ The UE executable is able to "simulate" multiple UEs in order to stimulate the s
 
 **This simulator is available starting the `v1.0.0` release on the `master` branch.**
 
+**2022/03/08: CAUTION, THIS TUTORIAL IS NO LONGER VALID on the `develop` branch after the `2022.w01` tag.**
+
+**2022/03/08: CAUTION, THE LAST VALID TAG on `develop` branch is `2021.w51_c`.**
+
 Currently the Continuous Integration process is validating this simulator the following way:
 
 *  the LTE modem executable is run on one host (in our CI deployment it is a **Xenial Virtual Machine**)
@@ -31,6 +35,17 @@ Normally it should be fine to run both executables on the same host using the `l
 1. [With S1 -- eNB and UE on 2 hosts](L2NFAPI_S1.md)
 2. [No S1 -- eNB and UE on 2 hosts](L2NFAPI_NOS1.md)
 
+
+**2022/03/08: Starting the `2022.w01` tag on the `develop` branch, the L2 nFAPI simulation is using a proxy.**
+
+A tutorial is available on the [EpiSci GitHub Repository](https://github.com/EpiSci/oai-lte-5g-multi-ue-proxy#readme).
+
+This proxy allows to perform L2 nFAPI simulator for:
+
+* LTE
+* 5G-NSA
+* 5G-SA
+
 ----
 
 [oai wiki home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

doc/L2NFAPI_NOS1.md

@@ -12,6 +12,10 @@
   </tr>
 </table>
 
+**2022/03/08: CAUTION, THIS TUTORIAL IS NO LONGER VALID on the `develop` branch after the `2022.w01` tag.**
+
+**2022/03/08: CAUTION, THE LAST VALID TAG on `develop` branch is `2021.w51_c`.**
+
 ## Table of Contents ##
 
 1.   [Environment](#1-environment)

doc/L2NFAPI_S1.md

@@ -12,6 +12,10 @@
   </tr>
 </table>
 
+**2022/03/08: CAUTION, THIS TUTORIAL IS NO LONGER VALID on the `develop` branch after the `2022.w01` tag.**
+
+**2022/03/08: CAUTION, THE LAST VALID TAG on `develop` branch is `2021.w51_c`.**
+
 ## Table of Contents ##
 
 1.   [Environment](#1-environment)

doc/RUNMODEM.md

@@ -33,7 +33,7 @@ It is planned to enhance this simulator with the following functionalities:
 
 This simulator connects a eNodeB  and UEs through a nfapi interface, short-cutting the L1 layer. The objective of this simulator is to allow multi UEs simulation, with a large number of UEs (ideally up to 255 ) .Here to ease the platform setup, UEs are simulated via a single `lte-uesoftmodem` instance. Today the CI tests just with one UE and architecture has to be reviewed to allow a number of UE above about 16. This work is on-going.
 
-As for the rf simulator, no specific hardware is required. The [L2 nfapi simlator page](L2NFAPI.md) contains the detailed documentation.
+As for the rf simulator, no specific hardware is required. The [L2 nfapi simulator page](L2NFAPI.md) contains the detailed documentation.
 
 # L1 Simulator