summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.adoc
diff options
context:
space:
mode:
authorPatrick Vacek <patrickvacek@gmail.com>2018-11-16 17:35:39 +0100
committerPatrick Vacek <patrickvacek@gmail.com>2018-11-16 17:37:46 +0100
commit433b40e6fee7db4f3ff675ce5361c02a8f24ac49 (patch)
tree677310579787e37d866cd9722195dd93409cc7be /CONTRIBUTING.adoc
parentf799da5e7a73a740f33fa40087b9799e10ac8d7c (diff)
downloadmeta-updater-433b40e6fee7db4f3ff675ce5361c02a8f24ac49.tar.gz
docs: better explanation of oe-selftest requirements.doc/oe-selftest-and-rm-example
Also remove all references to aktualizr-example-interface. It has been removed. Signed-off-by: Patrick Vacek <patrickvacek@gmail.com>
Diffstat (limited to 'CONTRIBUTING.adoc')
-rw-r--r--CONTRIBUTING.adoc2
1 files changed, 1 insertions, 1 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
17 17
18* 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. 18* 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.
19* If your change touches platform code (like `classes/sota_<platform>.bbclass`), please check building and updating on this particular platform. 19* If your change touches platform code (like `classes/sota_<platform>.bbclass`), please check building and updating on this particular platform.
20* oe-selftest succeeds. To test meta-updater, run `oe-selftest -r updater` from a build directory with `MACHINE` set to `qemux86-64`. 20* 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.
21* 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. 21* 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.
22* 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. 22* 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.
23 23