From 230d0b58f65a9261099f0c75eb166147cd958de0 Mon Sep 17 00:00:00 2001 From: Merlin Carter Date: Thu, 29 Aug 2019 12:36:03 +0200 Subject: OTA-3629: Responding to PR comments - added "tree" instead of "blob" in root path. - Adding ref to developer guide - fixed erroneous note. Signed-off-by: Merlin Carter --- README.adoc | 7 +++++-- docs/modules/ROOT/pages/sota-variables.adoc | 6 ------ 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/README.adoc b/README.adoc index ab7879b..97b9987 100644 --- a/README.adoc +++ b/README.adoc @@ -1,11 +1,11 @@ = meta-updater :toc: macro :toc-title: -:meta-updater-github-url: https://github.com/advancedtelematic/meta-updater/blob/master/ +:meta-updater-github-url: https://github.com/advancedtelematic/meta-updater/tree/master/ ifndef::env-github[:meta-updater-github-url:] -Meta-updater is a link:https://www.yoctoproject.org/software-overview/layers/[Yocto layer] that enables over-the-air updates (OTA) with https://github.com/ostreedev/ostree[OSTree] and https://github.com/advancedtelematic/aktualizr[Aktualizr]. +Meta-updater is a link:https://www.yoctoproject.org/software-overview/layers/[Yocto layer] that enables over-the-air updates (OTA) with https://github.com/ostreedev/ostree[OSTree] and https://github.com/advancedtelematic/aktualizr[Aktualizr] -- the default client for link:https://www.here.com/products/automotive/ota-technology[HERE OTA Connect]. https://github.com/ostreedev/ostree[OSTree] is a tool for atomic full file system upgrades with rollback capability. OSTree has several advantages over traditional dual-bank systems, but the most important one is that it minimizes network bandwidth and data storage footprint by sharing files with the same contents across file system deployments. @@ -13,6 +13,9 @@ https://github.com/advancedtelematic/aktualizr[Aktualizr] (and https://github.co [discrete] == Table of Contents + +The following documentation focuses on tasks that involve the meta-updater layer. If you want to get an idea of the overall developer workflow in OTA Connect, see the link:https://docs.ota.here.com/ota-client/dev/index.html[OTA Connect Developer Guide]. + * xref:{meta-updater-github-url}docs/modules/ROOT/pages/build.adoc[Build] + Learn how to use this layer to build a basic disk image and add it to your own Yocto project. diff --git a/docs/modules/ROOT/pages/sota-variables.adoc b/docs/modules/ROOT/pages/sota-variables.adoc index 1dbc89a..7614a8a 100644 --- a/docs/modules/ROOT/pages/sota-variables.adoc +++ b/docs/modules/ROOT/pages/sota-variables.adoc @@ -15,12 +15,6 @@ | `OSTREE_DEPLOY_DEVICETREE`|Set this to '1' to include devicetree(s) to boot | `GARAGE_SIGN_AUTOVERSION`|Set this to '1' to automatically fetch the last version of the garage tools installed by the aktualizr-native. Otherwise use the fixed version specified in the recipe. | `GARAGE_TARGET_URL` | Sets the `--url` parameter of `garage-sign targets add`, which sets a custom URL for the Image repository targets. -ifndef::env-github[] -[NOTE] -==== -Currently, this only works when using the master branch of meta-updater. -==== -endif::[] | `GARAGE_TARGET_EXPIRES` | Sets the `--expires` parameter of `garage-sign targets sign`. Format is a UTC instant such as '2018-01-01T00:01:00Z'. ifndef::env-github[] [NOTE] -- cgit v1.2.3-54-g00ecf