Bulk documentation updates for Magic Marlin 21/27321/3
authorJan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tue, 29 Mar 2022 14:25:21 +0000 (16:25 +0200)
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>
Wed, 30 Mar 2022 11:40:47 +0000 (11:40 +0000)
Update the branches used in the documents.

Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Change-Id: I04d0003d85bbe044ad694fbbd22ab2841b7e3e8d
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27321

docs/0_Getting_Started/1_Quickstart/Using_Ready_Made_Images.md
docs/0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host.md
docs/0_Getting_Started/2_Building_AGL_Image/2_Downloading_AGL_Software.md
docs/0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md
docs/0_Getting_Started/2_Building_AGL_Image/4_Customizing_Your_Build.md
docs/0_Getting_Started/2_Building_AGL_Image/5_1_x86_Emulation_and_Hardware.md
docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md
docs/3_Developer_Guides/1_Setting_Up_AGL_SDK.md
docs/3_Developer_Guides/6_AGL_Layers/3_meta-agl-demo.md

index eaae38e..38faa06 100644 (file)
@@ -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/marlin/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/marlin/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/marlin/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/marlin/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/marlin/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/marlin/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-demo-platform-crosssdk-bbe.wic.xz).
+  1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/marlin/latest/bbe/deploy/images/bbe/agl-demo-platform-crosssdk-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/marlin/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/marlin/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/marlin/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/marlin/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/marlin/latest/h3ulcb-nogfx/deploy/images/h3ulcb/agl-demo-platform-crosssdk-h3ulcb.wic.xz).
 
   3. Extract the image into the boot device :
 
index 6acdfdd..6834b44 100644 (file)
@@ -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/marlin/latest/) exist for several boards as
 well as for the Quick EMUlator (QEMU).
 See the
 "[Quickstart](../1_Quickstart/Using_Ready_Made_Images.md)"
@@ -26,7 +26,7 @@ section for more information on the ready-made images.
 1. **Use a Supported Linux Distribution:** To use the AGL software, it is
    recommended that your build host is a native Linux machine that runs a
    Yocto Project supported distribution as described by the
-   "[Supported Linux Distributions](https://www.yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#detailed-supported-distros)"
+   "[Supported Linux Distributions](https://www.yoctoproject.org/docs/3.1.14/ref-manual/ref-manual.html#detailed-supported-distros)"
    section in the Yocto Project Reference Manual.
    Basically, you should be running a recent version of Ubuntu, Fedora, openSUSE,
    CentOS, or Debian.
@@ -42,7 +42,7 @@ section for more information on the ready-made images.
    * Python 3.4.0 or greater
 
    If your distribution does not meet these minimal requirements, see the
-   "[Required Git, tar, and Python Versions](https://www.yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#required-git-tar-and-python-versions)"
+   "[Required Git, tar, and Python Versions](https://www.yoctoproject.org/docs/3.1.14/ref-manual/ref-manual.html#required-git-tar-and-python-versions)"
    section in the Yocto Project Reference Manual for steps that you can
    take to be sure you have these tools.
 
@@ -51,13 +51,13 @@ section for more information on the ready-made images.
    Depending on the Linux distribution you are using, the list of
    host packages differ.
    See
-   "[The Build Host Packages](https://www.yoctoproject.org/docs/3.1.4/yocto-project-qs/yocto-project-qs.html#packages)"
+   "[The Build Host Packages](https://www.yoctoproject.org/docs/3.1.14/yocto-project-qs/yocto-project-qs.html#packages)"
    section of the Yocto Project Quick Start for information on the packages you need.
 
    **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://www.yoctoproject.org/docs/3.1.4/yocto-project-qs/yocto-project-qs.html#packages)"
+   "[The Build Host Packages](https://www.yoctoproject.org/docs/3.1.14/yocto-project-qs/yocto-project-qs.html#packages)"
    section of the Yocto Project Quick Start.
 
    Aside from the packages listed in the previous section, you need the following:
index ee18805..c0ca7b7 100644 (file)
@@ -51,14 +51,14 @@ The remainder of this section provides steps on how to download the AGL source f
      Using the latest stable release gives you a solid snapshot of the
      latest know release.
      The release is static, tested, and known to work.
-     To download the latest stable release branch (i.e. Jellyfish), use
+     To download the latest stable release branch (i.e. marlin), use
      the following commands:
 
      ```sh
      $ cd $AGL_TOP
-     $ mkdir koi
-     $ cd koi
-     $ repo init -b koi -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo
+     $ mkdir marlin
+     $ cd marlin
+     $ repo init -b marlin -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo
      $ repo sync
      ```
 
index efe7001..61de443 100644 (file)
@@ -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/marlin/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/marlin
 $ 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/marlin/qemux86-64`.
 
 The script's output also indicates the machine and AGL features selected for the build.
 
index d1d4101..dd67e9e 100644 (file)
@@ -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/marlin/${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/marlin/qemux86-64/
 $ ln -sf $AGL_TOP/site.conf conf/
 
 In General;
index 7282f66..02c9097 100644 (file)
@@ -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/marlin/qemux86-64/agl-init-build-env
 ```
 
 In general :
