public inbox for isar-users@googlegroups.com
 help / color / mirror / Atom feed
From: Uladzimir Bely <ubely@ilbers.de>
To: isar-users@googlegroups.com
Subject: [PATCH 2/2] doc: Add section about ccache usage
Date: Mon, 13 Sep 2021 17:10:09 +0200	[thread overview]
Message-ID: <20210913151009.28655-3-ubely@ilbers.de> (raw)
In-Reply-To: <20210913151009.28655-1-ubely@ilbers.de>

Signed-off-by: Uladzimir Bely <ubely@ilbers.de>
---
 doc/user_manual.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/doc/user_manual.md b/doc/user_manual.md
index 1da0e9d..903f9ae 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -18,6 +18,7 @@ Copyright (C) 2016-2019, ilbers GmbH
  - [Add a New Image Type](#add-a-new-image-type)
  - [Add a Custom Application](#add-a-custom-application)
  - [Enabling Cross-compilation](#isar-cross-compilation)
+ - [Using ccache for custom packages](#using-ccache-for-custom-packages)
  - [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)
@@ -896,6 +897,21 @@ package build. To invoke it, just call
 `bitbake mc:${MACHINE}-${DISTRO}:<package_name> -c devshell`.
 
 
+## Using ccache for custom packages
+
+While base system is created from binary debian repositories, some user
+packages are built from sources. It's possible to reduce build time
+for such packages by enabling ccache.
+
+To enable global ccache functionality, `INHERIT += ccache` can be added
+to `local.conf`. If some package requires ccache to be always disabled,
+`CCACHE_DISABLE = '1'` can be used in the recipe.
+
+By default, ccache directory is created inside `TMPDIR`, but it can be
+adjusted by `CCACHE_TOP_DIR` variable in `local.conf`. Ccache directory
+`CCACHE_DIR` default value is `"${CCACHE_TOP_DIR}/${DISTRO}-${MACHINE}"`,
+that means caches for different distros and machines are not overlapped.
+
 ## Create an ISAR SDK root filesystem
 
 ### Motivation
-- 
2.20.1


  parent reply	other threads:[~2021-09-13 15:10 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-13 15:10 [PATCH 0/2] Support for ccache Uladzimir Bely
2021-09-13 15:10 ` [PATCH 1/2] meta: Support for ccache for custom packages in buildchroot Uladzimir Bely
2021-09-13 18:21   ` Jan Kiszka
2021-09-13 15:10 ` Uladzimir Bely [this message]
2021-09-13 18:16   ` [PATCH 2/2] doc: Add section about ccache usage Jan Kiszka
2021-09-16 11:00     ` Baurzhan Ismagulov
2021-09-15 16:43 ` [PATCH 0/2] Support for ccache Henning Schild
2021-09-15 17:39   ` Jan Kiszka

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=20210913151009.28655-3-ubely@ilbers.de \
    --to=ubely@ilbers.de \
    --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