From eaee7001e061ed8cf644b013be8e0ec62a9e3f74 Mon Sep 17 00:00:00 2001 From: Patrick Vacek Date: Fri, 16 Nov 2018 17:35:39 +0100 Subject: docs: better explanation of oe-selftest requirements. Also remove all references to aktualizr-example-interface. It has been removed. Signed-off-by: Patrick Vacek --- CONTRIBUTING.adoc | 2 +- README.adoc | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index f12b95d..4d9e8f6 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -17,7 +17,7 @@ If you are developing with meta-updater, it may be helpful to read the README an * OTA-enabled build succeeds for at least one platform, the resulting image boots, and an update can be installed. This check is absolutely necessary for every pull request unless it only touches documentation. * If your change touches platform code (like `classes/sota_.bbclass`), please check building and updating on this particular platform. -* oe-selftest succeeds. To test meta-updater, run `oe-selftest -r updater` from a build directory with `MACHINE` set to `qemux86-64`. +* oe-selftest succeeds. To test meta-updater, run `oe-selftest -r updater` from a build directory with `MACHINE` set to `qemux86-64`. See the link:README.adoc#qa-with-oe-selftest[relevant section of the README] for more details. * Updates are forwards- and backwards-compatible. You should be able to update an OTA-enabled build before the change is applied to the version with change applied and vice versa. One should pay double attention to the compatibility when bootloader code is affected. * The patch/branch should be based on the latest version of the target branch. This may mean that rebasing is necessary if other PRs are merged before yours is approved. diff --git a/README.adoc b/README.adoc index ee88efa..43d625c 100644 --- a/README.adoc +++ b/README.adoc @@ -146,7 +146,6 @@ First, you can set `SOTA_CLIENT_PROV` to control which provisioning recipe is us Second, you can write recipes to install additional config files with customized options. A few recipes already exist to address common needs and provide an example: -* link:recipes-sota/config/aktualizr-example-interface.bb[aktualizr-example-interface.bb] will configure aktualizr to connect to an example interface for a legacy flasher. This is intended to be used in conjunction with the `aktualizr-examples` package. See https://github.com/advancedtelematic/aktualizr/blob/master/docs/legacysecondary.adoc[legacysecondary.adoc] in the aktualizr repo for more information. * link:recipes-sota/config/aktualizr-disable-send-ip.bb[aktualizr-disable-send-ip.bb] disables the reporting of networking information to the server. This is enabled by default and supported by https://connect.ota.here.com/[HERE OTA Connect]. However, if you are using a different server that does not support this feature, you may want to disable it in aktualizr. * link:recipes-sota/config/aktualizr-log-debug.bb[aktualizr-log-debug.bb] sets the log level of aktualizr to 0 (trace). The default is 2 (info). This recipe is intended for development and debugging purposes. @@ -181,7 +180,7 @@ Please note that [target name, target version] pairs are expected to be unique i == QA with oe-selftest -This layer relies on the test framework oe-selftest for quality assurance. Follow the steps below to run the tests: +This layer relies on the test framework oe-selftest for quality assurance. Currently, you will need to run this in a build directory with `MACHINE` set to `qemux86-64`. Follow the steps below to run the tests: 1. Append the line below to `conf/local.conf` to disable the warning about supported operating systems: + -- cgit v1.2.3-54-g00ecf