summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMerlin Carter <merlin.carter@here.com>2019-08-29 12:36:03 +0200
committerMerlin Carter <merlin.carter@here.com>2019-08-29 12:37:32 +0200
commit230d0b58f65a9261099f0c75eb166147cd958de0 (patch)
tree72e04b845479321e28d3286dc07be1958e57732a
parent8ee9e9c0607d7ce0c057f2cb7454973ddf7a5778 (diff)
downloadmeta-updater-docs/OTA-3594/antora-merge.tar.gz
OTA-3629: Responding to PR commentsdocs/OTA-3594/antora-merge
- added "tree" instead of "blob" in root path. - Adding ref to developer guide - fixed erroneous note. Signed-off-by: Merlin Carter <merlin.carter@here.com>
-rw-r--r--README.adoc7
-rw-r--r--docs/modules/ROOT/pages/sota-variables.adoc6
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 @@
1= meta-updater 1= meta-updater
2:toc: macro 2:toc: macro
3:toc-title: 3:toc-title:
4:meta-updater-github-url: https://github.com/advancedtelematic/meta-updater/blob/master/ 4:meta-updater-github-url: https://github.com/advancedtelematic/meta-updater/tree/master/
5 5
6ifndef::env-github[:meta-updater-github-url:] 6ifndef::env-github[:meta-updater-github-url:]
7 7
8Meta-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]. 8Meta-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].
9 9
10https://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. 10https://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.
11 11
@@ -13,6 +13,9 @@ https://github.com/advancedtelematic/aktualizr[Aktualizr] (and https://github.co
13 13
14[discrete] 14[discrete]
15== Table of Contents 15== Table of Contents
16
17The 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].
18
16* xref:{meta-updater-github-url}docs/modules/ROOT/pages/build.adoc[Build] 19* xref:{meta-updater-github-url}docs/modules/ROOT/pages/build.adoc[Build]
17+ 20+
18Learn how to use this layer to build a basic disk image and add it to your own Yocto project. 21Learn 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 @@
15| `OSTREE_DEPLOY_DEVICETREE`|Set this to '1' to include devicetree(s) to boot 15| `OSTREE_DEPLOY_DEVICETREE`|Set this to '1' to include devicetree(s) to boot
16| `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. 16| `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.
17| `GARAGE_TARGET_URL` | Sets the `--url` parameter of `garage-sign targets add`, which sets a custom URL for the Image repository targets. 17| `GARAGE_TARGET_URL` | Sets the `--url` parameter of `garage-sign targets add`, which sets a custom URL for the Image repository targets.
18ifndef::env-github[]
19[NOTE]
20====
21Currently, this only works when using the master branch of meta-updater.
22====
23endif::[]
24| `GARAGE_TARGET_EXPIRES` | Sets the `--expires` parameter of `garage-sign targets sign`. Format is a UTC instant such as '2018-01-01T00:01:00Z'. 18| `GARAGE_TARGET_EXPIRES` | Sets the `--expires` parameter of `garage-sign targets sign`. Format is a UTC instant such as '2018-01-01T00:01:00Z'.
25ifndef::env-github[] 19ifndef::env-github[]
26[NOTE] 20[NOTE]