diff options
author | Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2023-02-27 12:19:13 +0100 |
---|---|---|
committer | Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2023-03-02 20:10:41 +0000 |
commit | 42b3550f0627400a778a5b1293b915204517ec2c (patch) | |
tree | d646338218280d74bbbc27db9824e0f043db7904 /docs | |
parent | ad469eb57940d03b580f75996157033e6e561c98 (diff) |
Prepare octopus branch for documentation
Change references from master to octopus.
Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Change-Id: I3508a3631c63a8c7ee85293f46d16ac52d384643
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28529
Diffstat (limited to 'docs')
18 files changed, 84 insertions, 84 deletions
diff --git a/docs/01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md b/docs/01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md index bc4da4b..ce91ac3 100644 --- a/docs/01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md +++ b/docs/01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md @@ -8,9 +8,9 @@ AGL provides a number of pre-built ready-made images of various versions. ### 1. QEMU (Emulation) -1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.ext4.xz). +1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.ext4.xz). -2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/bzImage). +2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemux86-64/deploy/images/qemux86-64/bzImage). 3. Install [QEMU](https://www.qemu.org/download/) : @@ -78,7 +78,7 @@ AGL provides a number of pre-built ready-made images of various versions. **NOTE :** Please note [https://www.virtualbox.org/ticket/19873](https://www.virtualbox.org/ticket/19873) as this affects the VMs resolution. The AGL demo images do require 1920x1080. The instructions below have been adapted. - 1. Download the [compressed vbox disk image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.wic.vmdk.xz). + 1. Download the [compressed vbox disk image](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.wic.vmdk.xz). 2. Install and set up [Virtual Box](https://www.virtualbox.org/wiki/Linux_Downloads). @@ -110,7 +110,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt **NOTE :** UEFI enabled system is required. - 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.wic.xz). + 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.wic.xz). 2. Extract the image into USB drive : @@ -128,9 +128,9 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt ### 1. QEMU (Emulation) -1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/deploy/images/qemuarm/agl-demo-platform-crosssdk-qemuarm.ext4.xz). +1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemuarm/deploy/images/qemuarm/agl-demo-platform-crosssdk-qemuarm.ext4.xz). -2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/deploy/images/qemuarm/zImage). +2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemuarm/deploy/images/qemuarm/zImage). 3. Install [QEMU](https://www.qemu.org/download/) : @@ -199,7 +199,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt ### 2. BeagleBone Enhanced (BBE) - 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/bbe/deploy/images/bbe/agl-telematics-demo-platform-bbe.wic.xz). + 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/bbe/deploy/images/bbe/agl-telematics-demo-platform-bbe.wic.xz). 2. Extract the image into the SD card of BeagleBone Enhanced : @@ -224,9 +224,9 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt ### 1. QEMU (Emulation) -1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/deploy/images/qemuarm64/agl-demo-platform-crosssdk-qemuarm64.ext4.xz). +1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemuarm64/deploy/images/qemuarm64/agl-demo-platform-crosssdk-qemuarm64.ext4.xz). -2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/deploy/images/qemuarm64/Image). +2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemuarm64/deploy/images/qemuarm64/Image). 3. Install [QEMU](https://www.qemu.org/download/) : @@ -295,7 +295,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt ### 2. Raspberry Pi 4 - 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/raspberrypi4/deploy/images/raspberrypi4-64/agl-demo-platform-crosssdk-raspberrypi4-64.wic.xz). + 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/raspberrypi4/deploy/images/raspberrypi4-64/agl-demo-platform-crosssdk-raspberrypi4-64.wic.xz). 2. Extract the image into the SD card of Raspberry Pi 4 : @@ -363,9 +363,9 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt **NOTE :** The prebuilt image does support **non-accelerated** graphics mode (software rendering). For **accelerated** graphics support, a local build with the neccesary graphics driver is required. - 1. Update the [firmware](https://elinux.org/R-Car/Boards/H3SK#Flashing_firmware) using files from [here](https://download.automotivelinux.org/AGL/snapshots/master/latest/h3ulcb-nogfx/deploy/images/h3ulcb/). + 1. Update the [firmware](https://elinux.org/R-Car/Boards/H3SK#Flashing_firmware) using files from [here](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/h3ulcb-nogfx/deploy/images/h3ulcb/). - 2. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/h3ulcb-nogfx/deploy/images/h3ulcb/agl-demo-platform-crosssdk-h3ulcb.wic.xz). + 2. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/h3ulcb-nogfx/deploy/images/h3ulcb/agl-demo-platform-crosssdk-h3ulcb.wic.xz). 3. Extract the image into the boot device : diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host.md b/docs/01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host.md index 846271f..12d0102 100644 --- a/docs/01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host.md @@ -17,7 +17,7 @@ the Yocto Project documentation **NOTE:** This entire section presumes you want to build an image. You can skip the entire build process if you want to use a ready-made development image. -The [supported images](https://download.automotivelinux.org/AGL/snapshots/master/latest/) exist for several boards as +The [supported images](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/) exist for several boards as well as for the Quick EMUlator (QEMU). See the "[Quickstart](../01_Quickstart/01_Using_Ready_Made_Images.md)" diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md b/docs/01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md index 62a33e4..8865a02 100644 --- a/docs/01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md @@ -10,7 +10,7 @@ run to initialize the build environment. You can find this script here: ```sh -$AGL_TOP/master/meta-agl/scripts/aglsetup.sh +$AGL_TOP/octopus/meta-agl/scripts/aglsetup.sh ``` The script accepts many options that allow you to define build parameters such @@ -18,7 +18,7 @@ as the target hardware (i.e. the machine), build directory, and so forth. Use the following commands to see the available options and script syntax: ```sh -$ cd $AGL_TOP/master +$ cd $AGL_TOP/octopus $ source meta-agl/scripts/aglsetup.sh -h ``` @@ -222,7 +222,7 @@ Common targets are: Running the script creates the Build Directory if it does not already exist. The default Build Directory is `$AGL_TOP/<release-branch-name>/build`, and the nomenclature to be used throughout this doc is going to be `$AGL_TOP/<release-branch-name>/<build-dir>` -For this example, the Build Directory is `$AGL_TOP/master/qemux86-64`. +For this example, the Build Directory is `$AGL_TOP/octopus/qemux86-64`. The script's output also indicates the machine and AGL features selected for the build. diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/05_Customizing_Your_Build.md b/docs/01_Getting_Started/02_Building_AGL_Image/05_Customizing_Your_Build.md index 31d2852..94637b3 100644 --- a/docs/01_Getting_Started/02_Building_AGL_Image/05_Customizing_Your_Build.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/05_Customizing_Your_Build.md @@ -128,7 +128,7 @@ using mirrors. To use mirrors, add this line to your `local.conf` file in the Build directory: ```sh -SSTATE_MIRRORS_append = " file://.* https://download.automotivelinux.org/sstate-mirror/master/${DEFAULTTUNE}/PATH \n " +SSTATE_MIRRORS_append = " file://.* https://download.automotivelinux.org/sstate-mirror/octopus/${DEFAULTTUNE}/PATH \n " ``` You can learn more about shared state and how it is used in the @@ -141,7 +141,7 @@ section of the Yocto Project Reference Manual. $ echo "# reuse download directories" >> $AGL_TOP/site.conf $ echo "DL_DIR = \"$HOME/downloads/\"" >> $AGL_TOP/site.conf $ echo "SSTATE_DIR = \"$AGL_TOP/sstate-cache/\"" >> $AGL_TOP/site.conf -$ cd $AGL_TOP/master/qemux86-64/ +$ cd $AGL_TOP/octopus/qemux86-64/ $ ln -sf $AGL_TOP/site.conf conf/ In General; diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/07_Building_for_x86_(Emulation_and_Hardware).md b/docs/01_Getting_Started/02_Building_AGL_Image/07_Building_for_x86_(Emulation_and_Hardware).md index e78ef58..ef70e96 100644 --- a/docs/01_Getting_Started/02_Building_AGL_Image/07_Building_for_x86_(Emulation_and_Hardware).md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/07_Building_for_x86_(Emulation_and_Hardware).md @@ -133,7 +133,7 @@ If you built your image with bitbake, you can now just use the ``runqemu`` wrapp For this example : ```sh -$ source $AGL_TOP/master/qemux86-64/agl-init-build-env +$ source $AGL_TOP/octopus/qemux86-64/agl-init-build-env ``` In general : diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md b/docs/01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md index 8622194..e228fa3 100644 --- a/docs/01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md @@ -65,7 +65,7 @@ Follow these steps to download the drivers you need: | AGL Version | Renesas version | |:-:|:-:| - | AGL master | 5.9.0 | + | AGL octopus | 5.9.0 | 3. **Download the Files:** @@ -652,8 +652,8 @@ similar to the following: ```text [snip] ---- fragment /home/working/workspace_agl_master/meta-agl/templates/machine/h3ulcb/50_setup.sh -/home/working/workspace_agl_master /home/working/workspace_agl_master/build_gen3 +--- fragment /home/working/workspace_agl_octopus/meta-agl/templates/machine/h3ulcb/50_setup.sh +/home/working/workspace_agl_octopus /home/working/workspace_agl_octopus/build_gen3 The graphics and multimedia acceleration packages for the R-Car Gen3 board can be downloaded from: https://www.renesas.com/en-us/solutions/automotive/rcar-demoboard-2.html @@ -661,11 +661,11 @@ https://www.renesas.com/en-us/solutions/automotive/rcar-demoboard-2.html These 2 files from there should be store in your'/home/devel/Downloads' directory. R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston8-20200923.zip R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston8-20200923.zip -/home/working/workspace_agl_master/build_gen3 ---- fragment /home/working/workspace_agl_master/meta-agl/templates/base/99_setup_EULAconf.sh +/home/working/workspace_agl_octopus/build_gen3 +--- fragment /home/working/workspace_agl_octopus/meta-agl/templates/base/99_setup_EULAconf.sh --- end of setup script OK -Generating setup file: /home/working/workspace_agl_master/build_gen3/agl-init-build-env ... OK +Generating setup file: /home/working/workspace_agl_octopus/build_gen3/agl-init-build-env ... OK ------------ aglsetup.sh: Done [snip] ``` diff --git a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/01_Instrument_Cluster_(IC-IVI_with_Container_isolation).md b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/01_Instrument_Cluster_(IC-IVI_with_Container_isolation).md index 9abaad8..c48fbc0 100644 --- a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/01_Instrument_Cluster_(IC-IVI_with_Container_isolation).md +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/01_Instrument_Cluster_(IC-IVI_with_Container_isolation).md @@ -41,10 +41,10 @@ git config --global user.name "Your Name" repo init -b marlin -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo repo sync ``` -- Optional: Specify the manifest file(marlin_13.0.0.xml) using -m option +- Optional: Specify the manifest file(octopus_15.0.0.xml) using -m option ```bash -repo init -b marlin -m marlin_13.0.0.xml -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo +repo init -b octopus -m octopus_15.0.0.xml -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo ``` - Optional: Specify the master branch ```bash @@ -64,7 +64,7 @@ cp R-Car_Gen3_Series_Evaluation_Software_Package_* $XDG_DOWNLOAD_DIR/ chmod a+rw $XDG_DOWNLOAD_DIR/*.zip ``` ## 5. Define Your Board -- Supporting Starter Kit Pro/M3 + kingfisher Board (For other supported boards, check [Define Your Board](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md)) +- Supporting Starter Kit Pro/M3 + kingfisher Board (For other supported boards, check [Define Your Board](https://docs.automotivelinux.org/en/octopus/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md)) ```bash export MACHINE=m3ulcb-kf ``` @@ -83,7 +83,7 @@ bitbake lxc-host-image-demo ## 8.Boot the Board (Deploying the AGL Demo Image) - To boot your image on the Renesas board, you need to do three things: -a) Update all [firmware](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards/#4-troubleshooting) on R-Car M3 Starter Kit board (Flashing firmware). +a) Update all [firmware](https://docs.automotivelinux.org/en/octopus/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards/#4-troubleshooting) on R-Car M3 Starter Kit board (Flashing firmware). b) Prepare the MicroSD card and Flash image to the MicroSD card using [Etcher](https://www.balena.io/etcher/) (**image file name:** lxc-host-image-demo-m3ulcb-kf.wic.xz), then insert MicroSD card in the R-Car M3SK. @@ -121,7 +121,7 @@ B) Connect HDMI panel to Kingfisher(CN49)for **Cluster Container** 1. [eLinux](https://elinux.org/R-Car/AGL) 1. [Kingfisher Board](https://elinux.org/R-Car/Boards/Kingfisher) 1. [R-Car M3SK](https://elinux.org/R-Car/Boards/M3SK#Flashing_firmware) - 1. [agl reference machines](https://docs.automotivelinux.org/en/master/#02_hardware_support/01_Supported_Hardware_Overview/) + 1. [agl reference machines](https://docs.automotivelinux.org/en/octopus/#02_hardware_support/01_Supported_Hardware_Overview/) 1. [AGL Tech Day Presenation](https://static.sched.com/hosted_files/agltechday2022/3b/agl-techday-202204.pdf) - 1. [Build AGL Image](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/0_Build_Process_Overview/) - 1. [Building for Supported Renesas Boards](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards/) + 1. [Build AGL Image](https://docs.automotivelinux.org/en/octopus/#01_Getting_Started/02_Building_AGL_Image/0_Build_Process_Overview/) + 1. [Building for Supported Renesas Boards](https://docs.automotivelinux.org/en/octopus/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards/) diff --git a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/02_Flutter_Instrument_Cluster_(qemu-x86).md b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/02_Flutter_Instrument_Cluster_(qemu-x86).md index 330d996..eabaa6e 100644 --- a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/02_Flutter_Instrument_Cluster_(qemu-x86).md +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/02_Flutter_Instrument_Cluster_(qemu-x86).md @@ -6,7 +6,7 @@ title: Flutter Instrument Cluster (qemu-x86) ## 0. Prepare Your Build Host -- Install the required tools to build an AGL Image. For detailed explanation, check [Preparing Your Build host](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host/) +- Install the required tools to build an AGL Image. For detailed explanation, check [Preparing Your Build host](https://docs.automotivelinux.org/en/octopus/#01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host/) ## 1. Define Your Top-Level Directory @@ -27,12 +27,12 @@ $ chmod a+x $HOME/bin/repo ``` ## 3. Download the AGL Source Files -To download the latest **master** branch AGL files, use the following commands: +To download the latest **octopus** branch AGL files, use the following commands: ```bash $ cd $AGL_TOP -$ mkdir master -$ cd master -$ repo init -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo +$ mkdir octopus +$ cd octopus +$ repo init -b octopus -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo $ repo sync ``` @@ -40,24 +40,24 @@ $ repo sync To initialize the build environment, we must use the setup script. This script is available here: ```bash -$ $AGL_TOP/master/meta-agl/scripts/aglsetup.sh +$ $AGL_TOP/octopus/meta-agl/scripts/aglsetup.sh ``` Run the script: ```bash $ cd $AGL_TOP -$ source master/meta-agl/scripts/aglsetup.sh -b build-flutter-cluster -m qemux86-64 agl-demo agl-devel +$ source octopus/meta-agl/scripts/aglsetup.sh -b build-flutter-cluster -m qemux86-64 agl-demo agl-devel ``` - Here `-b` is used to specify the build directory and `-m` is used to specify the target platform. -- Running this script, will create a build directory if it does not exist. Default build directory: `$AGL_TOP/master/build-flutter-cluster` +- Running this script, will create a build directory if it does not exist. Default build directory: `$AGL_TOP/octopus/build-flutter-cluster` - Default target paltform: `qemux86-64` ** NOTE: Set the API key in local.conf ** - By default navigation will not work, you need to set your openrouteservie API key to the variable `OPENROUTE_API_KEY` in your local.conf -- It is present at `$AGL_TOP/master/build-flutter-cluster/conf/local.conf` +- It is present at `$AGL_TOP/octopus/build-flutter-cluster/conf/local.conf` - Example: Just add `OPENROUTE_API_KEY = "your_openrouteservice_api_key"` to the end of local.conf @@ -65,7 +65,7 @@ $ source master/meta-agl/scripts/aglsetup.sh -b build-flutter-cluster -m qemux86 ## 5. Using BitBake ```bash -$ cd $AGL_TOP/master/build-flutter-cluster +$ cd $AGL_TOP/octopus/build-flutter-cluster $ source agl-init-build-env $ bitbake agl-cluster-demo-platform-flutter ``` @@ -74,7 +74,7 @@ $ bitbake agl-cluster-demo-platform-flutter Boot the image using QEMU ```bash -$ cd $AGL_TOP/master/build-flutter-cluster +$ cd $AGL_TOP/octopus/build-flutter-cluster $ source agl-init-build-env $ runqemu kvm serialstdio slirp publicvnc ``` diff --git a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_IVI_Flutter_apps.md b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_IVI_Flutter_apps.md index ddce79d..10f5604 100644 --- a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_IVI_Flutter_apps.md +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_IVI_Flutter_apps.md @@ -6,7 +6,7 @@ title: IVI Flutter apps ## 0. Prepare Your Build Host -- Install the required tools to build an AGL Image. For detailed explanation, check [Preparing Your Build host](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host/) +- Install the required tools to build an AGL Image. For detailed explanation, check [Preparing Your Build host](https://docs.automotivelinux.org/en/octopus/#01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host/) ## 1. Define Your Top-Level Directory @@ -27,12 +27,12 @@ $ chmod a+x $HOME/bin/repo ``` ## 3. Download the AGL Source Files -To download the latest **master** branch AGL files, use the following commands: +To download the latest **octopus** branch AGL files, use the following commands: ```bash $ cd $AGL_TOP -$ mkdir master -$ cd master -$ repo init -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo +$ mkdir octopus +$ cd octopus +$ repo init -b octopus -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo $ repo sync ``` @@ -40,18 +40,18 @@ $ repo sync To initialize the build environment, we must use the setup script. This script is available here: ```bash -$ $AGL_TOP/master/meta-agl/scripts/aglsetup.sh +$ $AGL_TOP/octopus/meta-agl/scripts/aglsetup.sh ``` Run the script: ```bash $ cd $AGL_TOP -$ source master/meta-agl/scripts/aglsetup.sh -b build-flutter-dashboard -m qemux86-64 agl-demo agl-devel +$ source octopus/meta-agl/scripts/aglsetup.sh -b build-flutter-dashboard -m qemux86-64 agl-demo agl-devel ``` - Here `-b` is used to specify the build directory and `-m` is used to specify the target platform. -- Running this script, will create a build directory if it does not exist. Default build directory: `$AGL_TOP/master/build-flutter-dashboard` +- Running this script, will create a build directory if it does not exist. Default build directory: `$AGL_TOP/octopus/build-flutter-dashboard` - Default target paltform: `qemux86-64` ## 5. Using BitBake diff --git a/docs/02_Hardware_Support/01_Supported_Hardware_Overview.md b/docs/02_Hardware_Support/01_Supported_Hardware_Overview.md index eb7c9a4..24d856b 100644 --- a/docs/02_Hardware_Support/01_Supported_Hardware_Overview.md +++ b/docs/02_Hardware_Support/01_Supported_Hardware_Overview.md @@ -16,11 +16,11 @@ The following table briefs about the various hardware platforms, supported by AG | BOARD | MACHINE | ARCHITECTURE | QUICK START GUIDE| LATEST SNAPSHOT | |:---------------:|:--------------:|:------------:|:----------------:|:--------------------:| -| QEMU | qemu-x86-64 | x86 |[QEMU Quick Start](https://docs.automotivelinux.org/en/master/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/#_top)| [qemu-x86-64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/)| -| | qemu-arm | arm32 | | [qemu-arm](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/)| -| | qemu-arm64 | arm64 | | [qemu-arm64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/)| +| QEMU | qemu-x86-64 | x86 |[QEMU Quick Start](https://docs.automotivelinux.org/en/octopus/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/#_top)| [qemu-x86-64](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemux86-64/)| +| | qemu-arm | arm32 | | [qemu-arm](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemuarm/)| +| | qemu-arm64 | arm64 | | [qemu-arm64](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemuarm64/)| | | | | -| RCar Gen 3 | h3ulcb | arm64 |[RCar Gen 3 Quick Start](https://docs.automotivelinux.org/en/master/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/#3-r-car-h3sk-h3ulcb-board)| [h3ulcb-nogfx](https://download.automotivelinux.org/AGL/snapshots/master/latest/h3ulcb-nogfx/)| +| RCar Gen 3 | h3ulcb | arm64 |[RCar Gen 3 Quick Start](https://docs.automotivelinux.org/en/octopus/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/#3-r-car-h3sk-h3ulcb-board)| [h3ulcb-nogfx](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/h3ulcb-nogfx/)| | | h3-salvator-x | arm64 | | | h3-kf | arm64 | | | m3ulcb | arm64 | @@ -28,7 +28,7 @@ The following table briefs about the various hardware platforms, supported by AG | | m3-kf | arm64 | | | agl-refhw | arm64 | | | | | -| Raspberry Pi | raspberrypi4 | arm64 |[Raspberry Pi Quick Start](https://docs.automotivelinux.org/en/master/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/#2-raspberry-pi-4)|[raspberrypi4](https://download.automotivelinux.org/AGL/snapshots/master/latest/raspberrypi4/)| +| Raspberry Pi | raspberrypi4 | arm64 |[Raspberry Pi Quick Start](https://docs.automotivelinux.org/en/octopus/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/#2-raspberry-pi-4)|[raspberrypi4](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/raspberrypi4/)| **Note:** Latest stable release source tar and binary for all the boards can be found [here](https://wiki.automotivelinux.org/agl-distro/release-notes#latest_stable_release) diff --git a/docs/03_Architecture_Guides/01_Introduction/01_Overview.md b/docs/03_Architecture_Guides/01_Introduction/01_Overview.md index f908ad4..245e281 100644 --- a/docs/03_Architecture_Guides/01_Introduction/01_Overview.md +++ b/docs/03_Architecture_Guides/01_Introduction/01_Overview.md @@ -50,4 +50,4 @@ The Application Framework layer provides the APIs for creating both managing and applications on an AGL system. The Services layer contains user space services that all applications can access. The Operating System (OS) layer provides the Linux kernel and device drivers along with standard OS utilities. For IVI (In Vehicle Infotainment) -system a full fledged demo is [available](https://docs.automotivelinux.org/en/master/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/). +system a full fledged demo is [available](https://docs.automotivelinux.org/en/octopus/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/). diff --git a/docs/04_Developer_Guides/01_Setting_Up_AGL_SDK.md b/docs/04_Developer_Guides/01_Setting_Up_AGL_SDK.md index d3f01fb..f7a86e9 100644 --- a/docs/04_Developer_Guides/01_Setting_Up_AGL_SDK.md +++ b/docs/04_Developer_Guides/01_Setting_Up_AGL_SDK.md @@ -9,19 +9,19 @@ quickstart the service and application development process. Please open the link below and download .sh file for desired machine. - **Note:** The links provided are for the master branch. If you want SDK for specific branch than change the name from master to specific branch. + **Note:** The links provided are for the octopus branch. If you want SDK for specific branch than change the name from octopus to specific branch. - - **x86** : [qemux86-64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/sdk/) + - **x86** : [qemux86-64](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemux86-64/deploy/sdk/) **Note:** .sh file will be with name "poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-$(version number).sh" where version number is regularly updated on the site. - - **ARM 32 bit** : [qemuarm](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/deploy/sdk/) + - **ARM 32 bit** : [qemuarm](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemuarm/deploy/sdk/) **Note:** .sh file will be with name " poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-armv7vet2hf-neon-vfpv4-qemuarm-toolchain-$(version number).sh" where version number is regularly updated on the site. - - **AARCH64 - ARM 64bit** : [qemuarm64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/deploy/sdk/) + - **AARCH64 - ARM 64bit** : [qemuarm64](https://download.automotivelinux.org/AGL/snapshots/octopus/latest/qemuarm64/deploy/sdk/) **Note:** .sh file will be with name " poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-aarch64-qemuarm64-toolchain-$(version number).sh" where version number is regularly updated on the site. diff --git a/docs/04_Developer_Guides/02_AGL_Layers/03_meta_agl_demo.md b/docs/04_Developer_Guides/02_AGL_Layers/03_meta_agl_demo.md index dbfe374..446c347 100644 --- a/docs/04_Developer_Guides/02_AGL_Layers/03_meta_agl_demo.md +++ b/docs/04_Developer_Guides/02_AGL_Layers/03_meta_agl_demo.md @@ -24,13 +24,13 @@ The `meta-agl-demo` layer has the following base dependencies: - URI: git://git.yoctoproject.org/poky - Branch: "thud" - Tested Revision: See the - [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml) + [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/octopus/default.xml) manifest file for the `AGL-repo` repository for revision information. - AGL `meta-agl` Layer: - URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl - - Branch: "master" + - Branch: "octopus" - OpenEmbedded `meta-openembedded` Layer: @@ -113,7 +113,7 @@ dependencies: - AGL's `meta-netboot` Layer within the `meta-agl` Layer: - URI: https://gerrit.automotivelinux.org/gerrit/gitweb?p=AGL/meta-agl.git - - Branch: "master" + - Branch: "octopus" ## Packagegroups diff --git a/docs/06_Component_Documentation/02_agl_compositor.md b/docs/06_Component_Documentation/02_agl_compositor.md index c5221cb..2eb4ef4 100644 --- a/docs/06_Component_Documentation/02_agl_compositor.md +++ b/docs/06_Component_Documentation/02_agl_compositor.md @@ -135,7 +135,7 @@ assigning them panel and/or background roles, and they're fully loaded, the client can then issue `ready()` request and the compositor will start presenting. -Please consult the [protocol file](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/agl-compositor.git;a=blob_plain;f=protocol/agl-shell.xml;hb=refs/heads/master) +Please consult the [protocol file](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/agl-compositor.git;a=blob_plain;f=protocol/agl-shell.xml;hb=refs/heads/octopus) as that is the authoritative way of getting the latest version. #### V2 updates @@ -205,7 +205,7 @@ protocol. These roles serve as hints for the compositor and should be used before the actual surface creation takes place, such that the compositor can take the necessary steps to satisfy those requirements. -Please consult the [protocol file](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/agl-compositor.git;a=blob_plain;f=protocol/agl-shell-desktop.xml;hb=refs/heads/master) +Please consult the [protocol file](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/agl-compositor.git;a=blob_plain;f=protocol/agl-shell-desktop.xml;hb=refs/heads/octopus) as that is the authoritative way of getting the latest version. #### Additional surface roles in agl-shell-desktop diff --git a/docs/07_How_To_Contribute/03_Working_with_Gerrit.md b/docs/07_How_To_Contribute/03_Working_with_Gerrit.md index ccd9133..3b083d4 100644 --- a/docs/07_How_To_Contribute/03_Working_with_Gerrit.md +++ b/docs/07_How_To_Contribute/03_Working_with_Gerrit.md @@ -103,7 +103,7 @@ repeat the ``git review`` command. ```sh $ cd documentation # Working Repository $ git remote -v update # Updating wrt remote - $ git checkout -b mytopicbranch origin/master # Creating new branch + $ git checkout -b mytopicbranch origin/octopus # Creating new branch ### CODE the CHANGES $ git add <file> # Track the changed files $ git commit -s # Signed Commit Message @@ -119,7 +119,7 @@ repeat the ``git review`` command. $ git add <file> # Track the changed files $ git commit -s # Signed Commit Message $ git review # Submit Changes to review - $ git checkout master # Return to master branch + $ git checkout octopus # Return to octopus branch ``` ## Reviewing Using Gerrit diff --git a/docs/07_How_To_Contribute/06_Gerrit_Recommended_Practices.md b/docs/07_How_To_Contribute/06_Gerrit_Recommended_Practices.md index 671c685..ef02acb 100644 --- a/docs/07_How_To_Contribute/06_Gerrit_Recommended_Practices.md +++ b/docs/07_How_To_Contribute/06_Gerrit_Recommended_Practices.md @@ -61,20 +61,20 @@ and help others ramp up. Topic branches are temporary branches that you push to commit a set of logically-grouped dependent commits: -To push changes from ``REMOTE/master`` tree to Gerrit for being reviewed as a +To push changes from ``REMOTE/octopus`` tree to Gerrit for being reviewed as a topic in **TopicName** use the following command as an example: ```sh -$ git push REMOTE HEAD:refs/for/master/TopicName +$ git push REMOTE HEAD:refs/for/octopus/TopicName ``` The topic will show up in the review ``UI`` and in the ``Open Changes List``. -Topic branches will disappear from the master tree when its content is merged. +Topic branches will disappear from the octopus tree when its content is merged. ## Finding Available Topics ```sh -$ ssh -p 29418 <LFID>@gerrit.automotivelinux.org gerrit query \ status:open branch:master| grep topic: | sort -u +$ ssh -p 29418 <LFID>@gerrit.automotivelinux.org gerrit query \ status:open branch:octopus| grep topic: | sort -u ``` - [gerrit.automotivelinux.org](https://gerrit.automotivelinux.org) is the @@ -159,13 +159,13 @@ list of commits, **c0...c7**, which were submitted as a topic branch: ```sh -$ git log REMOTE/master..master +$ git log REMOTE/octopus..octopus c0 ... c7 -$ git push REMOTE HEAD:refs/for/master/SOMETOPIC +$ git push REMOTE HEAD:refs/for/octopus/SOMETOPIC ``` After you get reviewers' feedback, there are changes in **c3** and **c4** that @@ -175,7 +175,7 @@ for more information. However, you must keep the same Change-Id and push the changes again: ```sh -$ git push REMOTE HEAD:refs/for/master/SOMETOPIC +$ git push REMOTE HEAD:refs/for/octopus/SOMETOPIC ``` This new push creates a patches revision, your local history is then cleared. @@ -193,18 +193,18 @@ you to make the necessary *Change-Ids*. The *Change-Ids* must be kept the same. - **reword:** changes the commit message. - **edit:** changes the commit content. - **reorder:** allows you to interchange the order of the commits. -- **rebase:** stacks the commits on top of the master. +- **rebase:** stacks the commits on top of the octopus. ## Rebasing During a Pull -Before pushing a rebase to your master, ensure that the history has a +Before pushing a rebase to your octopus, ensure that the history has a consecutive order. -For example, your ``REMOTE/master`` has the list of commits from **a0** to +For example, your ``REMOTE/octopus`` has the list of commits from **a0** to **a4**; Then, your changes **c0...c7** are on top of **a4**; thus: ```sh -$ git log --oneline REMOTE/master..master +$ git log --oneline REMOTE/octopus..octopus a0 a1 @@ -217,17 +217,17 @@ $ git log --oneline REMOTE/master..master c7 ``` -If ``REMOTE/master`` receives commits **a5**, **a6** and **a7**. Pull with a +If ``REMOTE/octopus`` receives commits **a5**, **a6** and **a7**. Pull with a rebase as follows: ```sh -$ git pull --rebase REMOTE master +$ git pull --rebase REMOTE octopus ``` This pulls **a5-a7** and re-apply **c0-c7** on top of them: ```sh -$ git log --oneline REMOTE/master..master +$ git log --oneline REMOTE/octopus..octopus a0 ... a7 diff --git a/docs/07_How_To_Contribute/08_Adding_Documentation.md b/docs/07_How_To_Contribute/08_Adding_Documentation.md index b879cc0..963a129 100644 --- a/docs/07_How_To_Contribute/08_Adding_Documentation.md +++ b/docs/07_How_To_Contribute/08_Adding_Documentation.md @@ -100,7 +100,7 @@ $ blc http://localhost:8000 -ro For testing hyperlinks of live website do: ```sh -$ blc https://docs.automotivelinux.org/en/master/ -ro +$ blc https://docs.automotivelinux.org/en/octopus/ -ro ``` The ```Broken Link Checker``` output will display the broken link and there location in diff --git a/docs/07_How_To_Contribute/09_Contribution_Checklist.md b/docs/07_How_To_Contribute/09_Contribution_Checklist.md index 89052e8..8de8f01 100644 --- a/docs/07_How_To_Contribute/09_Contribution_Checklist.md +++ b/docs/07_How_To_Contribute/09_Contribution_Checklist.md @@ -42,7 +42,7 @@ title: Contribution Checklist - [ ] Must have: a .gitreview file. - [ ] Option: Can have a .gitignore file. - [ ] Option: Can have a .editorconfig file. - - [ ] All code needs to build against master. + - [ ] All code needs to build against octopus. - [ ] Is a backport to a release branch required ? - [ ] Code contributions submitted need to have a Sign-off-by! (Follow [**DCO**](https://developercertificate.org/).) |