From patchwork Tue Jul 29 11:30:02 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 67640 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 77239C87FD2 for ; Tue, 29 Jul 2025 11:30:11 +0000 (UTC) Received: from relay2-d.mail.gandi.net (relay2-d.mail.gandi.net [217.70.183.194]) by mx.groups.io with SMTP id smtpd.web10.4702.1753788610702172864 for ; Tue, 29 Jul 2025 04:30:11 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=Zm5b42ss; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 05A9F43881; Tue, 29 Jul 2025 11:30:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1753788609; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=dzE5Tb5+n3dPvU+pCvJG44TnQn+ZMMS0n9Ul8HHn9UY=; b=Zm5b42ssNnoROKs3jN8MW7HschfYulX+7k78XqUxCmxmlE54OqYEOqbMZP1lE5Rf/gCINr nZzKf5vxS+XOv9FU3S3qpRpxY15RqpYfDLGFCdS+Ap+6Ku9wXMwHLxyVzo23V/sYMmMjpo Ij9bW4CTG59LZUndJWeVASOrsqXCs+ZL5NAhvvVSkZlv0m50ns5xpXuvoMntuJ9Ri8UXzr cQF+M7+emUyIBomawjiwBQAIM4JT/gn0gSYKWEszI6AO48aMfrC/66fnOhRHX4NAwXLgjB RLA51MAaVXMuBU/+m1e50woomLzma7SzljiW5/d3Usr6UC07CxwCuTxbUV95lg== From: Antonin Godard Date: Tue, 29 Jul 2025 13:30:02 +0200 Subject: [PATCH 1/5] Add a script to validate documentation glossaries MIME-Version: 1.0 Message-Id: <20250729-variables-checks-v1-1-5ad6ca9b9386@bootlin.com> References: <20250729-variables-checks-v1-0-5ad6ca9b9386@bootlin.com> In-Reply-To: <20250729-variables-checks-v1-0-5ad6ca9b9386@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=4970; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=9Mmxe4nPtaFomWEcDbrRD7akpGTYtqsOhyymlEqcIMQ=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBoiLC/AYSct8Y2kAx541RFPgJhFPXyaMaWUvTi/ rQ/uOc4LyqJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaIiwvwAKCRDRgEFAKaOo NtbFEACPRCRmWObTmn4Gx44W7NOd6qcblHQvD3Yi897PzlydlzPVsgHAygen055+vIJr295W6ub n+NZuLdCigQLhBnimI+YeXu5NUUrMmWO8PnzwiJvss8CPg07A9iMOtGjzLEc2DohoFDAHl1+/iL fwnaA6VHtXSZI6tKBpruzP8z0ufq4TajLmenyEzqr4vZsPVrbtrhZ2/8CrADCnX+LQYWPIGf5JI BsNlVdA/GVrsHakhxyk/0U2RXO8VwQ3gppAXCHGCqUV1j/NPJ4cCGxe3d6dKUe/ny4RT4StVg4k yajnEMP9JpvqDT6dGdXju755PcWiB7ee0AuCZbe71cUL/HppbhmnqzrnRTH38nKeu66XezPwJBt aWofN8K6/9oSbr6Gx9bOhtWe6cHXZBF0MX2csFLEmpGrDGmyN2RSYcjR8zKdUseCi/jfUx6ESXO OAgt5IltPLuQ7B+44Ns8oa9Ty4u44IzoPdiE82AjQowEZ//vBAQ+d13Z8DHj4pqcSdvQjpwjPcb BsgGXt2C9bdYxGzMThphrZO58qK01XJAgAGGMjEh0e5wqxcURdW683nljg/o/jCh4lCJ7xEKNay UrzTYi9KSfyJDBZTJDEQLy9zoAi1p/t3H5DcxjDa7bHHOPxErQNedeQkhPaRlwaO+bEuKws+86N yMiBvzIEpBxNPMw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeeffedrtdefgdelgeelfecutefuodetggdotefrodftvfcurfhrohhfihhlvgemucfitefpfffkpdcuggftfghnshhusghstghrihgsvgenuceurghilhhouhhtmecufedtudenucesvcftvggtihhpihgvnhhtshculddquddttddmnecujfgurhephfffufggtgfgkfhfjgfvvefosehtjeertdertdejnecuhfhrohhmpeetnhhtohhnihhnucfiohgurghrugcuoegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomheqnecuggftrfgrthhtvghrnhepheeigeeuhfefgeehfffgueeiteehieelfeehjeektefgkeeuheeuleduvdelgffhnecukfhppedvrgdtudemtggsudegmeehheeimeejrgdttdemfegtkedumegvsggrjeemudgskegsmegrhegtleenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepihhnvghtpedvrgdtudemtggsudegmeehheeimeejrgdttdemfegtkedumegvsggrjeemudgskegsmegrhegtledphhgvlhhopegluddvjedrtddruddrudgnpdhmrghilhhfrhhomheprghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmpdhnsggprhgtphhtthhopeefpdhrtghpthhtohepthhhohhmrghsrdhpvghtrgiiiihonhhisegsohhothhlihhnrdgtohhmpdhrtghpthhtohepughotghssehlihhsthhsrdihohgtthhophhrohhjvggtthdrohhrghdprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoo hhtlhhinhdrtghomh 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 ; Tue, 29 Jul 2025 11:30:11 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/7414 Instead of tracking the glossary manually, add a small script that checks if it is properly sorted. Add two comments between the start and end of the glossary for the script to know where it's located. The script also checks if the variables are properly sorted. It uses difflib and returns the diff if there's a difference between the unsorted and sorted list. Messages beginning with "WARNING:" are reported by the Autobuilder, which is the reason for this format. Signed-off-by: Antonin Godard --- documentation/ref-manual/variables.rst | 6 +++ documentation/tools/check-glossaries | 90 ++++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index e4d5a9c97..6c2344950 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -7,6 +7,9 @@ Variables Glossary This chapter lists common variables used in the OpenEmbedded build system and gives an overview of their function and contents. +.. + check_glossary_begin + :term:`A ` :term:`B` :term:`C ` :term:`D` :term:`E ` :term:`F ` :term:`G ` :term:`H ` :term:`I ` @@ -16,6 +19,9 @@ system and gives an overview of their function and contents. :term:`U ` :term:`V ` :term:`W ` :term:`X ` :term:`Z ` +.. + check_glossary_end + .. glossary:: :sorted: diff --git a/documentation/tools/check-glossaries b/documentation/tools/check-glossaries new file mode 100755 index 000000000..b5dfe834e --- /dev/null +++ b/documentation/tools/check-glossaries @@ -0,0 +1,90 @@ +#!/usr/bin/env python3 + +import argparse +import difflib +import os +import re + +from pathlib import Path + + +def parse_arguments() -> argparse.Namespace: + parser = argparse.ArgumentParser(description="Print supported distributions") + + parser.add_argument("-d", "--docs-dir", + type=Path, + default=Path(os.path.dirname(os.path.realpath(__file__))) / "documentation", + help="Path to documentation/ directory in yocto-docs") + + return parser.parse_args() + + +glossaries = ( + 'ref-manual/variables.rst', + 'ref-manual/terms.rst', +) + + +def main(): + + args = parse_arguments() + in_glossary = False + # Pattern to match: + # :term:`A ` :term:`B` :term:`C ` + glossary_re = re.compile(r":term:`(?P[A-Z]{1})( <(?P[A-Z_]+)>)?`") + entry_re = re.compile(r"^ :term:`(?P.+)`\s*$") + + for rst in glossaries: + + glossary = {} + rst_path = Path(args.docs_dir) / rst + + with open(rst_path, "r") as f: + for line in f.readlines(): + if "check_glossary_begin" in line: + in_glossary = True + continue + if in_glossary: + for m in re.finditer(glossary_re, line.strip()): + letter = m.group("letter") + varname = m.group("varname") + if varname is None: + varname = letter + glossary[letter] = varname + if "check_glossary_end" in line: + in_glossary = False + break + + entries = [] + + with open(rst_path, "r") as f: + for line in f.readlines(): + m = re.match(entry_re, line) + if m: + entries.append(m.group("entry")) + + # We lower here because underscore (_) come before lowercase letters + # (the natural way) but after uppercase letters (which is not natural) + sorted_entries = sorted(entries, key=lambda t: t.lower()) + diffs = list(difflib.unified_diff(entries, + sorted_entries, + fromfile="original_list", + tofile="sorted_list")) + + if diffs: + print(f"WARNING: {rst}: entries are not properly sorted:") + print('\n'.join(diffs)) + + for letter in glossary: + try: + index = entries.index(glossary[letter]) + except ValueError: + print(f"WARNING: {rst}: variable " + f"{glossary[letter]} in glossary does not exist") + if index > 0 and entries[index - 1].startswith(letter[0]): + print(f"WARNING: {rst}: The variable {glossary[letter]} shouldn't be in " + "the glossary.") + + +if __name__ == "__main__": + main() From patchwork Tue Jul 29 11:30:03 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 67638 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 63750C87FCA for ; Tue, 29 Jul 2025 11:30:11 +0000 (UTC) Received: from relay2-d.mail.gandi.net (relay2-d.mail.gandi.net [217.70.183.194]) by mx.groups.io with SMTP id smtpd.web11.4865.1753788610655134112 for ; Tue, 29 Jul 2025 04:30:11 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=cRV+3dNA; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 3932D43866; Tue, 29 Jul 2025 11:30:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1753788609; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Eu0JNHpF+tHZcl9omFEOML0PKf3zBmwlsEVtkDiQvD0=; b=cRV+3dNAiPGMdtP6hG2FPtUsi3IKsbRjiQup9t8Ch1u8EFwBWE0SkO5c3T6OrFIqz/02i1 HB8fivgytaeLS0elW7w5TxiLplul+VhA6dmckipu9WalhjX9UkDumvvo0Hauj/n8toeB44 /m3mhG7yF0gVpx9gi0Ua8RCZH/OmD/af7pVr67jyIT/wzvTHfrskfJX5CIz3vds/LldU2i 71pPyf5HFlya6mxz3E9B13yO/tNYLbR8HuKTeVliECswACxgRABe7I+glbemiVLBHJ2Zf7 EqZOE2+BukhMbD4eZ76Kr0Wa6HKs7A+J3fgNAkl0bWNKZzR8ur+0ewdyOuiP0Q== From: Antonin Godard Date: Tue, 29 Jul 2025 13:30:03 +0200 Subject: [PATCH 2/5] Makefile: add a checks rule MIME-Version: 1.0 Message-Id: <20250729-variables-checks-v1-2-5ad6ca9b9386@bootlin.com> References: <20250729-variables-checks-v1-0-5ad6ca9b9386@bootlin.com> In-Reply-To: <20250729-variables-checks-v1-0-5ad6ca9b9386@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=1304; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=8u88q/FAMwDqljPT3zgg7i/JiJy0JHDYV0qD3M3RYAE=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBoiLC/wI+3FN1VAlLhx5aRtLHwqli5wReNNCB85 Lmc6eYQsmyJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaIiwvwAKCRDRgEFAKaOo NuFvEACeAOXiNqYaFoCo4fZ7SNDNFGg9rVYJNrk37Olq5RNHTAFKWeyUZ617v41/7lzoicp6mBB 2Cp9012abj2WUdr4JSUNPEhvTG7rjFSmBtc2IDjmlSIP5YLnEU98LvU5y6hthI3h8psFDC+SUua 0xhEoG2Cl+NTGjMWqAZoLyNG3wXqQuL1hu3s15RWiwLfJqgPNl8BzgZuAhvGK85aRKJBB1SNouK URPzx1r29BVyE/+wc8dKb7L7oHLWqikkthPpXSYo/VbkyBdv/AWwku2cHHHosRinxZh+jxjfsyT EW8xQcRkudb3M5QkTRSsLbajHCHVye553rgNcGF9yhzy3whY5xalQP9AV1NLn8xxY86/W9mRqv2 U+1q8gkjX3rRA+D3Dl7XtBxCTlz+Vps2oYkpb4PYyFBJFaDQj1TyRO+c01nqTVpEGJ4gk/f2sP4 7eTU7bS0969dlDCgEe2+H7iuwujux/gTIGDxg0CpBzu7OsjZQyL9zevTzCuEZIygim68Cy0xKyw 0UwtCBLcusoLJ9mrcEBenYo5PnZZB6n0USRyWfecquDiHg/klBj2Xb3tsXxocdUyk2MWrAQpP0N aWWK37iXP+THLFbKDggqGTLG7htXiRghJ0mJRvqAL21+UhXSNxbUSzBSyhp4tVd/swi0fZaaWud 8eyvQxiLz2L0wzg== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeeffedrtdefgdelgeelfecutefuodetggdotefrodftvfcurfhrohhfihhlvgemucfitefpfffkpdcuggftfghnshhusghstghrihgsvgenuceurghilhhouhhtmecufedtudenucesvcftvggtihhpihgvnhhtshculddquddttddmnecujfgurhephfffufggtgfgkfhfjgfvvefosehtjeertdertdejnecuhfhrohhmpeetnhhtohhnihhnucfiohgurghrugcuoegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomheqnecuggftrfgrthhtvghrnhepheeigeeuhfefgeehfffgueeiteehieelfeehjeektefgkeeuheeuleduvdelgffhnecukfhppedvrgdtudemtggsudegmeehheeimeejrgdttdemfegtkedumegvsggrjeemudgskegsmegrhegtleenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepihhnvghtpedvrgdtudemtggsudegmeehheeimeejrgdttdemfegtkedumegvsggrjeemudgskegsmegrhegtledphhgvlhhopegluddvjedrtddruddrudgnpdhmrghilhhfrhhomheprghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmpdhnsggprhgtphhtthhopeefpdhrtghpthhtohepthhhohhmrghsrdhpvghtrgiiiihonhhisegsohhothhlihhnrdgtohhmpdhrtghpthhtohepughotghssehlihhsthhsrdihohgtthhophhrohhjvggtthdrohhrghdprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoo hhtlhhinhdrtghomh 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 ; Tue, 29 Jul 2025 11:30:11 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/7413 The checks rule can be run to perform some checks on the docs. For now it only includes running the check-glossaries script. This rule should only run basic checks or should not prevent the user from building the docs in case of failure. This rule can be used in the future to run additional checks on the documentation. Signed-off-by: Antonin Godard --- documentation/Makefile | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/documentation/Makefile b/documentation/Makefile index 65e29713d..5ba3d42fc 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -52,6 +52,9 @@ PNGs := $(foreach dir, $(IMAGEDIRS), $(patsubst %.svg,%.png,$(wildcard $(SOURCED clean: @rm -rf $(BUILDDIR) $(PNGs) $(PDFs) poky.yaml sphinx-static/switchers.js releases.rst +checks: + $(SOURCEDIR)/tools/check-glossaries --docs-dir $(SOURCEDIR) + stylecheck: vale sync vale $(VALEOPTS) $(VALEDOCS) @@ -74,6 +77,6 @@ all: html epub latexpdf # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: +%: checks $(SOURCEDIR)/set_versions.py @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) From patchwork Tue Jul 29 11:30:04 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 67639 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 66A10C87FCC for ; Tue, 29 Jul 2025 11:30:11 +0000 (UTC) Received: from relay2-d.mail.gandi.net (relay2-d.mail.gandi.net [217.70.183.194]) by mx.groups.io with SMTP id smtpd.web11.4866.1753788610821631631 for ; Tue, 29 Jul 2025 04:30:11 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=kXLhXfAw; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 6A92743882; Tue, 29 Jul 2025 11:30:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1753788609; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=IZpn3xnOexifeJLoTGUw4kMbm5Y/AD9QaOC0206LRvQ=; b=kXLhXfAwKld8KpVm4yvs1JiCz1TL/ctXnZvdgcL3VZZT0wkLyzTtVZnKvlKeBMZS6+MN87 cGN52aUjlyY9mb7DILC+ZpFJnE7h0O/3K5avUn7db06ZHLuLoI8pO4HhAHR+obciN7h9Zl 2QOvv7FwDHNNcHX8Am8KnWOqF8ww4ni11DBeR2aDB4BQbP0nKl5l3r0U9aX4pAYzTapkm2 xYHIJm7Urlrm2LGZ0t9zKZCL9avGZU3vM9V0jqYtedCGZNRWGyx88mT9I5k+gYgLsN6/D0 5yp4CwkbsTvXhlUYPc5EK67L284t3yMmaVMJWy2a3A0yZ1g2+NY6Lr1TZv4Jkw== From: Antonin Godard Date: Tue, 29 Jul 2025 13:30:04 +0200 Subject: [PATCH 3/5] ref-manual/variables.rst: fix the glossary MIME-Version: 1.0 Message-Id: <20250729-variables-checks-v1-3-5ad6ca9b9386@bootlin.com> References: <20250729-variables-checks-v1-0-5ad6ca9b9386@bootlin.com> In-Reply-To: <20250729-variables-checks-v1-0-5ad6ca9b9386@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=1405; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=9c1ll1xRom7PfDFD0GRRJF2kiq/a7tn0U6hyez15xdY=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBoiLC/7yGVZN8V7eXf9Ze150taEI2tzey/MXY9k k2o7R5YXxeJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaIiwvwAKCRDRgEFAKaOo NhmYD/4xcvlrKYh78ODLWpq3yupAVV8VkJWmLKhBfXbgRqL5SK73M9/u2deXdRzrQWNU/2JN+pK YB1wJjulgyaBk2e8HXMqPVxjEHVnodLRigVs7ATQP2v5CKckzxZrrIkJcb+h672pptqphy/zSGv JrEKz7C3Z4Kr5MtumXVE5aZU8Nt/wAuebkclOCWskc7QfRb2AXXMDr67I+KFAc+EBh1VT6wr0E0 PB1+LZaY2JxdjzYgprhp7uxmKAoeJ52fbsFA9HHkZP0xOz+ochdND5EYusltIwkAMXR7WLoE1Fu CRiGdExuIFCQC6H4ITcqCtZYe4nahyLyhEHPo7d+Pw/Jd6ngXAEJA8vYw6lbQzaa9L1ZUvvoBxx eyX/uSMCGAWKKg52zs8qBrLTnfIWPEQ73UQOvlm/i/zyEH6kXRlBx/OiokO1wp4aMc9KwyAU4xH 1d2dtKWgRdWOjV6hwVQxEsa90MVac3PPQ6ZUHSAa8t2WuCUP6vw1QI3x0MxFVJOowIDLKVsRe56 fU3fsmZI1yakYssFE2Q/nYjRH1fuP3p0whucO9O8n0Ddg2YMfPHQfmVatIn/uicjVPJpyWDMWHm gCaoLYzWr4S2uTvtvWvhRGekuI9pC8r9EpS5kPqLv/9Hqhbxur6jSONFXi6m0uR3O2pDKer0Wbj TmpoDl2ej9aVxxA== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeeffedrtdefgdelgeelfecutefuodetggdotefrodftvfcurfhrohhfihhlvgemucfitefpfffkpdcuggftfghnshhusghstghrihgsvgenuceurghilhhouhhtmecufedtudenucesvcftvggtihhpihgvnhhtshculddquddttddmnecujfgurhephfffufggtgfgkfhfjgfvvefosehtjeertdertdejnecuhfhrohhmpeetnhhtohhnihhnucfiohgurghrugcuoegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomheqnecuggftrfgrthhtvghrnhepheeigeeuhfefgeehfffgueeiteehieelfeehjeektefgkeeuheeuleduvdelgffhnecukfhppedvrgdtudemtggsudegmeehheeimeejrgdttdemfegtkedumegvsggrjeemudgskegsmegrhegtleenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepihhnvghtpedvrgdtudemtggsudegmeehheeimeejrgdttdemfegtkedumegvsggrjeemudgskegsmegrhegtledphhgvlhhopegluddvjedrtddruddrudgnpdhmrghilhhfrhhomheprghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmpdhnsggprhgtphhtthhopeefpdhrtghpthhtohepthhhohhmrghsrdhpvghtrgiiiihonhhisegsohhothhlihhnrdgtohhmpdhrtghpthhtohepughotghssehlihhsthhsrdihohgtthhophhrohhjvggtthdrohhrghdprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoo hhtlhhinhdrtghomh 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 ; Tue, 29 Jul 2025 11:30:11 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/7416 documentation/scripts/check-glossaries returns: WARNING: ref-manual/variables.rst: The variable EFI_PROVIDER shouldn't be in the glossary. WARNING: ref-manual/variables.rst: The variable ZSTD_THREADS shouldn't be in the glossary. Signed-off-by: Antonin Godard --- documentation/ref-manual/variables.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 6c2344950..15ca6543a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -11,13 +11,13 @@ system and gives an overview of their function and contents. check_glossary_begin :term:`A ` :term:`B` :term:`C ` -:term:`D` :term:`E ` :term:`F ` +:term:`D` :term:`E ` :term:`F ` :term:`G ` :term:`H ` :term:`I ` :term:`K ` :term:`L ` :term:`M ` :term:`N ` :term:`O ` :term:`P` :term:`Q ` :term:`R ` :term:`S` :term:`T` :term:`U ` :term:`V ` -:term:`W ` :term:`X ` :term:`Z ` +:term:`W ` :term:`X ` :term:`Z ` .. check_glossary_end From patchwork Tue Jul 29 11:30:05 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 67642 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 7CA2EC87FCA for ; Tue, 29 Jul 2025 11:30:21 +0000 (UTC) Received: from relay2-d.mail.gandi.net (relay2-d.mail.gandi.net [217.70.183.194]) by mx.groups.io with SMTP id smtpd.web10.4704.1753788611114244241 for ; Tue, 29 Jul 2025 04:30:11 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=WAPS5Nge; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 9AE4943885; Tue, 29 Jul 2025 11:30:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1753788609; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=w61GcJq4n7hVYK8laVyczIkWfKWZ6vuOfryQIJkNFlI=; b=WAPS5NgeTsUbyB1ZgfPIVnukB6MYBKDnI18v55JF7eUTlHVWAYro7smjSXT9BmSTvghGLC iRxnyTUNrkOXK/o38nmXDWh7ElFIq3C4hiAhS4oQwZK4yWCrVzBXJfifPa7qLt56crhJ5r 7jjePyQrQelibRf/kPEEGQpsf0p1/3MvwS6NFAVjx7E1OD0oYyowgs1v6zOG59903peedJ UJ5TpqUjziAkZVeHIaGqEzRflBOil9+XPKHpxOow5c0hI455AD5ap4J8kmIkZnnT6x+txW BP7Ix1RTPbgRNEA0PYBp6R7APH/Tb1YPWfMdyjFhElMHgpWhDmg5LtmmLAA5dg== From: Antonin Godard Date: Tue, 29 Jul 2025 13:30:05 +0200 Subject: [PATCH 4/5] ref-manual/variables.rst: sort variables MIME-Version: 1.0 Message-Id: <20250729-variables-checks-v1-4-5ad6ca9b9386@bootlin.com> References: <20250729-variables-checks-v1-0-5ad6ca9b9386@bootlin.com> In-Reply-To: <20250729-variables-checks-v1-0-5ad6ca9b9386@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=27194; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=u7YrqemYQroD2QwNnpiuPH6SzXDnZLJe3v+GEzzxvmE=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBoiLDAidtGPWIaQUgPnEM6AcfBzlDe21CUEfDf/ A8kZyO3pkaJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaIiwwAAKCRDRgEFAKaOo NtzcEAC54+FnrqK5BoslAI/zZ9tGfYSYQKunxRaw9BNVk6w5UQrH1mHb5QIlwL1e2Iq+NyOueQz tR29rtJ50oiD9L3GAVvfk1K1WgNDihqO92lq9DNP0x/YrD054cvNTTPEfv2kKsRUX9NIn2mr8VE kkhgUODlSjQMY/MqYsgqID6/ClJS8pVdEsx9gUiANg+idoYdMNV5myEaG2esOjhV/GxZdktnwGB hHKkFJnqP7rfVeuOuPv2bOun5+yRAEObWy8gAaLkMSdap7dZKXCsIxYOK1kiVDlzYWGlHghE4wx TQ19PNPIqlxI+1Bo2eBdpRfCsQFzovOXApAH5bhDSwMiD7+OLfztDd13cNcaKnsZipo1Iz7CkQ8 YnUy2nxcIeQtWiBH36J6OS7+r0pyB55M2l7w4aUHvLwfueUlbRJfQ3LKQh5CV70Yi9TY0lqWoip /lV5xm1QjO+vQoxix9Z+S4Dt5VX5HjdP5+YnRTDx77jZv4l9OjrpRwS05Cunvb7FcKtWFAcKRMX AvPN7T9gY2Nz8wtPj4WknGSofWgdyCUr2z/OtimKVys52IGEQWIhCuwxSoE6d1EtkyCxSKnJ/lR u4bvnJmCSyiPzjFDfQjg5dPxxmN7o8MmvtSXA6OA+6RyQnq+Ncy1WQdHrsnrYIK7RCZ9Bo0s40Q kSD/TjR5paKPyHw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -57 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeeffedrtdefgdelgeelfecutefuodetggdotefrodftvfcurfhrohhfihhlvgemucfitefpfffkpdcuggftfghnshhusghstghrihgsvgenuceurghilhhouhhtmecufedtudenucesvcftvggtihhpihgvnhhtshculddquddttddmnegoufhushhpvggtthffohhmrghinhculdegledmnegfrhhlucfvnfffucdlqdeimdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeegvdethffhkeeikedtveeiledvhfetvdeiffegjeffteekuedvueetiedttdejueenucffohhmrghinhepnhhishhtrdhgohhvpdhmvghsohhnsghuihhlugdrtghomhdprhgvphhrohguuhgtihgslhgvrdhphidpshhpugigrdhorhhgpdhfrhgvvgguvghskhhtohhprdhorhhgpdhurghpihdqghhrohhuphdrohhrghenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeeftgekudemvggsrgejmedusgeksgemrgehtgelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeeftgekudemvggsrgejmedusgeksgemrgehtgelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghru gessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepfedprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtlhhinhdrtghomhdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhgpdhrtghpthhtoheprghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhm 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 ; Tue, 29 Jul 2025 11:30:21 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/7417 documentation/scripts/check-glossaries returns: WARNING: ref-manual/variables.rst: entries are not properly sorted: --- original_list +++ sorted_list @@ -12,8 +12,8 @@ ASSUME_PROVIDED ASSUME_SHLIBS AUTO_LIBNAME_PKGS +AUTO_SYSLINUXMENU AUTOREV -AUTO_SYSLINUXMENU AUTOTOOLS_SCRIPT_PATH AVAILTUNES AZ_SAS @@ -28,8 +28,8 @@ BB_CACHEDIR BB_CHECK_SSL_CERTS BB_CONSOLELOG +BB_CURRENT_MC BB_CURRENTTASK -BB_CURRENT_MC BB_DEFAULT_TASK BB_DEFAULT_UMASK BB_DEFER_BBCLASSES @@ -188,13 +188,13 @@ CVE_CHECK_REPORT_PATCHED CVE_CHECK_SHOW_WARNINGS CVE_CHECK_SKIP_RECIPE +CVE_CHECK_STATUSMAP +CVE_CHECK_VEX_JUSTIFICATION CVE_DB_INCR_UPDATE_AGE_THRES CVE_DB_UPDATE_INTERVAL CVE_PRODUCT CVE_STATUS CVE_STATUS_GROUPS -CVE_CHECK_STATUSMAP -CVE_CHECK_VEX_JUSTIFICATION CVE_VERSION CVSDIR CXX @@ -254,9 +254,8 @@ EXCLUDE_FROM_WORLD EXTENDPE EXTENDPKGV +EXTERNAL_KERNEL_DEVICETREE EXTERNAL_KERNEL_TOOLS -EXTERNAL_KERNEL_DEVICETREE -KERNEL_LOCALVERSION EXTERNAL_TOOLCHAIN EXTERNALSRC EXTERNALSRC_BUILD @@ -267,8 +266,8 @@ EXTRA_OECMAKE EXTRA_OECONF EXTRA_OEMAKE +EXTRA_OEMESON EXTRA_OESCONS -EXTRA_OEMESON EXTRA_USERS_PARAMS EXTRANATIVEPATH FAKEROOT @@ -300,8 +299,8 @@ FIT_KEY_GENRSA_ARGS FIT_KEY_REQ_ARGS FIT_KEY_SIGN_PKCS +FIT_PAD_ALG FIT_SIGN_ALG -FIT_PAD_ALG FIT_SIGN_INDIVIDUAL FIT_SIGN_NUMBITS FIT_UBOOT_ENV @@ -431,6 +430,7 @@ KERNEL_IMAGE_NAME KERNEL_IMAGETYPE KERNEL_IMAGETYPES +KERNEL_LOCALVERSION KERNEL_MODULE_AUTOLOAD KERNEL_MODULE_PROBECONF KERNEL_PACKAGE_NAME @@ -505,15 +505,15 @@ OBJCOPY OBJDUMP OE_BINCONFIG_EXTRA_MANGLE -OECMAKE_GENERATOR OE_INIT_ENV_SCRIPT OE_SHARED_UMASK OE_TERMINAL -OEROOT +OECMAKE_GENERATOR OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS OEQA_REPRODUCIBLE_TEST_PACKAGE +OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS OEQA_REPRODUCIBLE_TEST_TARGET -OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS +OEROOT OLDEST_KERNEL OPKG_MAKE_INDEX_EXTRA_PARAMS OPKGBUILDCMD @@ -691,11 +691,11 @@ SPDX_ARCHIVE_PACKAGED SPDX_ARCHIVE_SOURCES SPDX_CUSTOM_ANNOTATION_VARS +SPDX_INCLUDE_COMPILED_SOURCES SPDX_INCLUDE_SOURCES -SPDX_INCLUDE_COMPILED_SOURCES SPDX_NAMESPACE_PREFIX +SPDX_PACKAGE_URL SPDX_PACKAGE_VERSION -SPDX_PACKAGE_URL SPDX_PRETTY SPDXLICENSEMAP SPECIAL_PKGSUFFIX @@ -707,12 +707,12 @@ SPL_SIGN_KEYNAME SPLASH SPLASH_IMAGES -SRCREV_FORMAT SRC_URI SRC_URI_OVERRIDES_PACKAGE_ARCH SRCDATE SRCPV SRCREV +SRCREV_FORMAT SRCTREECOVEREDTASKS SSTATE_DIR SSTATE_EXCLUDEDEPS_SYSROOT @@ -779,9 +779,9 @@ TARGET_PREFIX TARGET_SYS TARGET_VENDOR +TC_CXX_RUNTIME TCLIBC TCMODE -TC_CXX_RUNTIME TEMPLATECONF TEST_EXPORT_DIR TEST_EXPORT_ONLY @@ -804,9 +804,9 @@ TOOLCHAIN TOOLCHAIN_HOST_TASK TOOLCHAIN_HOST_TASK_ESDK +TOOLCHAIN_NATIVE TOOLCHAIN_OPTIONS TOOLCHAIN_OUTPUTNAME -TOOLCHAIN_NATIVE TOOLCHAIN_TARGET_TASK TOPDIR TRANSLATED_TARGET_ARCH @@ -860,13 +860,13 @@ UBOOT_SUFFIX UBOOT_TARGET UBOOT_VERSION -UKIFY_CMD UKI_CMDLINE UKI_CONFIG_FILE UKI_FILENAME UKI_KERNEL_FILENAME UKI_SB_CERT UKI_SB_KEY +UKIFY_CMD UNKNOWN_CONFIGURE_OPT_IGNORE UNPACKDIR UPDATERCPN @@ -897,7 +897,7 @@ WKS_FILES WORKDIR XSERVER +XZ_MEMLIMIT XZ_THREADS -XZ_MEMLIMIT ZSTD_COMPRESSION_LEVEL ZSTD_THREADS Signed-off-by: Antonin Godard --- documentation/ref-manual/variables.rst | 258 ++++++++++++++++----------------- 1 file changed, 129 insertions(+), 129 deletions(-) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 15ca6543a..d559899c6 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -209,6 +209,11 @@ system and gives an overview of their function and contents. :ref:`ref-classes-debian` class to act on all packages that are explicitly generated by the recipe. + :term:`AUTO_SYSLINUXMENU` + Enables creating an automatic menu for the syslinux bootloader. You + must set this variable in your recipe. The + :ref:`ref-classes-syslinux` class checks this variable. + :term:`AUTOREV` When :term:`SRCREV` is set to the value of this variable, it specifies to use the latest source revision in the repository. Here is an example:: @@ -226,11 +231,6 @@ system and gives an overview of their function and contents. ":ref:`dev-manual/packages:automatically incrementing a package version number`" section in the Yocto Project Development Tasks Manual. - :term:`AUTO_SYSLINUXMENU` - Enables creating an automatic menu for the syslinux bootloader. You - must set this variable in your recipe. The - :ref:`ref-classes-syslinux` class checks this variable. - :term:`AUTOTOOLS_SCRIPT_PATH` When using the :ref:`ref-classes-autotools` class, the :term:`AUTOTOOLS_SCRIPT_PATH` variable stores the location of the @@ -400,12 +400,12 @@ system and gives an overview of their function and contents. :term:`BB_CONSOLELOG` See :term:`bitbake:BB_CONSOLELOG` in the BitBake manual. - :term:`BB_CURRENTTASK` - See :term:`bitbake:BB_CURRENTTASK` in the BitBake manual. - :term:`BB_CURRENT_MC` See :term:`bitbake:BB_CURRENT_MC` in the BitBake manual. + :term:`BB_CURRENTTASK` + See :term:`bitbake:BB_CURRENTTASK` in the BitBake manual. + :term:`BB_DEFAULT_TASK` See :term:`bitbake:BB_DEFAULT_TASK` in the BitBake manual. @@ -1998,6 +1998,20 @@ system and gives an overview of their function and contents. The list of package names (:term:`PN`) for which CVEs (Common Vulnerabilities and Exposures) are ignored. + :term:`CVE_CHECK_STATUSMAP` + Mapping variable for all possible reasons of :term:`CVE_STATUS`: + ``Patched``, ``Unpatched`` and ``Ignored``. + See :ref:`ref-classes-cve-check` or ``meta/conf/cve-check-map.conf`` for more details:: + + CVE_CHECK_STATUSMAP[cpe-incorrect] = "Ignored" + + :term:`CVE_CHECK_VEX_JUSTIFICATION` + Mapping variable for :term:`CVE_STATUS` reasons + (for example ``not-applicable-platform``) to :ref:`ref-classes-vex` + justifications. Should be set as follows:: + + CVE_CHECK_VEX_JUSTIFICATION[not-applicable-config] = "vulnerableCodeNotPresent" + :term:`CVE_DB_INCR_UPDATE_AGE_THRES` Specifies the maximum age of the CVE database in seconds for an incremental update (instead of a full-download). Use "0" to force a @@ -2053,20 +2067,6 @@ system and gives an overview of their function and contents. CVE_STATUS_PATCHED = "CVE-1234-0003 CVE-1234-0004" CVE_STATUS_PATCHED[status] = "fixed-version: Fixed externally" - :term:`CVE_CHECK_STATUSMAP` - Mapping variable for all possible reasons of :term:`CVE_STATUS`: - ``Patched``, ``Unpatched`` and ``Ignored``. - See :ref:`ref-classes-cve-check` or ``meta/conf/cve-check-map.conf`` for more details:: - - CVE_CHECK_STATUSMAP[cpe-incorrect] = "Ignored" - - :term:`CVE_CHECK_VEX_JUSTIFICATION` - Mapping variable for :term:`CVE_STATUS` reasons - (for example ``not-applicable-platform``) to :ref:`ref-classes-vex` - justifications. Should be set as follows:: - - CVE_CHECK_VEX_JUSTIFICATION[not-applicable-config] = "vulnerableCodeNotPresent" - :term:`CVE_VERSION` In a recipe, defines the version used to match the recipe version against the version in the `NIST CVE database `__ @@ -2816,6 +2816,13 @@ system and gives an overview of their function and contents. The dependency relationships are intended to force the package manager to upgrade these types of packages in lock-step. + :term:`EXTERNAL_KERNEL_DEVICETREE` + When inheriting :ref:`ref-classes-kernel-fit-image` and a + :term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the + variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a + directory containing one or more compiled device tree or device tree + overlays to use. + :term:`EXTERNAL_KERNEL_TOOLS` When set, the :term:`EXTERNAL_KERNEL_TOOLS` variable indicates that these tools are not in the source tree. @@ -2826,23 +2833,6 @@ system and gives an overview of their function and contents. external tools. See the :ref:`ref-classes-kernel-yocto` class in ``meta/classes-recipe`` to see how the variable is used. - :term:`EXTERNAL_KERNEL_DEVICETREE` - When inheriting :ref:`ref-classes-kernel-fit-image` and a - :term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the - variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a - directory containing one or more compiled device tree or device tree - overlays to use. - - :term:`KERNEL_LOCALVERSION` - This variable allows to append a string to the version - of the kernel image. This corresponds to the ``CONFIG_LOCALVERSION`` - kernel configuration parameter. - - Using this variable is only useful when you are using a kernel recipe - inheriting the :ref:`ref-classes-kernel` class, and which doesn't - already set a local version. Therefore, setting this variable has no - impact on ``linux-yocto`` kernels. - :term:`EXTERNAL_TOOLCHAIN` When you intend to use an :ref:`external toolchain `, @@ -2969,11 +2959,6 @@ system and gives an overview of their function and contents. :term:`PARALLEL_MAKEINST` also make use of :term:`EXTRA_OEMAKE` to pass the required flags. - :term:`EXTRA_OESCONS` - When inheriting the :ref:`ref-classes-scons` class, this - variable specifies additional configuration options you want to pass - to the ``scons`` command line. - :term:`EXTRA_OEMESON` Additional `Meson `__ options. See the :ref:`ref-classes-meson` class for additional information. @@ -2988,6 +2973,11 @@ system and gives an overview of their function and contents. Note that any custom value for the Meson ``--buildtype`` option should be set through the :term:`MESON_BUILDTYPE` variable. + :term:`EXTRA_OESCONS` + When inheriting the :ref:`ref-classes-scons` class, this + variable specifies additional configuration options you want to pass + to the ``scons`` command line. + :term:`EXTRA_USERS_PARAMS` When inheriting the :ref:`ref-classes-extrausers` class, this variable provides image level user and group operations. @@ -3428,16 +3418,16 @@ system and gives an overview of their function and contents. The default value is set to "x509" by the :ref:`ref-classes-kernel-fit-image` class. - :term:`FIT_SIGN_ALG` - Specifies the signature algorithm used in creating the FIT Image. - This variable is set by default to "rsa2048" by the - :ref:`ref-classes-kernel-fit-image` class. - :term:`FIT_PAD_ALG` Specifies the padding algorithm used in creating the FIT Image. The default value is set to "pkcs-1.5" by the :ref:`ref-classes-kernel-fit-image` class. + :term:`FIT_SIGN_ALG` + Specifies the signature algorithm used in creating the FIT Image. + This variable is set by default to "rsa2048" by the + :ref:`ref-classes-kernel-fit-image` class. + :term:`FIT_SIGN_INDIVIDUAL` If set to "1", the :ref:`ref-classes-kernel-fit-image` class signs each image node individually, including the kernel, DTB, RAM disk, and any @@ -5243,6 +5233,16 @@ system and gives an overview of their function and contents. to image type specified in :term:`KERNEL_IMAGETYPE`. Usually set by the machine configuration files. + :term:`KERNEL_LOCALVERSION` + This variable allows to append a string to the version + of the kernel image. This corresponds to the ``CONFIG_LOCALVERSION`` + kernel configuration parameter. + + Using this variable is only useful when you are using a kernel recipe + inheriting the :ref:`ref-classes-kernel` class, and which doesn't + already set a local version. Therefore, setting this variable has no + impact on ``linux-yocto`` kernels. + :term:`KERNEL_MODULE_AUTOLOAD` Lists kernel modules that need to be auto-loaded during boot. @@ -6225,16 +6225,6 @@ system and gives an overview of their function and contents. :term:`Source Directory` for details on how this class applies these additional sed command arguments. - :term:`OECMAKE_GENERATOR` - A variable for the :ref:`ref-classes-cmake` class, allowing to choose - which back-end will be generated by CMake to build an application. - - By default, this variable is set to ``Ninja``, which is faster than GNU - make, but if building is broken with Ninja, a recipe can use this - variable to use GNU make instead:: - - OECMAKE_GENERATOR = "Unix Makefiles" - :term:`OE_INIT_ENV_SCRIPT` The name of the build environment setup script for the purposes of setting up the environment within the extensible SDK. The default @@ -6265,15 +6255,15 @@ system and gives an overview of their function and contents. - konsole - none - :term:`OEROOT` - The directory from which the top-level build environment setup script - is sourced. The Yocto Project provides a top-level build environment - setup script: :ref:`structure-core-script`. When you run this - script, the :term:`OEROOT` variable resolves to the directory that - contains the script. + :term:`OECMAKE_GENERATOR` + A variable for the :ref:`ref-classes-cmake` class, allowing to choose + which back-end will be generated by CMake to build an application. - For additional information on how this variable is used, see the - initialization script. + By default, this variable is set to ``Ninja``, which is faster than GNU + make, but if building is broken with Ninja, a recipe can use this + variable to use GNU make instead:: + + OECMAKE_GENERATOR = "Unix Makefiles" :term:`OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS` Set build target(s) for build reproducibility testing but activate @@ -6287,14 +6277,24 @@ system and gives an overview of their function and contents. See :yocto_git:`reproducible.py ` and :doc:`/test-manual/reproducible-builds`. + :term:`OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS` + Set build targets which can be rebuilt using :ref:`shared state ` + when running build reproducibility tests. See :doc:`/test-manual/reproducible-builds`. + :term:`OEQA_REPRODUCIBLE_TEST_TARGET` Set build target for build reproducibility testing. By default all available recipes are compiled with "bitbake world", see also :term:`EXCLUDE_FROM_WORLD` and :doc:`/test-manual/reproducible-builds`. - :term:`OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS` - Set build targets which can be rebuilt using :ref:`shared state ` - when running build reproducibility tests. See :doc:`/test-manual/reproducible-builds`. + :term:`OEROOT` + The directory from which the top-level build environment setup script + is sourced. The Yocto Project provides a top-level build environment + setup script: :ref:`structure-core-script`. When you run this + script, the :term:`OEROOT` variable resolves to the directory that + contains the script. + + For additional information on how this variable is used, see the + initialization script. :term:`OLDEST_KERNEL` Declares the oldest version of the Linux kernel that the produced @@ -8782,27 +8782,6 @@ system and gives an overview of their function and contents. } ], - :term:`SPDX_INCLUDE_SOURCES` - This option allows to add a description of the source files used to build - the host tools and the target packages, to the ``spdx.json`` files in - ``tmp/deploy/spdx/MACHINE/recipes/`` under the :term:`Build Directory`. - As a consequence, the ``spdx.json`` files under the ``by-namespace`` and - ``packages`` subdirectories in ``tmp/deploy/spdx/MACHINE`` are also - modified to include references to such source file descriptions. - - Enable this option as follows:: - - SPDX_INCLUDE_SOURCES = "1" - - According to our tests on release 4.1 "langdale", building - ``core-image-minimal`` for the ``qemux86-64`` machine, enabling - this option multiplied the total size of the ``tmp/deploy/spdx`` - directory by a factor of 3 (+291 MiB for this image), - and the size of the ``IMAGE-MACHINE.spdx.tar.zst`` in - ``tmp/deploy/images/MACHINE`` by a factor of 130 (+15 MiB for this - image), compared to just using the :ref:`ref-classes-create-spdx` class - with no option. - :term:`SPDX_INCLUDE_COMPILED_SOURCES` This option allows the same as :term:`SPDX_INCLUDE_SOURCES` but including only the sources used to compile the host tools and the target packages. @@ -8825,22 +8804,43 @@ system and gives an overview of their function and contents. :term:`SPDX_INCLUDE_SOURCES` reduces the size of the ``tmp/deploy/spdx`` directory from 2GB to 1.6GB. + :term:`SPDX_INCLUDE_SOURCES` + This option allows to add a description of the source files used to build + the host tools and the target packages, to the ``spdx.json`` files in + ``tmp/deploy/spdx/MACHINE/recipes/`` under the :term:`Build Directory`. + As a consequence, the ``spdx.json`` files under the ``by-namespace`` and + ``packages`` subdirectories in ``tmp/deploy/spdx/MACHINE`` are also + modified to include references to such source file descriptions. + + Enable this option as follows:: + + SPDX_INCLUDE_SOURCES = "1" + + According to our tests on release 4.1 "langdale", building + ``core-image-minimal`` for the ``qemux86-64`` machine, enabling + this option multiplied the total size of the ``tmp/deploy/spdx`` + directory by a factor of 3 (+291 MiB for this image), + and the size of the ``IMAGE-MACHINE.spdx.tar.zst`` in + ``tmp/deploy/images/MACHINE`` by a factor of 130 (+15 MiB for this + image), compared to just using the :ref:`ref-classes-create-spdx` class + with no option. + :term:`SPDX_NAMESPACE_PREFIX` This option could be used in order to change the prefix of ``spdxDocument`` and the prefix of ``documentNamespace``. It is set by default to ``http://spdx.org/spdxdoc``. - :term:`SPDX_PACKAGE_VERSION` - This variable controls the package version as seen in the SPDX 3.0 JSON - output (``software_packageVersion``). The default value for this variable - is :term:`PV`. - :term:`SPDX_PACKAGE_URL` Provides a place for the SPDX data creator to record the package URL string (``software_packageUrl``, in accordance with the Package URL specification) for a software Package. The default value of this variable is an empty string. + :term:`SPDX_PACKAGE_VERSION` + This variable controls the package version as seen in the SPDX 3.0 JSON + output (``software_packageVersion``). The default value for this variable + is :term:`PV`. + :term:`SPDX_PRETTY` This option makes the SPDX output more human-readable, using identation and newlines, instead of the default output in a @@ -8962,9 +8962,6 @@ system and gives an overview of their function and contents. ":ref:`dev-manual/layers:appending other layers metadata with your layer`" section. - :term:`SRCREV_FORMAT` - See :term:`bitbake:SRCREV_FORMAT` in the BitBake manual. - :term:`SRC_URI` See the BitBake manual for the initial description for this variable: @@ -9058,6 +9055,9 @@ system and gives an overview of their function and contents. ":ref:`dev-manual/packages:automatically incrementing a package version number`" section, which is in the Yocto Project Development Tasks Manual. + :term:`SRCREV_FORMAT` + See :term:`bitbake:SRCREV_FORMAT` in the BitBake manual. + :term:`SRCTREECOVEREDTASKS` A list of tasks that are typically not relevant (and therefore skipped) when building using the :ref:`ref-classes-externalsrc` @@ -9847,6 +9847,12 @@ system and gives an overview of their function and contents. :term:`TARGET_VENDOR` Specifies the name of the target vendor. + :term:`TC_CXX_RUNTIME` + Specifies the C/C++ STL and runtime variant to use during + the build process. Default value is 'gnu' + + You can select "gnu", "llvm", or "android". + :term:`TCLIBC` Specifies the GNU standard C library (``libc``) variant to use during the build process. @@ -9896,12 +9902,6 @@ system and gives an overview of their function and contents. up any pre-built objects in the toolchain such as ``libgcc``, ``libstdcc++``, any locales, and ``libc``. - :term:`TC_CXX_RUNTIME` - Specifies the C/C++ STL and runtime variant to use during - the build process. Default value is 'gnu' - - You can select "gnu", "llvm", or "android". - :term:`TEMPLATECONF` Specifies the directory used by the build system to find templates from which to build the ``bblayers.conf`` and ``local.conf`` files. @@ -10201,6 +10201,18 @@ system and gives an overview of their function and contents. portion of an eSDK. This is similar to :term:`TOOLCHAIN_HOST_TASK` applying to SDKs. + :term:`TOOLCHAIN_NATIVE` + The :term:`TOOLCHAIN_NATIVE` variable can be used to override the + toolchain used by a :ref:`ref-classes-native` recipe. + + The default value for this variable is the value of + :term:`PREFERRED_TOOLCHAIN` (in :ref:`ref-classes-native` contexts). See + the description of :term:`PREFERRED_TOOLCHAIN` to know the list of + possible values for :term:`TOOLCHAIN_NATIVE`. + + It is possible to override the value of this variable from a recipe if + this recipe is known to support only a specific toolchain. + :term:`TOOLCHAIN_OPTIONS` This variable holds extra options passed to the compiler and the linker for non ``-native`` recipes as they have to point to their custom @@ -10223,18 +10235,6 @@ system and gives an overview of their function and contents. :term:`SDK_VERSION` variables for additional information. - :term:`TOOLCHAIN_NATIVE` - The :term:`TOOLCHAIN_NATIVE` variable can be used to override the - toolchain used by a :ref:`ref-classes-native` recipe. - - The default value for this variable is the value of - :term:`PREFERRED_TOOLCHAIN` (in :ref:`ref-classes-native` contexts). See - the description of :term:`PREFERRED_TOOLCHAIN` to know the list of - possible values for :term:`TOOLCHAIN_NATIVE`. - - It is possible to override the value of this variable from a recipe if - this recipe is known to support only a specific toolchain. - :term:`TOOLCHAIN_TARGET_TASK` This variable lists packages the OpenEmbedded build system uses when it creates the target part of an SDK (i.e. the part built for the @@ -10828,12 +10828,6 @@ system and gives an overview of their function and contents. :term:`UBOOT_VERSION` variable contains this information, but can be overridden if desired. - :term:`UKIFY_CMD` - When inheriting the :ref:`ref-classes-uki` class, - `ukify `__ command to build - `Unified Kernel Image (UKI) `__. - Defaults to ``ukify build``. - :term:`UKI_CMDLINE` When inheriting the :ref:`ref-classes-uki` class, the kernel command line to use when booting the `Unified Kernel Image (UKI) @@ -10865,6 +10859,12 @@ system and gives an overview of their function and contents. secureboot private key to sign the `Unified Kernel Image (UKI) `__. + :term:`UKIFY_CMD` + When inheriting the :ref:`ref-classes-uki` class, + `ukify `__ command to build + `Unified Kernel Image (UKI) `__. + Defaults to ``ukify build``. + :term:`UNKNOWN_CONFIGURE_OPT_IGNORE` Specifies a list of options that, if reported by the configure script as being invalid, should not generate a warning during the @@ -11277,6 +11277,12 @@ system and gives an overview of their function and contents. The default value of :term:`XSERVER`, if not specified in the machine configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev". + :term:`XZ_MEMLIMIT` + Specifies the maximum memory the xz compression should use as a percentage + of system memory. If unconstrained the xz compressor can use large amounts of + memory and become problematic with parallelism elsewhere in the build. + "50%" has been found to be a good value. + :term:`XZ_THREADS` Specifies the number of parallel threads that should be used when using xz compression. @@ -11290,12 +11296,6 @@ system and gives an overview of their function and contents. On systems where many tasks run in parallel, setting a limit to this can be helpful in controlling system resource usage. - :term:`XZ_MEMLIMIT` - Specifies the maximum memory the xz compression should use as a percentage - of system memory. If unconstrained the xz compressor can use large amounts of - memory and become problematic with parallelism elsewhere in the build. - "50%" has been found to be a good value. - :term:`ZSTD_COMPRESSION_LEVEL` Specifies the compression level to be used with ZStandard compression (from ``1`` to ``19``, set to ``3`` by default, following upstream choice). From patchwork Tue Jul 29 11:30:06 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 67641 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 7832DC87FC9 for ; Tue, 29 Jul 2025 11:30:21 +0000 (UTC) Received: from relay2-d.mail.gandi.net (relay2-d.mail.gandi.net [217.70.183.194]) by mx.groups.io with SMTP id smtpd.web11.4867.1753788611297785356 for ; Tue, 29 Jul 2025 04:30:11 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=WuALr2Ba; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id DAB274389E; Tue, 29 Jul 2025 11:30:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1753788610; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=BiFmrR4LMOjtGCLb6N4mY+mHfuvGzVfg0Q9cmLIVZw4=; b=WuALr2BaDS0A86ksFqdkXohrCL8AuGd9FlCoJIAKsVoopQwEHm4TpnGEGbbE5W7L9W490W PZ4Ym75cNQeGLDuh7+l5swMYWySgM7xWDcB4zDOr8k3bhZ0Fhdj91vRqHiehj04XOO7c2G zfIH7Xk5oj2t11dTM1A5dtgx6FGvd2fepQfbR8KphNEFRfzzGA3FdeCOTvOeU9wqelmJQq MuS47Nz2G3UQ3rQGfDKG4vMoQpXd0ZuNE+tAGesDHG6dd1Q/WXbNFRff+6EWXTU90PtojF Q4N+tKdt3C5k+jwpNRmBZOZWnuq4Hw05XNiUkVOg9DUQB5+f1KPy+6yO/Yaexw== From: Antonin Godard Date: Tue, 29 Jul 2025 13:30:06 +0200 Subject: [PATCH 5/5] ref-manual/terms.rst: sort entries MIME-Version: 1.0 Message-Id: <20250729-variables-checks-v1-5-5ad6ca9b9386@bootlin.com> References: <20250729-variables-checks-v1-0-5ad6ca9b9386@bootlin.com> In-Reply-To: <20250729-variables-checks-v1-0-5ad6ca9b9386@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=2798; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=kURiEE3g1FHROkv1uOgK4Ts4uyaUTtTCSefV/MToetI=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBoiLDAUdDJlpSRzJXPnTLJNs57Hw0OY6m13jUK7 26m5fsKaoqJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCaIiwwAAKCRDRgEFAKaOo Njr5EACN/6Xh3FYFZkBWGOVpx/sQ/tJ641pF/to3q5HvjLCFPP++HlJJt0H9YS4AGQ+EL6Za2G4 Fp7W7vF4w7zaM8JqzwzoPDXp2Koj6CR5NGJqzPyl+/ORRfvBBi7T6EiCW5sSWhFH1uxnC3V/oSs +QNL2UMmdZ9Wukd+7jAsXOcJz00kswcJPGDpfwPDf4Dgbn08uThKI3QEDfLfzl4AhxnyyNJQsTG SFRgmKYIWdR6Sl2gNhIVzsb3rdr8MxrKRzlV+P+5YILZMa54zl8cYRBmpOrKb1DPL0j55Tn2Es9 g9ZnKY5sH7vDcXC6C2Wd3wDSLzhH561cl3lfJLptafxd/mEglXRJtBJKRKrx5XioPeh0+X7E1Ew 5UdGEcGJEqZFLSNq1Vo/wIk2tYUeJSSm78nTqixaxUSB35IhrtB21orVVPI2qE2lMuESZXj90G+ XJoSG5ovqc36pcP5HVcDUcUh+bQP/CWIpbWKQyjJS6Zf6MEEqdkTSI4b5iYWsjcCnYSEpPzVfuc VB5JnXU/MScedL6WkRL/hpbUATVcIABJm6LgklIvSGFirRVTySprZWEFGk7LHXYZ12dvmMT3Ry1 TEglTKxCCDSPERynMCCZPjSHyNQhp1bX7UbJv+xgLtf1V1deW8crCufhhfpmIWAhZ+rLiEmZjyS z3TTPPmwbqUIhVQ== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeeffedrtdefgdelgeelfecutefuodetggdotefrodftvfcurfhrohhfihhlvgemucfitefpfffkpdcuggftfghnshhusghstghrihgsvgenuceurghilhhouhhtmecufedtudenucesvcftvggtihhpihgvnhhtshculddquddttddmnecujfgurhephfffufggtgfgkfhfjgfvvefosehtjeertdertdejnecuhfhrohhmpeetnhhtohhnihhnucfiohgurghrugcuoegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomheqnecuggftrfgrthhtvghrnhepheeigeeuhfefgeehfffgueeiteehieelfeehjeektefgkeeuheeuleduvdelgffhnecukfhppedvrgdtudemtggsudegmeehheeimeejrgdttdemfegtkedumegvsggrjeemudgskegsmegrhegtleenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepihhnvghtpedvrgdtudemtggsudegmeehheeimeejrgdttdemfegtkedumegvsggrjeemudgskegsmegrhegtledphhgvlhhopegluddvjedrtddruddrudgnpdhmrghilhhfrhhomheprghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmpdhnsggprhgtphhtthhopeefpdhrtghpthhtohepthhhohhmrghsrdhpvghtrgiiiihonhhisegsohhothhlihhnrdgtohhmpdhrtghpthhtohepughotghssehlihhsthhsrdihohgtthhophhrohhjvggtthdrohhrghdprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoo hhtlhhinhdrtghomh 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 ; Tue, 29 Jul 2025 11:30:21 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/7418 documentation/scripts/check-glossaries returns: WARNING: ref-manual/terms.rst: entries are not properly sorted: --- original_list +++ sorted_list @@ -17,8 +17,8 @@ LTS Metadata Mixin +OpenEmbedded Build System OpenEmbedded-Core (OE-Core) -OpenEmbedded Build System Package Package Groups Poky Signed-off-by: Antonin Godard --- documentation/ref-manual/terms.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index 9f6106141..f3d3d059d 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst @@ -304,19 +304,6 @@ universal, the list includes them just in case: :term:`LTS` release. See the :ref:`ref-long-term-support-releases` section for details. - :term:`OpenEmbedded-Core (OE-Core)` - OE-Core is metadata comprised of - foundational recipes, classes, and associated files that are meant to - be common among many different OpenEmbedded-derived systems, - including the Yocto Project. OE-Core is a curated subset of an - original repository developed by the OpenEmbedded community that has - been pared down into a smaller, core set of continuously validated - recipes. The result is a tightly controlled and an quality-assured - core set of recipes. - - You can see the Metadata in the ``meta`` directory of the Yocto - Project :yocto_git:`Source Repositories `. - :term:`OpenEmbedded Build System` The build system specific to the Yocto Project. The OpenEmbedded build system is based on another project @@ -331,6 +318,19 @@ universal, the list includes them just in case: For some historical information about Poky, see the :term:`Poky` term. + :term:`OpenEmbedded-Core (OE-Core)` + OE-Core is metadata comprised of + foundational recipes, classes, and associated files that are meant to + be common among many different OpenEmbedded-derived systems, + including the Yocto Project. OE-Core is a curated subset of an + original repository developed by the OpenEmbedded community that has + been pared down into a smaller, core set of continuously validated + recipes. The result is a tightly controlled and an quality-assured + core set of recipes. + + You can see the Metadata in the ``meta`` directory of the Yocto + Project :yocto_git:`Source Repositories `. + :term:`Package` In the context of the Yocto Project, this term refers to a recipe's packaged output produced by BitBake (i.e. a "baked recipe").