Add documentation for persistent storage grpc API
[AGL/documentation.git] / docs / 01_Getting_Started / 02_Building_AGL_Image / 04_Initializing_Your_Build_Environment.md
index efe7001..03b2f5f 100644 (file)
@@ -75,47 +75,46 @@ Following is a list of the available features:
 Available features:
 
    [meta-agl]                                    # CORE layer
-       agl-all-features :( agl-demo  agl-pipewire  agl-app-framework  agl-netboot )
-                                                 # For the usual demo image
+       Refer: https://git.automotivelinux.org/AGL/meta-agl/tree/templates/feature
+       agl-all-features                          # For the usual demo image
        agl-app-framework                         # Application Framework
        agl-archiver                              # Source Archiver
        agl-buildstats                            # Build Statistics
-       agl-devel :( agl-package-management )     # Developer Env (root login)
-       agl-fossdriver                            # Fossology integration
-       agl-gplv2                                 # GPLv2-only packages
-       agl-localdev                              # inclusion of local development folder
-       agl-netboot                               # network boot (e.g. CI)
+       agl-ci-change-features-nogfx              # CI: features enabled for gerrit change builds w/o  gfx
+       agl-ci-change-features                    # CI: features enabled for gerrit change builds with gfx
+       agl-ci-snapshot-features-nogfx            # CI: features enabled for nightly builds w/o  gfx
+       agl-ci-snapshot-features                  # CI: features enabled for nightly builds with gfx
+       agl-ci                                    # CI: specific settings for the CI environment
+       agl-create-spdx                           # Software Bill of Materials (SBOM) generation
+       agl-devel :( agl-package-management )     # Developer Env (root login w/o pass)
+       agl-fossdriver                            # Fossology integration, Scancode, etc.
+       agl-localdev                              # inclusion of local development folder ./meta-localdev
+       agl-netboot                               # network boot (e.g. in CI)
        agl-package-management                    # include package management (e.g. rpm)
        agl-pipewire                              # include pipewire
        agl-ptest                                 # enable ptest pckages
-       agl-refhw-h3                              # enable reference hardware
+       agl-refhw-h3                              # enable reference hardware when building h3ulcb machine
+       agl-selinux                               # Enables building with SELinux
        agl-virt                                  # EG-Virt features
        agl-virt-guest-xen                        # EG-Virt features
-       agl-virt-xen :( agl-virt )                # EG-Virt features
-       agl-weston-remoting :( agl-demo  agl-pipewire  agl-app-framework )
-       agl-weston-waltham-remoting :( agl-demo  agl-pipewire  agl-app-framework )
+       agl-virt-xen                              # EG-Virt features
+       agl-weston-remoting                       # remote streaming support
+       agl-weston-waltham-remoting               # remote streaming support w/ waltham
 
    [meta-agl-demo]                                    # DEMO layer
-       agl-cluster-demo-support :( agl-weston-remoting  agl-demo  agl-pipewire  agl-app-framework )
-                                                      # sample IVI demo
-       agl-demo :( agl-pipewire  agl-app-framework )  # default IVI demo
-       agl-demo-preload                               # Add Tokens and sample files
+       Refer: https://git.automotivelinux.org/AGL/meta-agl-demo/tree/templates/feature
+       agl-demo                                       # default IVI demo 
+       agl-kvm                                        # Enables support for building multiconfig based KVM+QEMU demo images
 
    [meta-agl-devel]                                   # Development layer
+       Refer: https://git.automotivelinux.org/AGL/meta-agl-devel/tree/templates/feature
        agl-basesystem                                 # Toyota basesystem
        agl-drm-lease                                  # DRM lease support
        agl-egvirt                                     # EG-Virt feature
        agl-flutter                                    # Flutter support
