build_inf_prepare_jenkins: fix for py27 venv and mock_overlay

[pti/rtp.git] / docs / developer-guide.rst

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
old mode 100644 (file)
new mode 100755 (executable)
index d5282f4..048ca3d
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -12,7 +12,7 @@ Developer-Guide
 
 This project implements a real time platform to deploy the O-CU and O-DU and it's based on Yocto/OpenEmbedded.
 
-This includes a Yocto/OpenEmbedded compatible layer meta-oran and wrapper scripts
+This includes a Yocto/OpenEmbedded compatible layer meta-stx-oran and wrapper scripts
 to pull all required Yocto/OE layers to build out the reference platform.
 
 To contribute on this project, basic knowledge of Yocto/OpenEmbedded is needed, please refer to the following docs if you want to learn about how to develop with Yocto/OpenEmbedded:
@@ -24,11 +24,9 @@ To contribute on this project, basic knowledge of Yocto/OpenEmbedded is needed,
 .. _`OpenEmbedded wiki`: http://www.openembedded.org/wiki/Main_Page
 
 
-Processes
----------
 
 1. Prerequisite for build environment
-`````````````````````````````````````
+-------------------------------------
 
 * Your host need to meet the requirements for Yocto, please refer to:
 
@@ -36,12 +34,12 @@ Processes
   * `Supported Linux Distributions`_
   * `Required Packages for the Build Host`_
 
-* The recommended and tested host is Ubuntu 16.04/18.04 and CentOS 7.
+The recommended and tested host is Ubuntu 16.04/18.04 and CentOS 7.
 
-  * To install the required packages for Ubuntu 16.04/18.04:
+* To install the required packages for Ubuntu 16.04/18.04:
 
 .. _`Compatible Linux Distribution`: https://www.yoctoproject.org/docs/2.6.3/brief-yoctoprojectqs/brief-yoctoprojectqs.html#brief-compatible-distro
-.. _`Supported Linux Distributions`: https://www.yoctoproject.org/docs/2.6.3/ref-manual/ref-manual.html#detailed-supported-distros)
+.. _`Supported Linux Distributions`: https://www.yoctoproject.org/docs/2.6.3/ref-manual/ref-manual.html#detailed-supported-distros
 .. _`Required Packages for the Build Host`: https://www.yoctoproject.org/docs/2.6.3/ref-manual/ref-manual.html#required-packages-for-the-build-host
 
 ::
@@ -51,7 +49,7 @@ Processes
     xz-utils debianutils iputils-ping make xsltproc docbook-utils fop dblatex xmlto \
     python-git
 
-    * To install the required packages for CentOS 7:
+* To install the required packages for CentOS 7:
 
 ::
 
@@ -62,19 +60,19 @@ Processes
     perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-Digest-SHA \
     python34-pip xz which SDL-devel xterm
 
-
-2. Use wrapper script build_oran.sh to setup build env and build the image
-``````````````````````````````````````````````````````````````````````````
+2. Use wrapper script build_inf.sh to setup build env and build the INF AIO x86 image
+-------------------------------------------------------------------------------------
 
 ::
 
   # Get the wrapper script with either curl or wget
-  $ curl -o build_oran.sh 'https://gerrit.o-ran-sc.org/r/gitweb?p=pti/rtp.git;a=blob_plain;f=scripts/build_oran.sh;hb=HEAD'
-  $ wget -O build_oran.sh 'https://gerrit.o-ran-sc.org/r/gitweb?p=pti/rtp.git;a=blob_plain;f=scripts/build_oran.sh;hb=HEAD'
-  
-  $ chmod +x build_oran.sh
+  $ curl -o build_inf.sh 'https://gerrit.o-ran-sc.org/r/gitweb?p=pti/rtp.git;a=blob_plain;f=scripts/build_inf.sh;hb=HEAD'
+  $ wget -O build_inf.sh 'https://gerrit.o-ran-sc.org/r/gitweb?p=pti/rtp.git;a=blob_plain;f=scripts/build_inf.sh;hb=HEAD'
+
+  $ chmod +x build_inf.sh
   $ WORKSPACE=/path/to/workspace
-  $ ./build_oran.sh -w ${WORKSPACE}
+  $ ./build_inf.sh -w ${WORKSPACE}
 
 If all go well, you will get the ISO image in:
-${WORKSPACE}/prj_wrl1018_oran/tmp-glibc/deploy/images/intel-x86-64/oran-image-inf-host-intel-x86-64.iso
+${WORKSPACE}/prj_oran_inf_anaconda/tmp-glibc/deploy/images/intel-corei7-64/inf-image-aio-installer-intel-corei7-64.iso
+