index b7f6cd0..84965d8 100644 (file)
@@ -65,7 +65,7 @@ Follow these steps to download the drivers you need:
 
     | AGL Version | Renesas version |
     |:-:|:-:|
-    | AGL master | 5.9.0 |
+    | AGL marlin | 5.9.0 |
 
 3. **Download the Files:**
 
index 8cdbe3e..ccb3e3a 100644 (file)
@@ -7,11 +7,11 @@ quickstart the service and application development process.
 
 1. Download the prebuilt SDK :
 
-      - **x86** : [qemux86-64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-10.90.0+snapshot.sh)
+      - **x86** : [qemux86-64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-13.0.0+snapshot.sh)
 
-      - **ARM 32 bit** : [qemuarm](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-armv7vet2hf-neon-vfpv4-qemuarm-toolchain-10.90.0+snapshot.sh)
+      - **ARM 32 bit** : [qemuarm](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-armv7vet2hf-neon-vfpv4-qemuarm-toolchain-13.0.0+snapshot.sh)
 
-      - **AARCH64 - ARM 64bit** : [qemuarm64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-aarch64-qemuarm64-toolchain-10.90.0+snapshot.sh)
+      - **AARCH64 - ARM 64bit** : [qemuarm64](https://download.automotivelinux.org/AGL/snapshots/marlin/latest/qemuarm64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-aarch64-qemuarm64-toolchain-13.0.0+snapshot.sh)
 
         *Henceforth,* **qemux86-64** *is used in these guides, unless specified
         otherwise. We also use the 'agl-demo-platform-crosssdk' as example.*
@@ -20,23 +20,23 @@ quickstart the service and application development process.
 
     ```sh
     $ mkdir ~/agl-app
-    $ cp ~/Downloads/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-10.90.0+snapshot.sh ~/agl-app/
+    $ cp ~/Downloads/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-13.0.0+snapshot.sh ~/agl-app/
     $ cd ~/agl-app
     ```
 
 3. Install the downloaded SDK :
 
     ```sh
-    $ chmod 777 poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-10.90.0+snapshot.sh
+    $ chmod 777 poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-13.0.0+snapshot.sh
     $ mkdir agl-sdk/
-    $ ./poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-10.90.0+snapshot.sh
+    $ ./poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-13.0.0+snapshot.sh
     ```
     Select target directory for SDK : `~/agl-app/agl-sdk`
 
     ```sh
-    Automotive Grade Linux SDK installer version 10.90.0+snapshot
+    Automotive Grade Linux SDK installer version 13.0.0+snapshot
     =============================================================
-    Enter target directory for SDK (default: /opt/agl-sdk/10.90.0+snapshot-corei7-64): ~/agl-app/agl-sdk
+    Enter target directory for SDK (default: /opt/agl-sdk/13.0.0+snapshot-corei7-64): ~/agl-app/agl-sdk
     You are about to install the SDK to "/home/boron/agl-app/agl-sdk". Proceed [Y/n]? Y
     Extracting SDK..........................................................................................................................................done
     Setting it up...done
index c560989..bd26e74 100644 (file)
@@ -24,19 +24,19 @@ 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/marlin/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: "marlin"
 
 - OpenEmbedded `meta-openembedded` Layer:
 
     - 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/marlin/default.xml)
       manifest file for the `AGL-repo` repository for revision information.
 
     Specifically, out of `meta-openembedded`, these sub-layers are used:
@@ -114,12 +114,12 @@ 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: "marlin"
 
 
 ## Packagegroups
 
-AGL DEMO Platform's [packagegroups](https://www.yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks)
+AGL DEMO Platform's [packagegroups](https://www.yoctoproject.org/docs/3.1.14/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks)
 consist of the following:
 
 - packagegroup-agl-demo-platform
@@ -138,22 +138,3 @@ consist of the following:
       * `packagegroup-agl-image-ivi`
       * `packagegroup-agl-demo-platform`
 
-- packagegroup-agl-appfw*
-
-    These packagegroups contain packages for the AGL distribution's
-    Application Framework. Subsystem should maintain
-    `packagegroup-agl-appfw-[subsystem].bb`, which should hold sufficient packages
-    for the Application Framework.
-
-    Subsystems also can maintain their own packagegroups using appropriate
-    `recipes-*/`.
-
-    For example, Qt5 has two packagegroups in `meta-agl-demo`:
-    `packagegroup-agl-appfw-native-qt5` and `packagegroup-agl-demo-qt-examples`,
-    which are under `recipes-qt/`.
-
-    The `packagegroup-agl-appfw-native-qt5` is included by `packagegroup-agl-appfw-native` because Qt5 belongs to native application framework of AGL Distro.
-
-    Because the `packagegroup-agl-demo-qt-examples` is not mandatory for the AGL
-    Application Framework and the AGL DEMO, the packagegroup is added to the layer's
-    `local.conf` file only when needed.
\ No newline at end of file