From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id DEC46D29FB1 for ; Wed, 6 Nov 2024 07:31:44 +0000 (UTC) Received: from relay1-d.mail.gandi.net (relay1-d.mail.gandi.net [217.70.183.193]) by mx.groups.io with SMTP id smtpd.web11.40614.1730878294731227131 for ; Tue, 05 Nov 2024 23:31:35 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=F08gnJmX; spf=pass (domain: bootlin.com, ip: 217.70.183.193, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 7FCCD240002; Wed, 6 Nov 2024 07:31:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1730878292; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=X8j5PaG+G79RRU4cRgNHMFNoKZMieVtdtHA6UUlBjn8=; b=F08gnJmXIRoEo6K0xhP4uDZMg4/jMNTzcY0eKigMG4OFQnD7Vj7sx/Qbm5EfbnaXYn6qT1 RoDXaCaB17SOI9GjLAUGUkeBO9HFqr8CsFsLPNaou5nr6Mwja2e6LELZQpx2cD+a0xA3og dRzYVvkAR3vgZu7HtnPlSvRhTxrj1GYGNJ1b2kl8rfDO5s6ZclClLfLVKvrL6yDQJFRjx6 8KsEMIdkY6mFUMODxo8G7+opjrcKKdhuDd0175rxXEpdIq3QbIJZ/PkbS2Z5VoehEfA26N 2v997tqdMO0hGd1pLjUNazG1vhkwnph4linzMQhIVvNFCLpoP12QfaJTCmWP2A== Mime-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=UTF-8 Date: Wed, 06 Nov 2024 08:31:32 +0100 Message-Id: Subject: Re: [docs] [PATCH v3 3/3] dev-manual: add bblock documentation From: "Antonin Godard" To: "Julien Stephan" , X-Mailer: aerc 0.18.2.r87.gd0484b15 References: <20241105-add-bblock-documentation-v3-0-b870ded39a2d@baylibre.com> <20241105-add-bblock-documentation-v3-3-b870ded39a2d@baylibre.com> In-Reply-To: <20241105-add-bblock-documentation-v3-3-b870ded39a2d@baylibre.com> X-GND-Sasl: antonin.godard@bootlin.com List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 06 Nov 2024 07:31:44 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/5684 Hi Julien, Thanks for this v3. Here are my suggestions: On Tue Nov 5, 2024 at 9:17 AM CET, Julien Stephan wrote: > bblock is a helper tool to lock/unlock tasks and recipes to specific > signatures. Add a documentation page for it. > > Signed-off-by: Julien Stephan > --- > documentation/dev-manual/bblock.rst | 129 +++++++++++++++++++++++++++= ++++++ > documentation/dev-manual/index.rst | 1 + > documentation/ref-manual/structure.rst | 8 ++ > documentation/ref-manual/variables.rst | 3 + > 4 files changed, 141 insertions(+) > > diff --git a/documentation/dev-manual/bblock.rst b/documentation/dev-manu= al/bblock.rst > new file mode 100644 > index 0000000000000000000000000000000000000000..cb45abcc6963e0dc2196cc02f= ad72010fbdb8df1 > --- /dev/null > +++ b/documentation/dev-manual/bblock.rst > @@ -0,0 +1,129 @@ > +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK > + > +Locking and Unlocking Recipes Using ``bblock`` > +********************************************** > + > +By design, the OpenEmbedded build system builds everything from scratch > +unless BitBake determines that specific tasks do not require rebuilding. > +At startup, it computes a signature for all tasks, based on the task's i= nput. > +Then, it compares these signatures with the ones from the sstate (if the= y s/the sstate/the sstate cache/ [...] > diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-m= anual/structure.rst > index bbeda78c791d430faa55356a3209f5eeb1402837..339ee2fbd77b1264e62b9b703= 81ff970b816d728 100644 > --- a/documentation/ref-manual/structure.rst > +++ b/documentation/ref-manual/structure.rst > @@ -335,6 +335,14 @@ Once the build process gets the sample file, it uses= ``sed`` to substitute final > version of the ``bblayers.conf.sample`` file in the ``meta-poky/conf/= templates/default`` > directory. > =20 > +.. _structure-build-conf-bblock.conf: > + > +``build/conf/bblock.conf`` > +-------------------------- > + > +This configuration file is generated by :doc:`bblock ` and > +contains the signatures locked by ``bblock``. > + Thank you for adding this. Could you mention that this file does not exist = by default? This is so that users reading this page don't wonder why it doesn'= t exist on their setup. > .. _structure-build-downloads: > =20 > ``build/downloads/`` > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-m= anual/variables.rst > index b24286813eafaa562f4ebd070190f1e97e0cf23c..3d2d3f95695c98e583377ef53= 92fdfe7fa0ab28e 100644 > --- a/documentation/ref-manual/variables.rst > +++ b/documentation/ref-manual/variables.rst > @@ -7901,6 +7901,9 @@ system and gives an overview of their function and = contents. > Then you can look at files in ``build/stamps//bc`` and search= for the > file: ``.do_compile.sigdata.09772aa4532512baf96d433484f27234d4b= 7c11dd9cda0d6f56fa1b7ce6f25f0``. > =20 > + Alternatively, you can also use :doc:`bblock ` = to > + generate this line for you. > + Good idea adding this here! > :term:`SIGGEN_LOCKEDSIGS_TASKSIG_CHECK` > Specifies the debug level of task signature check. 3 levels are sup= ported: > =20 Cheers, Antonin --=20 Antonin Godard, Bootlin Embedded Linux and Kernel engineering https://bootlin.com