From 19c407da96d2b071990d3b1871b4581ecc72f414 Mon Sep 17 00:00:00 2001 From: Jan-Simon Moeller Date: Wed, 10 Aug 2022 12:58:51 +0200 Subject: Bulk documentation updates for needlefish Mostly just s/master/needlefish . Little corrections where necessary. Add a FIXME for the platform doc/Security Blueprint Signed-off-by: Jan-Simon Moeller Change-Id: Ia54ba1a46f0575689268ff5999a1c953a6f8a54c Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27894 --- .../2_Building_AGL_Image/1_Preparing_Your_Build_Host.md | 2 +- .../2_Building_AGL_Image/2_Downloading_AGL_Software.md | 7 ++----- .../2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md | 6 +++--- .../2_Building_AGL_Image/4_Customizing_Your_Build.md | 4 ++-- .../2_Building_AGL_Image/5_1_x86_Emulation_and_Hardware.md | 2 +- docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md | 4 ++-- 6 files changed, 11 insertions(+), 14 deletions(-) (limited to 'docs/0_Getting_Started/2_Building_AGL_Image') diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host.md b/docs/0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host.md index b7c1d4b..b2c15c0 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host.md @@ -17,7 +17,7 @@ the Yocto Project documentation **NOTE:** This entire section presumes you want to build an image. You can skip the entire build process if you want to use a ready-made development image. -The [supported images](https://download.automotivelinux.org/AGL/snapshots/master/latest/) exist for several boards as +The [supported images](https://download.automotivelinux.org/AGL/release/needlefish/latest/) exist for several boards as well as for the Quick EMUlator (QEMU). See the "[Quickstart](../1_Quickstart/Using_Ready_Made_Images.md)" diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/2_Downloading_AGL_Software.md b/docs/0_Getting_Started/2_Building_AGL_Image/2_Downloading_AGL_Software.md index ee18805..bb32dd4 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/2_Downloading_AGL_Software.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/2_Downloading_AGL_Software.md @@ -51,14 +51,14 @@ The remainder of this section provides steps on how to download the AGL source f Using the latest stable release gives you a solid snapshot of the latest know release. The release is static, tested, and known to work. - To download the latest stable release branch (i.e. Jellyfish), use + To download the latest stable release branch (i.e. Needlefish), use the following commands: ```sh $ cd $AGL_TOP $ mkdir koi $ cd koi - $ repo init -b koi -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo + $ repo init -b needlefish -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo $ repo sync ``` @@ -91,10 +91,7 @@ The remainder of this section provides steps on how to download the AGL source f ├── bsp ├── external ├── meta-agl - ├── meta-agl-cluster-demo ├── meta-agl-demo ├── meta-agl-devel - ├── meta-agl-extra - └── meta-agl-telematics-demo ``` diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md b/docs/0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md index efe7001..199a1e8 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md @@ -10,7 +10,7 @@ run to initialize the build environment. You can find this script here: ```sh -$AGL_TOP/master/meta-agl/scripts/aglsetup.sh +$AGL_TOP/needlefish/meta-agl/scripts/aglsetup.sh ``` The script accepts many options that allow you to define build parameters such @@ -18,7 +18,7 @@ as the target hardware (i.e. the machine), build directory, and so forth. Use the following commands to see the available options and script syntax: ```sh -$ cd $AGL_TOP/master +$ cd $AGL_TOP/needlefish $ source meta-agl/scripts/aglsetup.sh -h ``` @@ -222,7 +222,7 @@ Common targets are: Running the script creates the Build Directory if it does not already exist. The default Build Directory is `$AGL_TOP//build`, and the nomenclature to be used throughout this doc is going to be `$AGL_TOP//` -For this example, the Build Directory is `$AGL_TOP/master/qemux86-64`. +For this example, the Build Directory is `$AGL_TOP/needlefish/qemux86-64`. The script's output also indicates the machine and AGL features selected for the build. diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/4_Customizing_Your_Build.md b/docs/0_Getting_Started/2_Building_AGL_Image/4_Customizing_Your_Build.md index 1c30ddd..6a175e6 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/4_Customizing_Your_Build.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/4_Customizing_Your_Build.md @@ -128,7 +128,7 @@ using mirrors. To use mirrors, add this line to your `local.conf` file in the Build directory: ```sh -SSTATE_MIRRORS_append = " file://.* https://download.automotivelinux.org/sstate-mirror/master/${DEFAULTTUNE}/PATH \n " +SSTATE_MIRRORS_append = " file://.* https://download.automotivelinux.org/sstate-mirror/${AGL_BRANCH}/${DEFAULTTUNE}/PATH \n " ``` You can learn more about shared state and how it is used in the @@ -141,7 +141,7 @@ section of the Yocto Project Reference Manual. $ echo "# reuse download directories" >> $AGL_TOP/site.conf $ echo "DL_DIR = \"$HOME/downloads/\"" >> $AGL_TOP/site.conf $ echo "SSTATE_DIR = \"$AGL_TOP/sstate-cache/\"" >> $AGL_TOP/site.conf -$ cd $AGL_TOP/master/qemux86-64/ +$ cd $AGL_TOP/needlefish/qemux86-64/ $ ln -sf $AGL_TOP/site.conf conf/ In General; diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/5_1_x86_Emulation_and_Hardware.md b/docs/0_Getting_Started/2_Building_AGL_Image/5_1_x86_Emulation_and_Hardware.md index 871179f..8e66014 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/5_1_x86_Emulation_and_Hardware.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/5_1_x86_Emulation_and_Hardware.md @@ -133,7 +133,7 @@ If you built your image with bitbake, you can now just use the ``runqemu`` wrapp For this example : ```sh -$ source $AGL_TOP/master/qemux86-64/agl-init-build-env +$ source $AGL_TOP/needlefish/qemux86-64/agl-init-build-env ``` In general : diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md b/docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md index 33fc50a..e5da698 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md @@ -1,4 +1,4 @@ ---- +--- title: Building for Supported Renesas Boards --- @@ -65,7 +65,7 @@ Follow these steps to download the drivers you need: | AGL Version | Renesas version | |:-:|:-:| - | AGL master | 5.9.0 | + | AGL needlefish | 5.9.0 | 3. **Download the Files:** -- cgit 1.2.3-korg