Merge remote-tracking branch 'origin/doc-updates' into integration_2024_w26

README.md

@@ -70,11 +70,11 @@ openairinterface5g
 ├── executables       : Top-level executable source files (gNB, eNB, ...)
 ├── maketags          : Script to generate emacs tags.
 ├── nfapi             : (n)FAPI code for MAC-PHY interface
-├── openair1          : 3GPP LTE Rel-10/12 PHY layer / 3GPP NR Rel-15 layer. A local Readme file provides more details.
-├── openair2          : 3GPP LTE Rel-10 RLC/MAC/PDCP/RRC/X2AP + LTE Rel-14 M2AP implementation. Also 3GPP NR Rel-15 RLC/MAC/PDCP/RRC/X2AP.
-├── openair3          : 3GPP LTE Rel10 for S1AP, NAS GTPV1-U for both ENB and UE.
+├── openair1          : Layer 1 (3GPP LTE Rel-10/12 PHY, NR Rel-15 PHY)
+├── openair2          : Layer 2 (3GPP LTE Rel-10 MAC/RLC/PDCP/RRC/X2AP, LTE Rel-14 M2AP, NR Rel-15+ MAC/RLC/PDCP/SDAP/RRC/X2AP/F1AP/E1AP), E2AP
+├── openair3          : Layer 3 (3GPP LTE Rel-10 S1AP/GTP, NR Rel-15 NGAP/GTP)
 ├── openshift         : OpenShift helm charts for some deployment options of OAI
-├── radio             : Drivers for various radios such as USRP, AW2S, RFsim, ...
+├── radio             : Drivers for various radios such as USRP, AW2S, RFsim, 7.2 FHI, ...
 └── targets           : Some configuration files; only historical relevance, and might be deleted in the future
 ```
 

doc/BUILD.md

@@ -149,7 +149,7 @@ cd openairinterface5g/cmake_targets/
 
 After completing the build, the binaries are available in the `cmake_targets/ran_build/build` directory.
 
-Detailed information about these simulators can be found [in this dedicated page](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/OpenAirLTEPhySimul)
+Detailed information about these simulators can be found [in the dedicated page](./physical-simulators.md)
 
 ## Building UEs, eNodeB and gNodeB Executables
 

doc/FEATURE_SET.md

@@ -117,9 +117,7 @@ Furthermore, the gNB and UE support
   - evalution of RSRP report
   - evaluation of CQI report
 - MAC scheduling of SR reception
-- Bandwidth part (BWP) operation
-  - Handle multiple dedicated BWPs, supports one UE
-  - BWP switching through RRCReconfiguration method
+- Support of up to 16 UEs (can be increased to 32)
 
 ## gNB RLC
 
@@ -154,18 +152,15 @@ Furthermore, the gNB and UE support
 
 - NR RRC (38.331) Rel 17 messages using new [asn1c](https://github.com/mouse07410/asn1c)
 - LTE RRC (36.331) also updated to Rel 15
-- Generation of CellGroupConfig (for eNB) and MIB
-- Generation of system information block 1 (SIB1)
-- Generation of system information block 2 (SIB2)
-- Application to read configuration file and program gNB RRC
+- Generation of MIB/SIB1 (received from DU)
 - RRC can configure PDCP, RLC, MAC
-- Interface with GTP-U (tunnel creation/handling for S1-U (NSA), N3 (SA) interfaces)
+- Interface with GTP-U (tunnel creation/handling for S1-U (NSA), N3 (SA), F1 interfaces)
 - Integration of RRC messages and procedures supporting UE 5G SA connection
   - RRCSetupRequest/RRCSetup/RRCSetupComplete
   - RRC Uplink/Downlink Information transfer carrying NAS messages transparently
   - RRC Reconfiguration/Reconfiguration complete
   - RRC Reestablishment/Reestablishment complete
-  - Support for master cell group configuration
+  - Support for MasterCellGroup configuration (from DU)
   - Interface with NGAP for the interactions with the AMF
   - Interface with F1AP for CU/DU split deployment option
   - Periodic RRC measurements of serving cell (no A/B events)
@@ -200,7 +195,8 @@ Furthermore, the gNB and UE support
   - F1 UE Context release req/cmd/complete
   - F1 gNB CU configuration update
 - Interface with RRC
-- Interface with gtp-u (tunnel creation/handling for F1-U interface)
+- Interface with GTP-u (tunnel creation/handling for F1-U interface)
+- One CU(-CP) can handle multiple DUs
 
 ## gNB E1AP
 
@@ -216,6 +212,7 @@ Furthermore, the gNB and UE support
       - E1 Bearer Context Modification Request
       - E1 Bearer Context Modification Response
 - Interface with RRC and PDCP
+- One CU-CP can handle multiple CU-UPs
 
 ## gNB GTP-U
 

doc/GET_SOURCES.md

-The OpenAirInterface software can be obtained from our gitLab
-server. You will need a git client to get the sources. The repository
-is currently used for main developments.
+The OpenAirInterface software can be obtained from our gitLab server. You will
+need a git client to get the sources. The repository is used for main
+developments.
 
 # Prerequisites
 
-You need to install git using the following commands:
+You need to install `git` using the following commands:
 
 ```shell
 sudo apt-get update
 sudo apt-get install git
 ```
 
-# Using EURECOM Gitlab
+# Clone the Git repository (for OAI Users without login to gitlab server)
 
 The [openairinterface5g repository](https://gitlab.eurecom.fr/oai/openairinterface5g.git)
 holds the source code for the RAN (4G and 5G).
 
-Configure git with your name/email address (only important if you are developer and want to contribute/push code to Git Repository):
+## All users, anonymous access
+
+Clone the RAN repository:
 
 ```shell
