agl-shell-activator_git.bb: Bump SRCREV
[AGL/meta-agl.git] / meta-agl.md
1 ## Introduction
2
3 The `meta-agl` layer provides the minimal set of software
4 to boot an AGL Distribution system.
5 You use this layer as the minimal core on which to build AGL profiles.
6
7 **NOTE:** The `meta-agl` layer does not include a reference UI.
8   The reference UI is included as part of the
9   [`meta-agl-demo`](./meta-agl-demo.html) layer.
10
11 ## Sub-Layers
12
13 The `meta-agl` layer itself contains many sub-layers and files.
14 Following is a "tree" look at the layer:
15
16 ```
17 |-- LICENSE
18 |-- LICENSE.GPL-2.0-only
19 |-- LICENSE.MIT
20 |-- README-AGL.md
21 |-- README.md -> meta-agl.md
22 |-- agl-layers-overview.md
23 |-- docs
24 |-- meta-agl-bsp
25 |-- meta-agl-core
26 |-- meta-agl-core-test
27 |-- meta-agl-ic
28 |-- meta-agl-ivi
29 |-- meta-agl.md
30 |-- meta-netboot
31 |-- meta-pipewire
32 |-- scripts
33 `-- templates
34 ```
35
36 This list provides some overview information on the files and sub-layers
37 in `meta-agl`:
38
39 * LICENSE* : licenses of the various components. 
40 * README* : RTFM
41 * agl-layers-overview.md: references to the various layers that make up AGL
42 * `docs`: Contains files that support AGL documentation.
43 * `meta-agl-bsp`: Contains adaptations for recipes and required packages
44   to boot an AGL distribution on targeted hardware and emulation (i.e. QEMU).
45 * `meta-agl-core`: This is the core layer with essential recipes and the distro.
46 * `meta-agl-core-test`: recipes supporting qa images (separate layer due to external dependencies)
47 * `meta-agl-ic`: Instrument Cluster platform
48 * `meta-agl-ivi`: IVI platform
49 * `meta-netboot`: Contains recipes and configuration adjustments to allow network
50   boot through network block device (NBD) since network file system (NFS) does not
51   support security labels.
52 * `meta-pipewire`: Configuration and recipes supporting pipewire as audio manager
53 * `scripts`: AGL development setup and support scripts.
54 * `templates`: Base, feature, and machine templates used in the AGL development
55   environment.
56
57 ## Packagegroups
58
59 This section describes the AGL
60 [packagegroup](https://yoctoproject.org/docs/2.4.4/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks)
61 design:
62
63 ### core non-ui packagegroups:
64 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-connectivity.bb
65 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-devel.bb
66 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-security.bb
67 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-os-commonlibs.bb
68
69 ### graphical subsystem
70 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-profile-graphical.bb
71 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-graphical-multimedia.bb
72 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-graphical-weston.bb
73
74 ### image-related packagegroups
75 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-boot.bb
76 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-image-boot.bb
77 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-image-minimal.bb
78
79 ### QA/Test related packagegroups
80 meta-agl-core-test/recipes-test/packagegroups
81 meta-agl-core-test/recipes-test/packagegroups/packagegroup-agl-test.bb
82
83 ## Images
84
85 ### (Barely) bootable image
86 meta-agl-core/recipes-platform/images/agl-image-boot.bb
87
88 ### minimal image and SDK (console)
89 meta-agl-core/recipes-platform/images/agl-image-minimal.bb
90 meta-agl-core/recipes-platform/images/agl-image-minimal-crosssdk.bb
91
92 ### weston-based image for re-use
93 meta-agl-core/recipes-platform/images/agl-image-weston.bb
94
95 ### image for use in the YP autobuilder
96 meta-agl-core/recipes-platform/images/agl-image-core-autobuilder.bb
97
98 ### image with extra QA tooling (e.g. to run LTP)
99 meta-agl-core-test/images/agl-image-minimal-qa.bb