diff options
| author |   Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2024-05-23 19:21:36 +0200 |
|---|---|---|
| committer |   Scott Murray <scott.murray@konsulko.com> | 2024-06-03 14:15:47 +0000 |
| commit | e14a03fbbb566603ad70230f710a9ee2c0199b23 (patch) | |
| tree | 715e04b4f1d55f4dc15dc876f7d4faa0da3eb71c /docs/01_Getting_Started/02_Building_AGL_Image | |
| parent | 97bdc3e9a2022d596d1f5529f9b4c3e79bf1626e (diff) | |
doc changes for image renaming.
Changes:
- Global replace of image names with post-rework names.
- .rootfs image name suffix added to locally built image filenames.
- Image list updated in a couple of places to match conf-notes.txt
update that has been submitted for meta-agl-core.
Bug-AGL: SPEC-5138
Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Signed-off-by: Scott Murray <scott.murray@konsulko.com>
Change-Id: I437f1e32078972ead2d1156686c54475e87bebaf
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29915
Diffstat (limited to 'docs/01_Getting_Started/02_Building_AGL_Image')
5 files changed, 51 insertions, 44 deletions
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 347e1bf..03b2f5f 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 @@ -103,8 +103,6 @@ Available features: [meta-agl-demo] # DEMO layer Refer: https://git.automotivelinux.org/AGL/meta-agl-demo/tree/templates/feature - agl-demo-cluster-support # Add streaming to cluster of AGL demo system - agl-demo-preload # Add Tokens and sample files specific to AGL demo system agl-demo # default IVI demo agl-kvm # Enables support for building multiconfig based KVM+QEMU demo images @@ -115,7 +113,6 @@ Available features: agl-egvirt # EG-Virt feature agl-flutter # Flutter support agl-ic-container # Instrument Cluster EG demo using containers - agl-jailhouse # GSoC: jailhouse enablement agl-offline-voice-agent # Feature template for meta-offline-voice-agent layer agl-test # Test framework under development @@ -166,7 +163,7 @@ Following are brief descriptions of the AGL features you can specify on the as part of the build. * **agl-demo**: Enables the layers meta-agl-demo and meta-qt5. - You need agl-demo if you are going to build the agl-demo-platform. + You need agl-demo if you are going to build the agl-ivi-demo-qt. * **agl-pipewire**: Enables AGLs pipewire support. @@ -205,21 +202,31 @@ aglsetup.sh: Done Shell environment set up for builds. You can now run 'bitbake target' Common targets are: - - meta-agl: (core system) - agl-image-minimal - agl-image-minimal-qa +- meta-agl layer: + - included by default + * agl-image-boot (just enough to boot) + * agl-image-minimal (minimal filesystem with APIs) + * agl-image-minimal-crosssdk (crosssdk for ^^) - agl-image-ivi - agl-image-ivi-qa - agl-image-ivi-crosssdk + * agl-image-weston (minimal filesystem with weston) + * agl-image-compositor (minimal filesystem with AGL compositor) - agl-image-weston +- meta-agl-demo: (IVI demo with UI) + - with 'agl-demo' + * agl-ivi-image (base for IVI targets) + * agl-ivi-image-crosssdk (sdk for ^^) - - meta-agl-demo: (demo with UI) - agl-demo-platform (* default demo target) - agl-demo-platform-qa - agl-demo-platform-crosssdk - agl-demo-platform-html5 + * agl-ivi-demo-qt (IVI Qt demo image) + * agl-ivi-demo-qt-crosssdk (sdk for ^^) + * agl-ivi-demo-flutter (IVI Flutter demo image) + * agl-ivi-demo-html5 (IVI HTML5 demo image) + + * agl-cluster-demo-qt (cluster Qt demo image) + * agl-cluster-demo-flutter (cluster Flutter demo image) + + * agl-telematics-demo (telematics demo image) + + * agl-gateway-demo (gateway demo image) ``` Running the script creates the Build Directory if it does not already exist. 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..89ee35d 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 @@ -71,33 +71,33 @@ CPU and and Internet connection speeds. The build also takes approximately 100G-bytes of free disk space. **Sample Qt based IVI demo :** -The target is `agl-demo-platform`. +The target is `agl-ivi-demo-qt`. ```sh -$ time bitbake agl-demo-platform +$ time bitbake agl-ivi-demo-qt ``` By default, the build process puts the resulting image in the Build Directory and further exporting that as `$IMAGE_NAME`: ```sh -<build_directory>/tmp/deploy/images/qemux86-64/agl-demo-platform-qemux86-64.vmdk.xz +<build_directory>/tmp/deploy/images/qemux86-64/agl-ivi-demo-qt-qemux86-64.vmdk.xz -$ export IMAGE_NAME=agl-demo-platform-qemux86-64.vmdk.xz +$ export IMAGE_NAME=agl-ivi-demo-qt-qemux86-64.vmdk.xz ``` **Sample HTML5 based IVI demo :** -The target is `agl-demo-platform-html5`. +The target is `agl-ivi-demo-html5`. ```sh -$ time bitbake agl-demo-platform-html5 +$ time bitbake agl-ivi-demo-html5 ``` By default, the build process puts the resulting image in the Build Directory and further exporting that as `$IMAGE_NAME`: ```sh -<build_directory>/tmp/deploy/images/qemux86-64/agl-demo-platform-html5-qemux86-64.vmdk.xz +<build_directory>/tmp/deploy/images/qemux86-64/agl-ivi-demo-html5-qemux86-64.vmdk.xz -$ export IMAGE_NAME=agl-demo-platform-html5-qemux86-64.vmdk.xz +$ export IMAGE_NAME=agl-ivi-demo-html5-qemux86-64.vmdk.xz ``` **IVI-EG Flutter based demo :** @@ -121,7 +121,7 @@ $ time bitbake agl-image-flutter Deploying the image consists of decompressing the image and then booting it using either QEMU, VirtualBox or physical system. -The examples below are usually for the 'agl-demo-platform' target. +The examples below are usually for the 'agl-ivi-demo-qt' target. Please adapt accordingly to your target image. **3.1 QEMU** @@ -145,7 +145,7 @@ $ source $AGL_TOP/<release-branch-name>/<build-dir>/ And further use `runqemu` to boot the image : ```sh -$ runqemu tmp/deploy/images/qemux86-64/agl-demo-platform-qemux86-64.qemuboot.conf kvm serialstdio slirp publicvnc audio +$ runqemu tmp/deploy/images/qemux86-64/agl-ivi-demo-qt-qemux86-64.qemuboot.conf kvm serialstdio slirp publicvnc audio ``` If you need to run it outside of the bitbake environment or need special settings for @@ -229,7 +229,7 @@ Once VirtualBox is installed, follow these steps to boot the image:  - Select Memory size. Recommended is `2048 MB`, click on `Next`.  - - Click on `Use an existing virtual hard disk file`, and select the extracted `agl-demo-platform-qemux86-64.vmdk.xz` or `<html5-image?>` file, click on `Create`. + - Click on `Use an existing virtual hard disk file`, and select the extracted `agl-ivi-demo-qt-qemux86-64.vmdk.xz` or `<html5-image?>` file, click on `Create`.  - Go to `Settings`, and into `System`. Select `Chipset : IHC9`. Check on `Enable EFI (special OSes only)` and click on `OK`.  @@ -248,7 +248,7 @@ Once VirtualBox is installed, follow these steps to boot the image: $ cd tmp/deploy/images/qemux86-64 $ lsblk $ sudo umount <usb_device_name> - $ xzcat agl-demo-platform-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 ``` diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/08_Building_for_Raspberry_Pi_4.md b/docs/01_Getting_Started/02_Building_AGL_Image/08_Building_for_Raspberry_Pi_4.md index 2ac3a2a..057d70b 100644 --- a/docs/01_Getting_Started/02_Building_AGL_Image/08_Building_for_Raspberry_Pi_4.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/08_Building_for_Raspberry_Pi_4.md @@ -80,35 +80,35 @@ CPU and and Internet connection speeds. The build also takes approximately 100G-bytes of free disk space. **Qt Based IVI demo :** -The target is `agl-demo-platform`. +The target is `agl-ivi-demo-qt`. ```sh -$ time bitbake agl-demo-platform +$ time bitbake agl-ivi-demo-qt ``` By default, the build process puts the resulting image in the Build Directory and further exporting that as `$IMAGE_NAME`. Here is example for the Raspberry Pi 4 board for Qt Based demo: ```sh -<build_dir>/tmp/deploy/images/raspberrypi4/agl-demo-platform-raspberrypi4.wic.xz +<build_dir>/tmp/deploy/images/raspberrypi4/agl-ivi-demo-qt-raspberrypi4.rootfs.wic.xz -$ export IMAGE_NAME=agl-demo-platform-raspberrypi4.wic.xz +$ export IMAGE_NAME=agl-ivi-demo-qt-raspberrypi4.rootfs.wic.xz ``` **HTML5 Based IVI demo :** -The target is `agl-demo-platform-html5`. +The target is `agl-ivi-demo-html5`. ```sh -$ time bitbake agl-demo-platform-html5 +$ time bitbake agl-ivi-demo-html5 ``` By default, the build process puts the resulting image in the Build Directory and further exporting that as `$IMAGE_NAME`. Here is example for the Raspberry Pi 4 board for HTML5 Based demo: ```sh -<build_dir>/tmp/deploy/images/raspberrypi4/agl-demo-platform-html5-raspberrypi4-64.wic.xz +<build_dir>/tmp/deploy/images/raspberrypi4/agl-ivi-demo-html5-raspberrypi4-64.rootfs.wic.xz -$ export IMAGE_NAME=agl-demo-platform-html5-raspberrypi4-64.wic.xz +$ export IMAGE_NAME=agl-ivi-demo-html5-raspberrypi4-64.rootfs.wic.xz ``` ## 4. Deploying the AGL Demo Image 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..95a2267 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 @@ -251,17 +251,17 @@ CPU and and Internet connection speeds. The build also takes approximately 100G-bytes of free disk space. **Qt based IVI demo :** -For this example, the target is "agl-demo-platform": +For this example, the target is "agl-ivi-demo-qt": ```sh -bitbake agl-demo-platform +bitbake agl-ivi-demo-qt ``` **HTML5 based IVI demo :** -The target is `agl-demo-platform-html5`. +The target is `agl-ivi-demo-html5`. ```sh -$ time bitbake agl-demo-platform-html5 +$ time bitbake agl-ivi-demo-html5 ``` **Instrument Cluster with Container isolation demo :** @@ -349,7 +349,7 @@ card with a new image. ```sh cd $AGL_TOP/build/tmp/deploy/images/$MACHINE - bmaptool copy ./agl-demo-platform-$MACHINE.wic.xz <boot_device_name> + bmaptool copy ./agl-ivi-demo-qt-$MACHINE.rootfs.wic.xz <boot_device_name> ``` Alternatively, you can leave the image in an uncompressed state and write it @@ -357,7 +357,7 @@ card with a new image. ```sh sudo umount <boot_device_name> - xzcat ./agl-demo-platform-$MACHINE.wic.xz | sudo dd of=<boot_device_name> bs=4M + xzcat ./agl-ivi-demo-qt-$MACHINE.rootfs.wic.xz | sudo dd of=<boot_device_name> bs=4M sync ``` diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/10_Building_for_Virtio.md b/docs/01_Getting_Started/02_Building_AGL_Image/10_Building_for_Virtio.md index a80479d..b8aefc7 100644 --- a/docs/01_Getting_Started/02_Building_AGL_Image/10_Building_for_Virtio.md +++ b/docs/01_Getting_Started/02_Building_AGL_Image/10_Building_for_Virtio.md @@ -49,10 +49,10 @@ $ bitbake agl-image-minimal ``` **Qt Based IVI demo :** -The target is `agl-demo-platform`. +The target is `agl-ivi-demo-qt`. ```sh -$ bitbake agl-demo-platform +$ bitbake agl-ivi-demo-qt ``` ## 3. Deploying the AGL Demo Image |