aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorShankho Boron Ghosh <shankhoghosh123@gmail.com>2020-11-30 00:35:56 +0530
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2020-12-07 19:57:24 +0000
commit6884dcaf7cfd18d806e6d303892265ec5234f1a9 (patch)
tree40ecb19d58b9bf37526267bd7707e0fc76fca4e9
parent3d5ee95786cf1d6cd39772cb45c789157dde861d (diff)
Added AGL Layers in Developer Guides
Revised and added AGL Layers as a part of Developer Guides. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: Ie66bd8bfd89d129c7fc49c20a83c331e069e4a46 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25661 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
-rw-r--r--docs/3_Developer_Guides/1_AGL_Layers/3_meta-agl-demo.md166
-rw-r--r--docs/3_Developer_Guides/6_AGL_Layers/1_Overview.md (renamed from docs/3_Developer_Guides/1_AGL_Layers/1_Overview.md)8
-rw-r--r--docs/3_Developer_Guides/6_AGL_Layers/2_meta-agl.md (renamed from docs/3_Developer_Guides/1_AGL_Layers/2_meta-agl.md)4
-rw-r--r--docs/3_Developer_Guides/6_AGL_Layers/3_meta-agl-demo.md159
-rw-r--r--docs/3_Developer_Guides/6_AGL_Layers/4_meta-agl-devel.md (renamed from docs/3_Developer_Guides/1_AGL_Layers/4_meta-agl-devel.md)8
5 files changed, 166 insertions, 179 deletions
diff --git a/docs/3_Developer_Guides/1_AGL_Layers/3_meta-agl-demo.md b/docs/3_Developer_Guides/1_AGL_Layers/3_meta-agl-demo.md
deleted file mode 100644
index df412ae..0000000
--- a/docs/3_Developer_Guides/1_AGL_Layers/3_meta-agl-demo.md
+++ /dev/null
@@ -1,166 +0,0 @@
----
-title: meta-agl-demo
----
-
-<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/devguides/master/meta-agl-demo-guides-devguides-book.yml -->
-
-## Introduction
-
-The `meta-agl-demo` layer is the reference user interface layer for the DEMO
-platform of Automotive Grade Linux (AGL).
-The layer provides a reference platform and applications.
-The BitBake target name for the DEMO platform is `agl-demo-platform`, which is
-the full DEMO platform image.
-
-## Layer Dependencies
-
-This section describes dependencies for the `meta-agl-demo` layer.
-Dependencies are grouped into base, hardware, and feature dependencies.
-
-### Base Dependencies
-
-The `meta-agl-demo` layer has the following base dependencies:
-
-* Yocto Project Release:
-
- - URI: git://git.yoctoproject.org/poky
- - Branch: "thud"
- - Tested Revision: See the [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml)
- manifest file for the `AGL-repo` repository for revision
- information.<br/><br/>
-
-* AGL `meta-agl` Layer:
-
- - URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl
- - Branch: "master"<br/><br/>
-
-* OpenEmbedded `meta-openembedded` Layer:
-
- - Branch: "thud"
- - Tested Revision: See the [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml)
- manifest file for the `AGL-repo` repository for revision
- information.
-
- Specifically, out of `meta-openembedded`, these sub-layers are used:
-
- - `meta-oe`
- - `meta-multimedia`
- - `meta-networking`
- - `meta-python`<br/><br/>
-
-* Yocto Project `meta-qt5` Layer from the
- [OpenEmbedded Layer Index](https://layers.openembedded.org/layerindex/branch/master/layers/):
-
- - URI: https://github.com/meta-qt5/meta-qt5.git
- - Branch: "thud"
- - Tested Revision: See the [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml)
- manifest file for the `AGL-repo` repository for revision
- information.<br/><br/>
-
-### Hardware Dependencies
-
-Aside from the previously listed base dependencies, if you are using a
-[supported Renesas board](../getting_started/reference/getting-started/machines/renesas.html)
-supported Renesas board, these dependencies exist:
-
-* AGL's `meta-renesas` Layer:
-
- - URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-renesas
-
-### Feature Dependencies
-
-The `meta-agl-demo` layer has the following AGL
-[feature](../getting_started/reference/getting-started/image-workflow-initialize-build-environment.html#agl-features)
-dependencies:
-
-* Yocto Project `meta-security` Layer:
-
- - URI: https://git.yoctoproject.org/cgit/cgit.cgi/meta-security
- - Branch: "master"
- - Tested Revision: See the [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml)
- manifest file for the `AGL-repo` repository for revision
- information.<br/><br/>
-
-* AGL's `meta-app-framework` Layer within the `meta-agl` Layer:
-
- - URI: https://gerrit.automotivelinux.org/gerrit/gitweb?p=AGL/meta-agl.git
- - Branch: "master"<br/><br/>
-
-**The `agl-sota` Feature:**
-
-* Here Technologies' `meta-updater` Layer:
-
- - URI: https://github.com/advancedtelematic/meta-updater/
- - Branch: "thud"<br/><br/>
-
-* Here Technologies' `meta-updater-qemux86-64` Layer:
-
- - URI: https://github.com/advancedtelematic/meta-updater-qemux86-64/
- - Branch: "thud"<br/><br/>
-
-* OpenEmbedded's `meta-openembedded` Layer:
-
- - URI: https://github.com/openembedded/meta-openembedded
- - Branch: "thud"
- - Tested Revision: See the [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml)
- manifest file for the `AGL-repo` repository for revision
- information.
-
- Specifically, out of `meta-openembedded`, these sub-layers are used:
-
- - `meta-filesystems`
- - `meta-oe`
- - `meta-python`<br/><br/>
-
-**The `agl-netboot` Feature:**
-
-* AGL's `meta-netboot` Layer within the `meta-agl` Layer:
-
- - URI: https://gerrit.automotivelinux.org/gerrit/gitweb?p=AGL/meta-agl.git
- - Branch: "master"
-
-
-## Packagegroups
-
-AGL DEMO Platform's
-[packagegroups](https://www.yoctoproject.org/docs/3.1.2/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks)
-consist of the following:
-
-### packagegroup-agl-demo-platform
-
-This packagegroup is used for generating the `agl-demo-platform` image,
-which is the full image for the AGL distributions IVI profile.
-You can see the recipe (i.e. `agl-demo-platform.bb`) that installs
-the `packagegroup-agl-demo-platform` packagegroup
-[here](https://git.automotivelinux.org/AGL/meta-agl-demo/tree/recipes-platform/images/agl-demo-platform.bb).
-
-As meta-agl's design of packagegroups, the `agl-demo-platform.bb` recipe installs
-only `packagegroup-agl-demo-platform` and the packages of the DEMO applications.
-
-``agl-demo-platform`` contains the following three packagegroups:
-
- * `packagegroup-agl-image-minimal`
- * `packagegroup-agl-image-ivi`
- * `packagegroup-agl-demo-platform`
-
-### packagegroup-agl-appfw*
-
-These packagegroups contain packages for the AGL distribution's
-Application Framework.
-Subsystem should maintain `packagegroup-agl-appfw-[subsystem].bb`, which
-should hold sufficient packages for the Application Framework.
-
-Subsystems also can maintain their own packagegroups using appropriate
-`recipes-*/`.
-For example, Qt5 has two packagegroups in `meta-agl-demo`:
-`packagegroup-agl-appfw-native-qt5` and `packagegroup-agl-demo-qt-examples`,
-which are under `recipes-qt/`.
-
-The `packagegroup-agl-appfw-native-qt5` is included by
-`packagegroup-agl-appfw-native` because Qt5 belongs to native application
-framework of AGL Distro.
-
-Because the `packagegroup-agl-demo-qt-examples` is not mandatory for
-the AGL Application Framework and the AGL DEMO, the packagegroup is added
-to the layer's `local.conf` file only when needed.
-
diff --git a/docs/3_Developer_Guides/1_AGL_Layers/1_Overview.md b/docs/3_Developer_Guides/6_AGL_Layers/1_Overview.md
index 5df8217..dec8054 100644
--- a/docs/3_Developer_Guides/1_AGL_Layers/1_Overview.md
+++ b/docs/3_Developer_Guides/6_AGL_Layers/1_Overview.md
@@ -2,13 +2,9 @@
title: Overview
---
-Overview
-========
-
-The
-[AGL Project](https://www.automotivelinux.org/) is an automotive-specific
+The [AGL Project](https://www.automotivelinux.org/) is an automotive-specific
development environment that provides a Linux distribution
-[(AGL UCB](https://www.automotivelinux.org/software/unified-code-base)).
+([AGL UCB](https://www.automotivelinux.org/software/unified-code-base)).
AGL uses layers designed to be compatible with the
[Yocto Project](https://www.yoctoproject.org) and the
diff --git a/docs/3_Developer_Guides/1_AGL_Layers/2_meta-agl.md b/docs/3_Developer_Guides/6_AGL_Layers/2_meta-agl.md
index 0a8ab83..03134b0 100644
--- a/docs/3_Developer_Guides/1_AGL_Layers/2_meta-agl.md
+++ b/docs/3_Developer_Guides/6_AGL_Layers/2_meta-agl.md
@@ -10,7 +10,7 @@ You use this layer as the minimal core on which to build AGL profiles.
**NOTE:** The `meta-agl` layer does not include a reference UI.
The reference UI is included as part of the
- [`meta-agl-demo`](./meta-agl-demo.html) layer.
+ [`meta-agl-demo`](3_meta-agl-demo.md) layer.
Furthermore, `meta-agl` does not include additional components, such
as security, which are part of the
`meta-agl-extra` layer.
@@ -81,7 +81,7 @@ in `meta-agl`:
## Packagegroups
This section describes the AGL
-[packagegroup](https://yoctoproject.org/docs/ 3.1.2/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks)
+[packagegroup](https://yoctoproject.org/docs/3.1.2/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks)
design:
* packagegroup-agl-image-minimal
diff --git a/docs/3_Developer_Guides/6_AGL_Layers/3_meta-agl-demo.md b/docs/3_Developer_Guides/6_AGL_Layers/3_meta-agl-demo.md
new file mode 100644
index 0000000..a38f7ba
--- /dev/null
+++ b/docs/3_Developer_Guides/6_AGL_Layers/3_meta-agl-demo.md
@@ -0,0 +1,159 @@
+---
+title: meta-agl-demo
+---
+
+## Introduction
+
+The `meta-agl-demo` layer is the reference user interface layer for the DEMO
+platform of Automotive Grade Linux (AGL).
+The layer provides a reference platform and applications.
+The BitBake target name for the DEMO platform is `agl-demo-platform`, which is
+the full DEMO platform image.
+
+## Layer Dependencies
+
+This section describes dependencies for the `meta-agl-demo` layer.
+Dependencies are grouped into base, hardware, and feature dependencies.
+
+### Base Dependencies
+
+The `meta-agl-demo` layer has the following base dependencies:
+
+- Yocto Project Release:
+
+ - URI: git://git.yoctoproject.org/poky
+ - Branch: "thud"
+ - Tested Revision: See the
+ [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml)
+ manifest file for the `AGL-repo` repository for revision information.
+
+- AGL `meta-agl` Layer:
+
+ - URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl
+ - Branch: "master"
+
+- OpenEmbedded `meta-openembedded` Layer:
+
+ - Branch: "thud"
+ - Tested Revision: See the
+ [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml)
+ manifest file for the `AGL-repo` repository for revision information.
+
+ Specifically, out of `meta-openembedded`, these sub-layers are used:
+
+ - `meta-oe`
+ - `meta-multimedia`
+ - `meta-networking`
+ - `meta-python`
+
+- Yocto Project `meta-qt5` Layer from the
+ [OpenEmbedded Layer Index](https://layers.openembedded.org/layerindex/branch/master/layers/):
+
+ - URI: https://github.com/meta-qt5/meta-qt5.git
+ - Branch: "thud"
+ - Tested Revision: See the
+ [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml)
+ manifest file for the `AGL-repo` repository for revision information.
+
+### Hardware Dependencies
+
+Aside from the previously listed base dependencies, if you are using a
+[supported Renesas board](../../0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md)
+supported Renesas board, these dependencies exist:
+
+- AGL's `meta-renesas` Layer:
+
+ - URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-renesas
+
+### Feature Dependencies
+
+The `meta-agl-demo` layer has the following AGL [feature](../../0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md#agl-features)
+dependencies:
+
+- Yocto Project `meta-security` Layer:
+
+ - URI: https://git.yoctoproject.org/cgit/cgit.cgi/meta-security
+ - Branch: "master"
+ - Tested Revision: See the
+ [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml)
+ manifest file for the `AGL-repo` repository for revision information.
+
+- AGL's `meta-app-framework` Layer within the `meta-agl` Layer:
+
+ - URI: https://gerrit.automotivelinux.org/gerrit/gitweb?p=AGL/meta-agl.git
+ - Branch: "master"
+
+**The `agl-sota` Feature:**
+
+- Here Technologies' `meta-updater` Layer:
+
+ - URI: https://github.com/advancedtelematic/meta-updater/
+ - Branch: "thud"
+
+- Here Technologies' `meta-updater-qemux86-64` Layer:
+
+ - URI: https://github.com/advancedtelematic/meta-updater-qemux86-64/
+ - Branch: "thud"
+
+- OpenEmbedded's `meta-openembedded` Layer:
+
+ - URI: https://github.com/openembedded/meta-openembedded
+ - Branch: "thud"
+ - Tested Revision: See the
+ [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml)
+ manifest file for the `AGL-repo` repository for revision information.
+
+ Specifically, out of `meta-openembedded`, these sub-layers are used:
+
+ - `meta-filesystems`
+ - `meta-oe`
+ - `meta-python`
+
+**The `agl-netboot` Feature:**
+
+- AGL's `meta-netboot` Layer within the `meta-agl` Layer:
+
+ - URI: https://gerrit.automotivelinux.org/gerrit/gitweb?p=AGL/meta-agl.git
+ - Branch: "master"
+
+
+## Packagegroups
+
+AGL DEMO Platform's [packagegroups](https://www.yoctoproject.org/docs/3.1.2/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks)
+consist of the following:
+
+- packagegroup-agl-demo-platform
+
+ This packagegroup is used for generating the `agl-demo-platform` image,
+ which is the full image for the AGL distributions IVI profile. You can see the
+ recipe (i.e. `agl-demo-platform.bb`) that installs the
+ `packagegroup-agl-demo-platform` packagegroup [here](https://git.automotivelinux.org/AGL/meta-agl-demo/tree/recipes-platform/images/agl-demo-platform.bb).
+
+ As meta-agl's design of packagegroups, the `agl-demo-platform.bb` recipe installs
+ only `packagegroup-agl-demo-platform` and the packages of the DEMO applications.
+
+ ``agl-demo-platform`` contains the following three packagegroups:
+
+ * `packagegroup-agl-image-minimal`
+ * `packagegroup-agl-image-ivi`
+ * `packagegroup-agl-demo-platform`
+
+- packagegroup-agl-appfw*
+
+ These packagegroups contain packages for the AGL distribution's
+ Application Framework. Subsystem should maintain
+ `packagegroup-agl-appfw-[subsystem].bb`, which should hold sufficient packages
+ for the Application Framework.
+
+ Subsystems also can maintain their own packagegroups using appropriate
+ `recipes-*/`.
+
+ For example, Qt5 has two packagegroups in `meta-agl-demo`:
+ `packagegroup-agl-appfw-native-qt5` and `packagegroup-agl-demo-qt-examples`,
+ which are under `recipes-qt/`.
+
+ The `packagegroup-agl-appfw-native-qt5` is included by `packagegroup-agl-appfw-native` because Qt5 belongs to native application framework of AGL Distro.
+
+ Because the `packagegroup-agl-demo-qt-examples` is not mandatory for the AGL
+ Application Framework and the AGL DEMO, the packagegroup is added to the layer's
+ `local.conf` file only when needed. \ No newline at end of file
diff --git a/docs/3_Developer_Guides/1_AGL_Layers/4_meta-agl-devel.md b/docs/3_Developer_Guides/6_AGL_Layers/4_meta-agl-devel.md
index 859d958..8932b82 100644
--- a/docs/3_Developer_Guides/1_AGL_Layers/4_meta-agl-devel.md
+++ b/docs/3_Developer_Guides/6_AGL_Layers/4_meta-agl-devel.md
@@ -2,8 +2,6 @@
title: meta-agl-devel
---
-<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/devguides/master/meta-agl-devel-guides-devguides-book.yml -->
-
## Introduction
The `meta-agl-devel` layer contains components that are being tested or
@@ -118,7 +116,7 @@ environment using the `aglsetup.sh` script.
For information on how to use the `aglsetup.sh` script to initialize
your build environment, see the
-"[Initializing Your Build Environment](../getting_started/reference/getting-started/image-workflow-initialize-build-environment.html)"
+"[Initializing Your Build Environment](../../0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md)"
section.
Once you have included the AGL feature, you can build your image.
@@ -139,7 +137,7 @@ environment using the `aglsetup.sh` script.
For information on how to use the `aglsetup.sh` script to initialize
your build environment, see the
-"[Initializing Your Build Environment](../getting_started/reference/getting-started/image-workflow-initialize-build-environment.html)"
+"[Initializing Your Build Environment](../../0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md)"
section.
-Once you have included the AGL feature, you can build your image.
+Once you have included the AGL feature, you can build your image. \ No newline at end of file