From 1283c6eeea4b688a4cd5ffa9e58cb7450ad0b251 Mon Sep 17 00:00:00 2001 From: Werner Date: Wed, 22 Jan 2025 17:09:00 +0100 Subject: [PATCH] add `ARTIFACT_IGNORE_CACHE` to FAQ (#602) * add `ARTIFACT_IGNORE_CACHE` to FAQ * add `ARTIFACT_IGNORE_CACHE` got build switches --- docs/Developer-Guide_Build-Switches.md | 8 ++++++++ docs/User-Guide_FAQ.md | 10 ++++++++++ 2 files changed, 18 insertions(+) diff --git a/docs/Developer-Guide_Build-Switches.md b/docs/Developer-Guide_Build-Switches.md index 186e643c..c4905aff 100644 --- a/docs/Developer-Guide_Build-Switches.md +++ b/docs/Developer-Guide_Build-Switches.md @@ -246,6 +246,14 @@ Include directories created inside /home in final image. Automatically login as root for local consoles at first run. Disable if your security threat model requires. +**ARTIFACT_IGNORE_CACHE** ( string ) + +- `yes` +- `no` (default) + +Enforce building from source instead of using pre-built artifacts. + + # Build options below need to be retested and added above (COULD BE DEPRECATED) :warning: DO NOT USE! Obsolete documentation, new documentation above is in progress. diff --git a/docs/User-Guide_FAQ.md b/docs/User-Guide_FAQ.md index 0d5d5c55..d14c16f6 100644 --- a/docs/User-Guide_FAQ.md +++ b/docs/User-Guide_FAQ.md @@ -137,3 +137,13 @@ root@orangepione:~# echo none > /sys/devices/platform/leds/leds/orangepi:red:sta It would be VERY ressource intensive and just insane to pre-create and provide images for all possible combination of kernels, userspaces and desktops/CLI for all available boards and last but not least provide support for them. We simply cannot afford doing this since our ressources in both human and financial are limited. Therefore we provide a small selection for each board only. However with the Armbian build framework it is very easy and convenient to create an image of your desire by yourself. If there is enough public interest for a certain combination we may occasionally adjust our build targets. + +## When using the framework it does not build anything but downloads artifacts. How can I force rebuilding from sources? + +tl;dr: `ARTIFACT_IGNORE_CACHE=yes` + +Forcing a rebuild is usually not necessary, because: +> Armbian build [...] operates on smaller units called “artifacts”: the kernel, u-boot, firmware, rootfs, and then finally the full image. Each of those has its version calculated beforehand based on its would-be +contents, and looked up in both a local and remote cache (OCI registry), allowing users to re-use artifacts across builds and to use the best hardware available for each. [...] + +However sometimes local changes are not detected properly. Therefore this flag can be useful.