Commit 08547a48 authored by Diego Sueiro's avatar Diego Sueiro
Browse files

doc: Various documentation updates



Issue-Id: SCM-4397
Signed-off-by: Diego Sueiro's avatarDiego Sueiro <diego.sueiro@arm.com>
Change-Id: Iae00a9331d302b47c122a2c0bffb560c2321d381
parent 8fefdc7f
......@@ -18,7 +18,7 @@ orchestration of applications on edge platforms.
## EWAOL Documentation
The project's documentation can be browsed at
<https://ewaol.sites.arm.com/meta-ewaol>.
<https://ewaol.docs.arm.com>.
To build a local version of the documentation, a Python build script that
automates the documentation build process is available under
......
......@@ -272,15 +272,9 @@ Gitlab Account Setup
====================
In order to contribute to the repository, it is necessary to have an account on
|meta-ewaol repository host|. Please see `TBC`_ for details of how to create an
account. If contributing within a professional capacity, please include the
affiliation under the ``Organization`` heading on account settings.
The account must be able have sufficient personal project capacity to fork the
``meta-ewaol`` repository. Please see `TBC`_ for details of how to
increase personal project capacity.
.. _TBC: https://
|meta-ewaol repository host|. Please see
`<https://gitlab.arm.com/documentation/contributions>`_ for details of how to
create an account and request a fork of the ``meta-ewaol`` repository.
Submission
==========
......
......@@ -153,10 +153,10 @@ The documentation is structured as follows:
Provides guidance for configuring, building, and deploying EWAOL
distributions on supported target platforms, running and validating
supported EWAOL functionalities, and running the distribution on custom
hardware. Also includes migration guidance for how to enable these
activities on a later EWAOL release, when upgrading from an older release
version.
supported EWAOL functionalities, and building the distribution for a custom
or unsupported target platform. Also includes migration guidance for how to
enable these activities on a later EWAOL release, when upgrading from an
older release.
* :ref:`Developer Manual <manual/index:Developer Manual>`
......@@ -299,8 +299,8 @@ Guidance for contributing to the EWAOL project can be found at
:ref:`Contributing <contributing:Contributing>`.
To report issues with the repository such as potential bugs, security concerns,
or feature requests, please submit an Issue via GitLab, following the project's
Issue template.
or feature requests, please submit an Issue via |GitLab Issues|_, following the
project's template.
********************
Feedback and support
......
......@@ -36,17 +36,17 @@ The ``meta-ewaol-config/kas`` directory contains kas configuration files that
support building images via kas for the EWAOL project. and fall into three
ordered categories:
* Architecture Configs
* Build Modifier Configs
* Target Platform Configs
* **Architecture Configs**
* **Build Modifier Configs**
* **Target Platform Configs**
To build an EWAOL distribution image via kas, it is required to provide one
Architecture Config and one Target Platform Config, unless otherwise stated in
their descriptions below. Additional Build Modifiers are optional, and depend on
the target use-case. Currently, it is necessary that kas configuration files are
provided in order: the Architecture Config is defined first, then additional
build features via zero or more Build Modifier Configs, and finally the Target
Platform Config.
**Architecture Config** and one **Target Platform Config**, unless otherwise
stated in their descriptions below. Additional Build Modifiers are optional,
and depend on the target use-case. Currently, it is necessary that kas
configuration files are provided in order: the **Architecture Config** is
defined first, then additional build features via zero or more **Build Modifier
Configs**, and finally the **Target Platform Config**.
The kas configuration files to enable builds for a supported target platform or
to configure each EWAOL distribution image feature, are described in their
......@@ -58,6 +58,8 @@ respectively. Example usage of these kas configuration files can be found in the
If a kas configuration file does not set a particular build parameter, the
parameter will take its default value.
.. _manual_build_system_target_platforms:
****************
Target Platforms
****************
......@@ -215,9 +217,9 @@ generated for each Guest VM by appending the instance index to the
will have a hostname ``ewaol-guest-vm1``, the second will have a hostname
``ewaol-guest-vm2``, and so on. An example of configuring a second Guest VM
instance using the kas tool is given in
``meta-ewaol-config/kas/second-vm-parameters.yml``, although these variables
will only be used if ``EWAOL_GUEST_VM_INSTANCES`` is set to build two or more
Guest VMs.
``meta-ewaol-config/kas/include/second-guest-vm-parameters.yml``, although
these variables will only be used if ``EWAOL_GUEST_VM_INSTANCES`` is set to
build two or more Guest VMs.
Other EWAOL Features
====================
......@@ -415,9 +417,11 @@ Manual Bitbake Build Setup
In order to build an EWAOL distribution image without the kas build tool
directly via bitbake, it is necessary to prepare a bitbake project as follows:
* Configure dependent Yocto layers in ``bblayers.conf``.
* Configure :ref:`dependent Yocto layers <manual_yocto_layers_layer_dependency_overview>`
in ``bblayers.conf``.
* Configure the ``DISTRO`` as ``ewaol`` in ``local.conf``.
* Configure the image ``DISTRO_FEATURES`` in ``local.conf``.
* Configure the image ``DISTRO_FEATURES``, including the EWAOL Architecture
(``ewaol-baremetal`` or ``ewaol-virtualization``), in ``local.conf``.
Assuming correct environment configuration, the Bitbake build can then be run
for the desired image target corresponding to one of the following:
......
......@@ -16,10 +16,8 @@ on the target, such as:
* Tracing
* Runtime package management
.. note::
The precise list of packages and image features provided as part of the
EWAOL SDK can be found in
``meta-ewaol-distro/conf/distro/include/ewaol-sdk.inc``.
The precise list of packages and image features provided as part of the EWAOL
SDK can be found in ``meta-ewaol-distro/conf/distro/include/ewaol-sdk.inc``.
The Yocto project provides guidance for some of these common development tasks,
for example |kernel module compilation|_, |profiling and tracing|_, and
......
......@@ -33,6 +33,8 @@ Project, in the following sub-directories:
devicetree together with a Xen efi binary are included into the final wic
image in the ``boot`` partition.
.. _manual_yocto_layers_layer_dependency_overview:
*************************
Layer Dependency Overview
*************************
......@@ -78,7 +80,7 @@ is the ``meta-arm`` repository, which provides three Yocto layers:
The layers required from ``meta-arm`` depend on the EWAOL distribution image:
* EWAOL SDK distribution images require ``meta-arm`` and
``meta-arm-toolchain``, as the gator-daemon package is installed on the
``meta-arm-toolchain``, as the ``gator-daemon`` package is installed on the
rootfs.
* An EWAOL virtualization distribution image requires ``meta-arm`` and
......@@ -100,7 +102,6 @@ These layers are described as follows:
* URL: https://git.yoctoproject.org/cgit/cgit.cgi/meta-arm/tree/meta-arm-bsp.
* Board specific components for Arm target platforms.
* Can be replaced by ``meta-<SiP>-bsp``.
* ``meta-arm-toolchain``:
......
......@@ -58,4 +58,4 @@ file by running the following kas command:
.. code-block:: console
kas build meta-my-bsp-layer/my-machine.yml
kas build --update meta-my-bsp-layer/my-machine.yml
......@@ -22,8 +22,8 @@ features, and running example EWAOL use-cases.
extend
Describes how to extend the EWAOL project to build and run on a custom or
unsupported target platform.
Describes how to extend the EWAOL project to build for a custom or unsupported
target platform.
.. toctree::
:maxdepth: 1
......
......@@ -7,10 +7,11 @@
Reproduce
#########
The section of the User Guide describes how to reproduce a standard EWAOL
distribution image for a supported target platform, configuring and deploying
the supported set of distribution image features, and running simple examples of
the :ref:`EWAOL Use-Cases <introduction_use_cases_overview>`.
This section of the User Guide describes how to reproduce a standard EWAOL
distribution image for a supported
:ref:`target platform <manual_build_system_target_platforms>`, configuring and
deploying the supported set of distribution image features, and running simple
examples of the :ref:`EWAOL Use-Cases <introduction_use_cases_overview>`.
************
Introduction
......@@ -476,7 +477,7 @@ Build Host. The instructions are as follows:
sdb 8:0 0 2G 0 disk
└─sdb1 8:1 0 2G 0 part
.. note::
.. warning::
In this example, the ``/dev/sdb1`` partition is being mounted. As this
may vary on different machines, care should be taken when copying and
pasting the following commands.
......
......@@ -45,10 +45,9 @@ general_links = {
"link:Yocto Xen config": f"https://git.yoctoproject.org/cgit/cgit.cgi/yocto-kernel-cache/tree/features/xen/xen.cfg?h=yocto-{yocto_linux_version}",
"link:kas build tool": f"https://kas.readthedocs.io/en/{kas_version}/userguide.html",
"link:kas Dependencies & installation": f"https://kas.readthedocs.io/en/{kas_version}/userguide.html#dependencies-installation",
"link:meta-arm-bsp": f"https://git.yoctoproject.org/meta-arm/tree/meta-arm-bsp/documentation?h={yocto_release}",
"link:meta-arm-bsp": f"https://git.yoctoproject.org/meta-arm/tree/meta-arm-bsp/documentation/n1sdp.md?h={yocto_release}",
"link:xl domain configuration": f"https://xenbits.xen.org/docs/{xen_version}-testing/man/xl.cfg.5.html",
"link:xl documentation": f"https://xenbits.xen.org/docs/{xen_version}-testing/man/xl.1.html",
"link:N1SDP Technical Reference Manual": "https://developer.arm.com/documentation/101489/0000",
"link:PEP 8": "https://peps.python.org/pep-0008/",
"link:pycodestyle Documentation": "https://pycodestyle.pycqa.org/en/latest/",
......@@ -63,6 +62,7 @@ general_links = {
"link:Python Datetime Format Codes": "https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes",
"link:Nginx": "https://www.nginx.com/",
"link:Potential firmware damage notice": "https://community.arm.com/developer/tools-software/oss-platforms/w/docs/604/notice-potential-damage-to-n1sdp-boards-if-using-latest-firmware-release",
"link:GitLab Issues": "https://gitlab.arm.com/ewaol/meta-ewaol/-/issues",
}
layer_definitions = {
......
......@@ -130,6 +130,8 @@ loopback
lts
m
maxdepth
manual_build_system_target_platforms
manual_yocto_layers_layer_dependency_overview
mb
meta-arm-bsp
meta-ewaol
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment