Prepare Lucky Lamprey 12.1.20
[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-app-framework
31 |-- meta-netboot
32 |-- meta-pipewire
33 |-- scripts
34 `-- templates
35 ```
36
37 This list provides some overview information on the files and sub-layers
38 in `meta-agl`:
39
40 * LICENSE* : licenses of the various components. 
41 * README* : RTFM
42 * agl-layers-overview.md: references to the various layers that make up AGL
43 * `docs`: Contains files that support AGL documentation.
44 * `meta-agl-bsp`: Contains adaptations for recipes and required packages
45   to boot an AGL distribution on targeted hardware and emulation (i.e. QEMU).
46 * `meta-agl-core`: This is the core layer with essential recipes and the distro.
47 * `meta-agl-core-test`: recipes supporting qa images (separate layer due to external dependencies)
48 * `meta-agl-ic`: Instrument Cluster platform
49 * `meta-agl-ivi`: IVI platform
50 * `meta-app-framework`: Configuration and recipes supporting the AGL Application
51   Framework.
52 * `meta-netboot`: Contains recipes and configuration adjustments to allow network
53   boot through network block device (NBD) since network file system (NFS) does not
54   support security labels.
55 * `meta-pipewire`: Configuration and recipes supporting pipewire as audio manager
56 * `scripts`: AGL development setup and support scripts.
57 * `templates`: Base, feature, and machine templates used in the AGL development
58   environment.
59
60 ## Packagegroups
61
62 This section describes the AGL
63 [packagegroup](https://yoctoproject.org/docs/2.4.4/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks)
64 design:
65
66 ### core non-ui packagegroups:
67 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-connectivity.bb
68 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-devel.bb
69 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-security.bb
70 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-os-commonlibs.bb
71
72 ### graphical subsystem
73 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-profile-graphical.bb
74 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-graphical-multimedia.bb
75 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-graphical-weston.bb
76
77 ### image-related packagegroups
78 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-boot.bb
79 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-image-boot.bb
80 meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-image-minimal.bb
81
82 ### QA/Test related packagegroups
83 meta-agl-core-test/recipes-test/packagegroups
84 meta-agl-core-test/recipes-test/packagegroups/packagegroup-agl-test.bb
85
86 ## Images
87
88 ### (Barely) bootable image
89 meta-agl-core/recipes-platform/images/agl-image-boot.bb
90
91 ### minimal image and SDK (console)
92 meta-agl-core/recipes-platform/images/agl-image-minimal.bb
93 meta-agl-core/recipes-platform/images/agl-image-minimal-crosssdk.bb
94
95 ### weston-based image for re-use
96 meta-agl-core/recipes-platform/images/agl-image-weston.bb
97
98 ### image for use in the YP autobuilder
99 meta-agl-core/recipes-platform/images/agl-image-core-autobuilder.bb
100
101 ### image with extra QA tooling (e.g. to run LTP)
102 meta-agl-core-test/images/agl-image-minimal-qa.bb