From f0d0275127ed9891d40baf3fe39f191267566483 Mon Sep 17 00:00:00 2001 From: Jan-Simon Möller Date: Wed, 9 Aug 2023 14:54:29 +0200 Subject: Docs: Updates prior to Prickly Pike release MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update the documentation with 'pike' specific instructions and links. Signed-off-by: Jan-Simon Möller Change-Id: If8396da3000d1aad91d9e31ab4ac1110ca649f92 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29112 --- ...nt_Cluster_(IC-IVI_with_Container_isolation).md | 16 ++++++++-------- .../02_Flutter_Instrument_Cluster_(qemu-x86).md | 22 +++++++++++----------- .../03_IVI_Flutter_apps.md | 20 ++++++++++---------- 3 files changed, 29 insertions(+), 29 deletions(-) (limited to 'docs/01_Getting_Started/03_Build_and_Boot_guide_Profile') 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 c3ddf80..e18903e 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 @@ -38,13 +38,13 @@ export AGL_TOP=$HOME/AGL/marlin cd $AGL_TOP git config --global user.email "you@example.com" git config --global user.name "Your Name" -repo init -b marlin -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo +repo init -b pike -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(pike_16.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 pike -m pike_16.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/pike/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md)) ```bash export MACHINE=m3ulcb-kf ``` @@ -83,7 +83,7 @@ bitbake agl-cluster-demo-lxc-host ## 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/pike/#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/pike/#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/pike/#01_Getting_Started/02_Building_AGL_Image/0_Build_Process_Overview/) + 1. [Building for Supported Renesas Boards](https://docs.automotivelinux.org/en/pike/#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..59ea8ee 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/pike/#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 **pike** 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 pike +$ cd pike +$ repo init -n pike -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/pike/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 pike/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/pike/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/pike/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/pike/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/pike/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 6055436..71df17b 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/pike/#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 **pike** 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 pike +$ cd pike +$ repo init -b pike -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/pike/meta-agl/scripts/aglsetup.sh ``` Run the script: ```bash -$ cd $AGL_TOP/master +$ cd $AGL_TOP/pike $ source 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/pike/build-flutter-dashboard` - Default target paltform: `qemux86-64` ## 5. Using BitBake ```bash -$ cd $AGL_TOP/master/build-flutter-dashboard +$ cd $AGL_TOP/pike/build-flutter-dashboard $ source agl-init-build-env $ bitbake agl-ivi-demo-platform-flutter ``` @@ -66,7 +66,7 @@ $ bitbake agl-ivi-demo-platform-flutter Boot the image using QEMU ```bash -$ cd $AGL_TOP/master/build-flutter-dashboard +$ cd $AGL_TOP/pike/build-flutter-dashboard $ source agl-init-build-env $ runqemu kvm serialstdio slirp publicvnc ``` -- cgit 1.2.3-korg