diff options
21 files changed, 114 insertions, 153 deletions
@@ -26,6 +26,7 @@ $ git clone "ssh://$USER@gerrit.automotivelinux.org:29418/AGL/documentation" && ```sh $ cd documentation + $ git checkout salmon || git checkout -b salmon origin/salmon ``` 2. Install MkDocs and rtd-dropdown theme 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 ac22902..3dce920 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-ivi-demo-qt-crosssdk-qemux86-64.ext4.xz). +1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/salmon/latest/qemux86-64/deploy/images/qemux86-64/agl-ivi-demo-qt-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/release/salmon/latest/qemux86-64/deploy/images/qemux86-64/bzImage). 3. Install [QEMU](https://www.qemu.org/download/) : @@ -28,7 +28,7 @@ AGL provides a number of pre-built ready-made images of various versions. ```sh $ mkdir ~/agl-demo/ - $ cp ~/Downloads/agl-ivi-demo-qt-crosssdk-qemux86-64.ext4.xz ~/agl-demo/ + $ cp ~/Downloads/agl-ivi-demo-qt-qemux86-64.ext4.xz ~/agl-demo/ $ cp ~/Downloads/bzImage ~/agl-demo/ $ cd ~/agl-demo $ sync @@ -37,7 +37,7 @@ AGL provides a number of pre-built ready-made images of various versions. 6. Extract prebuilt compressed image : ```sh - $ xz -v -d agl-ivi-demo-qt-crosssdk-qemux86-64.ext4.xz + $ xz -v -d agl-ivi-demo-qt-qemux86-64.ext4.xz ``` 7. Launch QEMU with vinagre (for scaling), remove `- snapshot \` if you want to save changes to the image files : @@ -45,7 +45,7 @@ AGL provides a number of pre-built ready-made images of various versions. ```sh $ ( sleep 5 && vinagre --vnc-scale localhost ) > /tmp/vinagre.log 2>&1 & $ qemu-system-x86_64 -device virtio-net-pci,netdev=net0,mac=52:54:00:12:35:02 -netdev user,id=net0,hostfwd=tcp::2222-:22 \ - -drive file=agl-ivi-demo-qt-crosssdk-qemux86-64.ext4,if=virtio,format=raw -show-cursor -usb -usbdevice tablet -device virtio-rng-pci \ + -drive file=agl-ivi-demo-qt-qemux86-64.ext4,if=virtio,format=raw -show-cursor -usb -usbdevice tablet -device virtio-rng-pci \ -snapshot -vga virtio \ -vnc :0 -soundhw hda -machine q35 -cpu kvm64 -cpu qemu64,+ssse3,+sse4.1,+sse4.2,+popcnt -enable-kvm \ -m 2048 -serial mon:vc -serial mon:stdio -serial null -kernel bzImage \ @@ -66,7 +66,7 @@ AGL provides a number of pre-built ready-made images of various versions. ```sh $ ( sleep 5 && vncviewer ) & qemu-system-x86_64 -device virtio-net-pci,netdev=net0,mac=52:54:00:12:35:02 -netdev user,id=net0,hostfwd=tcp::2222-:22 \ - -drive file=agl-ivi-demo-qt-crosssdk-qemux86-64.ext4,if=virtio,format=raw -show-cursor -usb -usbdevice tablet -device virtio-rng-pci \ + -drive file=agl-ivi-demo-qt-qemux86-64.ext4,if=virtio,format=raw -show-cursor -usb -usbdevice tablet -device virtio-rng-pci \ -snapshot -vga virtio \ -vnc :0 -soundhw hda -machine q35 -cpu kvm64 -cpu qemu64,+ssse3,+sse4.1,+sse4.2,+popcnt -enable-kvm \ -m 2048 -serial mon:vc -serial mon:stdio -serial null -kernel bzImage \ @@ -78,11 +78,11 @@ 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-ivi-demo-qt-crosssdk-qemux86-64.wic.vmdk.xz). + 1. Download the [compressed vbox disk image](https://download.automotivelinux.org/AGL/release/salmon/latest/qemux86-64/deploy/images/qemux86-64/agl-ivi-demo-qt-qemux86-64.wic.vmdk.xz). 2. Install and set up [Virtual Box](https://www.virtualbox.org/wiki/Linux_Downloads). - 3. Extract the vmdk file : `$ xz -v -d agl-ivi-demo-qt-crosssdk-qemux86-64.wic.vmdk.xz` + 3. Extract the vmdk file : `$ xz -v -d agl-ivi-demo-qt-qemux86-64.wic.vmdk.xz` 4. Configure virtual box for AGL : - Click on `New` or `Add`. @@ -92,7 +92,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt  - Select Memory size. Recommended is `2048 MB`, click on `Next`.  - - Click on `Use an existing virtual hard disk file`, and select the extracted `agl-ivi-demo-qt-crosssdk-qemux86-64.wic.vmdk` file, click on `Create`. + - Click on `Use an existing virtual hard disk file`, and select the extracted `agl-ivi-demo-qt-qemux86-64.wic.vmdk` file, click on `Create`.  - Go to `Settings`, and into `System`. Select `Chipset : IHC9`. Check on `Enable EFI (special OSes only)` and click on `OK`.  @@ -110,14 +110,14 @@ 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-ivi-demo-qt-crosssdk-qemux86-64.wic.xz). + 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/salmon/latest/qemux86-64/deploy/images/qemux86-64/agl-ivi-demo-qt-qemux86-64.wic.xz). 2. Extract the image into USB drive : ```sh $ lsblk $ sudo umount <usb_device_name> - $ xzcat agl-ivi-demo-qt-crosssdk-qemux86-64.wic.xz | sudo dd of=<usb_device_name> bs=4M + $ xzcat agl-ivi-demo-qt-qemux86-64.wic.xz | sudo dd of=<usb_device_name> bs=4M $ sync ``` @@ -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-ivi-demo-qt-crosssdk-qemuarm.ext4.xz). +1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/salmon/latest/qemuarm/deploy/images/qemuarm/agl-ivi-demo-qt-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/release/salmon/latest/qemuarm/deploy/images/qemuarm/zImage). 3. Install [QEMU](https://www.qemu.org/download/) : @@ -148,7 +148,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt ```sh $ mkdir ~/agl-demo/ - $ cp ~/Downloads/agl-ivi-demo-qt-crosssdk-qemuarm.ext4.xz ~/agl-demo/ + $ cp ~/Downloads/agl-ivi-demo-qt-qemuarm.ext4.xz ~/agl-demo/ $ cp ~/Downloads/zImage ~/agl-demo/ $ cd ~/agl-demo $ sync @@ -157,7 +157,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt 6. Extract prebuilt compressed image : ```sh - $ xz -v -d agl-ivi-demo-qt-crosssdk-qemuarm.ext4.xz + $ xz -v -d agl-ivi-demo-qt-qemuarm.ext4.xz ``` 7. Launch QEMU with vinagre (for scaling), remove `- snapshot` if you want to save changes to the image files : @@ -170,7 +170,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt -device virtio-rng-pci -device VGA,vgamem_mb=64,edid=on -vnc :0 \ -device qemu-xhci -device usb-tablet -device usb-kbd \ -kernel zImage -append "console=ttyAMA0,115200 root=/dev/vda verbose systemd.log_color=false" \ - -drive format=raw,file=agl-ivi-demo-qt-crosssdk-qemuarm.ext4 \ + -drive format=raw,file=agl-ivi-demo-qt-qemuarm.ext4 \ -snapshot ``` @@ -193,13 +193,13 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt -device virtio-rng-pci -device VGA,vgamem_mb=64,edid=on -vnc :0 \ -device qemu-xhci -device usb-tablet -device usb-kbd \ -kernel zImage -append "console=ttyAMA0,115200 root=/dev/vda verbose systemd.log_color=false" \ - -drive format=raw,file=agl-ivi-demo-qt-crosssdk-qemuarm.ext4 \ + -drive format=raw,file=agl-ivi-demo-qt-qemuarm.ext4 \ -snapshot ``` ### 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-bbe.wic.xz). + 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/salmon/latest/bbe/deploy/images/bbe/agl-telematics-demo-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-ivi-demo-qt-crosssdk-qemuarm64.ext4.xz). +1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/salmon/latest/qemuarm64/deploy/images/qemuarm64/agl-ivi-demo-qt-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/release/salmon/latest/qemuarm64/deploy/images/qemuarm64/Image). 3. Install [QEMU](https://www.qemu.org/download/) : @@ -244,7 +244,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt ```sh $ mkdir ~/agl-demo/ - $ cp ~/Downloads/agl-ivi-demo-qt-crosssdk-qemuarm64.ext4.xz ~/agl-demo/ + $ cp ~/Downloads/agl-ivi-demo-qt-qemuarm64.ext4.xz ~/agl-demo/ $ cp ~/Downloads/zImage ~/agl-demo/ $ cd ~/agl-demo $ sync @@ -253,7 +253,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt 6. Extract prebuilt compressed image : ```sh - $ xz -v -d agl-ivi-demo-qt-crosssdk-qemuarm64.ext4.xz + $ xz -v -d agl-ivi-demo-qt-qemuarm64.ext4.xz ``` 7. Launch QEMU with vinagre (for scaling), remove `- snapshot \` if you want to save changes to the image files : @@ -266,7 +266,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt -device virtio-rng-pci -device VGA,vgamem_mb=64,edid=on \ -device qemu-xhci -device usb-tablet -device usb-kbd -vnc :0 \ -kernel Image -append "console=ttyAMA0,115200 root=/dev/vda verbose systemd.log_color=false " \ - -drive format=raw,file=agl-ivi-demo-qt-crosssdk-qemuarm64.ext4 \ + -drive format=raw,file=agl-ivi-demo-qt-qemuarm64.ext4 \ -snapshot ``` @@ -289,20 +289,20 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt -device virtio-rng-pci -device VGA,vgamem_mb=64,edid=on \ -device qemu-xhci -device usb-tablet -device usb-kbd -vnc :0 \ -kernel Image -append "console=ttyAMA0,115200 root=/dev/vda verbose systemd.log_color=false " \ - -drive format=raw,file=agl-ivi-demo-qt-crosssdk-qemuarm64.ext4 \ + -drive format=raw,file=agl-ivi-demo-qt-qemuarm64.ext4 \ -snapshot ``` ### 2. Raspberry Pi 4 - 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/raspberrypi4/deploy/images/raspberrypi4-64/agl-ivi-demo-qt-crosssdk-raspberrypi4-64.wic.xz). + 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/salmon/latest/raspberrypi4/deploy/images/raspberrypi4-64/agl-ivi-demo-qt-raspberrypi4-64.wic.xz). 2. Extract the image into the SD card of Raspberry Pi 4 : ```sh $ lsblk $ sudo umount <sdcard_device_name> - $ xzcat agl-ivi-demo-qt-crosssdk-raspberrypi4-64.wic.xz | sudo dd of=<sdcard_device_name> bs=4M + $ xzcat agl-ivi-demo-qt-raspberrypi4-64.wic.xz | sudo dd of=<sdcard_device_name> bs=4M $ sync ``` @@ -363,16 +363,16 @@ 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/release/salmon/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-ivi-demo-qt-crosssdk-h3ulcb.wic.xz). + 2. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/salmon/latest/h3ulcb-nogfx/deploy/images/h3ulcb/agl-ivi-demo-qt-h3ulcb.wic.xz). 3. Extract the image into the boot device : ```sh $ lsblk $ sudo umount <boot_device_name> - $ xzcat agl-ivi-demo-qt-crosssdk-h3ulcb.wic.xz | sudo dd of=<boot_device_name> bs=4M + $ xzcat agl-ivi-demo-qt-h3ulcb.wic.xz | sudo dd of=<boot_device_name> bs=4M $ sync ``` 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..fc1d74e 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/release/salmon/latest/) exist for several boards as well as for the Quick EMUlator (QEMU). See the "[Quickstart](../01_Quickstart/01_Using_Ready_Made_Images.md)" @@ -56,7 +56,7 @@ section for more information on the ready-made images. **NOTE:** If you are using the CentOS distribution, you need to separately install the epel-release package and run the `makecache` command as described in - "[The Build Host Packages](https://docs.yoctoproject.org/ref-manual/system-requirements.html#required-packages-for-the-build-host)" + "[The Build Host Packages](https://docs.yoctoproject.org/OAref-manual/system-requirements.html#required-packages-for-the-build-host)" section of the Yocto Project Quick Start. Aside from the packages listed in the previous section, you need the following: diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/03_Downloading_AGL_Software.md b/docs/01_Getting_Started/02_Building_AGL_Image/03_Downloading_AGL_Software.md index 02d9108..eb83c54 100644 --- a/docs/01_Getting_Started/02_Building_AGL_Image/03_Downloading_AGL_Software.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/03_Downloading_AGL_Software.md @@ -59,8 +59,8 @@ The remainder of this section provides steps on how to download the AGL source f ```sh $ cd $AGL_TOP - $ mkdir <<branch name>> - $ cd <<branch name>> + $ mkdir <<branch name>> # e.g. 'salmon' + $ cd <<branch name>> # e.g. 'salmon' $ repo init -b <<branch name>> -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo $ repo sync ``` 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 03b2f5f..3b3f314 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/salmon/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/salmon $ source meta-agl/scripts/aglsetup.sh -h ``` @@ -231,7 +231,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/salmon/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..4da499d 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/salmon/${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/salmon/qemux86-64/ $ ln -sf $AGL_TOP/site.conf conf/ In General; diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/02_Building_for_x86_(Emulation_and_Hardware).md b/docs/01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/02_Building_for_x86_(Emulation_and_Hardware).md index 89ee35d..85157ca 100644 --- a/docs/01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/02_Building_for_x86_(Emulation_and_Hardware).md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/02_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/salmon/qemux86-64/agl-init-build-env ``` In general : diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/04_Building_for_Supported_Renesas_Boards.md b/docs/01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/04_Building_for_Supported_Renesas_Boards.md index 2a49078..0c38c2a 100644 --- a/docs/01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/04_Building_for_Supported_Renesas_Boards.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/04_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 salmon | 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_salmon/meta-agl/templates/machine/h3ulcb/50_setup.sh +/home/working/workspace_agl_salmon /home/working/workspace_agl_salmon/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_salmon/build_gen3 +--- fragment /home/working/workspace_agl_salmon/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_salmon/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 3ecc77d..df899fb 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 @@ -44,10 +44,10 @@ Build environment for AGL IC container integration is same as AGL other profile build environment. ### 1st step: -Please read [[Build Process Overview]](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/01_Build_Process_Overview/) in AGL doc. +Please read [[Build Process Overview]](https://docs.automotivelinux.org/en/salmon/#01_Getting_Started/02_Building_AGL_Image/01_Build_Process_Overview/) in AGL doc. ### 2nd step: -Please read [[Preparing Your Build Host]](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host/) in AGL doc. +Please read [[Preparing Your Build Host]](https://docs.automotivelinux.org/en/salmon/#01_Getting_Started/02_Building_AGL_Image/02_Preparing_Your_Build_Host/) in AGL doc. ### 3rd step: Define Your Top-Level Directory. @@ -81,8 +81,8 @@ $ git config \--global user.name "Your Name" ```bash $ cd $AGL_TOP -$ mkdir master -$ export AGL_TOP=$HOME/AGL/master +$ mkdir salmon +$ export AGL_TOP=$HOME/AGL/salmon $ cd $AGL_TOP $ repo init -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo $ repo sync @@ -94,7 +94,7 @@ If your board is Raspberry Pi4, please skip this step. #### 7-1: Downloading Proprietary Drivers from [Renesas-automotive-products](https://www.renesas.com/us/en/products/automotive-products/automotive-system-chips-socs/r-car-h3-m3-documents-software). -In case of master, please download this. +In case of salmon, please download this. ***Note. Latest AGL use same binary as kirkstone.*** @@ -183,7 +183,7 @@ work flow that depend to Renesas propriety license limitation. We recommend to open new terminal to do this extra section. ```bash -$ export AGL_TOP=$HOME/AGL/master +$ export AGL_TOP=$HOME/AGL/salmon $ cd $AGL_TOP ``` @@ -238,31 +238,31 @@ OUT_OF_TREE_CONTAINER_IMAGE_DEPLOY_DIR = "/path/to/deploy/" ex. When your board is AGL RefHW and your home directory is "/home/user/". ```bash -OUT_OF_TREE_CONTAINER_IMAGE_DEPLOY_DIR = "/home/user/AGL/master/build-ivi-refhw/tmp/deploy" +OUT_OF_TREE_CONTAINER_IMAGE_DEPLOY_DIR = "/home/user/AGL/salmon/build-ivi-refhw/tmp/deploy" ``` ex. When your board is R- CarH3 Starter Kit with Kingfisher board and your home directory is "/home/user/". ```bash -OUT_OF_TREE_CONTAINER_IMAGE_DEPLOY_DIR = "/home/user/AGL/master/build-ivi-h3kf/tmp/deploy" +OUT_OF_TREE_CONTAINER_IMAGE_DEPLOY_DIR = "/home/user/AGL/salmon/build-ivi-h3kf/tmp/deploy" ``` ex. When your board is NanoPC T6 board and your home directory is "/home/user/". ```bash -OUT_OF_TREE_CONTAINER_IMAGE_DEPLOY_DIR = "/home/user/AGL/master/build-ivi-nanopc-t6/tmp/deploy" +OUT_OF_TREE_CONTAINER_IMAGE_DEPLOY_DIR = "/home/user/AGL/salmon/build-ivi-nanopc-t6/tmp/deploy" ``` ex. When your board is Raspberry Pi 4 and your home directory is "/home/user/". ```bash -OUT_OF_TREE_CONTAINER_IMAGE_DEPLOY_DIR = "/home/user/AGL/master/build-ivi-rpi4/tmp/deploy" +OUT_OF_TREE_CONTAINER_IMAGE_DEPLOY_DIR = "/home/user/AGL/salmon/build-ivi-rpi4/tmp/deploy" ``` ex. When your board is Raspberry Pi 5 and your home directory is "/home/user/". ```bash -OUT_OF_TREE_CONTAINER_IMAGE_DEPLOY_DIR = "/home/user/AGL/master/build-ivi-rpi5/tmp/deploy" +OUT_OF_TREE_CONTAINER_IMAGE_DEPLOY_DIR = "/home/user/AGL/salmon/build-ivi-rpi5/tmp/deploy" ``` #### 4th step: Build all in one image (2b). @@ -516,7 +516,7 @@ Upstream: 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/salmon/#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/salmon/#01_Getting_Started/02_Building_AGL_Image/0_Build_Process_Overview/) + 1. [Building for Supported Renesas Boards](https://docs.automotivelinux.org/en/salmon/#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/03_Flutter_Instrument_Cluster_(qemu-x86).md b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_Flutter_Instrument_Cluster_(qemu-x86).md index 1cb3899..c79471b 100644 --- a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_Flutter_Instrument_Cluster_(qemu-x86).md +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_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/salmon/#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 **salmon** 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 salmon +$ cd salmon +$ repo init -b salmon -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/salmon/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 salmon/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/salmon/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/salmon/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/salmon/build-flutter-cluster $ source agl-init-build-env $ bitbake agl-cluster-demo-flutter ``` @@ -74,7 +74,7 @@ $ bitbake agl-cluster-demo-flutter Boot the image using QEMU ```bash -$ cd $AGL_TOP/master/build-flutter-cluster +$ cd $AGL_TOP/salmon/build-flutter-cluster $ source agl-init-build-env $ runqemu kvm serialstdio slirp publicvnc ``` @@ -96,7 +96,7 @@ To get the navigation, you need to use `kuksa_viss_client` or `kuksa_vss_init.py After running the build, you should get this: ```bash -Automotive Grade Linux 13.93.0 qemux86-64 ttyS0 +Automotive Grade Linux 18.93.0 qemux86-64 ttyS0 qemux86-64 login: diff --git a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/04_IVI_Flutter_apps.md b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/04_IVI_Flutter_apps.md index 6d6bd93..3bdb0fe 100644 --- a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/04_IVI_Flutter_apps.md +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/04_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/salmon/#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 **salmon** 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 salmon +$ cd salmon +$ repo init -b salmon -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/salmon/meta-agl/scripts/aglsetup.sh ``` Run the script: ```bash -$ cd $AGL_TOP/master +$ cd $AGL_TOP/salmon $ 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/salmon/build-flutter-dashboard` - Default target paltform: `qemux86-64` ## 5. Using BitBake ```bash -$ cd $AGL_TOP/master/build-flutter-dashboard +$ cd $AGL_TOP/salmon/build-flutter-dashboard $ source agl-init-build-env $ bitbake agl-ivi-demo-flutter ``` @@ -66,7 +66,7 @@ $ bitbake agl-ivi-demo-flutter Boot the image using QEMU ```bash -$ cd $AGL_TOP/master/build-flutter-dashboard +$ cd $AGL_TOP/salmon/build-flutter-dashboard $ source agl-init-build-env $ runqemu kvm serialstdio slirp publicvnc ``` diff --git a/docs/02_Hardware_Support/01_Supported_Hardware_Overview.md b/docs/02_Hardware_Support/01_Supported_Hardware_Overview.md index eb7c9a4..ae2a973 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/salmon/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/#_top)| [qemu-x86-64](https://download.automotivelinux.org/AGL/release/salmon/latest/qemux86-64/)| +| | qemu-arm | arm32 | | [qemu-arm](https://download.automotivelinux.org/AGL/release/salmon/latest/qemuarm/)| +| | qemu-arm64 | arm64 | | [qemu-arm64](https://download.automotivelinux.org/AGL/release/salmon/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/salmon/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/#3-r-car-h3sk-h3ulcb-board)| [h3ulcb-nogfx](https://download.automotivelinux.org/AGL/release/salmon/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/salmon/#01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images/#2-raspberry-pi-4)|[raspberrypi4](https://download.automotivelinux.org/AGL/release/salmon/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..4d1ea48 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/salmon/#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 895d025..db341d4 100644 --- a/docs/04_Developer_Guides/01_Setting_Up_AGL_SDK.md +++ b/docs/04_Developer_Guides/01_Setting_Up_AGL_SDK.md @@ -2,6 +2,8 @@ title: Setting Up AGL SDK --- +FIXME! + AGL provides a pre-built ready-made Software Development Kit (SDK) to help quickstart the service and application development process. 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 7aae87c..114a453 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 @@ -22,22 +22,16 @@ The `meta-agl-demo` layer has the following base dependencies: - Yocto Project Release: - URI: git://git.yoctoproject.org/poky - - Branch: "kirkstone" - - Tested Revision: See the - [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml) - manifest file for the `AGL-repo` repository for revision information. + - Branch: "scarthgap" - AGL `meta-agl` Layer: - URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl - - Branch: "master" + - Branch: "salmon" - OpenEmbedded `meta-openembedded` Layer: - - Branch: "thud" - - Tested Revision: See the - [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml) - manifest file for the `AGL-repo` repository for revision information. + - Branch: "scarthgap" Specifically, out of `meta-openembedded`, these sub-layers are used: @@ -46,14 +40,11 @@ The `meta-agl-demo` layer has the following base dependencies: - `meta-networking` - `meta-python` -- Yocto Project `meta-qt5` Layer from the +- Yocto Project `meta-qt6` Layer from the [OpenEmbedded Layer Index](https://layers.openembedded.org/layerindex/branch/master/layers/): - - URI: https://github.com/meta-qt5/meta-qt5.git - - Branch: "kirkstone" - - Tested Revision: See the - [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml) - manifest file for the `AGL-repo` repository for revision information. + - URI: https://code.qt.io/yocto/meta-qt6 + - Branch: "6.7" ### Hardware Dependencies @@ -73,47 +64,13 @@ dependencies: - URI: https://git.yoctoproject.org/cgit/cgit.cgi/meta-security - Branch: "master" - - Tested Revision: See the - [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml) - manifest file for the `AGL-repo` repository for revision information. - -- AGL's `meta-app-framework` Layer within the `meta-agl` Layer: - - - URI: https://gerrit.automotivelinux.org/gerrit/gitweb?p=AGL/meta-agl.git - - Branch: "master" - -**The `agl-sota` Feature:** - -- Here Technologies' `meta-updater` Layer: - - - URI: https://github.com/advancedtelematic/meta-updater/ - - Branch: "kirkstone" - -- Here Technologies' `meta-updater-qemux86-64` Layer: - - - URI: https://github.com/advancedtelematic/meta-updater-qemux86-64/ - - Branch: "kirkstone" - -- OpenEmbedded's `meta-openembedded` Layer: - - - URI: https://github.com/openembedded/meta-openembedded - - Branch: "kirkstone" - - Tested Revision: See the - [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml) - manifest file for the `AGL-repo` repository for revision information. - - Specifically, out of `meta-openembedded`, these sub-layers are used: - - - `meta-filesystems` - - `meta-oe` - - `meta-python` **The `agl-netboot` Feature:** - 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: "salmon" ## Maintenance diff --git a/docs/06_Component_Documentation/02_agl_compositor.md b/docs/06_Component_Documentation/02_agl_compositor.md index 67b73da..810ff33 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/salmon) as that is the authoritative way of getting the latest version. #### V2 updates @@ -279,7 +279,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/salmon) as that is the authoritative way of getting the latest version. #### Additional surface roles in agl-shell-desktop @@ -464,8 +464,8 @@ message AppStateResponse { }; ``` -A C++ client implementation the gRPC API can be found in [agl-shell-activator](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/agl-shell-activator.git;a=tree;h=refs/heads/master;hb=refs/heads/master) -or in [window-management-client-grpc](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/window-management-client-grpc.git;a=tree;h=refs/heads/master;hb=refs/heads/master). +A C++ client implementation the gRPC API can be found in [agl-shell-activator](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/agl-shell-activator.git;a=tree;h=refs/heads/salmon;hb=refs/heads/salmon) +or in [window-management-client-grpc](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/window-management-client-grpc.git;a=tree;h=refs/heads/salmon;hb=refs/heads/salmon). ## Explicit output diff --git a/docs/06_Component_Documentation/10_agl_voice_agent_assistant.md b/docs/06_Component_Documentation/10_agl_voice_agent_assistant.md index e75382e..7c09f23 100644 --- a/docs/06_Component_Documentation/10_agl_voice_agent_assistant.md +++ b/docs/06_Component_Documentation/10_agl_voice_agent_assistant.md @@ -11,12 +11,12 @@ Note: RASA NLU is currently not available as it is not supported by Python 3.12, # Installation and Usage -Before diving into the detailed components documentation, let's first look at how to install and use the voice agent service. All of the features of the voice agent service are encapsulated in the `meta-offline-voice-agent` sub-layer, which can be found under the `meta-agl-devel layer`. These features are currently available in the `master` branch only. You can build this sub-layer into the final image using the following commands: +Before diving into the detailed components documentation, let's first look at how to install and use the voice agent service. All of the features of the voice agent service are encapsulated in the `meta-offline-voice-agent` sub-layer, which can be found under the `meta-agl-devel layer`. You can build this sub-layer into the final image using the following commands: ### Building for QEMU x86-64 ```shell -$ source master/meta-agl/scripts/aglsetup.sh -m qemux86-64 -b build-master agl-demo agl-devel agl-offline-voice-agent +$ source salmon/meta-agl/scripts/aglsetup.sh -m qemux86-64 -b build-salmon agl-demo agl-devel agl-offline-voice-agent $ source agl-init-build-env $ bitbake agl-ivi-demo-flutter ``` @@ -26,7 +26,7 @@ $ bitbake agl-ivi-demo-flutter Whisper AI does not work on the emulator; therefore, building and running on a physical device like the Raspberry Pi 5 is recommended. You can set up the build environment specifically for Raspberry Pi 5 using: ```shell -$ source master/meta-agl/scripts/aglsetup.sh -m raspberrypi5 -b build-master agl-demo agl-devel agl-offline-voice-agent +$ source salmon/meta-agl/scripts/aglsetup.sh -m raspberrypi5 -b build-salmon agl-demo agl-devel agl-offline-voice-agent $ source agl-init-build-env $ bitbake agl-ivi-demo-flutter ``` diff --git a/docs/06_Component_Documentation/11_Unified_HMI.md b/docs/06_Component_Documentation/11_Unified_HMI.md index 2b054b0..0a4f20d 100644 --- a/docs/06_Component_Documentation/11_Unified_HMI.md +++ b/docs/06_Component_Documentation/11_Unified_HMI.md @@ -60,11 +60,11 @@ Json files need to be created correctly for your execution environment. ## How to Build -Follow the [AGL documentation](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/01_Build_Process_Overview/) for the build process, and set up the "[Initializing Your Build Environment](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment/)" section as described below to enable the AGL feature 'agl-uhmi'. +Follow the [AGL documentation](https://docs.automotivelinux.org/en/salmon/#01_Getting_Started/02_Building_AGL_Image/01_Build_Process_Overview/) for the build process, and set up the "[Initializing Your Build Environment](https://docs.automotivelinux.org/en/salmon/#01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment/)" section as described below to enable the AGL feature 'agl-uhmi'. For example: ``` -$ cd $AGL_TOP/master +$ cd $AGL_TOP/salmon $ source ./meta-agl/scripts/aglsetup.sh -m qemux86-64 -b qemux86-64 agl-demo agl-devel agl-uhmi ``` @@ -88,9 +88,9 @@ Replace the `<image_name>` with the appropriate values you want. We have confirm ## How to setup and boot For Environment setup instructions for each platform, refer to the following links in the AGL Documentation: -[Building for x86(Emulation and Hardware)](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/02_Building_for_x86_%28Emulation_and_Hardware%29/) -[Building for Raspberry Pi 4](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/03_Building_for_Raspberry_Pi_4/) -[Building for Supported Renesas Boards](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/04_Building_for_Supported_Renesas_Boards/) +[Building for x86(Emulation and Hardware)](https://docs.automotivelinux.org/en/salmon/#01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/02_Building_for_x86_%28Emulation_and_Hardware%29/) +[Building for Raspberry Pi 4](https://docs.automotivelinux.org/en/salmon/#01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/03_Building_for_Raspberry_Pi_4/) +[Building for Supported Renesas Boards](https://docs.automotivelinux.org/en/salmon/#01_Getting_Started/02_Building_AGL_Image/06_Building_the_AGL_Image/04_Building_for_Supported_Renesas_Boards/) For Raspberry Pi 4 and Supported Renesas Boards, refer to the above URL for boot methods. For x86 emulation (qemu), network bridge is required to enable communication with other devices when using RVGPU. diff --git a/docs/06_Component_Documentation/Application_Framework/03_Creating_a_New_Application.md b/docs/06_Component_Documentation/Application_Framework/03_Creating_a_New_Application.md index aa528b1..f2595d4 100644 --- a/docs/06_Component_Documentation/Application_Framework/03_Creating_a_New_Application.md +++ b/docs/06_Component_Documentation/Application_Framework/03_Creating_a_New_Application.md @@ -93,7 +93,7 @@ LIC_FILES_CHKSUM = "file://LICENSE;md5=ae6497158920d9524cf208c09cc4c984" PV = "1.0+git${SRCREV}" -SRC_URI = "git://git.automotivelinux.org/apps/foo;protocol=https;branch=master" +SRC_URI = "git://git.automotivelinux.org/apps/foo;protocol=https;branch=${AGL_BRANCH}" SRCREV = "abcdef012" S = "${WORKDIR}/git" 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 e04fe17..a42f648 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/salmon # 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 salmon # Return to salmon branch ``` ## Reviewing Using Gerrit diff --git a/docs/07_How_To_Contribute/08_Adding_Documentation.md b/docs/07_How_To_Contribute/08_Adding_Documentation.md index 4da6165..2b5b261 100644 --- a/docs/07_How_To_Contribute/08_Adding_Documentation.md +++ b/docs/07_How_To_Contribute/08_Adding_Documentation.md @@ -26,6 +26,7 @@ $ git clone "ssh://<LFID>@gerrit.automotivelinux.org:29418/AGL/documentation" && ```sh $ cd documentation + $ git checkout salmon || git checkout -b salmon origin/salmon ``` 2. Install MkDocs and rtd-dropdown theme @@ -106,7 +107,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/salmon/ -ro ``` The ```Broken Link Checker``` output will display the broken link and there location in |