-       agl-jailhouse                                  # GSoC: jailhouse enablement
-       agl-lxc :( agl-drm-lease  agl-pipewire )       # IC-EG container support
-       agl-ros2                                       # GSoC: ros2 enablement
-
-Specialized features (e.g. CI):
-       agl-ci                                                                         # Tweaks for CI
-       agl-ci-change-features :( agl-demo  agl-pipewire  agl-app-framework  agl-devel  agl-package-management  agl-netboot  agl-pipewire  agl-buildstats  agl-ptest )
-       agl-ci-change-features-nogfx :( agl-demo  agl-pipewire  agl-app-framework  agl-devel  agl-package-management  agl-netboot  agl-pipewire  agl-buildstats  agl-ptest )
-       agl-ci-snapshot-features :( agl-demo  agl-pipewire  agl-app-framework  agl-devel  agl-package-management  agl-netboot  agl-archiver  agl-pipewire  agl-buildstats  agl-ptest )
-       agl-ci-snapshot-features-nogfx :( agl-demo  agl-pipewire  agl-app-framework  agl-devel  agl-package-management  agl-netboot  agl-archiver  agl-pipewire  agl-buildstats  agl-ptest )
+       agl-ic-container                               # Instrument Cluster EG demo using containers
+       agl-offline-voice-agent                        # Feature template for meta-offline-voice-agent layer
+       agl-test                                       # Test framework under development
 
 ```
 
@@ -160,11 +159,11 @@ Following are brief descriptions of the AGL features you can specify on the
   sdcards. Needs additional setup.
 
 * **agl-ptest**: Enables
-  [Ptest](https://yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#testing-packages-with-ptest)
+  [Ptest](https://docs.yoctoproject.org/dev-manual/common-tasks.html#testing-packages-with-ptest)
   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.
 
@@ -203,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-weston              (minimal filesystem with weston)
+    * agl-image-compositor          (minimal filesystem with AGL compositor)
+
+- meta-agl-demo:                    (IVI demo with UI)
+  - with 'agl-demo'
+    * agl-ivi-image                 (base for IVI targets)
+    * agl-ivi-image-crosssdk        (sdk for ^^)
+
+    * 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-image-ivi
-    agl-image-ivi-qa
-    agl-image-ivi-crosssdk
+    * agl-cluster-demo-qt           (cluster Qt demo image)
+    * agl-cluster-demo-flutter      (cluster Flutter demo image)
 
-    agl-image-weston
+    * agl-telematics-demo           (telematics demo image)
 
-  - 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-gateway-demo              (gateway demo image)
 ```
 
 Running the script creates the Build Directory if it does not already exist.
@@ -246,10 +255,10 @@ You can find lots of information on configuring builds in the Yocto Project
 documentation set.
 Here are some references if you want to dig into configuration further:
 
-* [Customizing Images Using local.conf](https://yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#usingpoky-extend-customimage-localconf)
-* [Local](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#ref-varlocality-config-local)
-* [build/conf/local.conf](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#structure-build-conf-local.conf)
-* [build/conf/bblayers.conf](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#structure-build-conf-bblayers.conf)
-* [BBLAYERS](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#var-BBLAYERS)
-* [User Configuration](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#user-configuration)
-* [Enabling Your Layer](https://yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#enabling-your-layer)
+* [Customizing Images Using local.conf](https://docs.yoctoproject.org/dev-manual/common-tasks.html#customizing-images-using-local-conf)
+* [Local](https://docs.yoctoproject.org/ref-manual/varlocality.html#local)
+* [build/conf/local.conf](https://docs.yoctoproject.org/ref-manual/structure.html#build-conf-local-conf)
+* [build/conf/bblayers.conf](https://docs.yoctoproject.org/ref-manual/structure.html#build-conf-bblayers-conf)
+* [BBLAYERS](https://docs.yoctoproject.org/ref-manual/variables.html#term-BBLAYERS)
+* [User Configuration](https://docs.yoctoproject.org/ref-manual/structure.html#build)
+* [Enabling Your Layer](https://docs.yoctoproject.org/dev-manual/common-tasks.html#enabling-your-layer)