mirror of
https://gitlab.eurecom.fr/oai/openairinterface5g.git
synced 2026-07-13 04:30:28 +00:00
4bff655952
Add doc/git-guide.md, a single entry point for the practical Git knowledge needed to contribute to OAI, consolidating the how-tos that were scattered across the documentation: - Setting up commit signing: moved from CONTRIBUTING.md, which keeps the normative DCO/Verified requirements and links to the guide; led by a compact SSH recipe, with the allowed_signers troubleshooting and a note on repository-level configuration for shared servers. - Managing your own branch: moved from code-style-contrib.md, which keeps the workflow policy and links to the guide; mentions git switch and covers fixup commits with git rebase --autosquash, including the --fixup=amend:<commit> variant. - Working with submodules: the update command and the unintended submodule-pointer-update pitfall seen in past PRs. - Recovering from mistakes: git restore --staged, git restore, git reset --soft/--hard, and git reflog. - Reusing conflict resolutions with git rerere: enabling, typical flow, inspecting, seeding from existing history, sharing the cache, and caveats, clarifying that contribution branches must keep a linear history while forks may carry merge commits. The guide is referenced from doc/README.md (Developer tools), code-style-contrib.md, and CONTRIBUTING.md. Guidance coupled to its own document is cross-linked instead of moved: clang-format.md (pre-commit hook), GET_SOURCES.md (branch and tag model), and doc_best_practices.md (docs: commit prefix). Also fix a typo in the T tracer addconsoletrace documentation. Signed-off-by: Andrea Lacava <thecave003@gmail.com>
OpenAirInterface documentation overview
This is the general overview page of the OpenAirInterface documentation. This page groups links to general information, tutorials, design documents, radio integration, and special-purpose libraries.
IMPORTANT NOTE:
Before reading this documentation, we strongly advise you to keep your own repository rebased on develop
or at least to checkout the documentation on the version of the repository you are using.
Then the documentation will better reflect the features available in your repository so that you may avoid some errors.
Beware if you previously pulled the develop branch that your repository may be now behind develop.
[[TOC]]
General
- FEATURE_SET.md: lists supported features
- GET_SOURCES.md: how to download the sources
- BUILD.md: how to build the sources
- environment-variables.md: the environment variables used by OAI
- tuning_and_security.md: performance and security considerations
- Supported_Hardware_Operating_System.md: List of supported hardware and operating system for OAI
There is some general information in the OpenAirInterface Gitlab Wiki
Tutorials
- Step-by-step tutorials to set up 5G:
- RUNMODEM.md: Information on how to run the gNB
- Run simulators
- Run with hardware
- (5G) Using SDAP and custom DRBs
- IF setups and arbitrary frequencies
- MIMO
- nrUE-specific configuration and modes
- Specific OAI modes (phy-test, do-ra, noS1)
- How to run OAI with O-RAN 7.2 FHI
- How to run a 5G-NSA setup
- How to run a 4G setup using L1 simulator Note: we recommend the RFsimulator
- How to use the L2 simulator
- How to use the OAI channel simulator
- How to run an NTN setup
- How to use GPU-accelerated channel simulation
- How to run OAI-VNF and OAI-PNF: how to run the FAPI/nFAPI split, including some general remarks on FAPI/nFAPI.
- How to use the positioning reference signal (PRS)
- How to use device-to-device communication (D2D, 4G)
- How to run with E2 agent
- How to run the physical simulators
- How to setup OAI with Nvidia Aerial and Foxconn
- How to setup OAI with LDPC accelerators (Xilinx T2/Intel ACCs)
- How to setup OAI with the XDMA FPGA LDPC accelerator
- How to do a handover
- How to setup gNB frequency
- How to use the RT data recording app
- How to use packages
Legacy unmaintained files:
L2NFAPI_NOS1.md,L2NFAPI_S1.md: old L2simulator, not valid anymore
Designs
- General software architecture notes: SW_archi.md
- Information on E1
- Information on F1
- Information on how NR nFAPI works
- Flow graph of the L1 in gNB
- L1 threads in NR-UE
- Information on gNB MAC
- Information on gNB RRC
- Information on analog beamforming implementation
- Information on the UE 5G NAS implementation
- Information on UL-MIMO: UL-MIMO specific notes
Building and running from images
- How to build images
- How to run 5G with the RFsimulator from images
- How to run 4G with the RFsimulator from images
- How to run physical simulators in OpenShift
Libraries
General
- The T tracer: a generic tracing tool (VCD, Wireshark, GUI, to save for later, ...)
- OPT: how to trace to wireshark
- The configuration module
- The logging module
- The shared object loader
- The threadpool used in L1
- The LDPC implementation is a shared library
- The time management module
Radios
Some directories under radio contain READMEs:
The other SDRs (AW2S, LimeSDR, ...) have no READMEs.
Special-purpose libraries
- OAI has two scopes: one based on Xforms and one based on imgui, described in this README
- OAI comes with an integrated telnet server to monitor and control
- OAI comes with an integrated web server
Testing
- UnitTests.md explains the unit testing setup
- Component tests are under
tests/. Currently, the following component tests are supported - TESTBenches.md lists the CI setup and links to pipelines
- The CI setup uses a custom framework to run end-to-end tests.
Developer tools
- code-style-contrib.md: overall working practices, code style, and review process
- git-guide.md: Git how-tos — commit signing setup, branch management, submodules, recovering from mistakes, reusing conflict resolutions (rerere)
- cross-compile.md: how to cross-compile OAI for ARM
- clang-format.md: how to format the code. See also the next entry for an error detection tool.
- formatting is a clang-format error detection tool
- cppcheck for static code analysis
- sanitizers.md: how to run with ASan/UBSan/MemSAN/TSan
- iwyu is a tool to detect
#includeerrors - docker-dev-env is a ubuntu24 docker development environment
- performance analysis with tracy
- doc_best_practices.md: overall best practices for writing documentations