From: sphoorthi Date: Thu, 3 Dec 2020 07:47:35 +0000 (+0530) Subject: Documentation updates X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=8da897d361e115f506cf166daabc7aa6a9999cd0;p=o-du%2Fl2.git Documentation updates Change-Id: Ic7471eab38172f1b74901ac37a2883863a19862e Signed-off-by: sphoorthi --- diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 5b193008b..61f405bf3 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -103,8 +103,8 @@ Cherry | | | +--------------------------------------+--------------------------------------+ | **Repo/commit-ID** | o-du/l2/ | -| | 27d8d877e837c2879a452538cdbe81afe48be| -| | d62 | +| | fc0bcf28e944ae7ba2423ad3c9a5c794df2dc| +| | 4ff | | | | +--------------------------------------+--------------------------------------+ | **Release designation** | Cherry Release | @@ -185,6 +185,21 @@ Cherry | https://jira.o-ran-sc.org/browse/ODUHIGH-189 | Integration with O-DU Low | | | | +-----------------------------------------------+-----------------------------------------------+ +| https://jira.o-ran-sc.org/browse/ODUHIGH-184 | UE UL Data path | +| | | ++-----------------------------------------------+-----------------------------------------------+ +| https://jira.o-ran-sc.org/browse/ODUHIGH-185 | UE DL Data path | +| | | ++-----------------------------------------------+-----------------------------------------------+ +| https://jira.o-ran-sc.org/browse/ODUHIGH-186 | Applying 64 QAM Modulation in DL | +| | | ++-----------------------------------------------+-----------------------------------------------+ +| https://jira.o-ran-sc.org/browse/ODUHIGH-187 | Applying 16 QAM Modulation in UL | +| | | ++-----------------------------------------------+-----------------------------------------------+ +| https://jira.o-ran-sc.org/browse/ODUHIGH-190 | Integration with VIAVI Software | +| | | ++-----------------------------------------------+-----------------------------------------------+ | https://jira.o-ran-sc.org/browse/ODUHIGH-214 | get-AlarmList implementation on O1 interface | | | | +-----------------------------------------------+-----------------------------------------------+ @@ -253,6 +268,14 @@ This release contains - release-notes.rst +- installation-guide.rst + +- user-guide.rst + +- api-docs.rst + +- developer-guide.rst + Known Limitations, Issues and Workarounds diff --git a/docs/user-guide.rst b/docs/user-guide.rst index cefed4b00..eb5ccfc98 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -5,6 +5,7 @@ User Guide *********** This is the user guide for Cherry release of O-DU/l2. +Follow installation-guide to get all the dependencies ready. .. contents:: :depth: 3 @@ -82,8 +83,22 @@ This section describes the changes required in compilation and execution of O-DU with Intel O-DU Low in timer mode. -I. Compilation -^^^^^^^^^^^^^^ +I. Pre-requisites +^^^^^^^^^^^^^^^^^^ + + 1. Install O-DU High as per installation-guide . + + 2. Clone O-DU Low code in from + + a. https://gerrit.o-ran-sc.org/r/admin/repos/o-du/phy and, + + b. https://github.com/intel/FlexRAN + + 3. Install O-DU Low as per https://docs.o-ran-sc.org/projects/o-ran-sc-o-du-phy/en/latest/index.html . + + +II. Compilation +^^^^^^^^^^^^^^^^ 1. Build ODU : @@ -115,8 +130,8 @@ I. Compilation - make odu PHY=INTEL_L1 PHY_MODE=TIMER MACHINE=BIT64 MODE=FDD -II. Execution -^^^^^^^^^^^^^ +III. Execution +^^^^^^^^^^^^^^^ 1. Execute O-DU Low: