diff options
| -rw-r--r-- | docs/getting-started/app-workflow-boot.md | 8 | ||||
| -rw-r--r-- | docs/getting-started/app-workflow-bootables.md | 11 | ||||
| -rw-r--r-- | docs/getting-started/app-workflow-debug-app.md | 4 | ||||
| -rw-r--r-- | docs/getting-started/app-workflow-image.md | 14 | ||||
| -rw-r--r-- | docs/getting-started/machines/raspberrypi.md | 2 | ||||
| -rw-r--r-- | docs/getting-started/machines/renesas.md | 33 |
6 files changed, 48 insertions, 24 deletions
diff --git a/docs/getting-started/app-workflow-boot.md b/docs/getting-started/app-workflow-boot.md index 2000518..c893d6b 100644 --- a/docs/getting-started/app-workflow-boot.md +++ b/docs/getting-started/app-workflow-boot.md @@ -6,17 +6,17 @@ point before deploying your application for testing. Steps exist for booting the following devices: 1. **Intel Devices:** See the - "[Boot the image on the target device](./machines/intel.html#boot-the-image-on-the-target-device)" + "[Booting the Image on the Target Device](./machines/intel.html#4-booting-the-image-on-the-target-device)" section. 2. **QEMU:** See the - "[Boot an image](./machines/qemu.html#boot-an-image)" + "[Deploying the AGL Demo Image](./machines/qemu.html#3-deploying-the-agl-demo-image)" section. 3. **R Car Starter Kit:** See the - "[Booting AGL Image on R-Car Starter Kit Gen3 boards using a microSD card](./machines/R-Car-Starter-Kit-gen3.html#booting-agl-image-on-r-car-starter-kit-gen3-boards-using-a-microsd-card)" + "[Booting the Image Using a MicroSD Card](./machines/renesas.html#7-booting-the-image-using-a-microsd-card)" section. 4. **Raspberry PI:** See the - "[Booting AGL Demo Platform on Raspberry Pi](./machines/raspberrypi.html#booting-agl-demo-platform-on-raspberry-pi)" + "[Booting the Image on Raspberry Pi](./machines/raspberrypi.html#2-booting-the-image-on-raspberry-pi)" section. diff --git a/docs/getting-started/app-workflow-bootables.md b/docs/getting-started/app-workflow-bootables.md index 4e6211a..508ff7a 100644 --- a/docs/getting-started/app-workflow-bootables.md +++ b/docs/getting-started/app-workflow-bootables.md @@ -6,12 +6,17 @@ To run the image, you need to create a bootable image that can be launched from an external device such as an SD card or USB stick. The following list overviews the process. -You find a more detailed description of the process in the -"[Create a bootable media](./machines/intel.html#create-a-bootable-media)" -section. 1. Insert your media into the appropriate build host interface (e.g. USB port). 2. Determine the device name of your portable media (e.g. ``sdb``). 3. Download the ``mkefi-agl.sh`` script. 4. Check your available script options. 5. Use ``mkefi-agl.sh`` to create your media. + +You can detailed steps for creating bootable images for several types of images +in the following sections: + +* "[Create a bootable media](./machines/intel.html#3-creating-bootable-media)" for most Intel boards +* "[Deploying the AGL Demo Image](./machines/qemu.html#3-deploying-the-agl-demo-image)" for emulation images +* "[Booting the Image Using a MicroSD Card](./machines/renesas.html#7-booting-the-image-using-a-microsd-card) for supported Renesas boards +* "[Booting the Image on Raspberry Pi](./machines/raspberrypi.html#2-booting-the-image-on-raspberrypi) for Raspberry Pi 2 and 3 boards diff --git a/docs/getting-started/app-workflow-debug-app.md b/docs/getting-started/app-workflow-debug-app.md index 91ef905..c0899de 100644 --- a/docs/getting-started/app-workflow-debug-app.md +++ b/docs/getting-started/app-workflow-debug-app.md @@ -25,7 +25,7 @@ Here are three methods: * Use Core Dumps if you have set the `agl-devel` feature. Core Dumps are obviously more suited for post-mortem analysis. For features, see the - "[Features supported by `aglsetup`](../../../../../docs/getting_started/en/dev/reference/source-code.html#features-supported-by-aglsetup)" + "[Initializing Your Build Environment](./image-workflow-initialize-build-environment.html#initializing-your-build-environment)" section. **NOTE:** Core Dumps are available only with the "Flunky Flounder" release (i.e. 6.x). @@ -43,5 +43,5 @@ Here are three methods: In order to use third-party debugging tools, you need to include the tools in the target image. You gain access to the tools by enabling the `agl-devel` feature when you run the `aglsetup.sh` script as described in the - "[Setup Build Environment Info](../../../../../docs/getting_started/en/dev/reference/source-code.html#set-up-build-environment-info)" + "[Initializing Your Build Environment](./image-workflow-initialize-build-environment.html#initializing-your-build-environment)" section. diff --git a/docs/getting-started/app-workflow-image.md b/docs/getting-started/app-workflow-image.md index 960f4f0..e64fd5f 100644 --- a/docs/getting-started/app-workflow-image.md +++ b/docs/getting-started/app-workflow-image.md @@ -77,7 +77,7 @@ The following procedure describes how to build your image: 1. **Prepare Your System:** Your system, known as a "build host" needs to meet some requirements in order to build images in the AGL environment. - The "[Setting up your operating system](./source-code.html#setting-up-your-operating-system)" + The "[Preparing Your Build Host](./image-workflow-prep-host.html)" section describes in detail how to make sure your system meets these requirements. @@ -96,7 +96,7 @@ The following procedure describes how to build your image: * Install required packages on the build host. This list of packages depends on the particular Linux Distribution your build host uses. See the - "[Setting up your operating system](./source-code.html#setting-up-your-operating-system)" + "[Preparing Your Build Host](./image-workflow-prep-host.html)" section for the packages you need to install for your specific distribution. @@ -113,7 +113,7 @@ The following procedure describes how to build your image: Otherwise, download the latest stable AGL release. You can see example steps in the - "[Download AGL source code](./source-code.html#download-agl-source-code)" + "[Download AGL source code](./image-workflow-download-sw.html)" section. 3. **Initialize the build environment:** The build process assumes many environment @@ -127,10 +127,8 @@ The following procedure describes how to build your image: before running the script. For information on running the script and on the features you can choose, see the - "[Set up Build Environment info](./source-code.html#set-up-build-environment-info)" - and - "[Features supported by aglsetup](./source-code.html#features-supported-by-aglsetup)" - sections. + "[Initializing Your Build Environment](./image-workflow-initialize-build-environment.html)" + section. 4. **Customize your build configuration:** Aside from environment variables and parameters, build parameters and variables need to be defined before @@ -140,7 +138,7 @@ The following procedure describes how to build your image: In general, the defaults in that file are good enough. However, you can customize aspects by editing the ``local.conf`` file. See the - "[Customize AGL build](./customize_bitbake_conf.html)" + "[Customizing Your Build](./image-workflow-cust-build.html)" section for the location of the file and a list of common customizations. **NOTE:** For detailed explanations of the configurations you can make diff --git a/docs/getting-started/machines/raspberrypi.md b/docs/getting-started/machines/raspberrypi.md index e016584..f963e0b 100644 --- a/docs/getting-started/machines/raspberrypi.md +++ b/docs/getting-started/machines/raspberrypi.md @@ -18,7 +18,7 @@ source meta-agl/scripts/aglsetup.sh -m raspberrypi2 agl-demo agl-netboot agl-app bitbake agl-demo-platform ``` -## Booting AGL Demo Platform on Raspberry Pi +## 2. Booting the Image on Raspberry Pi Follow the steps below to copy the image to microSD card and to boot it on Raspberry Pi 2 or 3: diff --git a/docs/getting-started/machines/renesas.md b/docs/getting-started/machines/renesas.md index f2e14c5..e8d9825 100644 --- a/docs/getting-started/machines/renesas.md +++ b/docs/getting-started/machines/renesas.md @@ -201,8 +201,11 @@ Follow these steps to download the drivers you need: 3. **Examine the Script's Log:** - Read the script's log to be sure no errors occurred during your setup. - For example, suppose the graphics drivers were missing or could not be extracted. + Running the `aglsetup.sh` script creates the `setup.log` file, which is in + the `build/conf` folder. + You can examine this log to see the results of the script. + For example, suppose the graphics drivers were missing or could not be extracted + when you ran the script. In case of missing graphics drivers, you could notice an error message similar to the following: @@ -230,9 +233,7 @@ Follow these steps to download the drivers you need: mentioned, remove the `$AGL_TOP/build` directory, and then re-launch the `aglsetup.sh` again. - You can find out more about any error by examining the `setup.log` file, which is in - the `build/conf` folder. - Here is an example that indicates the driver files could not be extracted from + Here is another example that indicates the driver files could not be extracted from the downloads directory: ```bash @@ -259,6 +260,26 @@ Follow these steps to download the drivers you need: ## 5. Checking Your Configuration + +4. **Customize your build configuration:** Aside from environment variables + and parameters you establish through running the `aglsetup.sh` script, + you can ensure your build's configuration is just how you want it by + examining the `local.conf` configuration file. + In general, the defaults along with the configuration fragments the + `aglsetup.sh` script applies in that file are good enough. + However, you can customize aspects by editing the ``local.conf`` file. + See the + "[Customize AGL build](./customize_bitbake_conf.html)" + section for the location of the file and a list of common customizations. + + **NOTE:** For detailed explanations of the configurations you can make + in the ``local.conf`` file, consult the + [Yocto Project Documentation](https://www.yoctoproject.org/docs/). + + + + + Users may want to check that the board is correctly selected in the environment: ```bash @@ -304,7 +325,7 @@ ls -l $AGL_TOP/build/tmp/deploy/images/$MACHINE In case of failure of the build it is safe to first check that the Linux distribution chosen for your host has been validated for the current version of Yocto used by AGL. -## Booting AGL Image on R-Car Starter Kit Gen3 boards using a microSD card +## 7. Booting the Image Using a MicroSD Card To boot the board using a micro-SD card, there are two operations that must be done prior to first initial boot: |