diff options
author | Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2025-01-13 12:01:36 +0100 |
---|---|---|
committer | Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2025-01-14 09:02:26 +0000 |
commit | 3c3ba5e5927ac5607439f18f95f09592519053a1 (patch) | |
tree | af4c00d740033dc8a623148a108cca43fbb75811 /docs/06_Component_Documentation | |
parent | d511041028a87e8569c98dfb2f4e034563973f3f (diff) |
Batch update for Super Salmon M3salmon_18.94.0salmon_18.93.0salmon/18.94.0salmon/18.93.018.94.018.93.0salmon
Update the documentation after branching for Milestone 3.
Bug-AGL: SPEC-5333
Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Change-Id: I04aa470eb53ed937e893445b4b029e24a7b8d12b
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30759
Diffstat (limited to 'docs/06_Component_Documentation')
4 files changed, 13 insertions, 13 deletions
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" |