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 4/4] doc: Add buildstats section in user manual
Date: Mon, 13 Sep 2021 17:03:55 +0200	[thread overview]
Message-ID: <20210913150355.9973-5-ubely@ilbers.de> (raw)
In-Reply-To: <20210913150355.9973-1-ubely@ilbers.de>

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

diff --git a/doc/user_manual.md b/doc/user_manual.md
index 1da0e9d..94c65ae 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -17,6 +17,7 @@ Copyright (C) 2016-2019, ilbers GmbH
  - [Add a New Image](#add-a-new-image)
  - [Add a New Image Type](#add-a-new-image-type)
  - [Add a Custom Application](#add-a-custom-application)
+ - [Build statistics collection](#build-statistics-collection)
  - [Enabling Cross-compilation](#isar-cross-compilation)
  - [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)
@@ -842,6 +843,24 @@ Such single debs can be included if need be. You just need to write a recipe
 that just fetches those debs to its `WORKDIR` and deploys them. They can then
 be installed via `IMAGE_INSTALL`. Have a look at `prebuilt-deb`.
 
+---
+
+## Build statistics collection
+
+While isar is building the system, build statistics is collected in `tmp/buildstats/<timestamp>` directory. This functionality is implemented in `buildstats` class, that is enabled by setting `USER_CLASSES ?= "buildstats"` in `local.conf`.
+
+The collected statistics can be represented visually by using `pybootchartgui.py` script (borrowed from OpenEmbedded):
+```
+../scripts/pybootchartgui/pybootchartgui.py tmp/buildstats/20210911054429/ -f pdf -o ~/buildstats.pdf
+```
+
+NOTE: `python3-cairo` package is required for `pybootchartgui.py` to work:
+```
+sudo apt-get install python3-cairo
+```
+
+---
+
 ## Isar Cross-compilation
 
 ### Motivation
-- 
2.20.1


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

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-13 15:03 [PATCH 0/4] Use buildstats from OE to generate build charts Uladzimir Bely
2021-09-13 15:03 ` [PATCH 1/4] buildstats: Borrow buildstats and pybootchartgui from OE Uladzimir Bely
2021-09-13 15:03 ` [PATCH 2/4] buildstats: Fix bbclass to work with ISAR Uladzimir Bely
2021-09-13 15:03 ` [PATCH 3/4] buildstats: Manage buildstats via USER_CLASSES variable Uladzimir Bely
2021-09-13 15:03 ` Uladzimir Bely [this message]
2021-09-13 18:23 ` [PATCH 0/4] Use buildstats from OE to generate build charts Jan Kiszka
2021-09-14  7:18   ` Uladzimir Bely
2021-09-14 11:23     ` 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=20210913150355.9973-5-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