From patchwork Mon Mar 18 15:02:09 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Kanavin X-Patchwork-Id: 41172 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 83290C54E5D for ; Mon, 18 Mar 2024 15:02:25 +0000 (UTC) Received: from mail-ed1-f44.google.com (mail-ed1-f44.google.com [209.85.208.44]) by mx.groups.io with SMTP id smtpd.web11.46835.1710774136274875608 for ; Mon, 18 Mar 2024 08:02:16 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20230601 header.b=TwfZ+1qb; spf=pass (domain: gmail.com, ip: 209.85.208.44, mailfrom: alex.kanavin@gmail.com) Received: by mail-ed1-f44.google.com with SMTP id 4fb4d7f45d1cf-568aa3096e9so5308809a12.0 for ; Mon, 18 Mar 2024 08:02:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1710774134; x=1711378934; darn=lists.yoctoproject.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=1yqsSaV4giw36xVx8dxhuSNPdyZIEEEJcpLD29R2LpM=; b=TwfZ+1qbgRoQRv+LdwGnkrB7n7d7EJRLBkrTTBQ++/HrOhFJudOThP6Z90eJxp5Qa5 RvxJWwSaCV0lRG1rZ41GFEBD15gwueXUEihZEowjMFcn83Mzw6Fg78YVSD0pzcu8ZaxC mbwMiE4piRrPu2xcceRXcCMWzjhTjEhXfhpCLg9fiT0NO5nRhYz5WP/ihqpJO/HbUwq7 Q8FEjOz4FA2KyiIiRz3Vk4HwHtsC9RlXctzHcg2yXaiRyy2Sylg1oMjMs1EFr0nCWZNx f6wRVCHoSr9wp38tK4hj5VqZxFjuarOtouLt1claDg8lh99tcpupthLxghToIOxEbVnr CzVw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1710774134; x=1711378934; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=1yqsSaV4giw36xVx8dxhuSNPdyZIEEEJcpLD29R2LpM=; b=LQdx0pCkW19s/fFYrwI+pYkhnePOAfCVDCPHk7DqFxff/DMiAUyXtys8vRnWM+zq3B pWKw7iCoYjz5HWyUTCsOZrNqRSUQc4P2hTjo+1qf6GfwXbk6/czSFHWzZqyi1xNPCwta eKcH2eObNU9n5MUS22fv1FHp0AVkwE831kwn3PBpnO873gSVMVXefXg5Px8+tLjGHvvP U9cT9onY4th8tY2FaUe2c0ezvSBiiTSIXofSNbGm6LHSOVeVbXqKr/1zRhC7/0IvsGUb 1yBuBXTrJ2896wxSUOVvCUtvvOgKRpBggrGpP0rETaQfwpMW7mmhbeeNMi/rukpAbGRs PhcA== X-Gm-Message-State: AOJu0Yw99VXWEqCywehkK6Pg5pY8ADoKuHZlpU+woS+Hp5ag58kssuLu x8nFxh2AyrxHkFcx/JkUrDrljgchDZxSfHAXpO6G8i0jIe/o6Yu133bQgp4M X-Google-Smtp-Source: AGHT+IFZuryNUJodBk2gIcUH4T0fzomphPk0OT3tJLRettjUGqxOGXB2Woi1bWGYbSW6s7c5mnwZWw== X-Received: by 2002:a17:907:7283:b0:a46:b43e:fa3c with SMTP id dt3-20020a170907728300b00a46b43efa3cmr4245943ejc.15.1710774134239; Mon, 18 Mar 2024 08:02:14 -0700 (PDT) Received: from Zen2.lab.linutronix.de. (drugstore.linutronix.de. [80.153.143.164]) by smtp.gmail.com with ESMTPSA id be7-20020a1709070a4700b00a46a9c38b16sm2635356ejc.138.2024.03.18.08.02.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 18 Mar 2024 08:02:13 -0700 (PDT) From: Alexander Kanavin X-Google-Original-From: Alexander Kanavin To: docs@lists.yoctoproject.org Cc: Alexander Kanavin Subject: [PATCH 1/3] dev-manual: improve descriptions of 'bitbake -S printdiff' Date: Mon, 18 Mar 2024 16:02:09 +0100 Message-Id: <20240318150211.1192651-1-alex@linutronix.de> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 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 ; Mon, 18 Mar 2024 15:02:25 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4986 Try to particularly emphasize that it can be used to find out why something rebuilds when it shouldn't. Signed-off-by: Alexander Kanavin --- documentation/dev-manual/building.rst | 7 +++---- documentation/dev-manual/debugging.rst | 13 ++++++++++--- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst index 7fcac33b754..e0d0aae85d0 100644 --- a/documentation/dev-manual/building.rst +++ b/documentation/dev-manual/building.rst @@ -775,10 +775,9 @@ your tunings to best consider build times and package feed maintenance. in the script for information on how to use the tool. - *BitBake's "-S printdiff" Option:* Using this option causes - BitBake to try to establish the closest signature match it can - (e.g. in the shared state cache) and then run ``bitbake-diffsigs`` - over the matches to determine the stamps and delta where these two - stamp trees diverge. + BitBake to try to establish the most recent signature match it can + (e.g. in the shared state cache) and then compare matched signatures + to determine the stamps and delta where these two stamp trees diverge. Building Software from an External Source ========================================= diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst index ce29815e9f5..9f87f48cec8 100644 --- a/documentation/dev-manual/debugging.rst +++ b/documentation/dev-manual/debugging.rst @@ -339,7 +339,10 @@ BitBake has determined by doing the following: :term:`BB_BASEHASH_IGNORE_VARS` information. -There is also a ``bitbake-diffsigs`` command for comparing two +Debugging signature construction and unexpected task executions +=============================================================== + +There is a ``bitbake-diffsigs`` command for comparing two ``siginfo`` or ``sigdata`` files. This command can be helpful when trying to figure out what changed between two versions of a task. If you call ``bitbake-diffsigs`` with just one file, the command behaves like @@ -356,8 +359,12 @@ BitBake command-line options:: .. note:: Two common values for `SIGNATURE_HANDLER` are "none" and "printdiff", which - dump only the signature or compare the dumped signature with the cached one, - respectively. + dump only the signature or compare the dumped signature with the most recent one, + respectively. "printdiff" will try to establish the most recent + signature match it can (e.g. in the sstate cache) and then + compare the matched signatures to determine the stamps and delta + where these two stamp trees diverge. This can be used to determine why + tasks need to be re-run in situations where that is not expected. Using BitBake with either of these options causes BitBake to dump out ``sigdata`` files in the ``stamps`` directory for every task it would From patchwork Mon Mar 18 15:02:10 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Kanavin X-Patchwork-Id: 41173 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 938B3C54E6A for ; Mon, 18 Mar 2024 15:02:25 +0000 (UTC) Received: from mail-ej1-f42.google.com (mail-ej1-f42.google.com [209.85.218.42]) by mx.groups.io with SMTP id smtpd.web10.46968.1710774136545437998 for ; Mon, 18 Mar 2024 08:02:16 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20230601 header.b=XXpjhsCt; spf=pass (domain: gmail.com, ip: 209.85.218.42, mailfrom: alex.kanavin@gmail.com) Received: by mail-ej1-f42.google.com with SMTP id a640c23a62f3a-a466f796fc1so569751166b.3 for ; Mon, 18 Mar 2024 08:02:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1710774135; x=1711378935; darn=lists.yoctoproject.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=eTpIZyRcBtAZeWSTWXzb1M8t+RwXfZkYYtxyTt0eHEk=; b=XXpjhsCtIujuWf9XN9ZmH2KJCN4/jTKOpCoC51iETX9rLLiQEpdruu8x+QoUIsb/Y6 la1gS0ZYmY3UQlu5W2eW1V9dzwwCCYB3AyxZ4MkkcCM0O2gP5V+Nl2FWE6hRitSlchYR dav4Oh6kf9ZJYGLlm2ypyyyvwbgM9hiw/uOqO8oNxr9bDTVRkNignClOOIL91oOQoI+x JoppHaK0pN/aN9auxL1HavVGR2lS2LJbVS26sg3w8HGNnDKWh5MWFIT5EulxTXhVztI6 GX+EJ1Svz2sbXGq7Co3NFPTBrPvncfQN35Vvrwo5GU0qiTlGVj4jxLAZwjRXSPWUWGo+ HeTQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1710774135; x=1711378935; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=eTpIZyRcBtAZeWSTWXzb1M8t+RwXfZkYYtxyTt0eHEk=; b=Y/gAcWyWUMTBT2Fs0RcMf1yxvyxxfvHoW+V0qmY/CYXeivaHbqMNCX85//Z8CR5sNt KjZg8yNobXYpJtPKyI6W9QiMdq8N2H0pmp9erV0Zxpl77kJDJbAFVBF9JoKpa26+qIlH 5Ul5oGZWEuBPdrt2oRpTacU+H6uCplKnZgPJfUY7v3KKiJPiu96ZTIVFtnB+UhECFSmq sjzlaDwFGcIxD84fT4ZW1QiJfHiBjAE9m6kpdXZi7GyRtsyYXviiIwRK0S2MXoWZjCkE IgPhL5zCmHY0krYhnSG9xBpQLkJR1bq9F2g9HJkcKZ4altEJ4FUhJyzivkEHrrc+04UT AzBA== X-Gm-Message-State: AOJu0YwMvdApXKACek8YgvAZMiUn9BQcEvXpCzGgqmbRMrsbxGQkvIt8 984JxZEo4BS4LelLsE458UOUX8+XWTrx1YpGnQVSF5X11oGd3aUePEmS+Kg5 X-Google-Smtp-Source: AGHT+IFy1rRpXAYCLi+YFHtMvbMfSojmKqh2koLtsNfh5iVT4NO+avAwxlHZHNdG7qWKQWKeZbi1nA== X-Received: by 2002:a17:906:a415:b0:a46:1f6d:3047 with SMTP id l21-20020a170906a41500b00a461f6d3047mr8060691ejz.4.1710774134747; Mon, 18 Mar 2024 08:02:14 -0700 (PDT) Received: from Zen2.lab.linutronix.de. (drugstore.linutronix.de. [80.153.143.164]) by smtp.gmail.com with ESMTPSA id be7-20020a1709070a4700b00a46a9c38b16sm2635356ejc.138.2024.03.18.08.02.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 18 Mar 2024 08:02:14 -0700 (PDT) From: Alexander Kanavin X-Google-Original-From: Alexander Kanavin To: docs@lists.yoctoproject.org Cc: Alexander Kanavin Subject: [PATCH 2/3] sdk-manual: correctly describe separate build-sysroots tasks in direct sdk workflows Date: Mon, 18 Mar 2024 16:02:10 +0100 Message-Id: <20240318150211.1192651-2-alex@linutronix.de> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240318150211.1192651-1-alex@linutronix.de> References: <20240318150211.1192651-1-alex@linutronix.de> MIME-Version: 1.0 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 ; Mon, 18 Mar 2024 15:02:25 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4987 They were separated in https://git.yoctoproject.org/poky/commit/?id=63e53fb8b60d38315015844bd3357fa1649cd639 Signed-off-by: Alexander Kanavin Reviewed-by: Michael Opdenacker --- documentation/sdk-manual/extensible.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst index 05dd527469e..3f6a754d881 100644 --- a/documentation/sdk-manual/extensible.rst +++ b/documentation/sdk-manual/extensible.rst @@ -76,7 +76,7 @@ Setting up the Extensible SDK environment directly in a Yocto build $ bitbake meta-ide-support $ bitbake -c populate_sysroot gtk+3 # or any other target or native item that the application developer would need - $ bitbake build-sysroots + $ bitbake build-sysroots -c build_native_sysroot && bitbake build-sysroots -c build_target_sysroot Setting up the Extensible SDK from a standalone installer --------------------------------------------------------- @@ -1507,8 +1507,12 @@ In this scenario, the Yocto build tooling, e.g. ``bitbake`` is directly accessible to build additional items, and it can simply be executed directly:: + $ bitbake curl-native + # Add newly built native items to native sysroot + $ bitbake build-sysroots -c build_native_sysroot $ bitbake mesa - $ bitbake build-sysroots + # Add newly built target items to target sysroot + $ bitbake build-sysroots -c build_target_sysroot When using a standalone installer for the Extensible SDK -------------------------------------------------------- From patchwork Mon Mar 18 15:02:11 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Kanavin X-Patchwork-Id: 41171 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 91D2FC54E58 for ; Mon, 18 Mar 2024 15:02:25 +0000 (UTC) Received: from mail-lf1-f54.google.com (mail-lf1-f54.google.com [209.85.167.54]) by mx.groups.io with SMTP id smtpd.web11.46836.1710774137427705746 for ; Mon, 18 Mar 2024 08:02:17 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20230601 header.b=VhyfK8Xz; spf=pass (domain: gmail.com, ip: 209.85.167.54, mailfrom: alex.kanavin@gmail.com) Received: by mail-lf1-f54.google.com with SMTP id 2adb3069b0e04-513dc9d6938so3418995e87.2 for ; Mon, 18 Mar 2024 08:02:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1710774135; x=1711378935; darn=lists.yoctoproject.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=oLOe/K7nF8umlGoLT2N9MjdWOAbL/4g+FBrKPN0vgjo=; b=VhyfK8XzQl6YW5Dprc9lVO/9xXHlkE4OmDPK6m0iIL4B8HhbKXYCAP/uzxS+HgSf0A ByRERi1QjLsNgLqBvIAivkSXQVkPry0rDfD0u3c001ZH09UX32wSxX498oN+SesZNhma 5FBIcvQ3c6bdjKHNKn5kXrPfikLO+H2w3UYQT6xliGMP4Ny0OKq3wl045hzr620FkG8H EfdYZVWEBgLcHUGFtgVOlJIr9SJaAtlb9wb5XC6Mf+leXtTk6jI70xqOXa8DZOg58ENE ecF5sym7+udLK9mr6qqX8fJAxaNpNe1TDAhOjXTawcloOBnxC6oelJJgdbr3Zt90XwZk Aotg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1710774135; x=1711378935; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=oLOe/K7nF8umlGoLT2N9MjdWOAbL/4g+FBrKPN0vgjo=; b=ufV2l/oPb1pbek+1UIZKUjnwi/rW47fDWXAWetT5eqmCwVcPYwAAcgYkQrjiMEs11a zR5VeuEnu9xx6zkpVQ70XbTtDDsrH8wF7uVQuaOzW2IjIPCHoKWpgzCKNAJ2P/hfFYzH UsgAln1IbihG1Kzkf6yjr1UrHv5JBmcroVdH694iFFe7ffYVC9S7u5KjOaRxrd7275zW KXZ8k2PvZ1zv9YShcnuzXX4ivePn4VK0jePaFgczWURhZitBnxUn/nUbXyg4Yejd1iLD xsYiq2v23gJL557Lz4V/Z9XfYH+9EIzITGWfxlSPpWRl1sjDakciDlQlSzzvLxn0r0oz DDSw== X-Gm-Message-State: AOJu0YwIyVgkd7wIpHfpgfdTSJvj98BOVGx9lghClVThNw4x1EWWvCut juwOhzPzwfUFDH6y8tKhgNOkYH+81OpApjarGSz36q9zr2pXRF84AdJKoeu0 X-Google-Smtp-Source: AGHT+IEE9OsBwewcShx4VxJyAORUGL+CVYp1pSFLBX491sHqqPsUEkIQ5mfce2qRdvVisfABfy43wQ== X-Received: by 2002:ac2:4a76:0:b0:513:5978:6919 with SMTP id q22-20020ac24a76000000b0051359786919mr7628253lfp.68.1710774135430; Mon, 18 Mar 2024 08:02:15 -0700 (PDT) Received: from Zen2.lab.linutronix.de. (drugstore.linutronix.de. [80.153.143.164]) by smtp.gmail.com with ESMTPSA id be7-20020a1709070a4700b00a46a9c38b16sm2635356ejc.138.2024.03.18.08.02.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 18 Mar 2024 08:02:15 -0700 (PDT) From: Alexander Kanavin X-Google-Original-From: Alexander Kanavin To: docs@lists.yoctoproject.org Cc: Alexander Kanavin Subject: [PATCH 3/3] dev/ref-manual: document conf-summary.txt together with conf-notes.txt Date: Mon, 18 Mar 2024 16:02:11 +0100 Message-Id: <20240318150211.1192651-3-alex@linutronix.de> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240318150211.1192651-1-alex@linutronix.de> References: <20240318150211.1192651-1-alex@linutronix.de> MIME-Version: 1.0 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 ; Mon, 18 Mar 2024 15:02:25 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4988 Signed-off-by: Alexander Kanavin Reviewed-by: Michael Opdenacker --- .../dev-manual/custom-template-configuration-directory.rst | 6 +++--- documentation/ref-manual/structure.rst | 7 ++++--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/documentation/dev-manual/custom-template-configuration-directory.rst b/documentation/dev-manual/custom-template-configuration-directory.rst index 9bffef35b46..06fcada822d 100644 --- a/documentation/dev-manual/custom-template-configuration-directory.rst +++ b/documentation/dev-manual/custom-template-configuration-directory.rst @@ -42,11 +42,11 @@ would be:: TEMPLATECONF=${TEMPLATECONF:-meta-poky/conf/templates/default} If you look at a configuration template directory, you will -see the ``bblayers.conf.sample``, ``local.conf.sample``, and +see the ``bblayers.conf.sample``, ``local.conf.sample``, ``conf-summary.txt`` and ``conf-notes.txt`` files. The build system uses these files to form the respective ``bblayers.conf`` file, ``local.conf`` file, and show -users a note about the build they're setting up +users usage information about the build they're setting up when running the ``oe-init-build-env`` setup script. These can be edited further if needed to improve or change the build configurations -available to the users. +available to the users, and provide useful summaries and detailed usage notes. diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index acadd5efa3c..9f26319c327 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst @@ -172,10 +172,11 @@ targets to build. Here is an example:: You can also run generated QEMU images with a command like 'runqemu qemux86-64' The default output of the ``oe-init-build-env`` script is from the -``conf-notes.txt`` file, which is found in the ``meta-poky`` directory +``conf-summary.txt`` and ``conf-notes.txt`` files, which are found in the ``meta-poky`` directory within the :term:`Source Directory`. If you design a -custom distribution, you can include your own version of this -configuration file to mention the targets defined by your distribution. +custom distribution, you can include your own versions of these +configuration files where you can provide a brief summary and detailed useage +notes, such as a list of the targets defined by your distribution. See the ":ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory`" section in the Yocto Project Development Tasks Manual for more