-git config --global user.name "Your Name"
-git config --global user.email "Your email address"
+git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git
 ```
 
-## In order to clone the Git repository (for OAI Users without login to gitlab server)
+## For contributors
 
-Cloning RAN repository:
+Configure git with your name/email address, important if you are developer and
+want to contribute by pushing code. Please put your full name and the e-mail
+address you use in Gitlab.
 
 ```shell
-git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git
+git config --global user.name "Your Name"
+git config --global user.email "Your email address"
 ```
 
-## In order to contribute to the Git RAN repository (for OAI Developers/admins with login to gitlab server)
-
-Please send email to [contact@openairinterface.org](mailto:contact@openairinterface.org) to be added to the repository
-as a developer (only important for users who want to commit code to the repository). If
-you do not have account on gitlab.eurecom.fr, please register yourself to gitlab.eurecom.fr and provide the login name in the email.
-
-More information can be found in [a separate page](../CONTRIBUTING.md).
+More information can be found in [the contributing page](../CONTRIBUTING.md).
 
 # Which branch to checkout?
 
-`develop`: contains recent commits that are tested on our CI test bench. The update frequency is about once a week. 5G is only in this branch. It is the recommended  and default branch.
-`master`: contains a stable version of 4G, and will be updated in the future with 5G.
+- `develop`: contains recent commits that are tested on our CI test bench. The
+  update frequency is about once a week. 5G is only in this branch. **It is the
+  recommended and default branch.**
+- `master`: contains a known stable version.
 
-Please see the work flow and policies page: https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/oai-policies-home
-
-You can find the latest stable tag release here: https://gitlab.eurecom.fr/oai/openairinterface5g/tags
+You can find the latest stable tag release here:
+https://gitlab.eurecom.fr/oai/openairinterface5g/tags
 
 The tag naming conventions are:
 
-- On `master` branch: **v1.`x`.`y`** where
-  * `x` is the minor release number, incremented every 2-3 months when we are merging `develop` into `master` branch.
-  * `y` is the maintenance number, starting at 0 when we do a minor release and being incremented when a bug fix is incorporated into `master` branch.
+- On `master` branch: **v`x`.`y`.`z`**
 - On `develop` branch **`yyyy`.w`xx`**
   * `yyyy` is the calendar year
   * `xx` the week number within the year
+
+More information on work flow and policies can be found in [this
+document](./code-style-contrib.md).