public inbox for isar-users@googlegroups.com
 help / color / mirror / Atom feed
From: Adriaan Schmidt <adriaan.schmidt@siemens.com>
To: <isar-users@googlegroups.com>
Cc: Adriaan Schmidt <adriaan.schmidt@siemens.com>
Subject: [PATCH 3/3] doc: add sstate to user manual
Date: Thu, 23 Dec 2021 12:34:00 +0100	[thread overview]
Message-ID: <20211223113400.1123555-4-adriaan.schmidt@siemens.com> (raw)
In-Reply-To: <20211223113400.1123555-1-adriaan.schmidt@siemens.com>

Signed-off-by: Adriaan Schmidt <adriaan.schmidt@siemens.com>
---
 doc/user_manual.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/doc/user_manual.md b/doc/user_manual.md
index caaab8c..df530e7 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -20,6 +20,7 @@ Copyright (C) 2016-2019, ilbers GmbH
  - [Build statistics collection](#build-statistics-collection)
  - [Enabling Cross-compilation](#isar-cross-compilation)
  - [Using ccache for custom packages](#using-ccache-for-custom-packages)
+ - [Using sstate-cache](#using-sstate-cache)
  - [Create an ISAR SDK root filesystem](#create-an-isar-sdk-root-filesystem)
  - [Create a containerized Isar SDK root filesystem](#create-a-containerized-isar-sdk-root-filesystem)
  - [Creation of local apt repo caching upstream Debian packages](#creation-of-local-apt-repo-caching-upstream-debian-packages)
@@ -964,6 +965,29 @@ adjusted by `CCACHE_TOP_DIR` variable in `local.conf`. Ccache directory
 that means caches for different distros and architectures are not overlapped.
 
 
+## Using sstate-cache
+
+Isar supports caching of bitbake task artifacts using the sstate-cache
+feature known from OpenEmbedded. Isar caches
+
+  * the Debian bootstrap (`isar-bootstrap` recipe)
+  * Debian packages (built with the `dpkg` or `dpkg-raw` classes)
+  * root file systems (buildchroot and image rootfs)
+
+The location of the sstate-cache is controlled by the variable `SSTATE_DIR`
+and defaults to `${TMPDIR}/sstate-cache`.
+
+Note that cached rootfs artifacts (bootstrap and buildchroot) have a limited
+"lifetime": Isar updates their package lists for the upstream package sources
+only once, when they are initially created. So as packages on the upstream
+mirrors change, those lists will be out-of-date and the rootfs becomes useless.
+To avoid this, it is recommended to regularly delete the contents of the
+sstate-cache.
+
+To build without using any sstate caching, you can use the bitbake argument
+`--no-setscene`.
+
+
 ## Create an ISAR SDK root filesystem
 
 ### Motivation
-- 
2.30.2


  parent reply	other threads:[~2021-12-23 11:34 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-23 11:33 [PATCH 0/3] Sstate-cache follow-up Adriaan Schmidt
2021-12-23 11:33 ` [PATCH 1/3] testsuite: refactor Adriaan Schmidt
2021-12-23 11:33 ` [PATCH 2/3] sstate: add test case Adriaan Schmidt
2021-12-23 11:34 ` Adriaan Schmidt [this message]
2022-01-04 15:47 ` [PATCH 0/3] Sstate-cache follow-up Jan Kiszka
2022-01-07  8:18   ` Schmidt, Adriaan
2022-02-22  6:24 ` Anton Mikanovich

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211223113400.1123555-4-adriaan.schmidt@siemens.com \
    --to=adriaan.schmidt@siemens.com \
    --cc=isar-users@googlegroups.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox