From patchwork Thu Mar 27 09:07:26 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 60059 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 D4684C3600C for ; Thu, 27 Mar 2025 09:07:57 +0000 (UTC) Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by mx.groups.io with SMTP id smtpd.web11.45524.1743066476483827810 for ; Thu, 27 Mar 2025 02:07:56 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=IFShh/KO; spf=pass (domain: bootlin.com, ip: 217.70.183.197, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id C4FA6432F7; Thu, 27 Mar 2025 09:07:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1743066474; 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=yMjyVSuMwTB5xvxfSqX8AnsGcW7VHt9Q51UsNH3GvKM=; b=IFShh/KO4ERw7ru4VMFgekDDn2n7w5j23AwKzCdzfSA8CfUBZXn6nLwWRv8s4zC4Gofj2Z k/f4zuUCpp70h7bpKU1kV9J8gEXWP8lcpM6siIaws/3YcSRDl0+T2cW+eHI5T7koC9lSeJ UwdympCvDx+Q1SNL/M3FOfpyrANIXd3HL7/AB7dXZyN4kyrnMY0GvfjxFvt+nZ7jTvIFLL RcwMsmZ/xiaRsCPKjVNK52ZSHBjIP8OePWXvlLm9fAnrfqDXzYpUqEfw2BfyQio0c6jscA U+8MzzEXYXRtgpfcx5vyiMDemL5j5s60/pjMljtWkeJ423uQ+5gmY4T0t9k4Fg== From: Antonin Godard Date: Thu, 27 Mar 2025 10:07:26 +0100 Subject: [PATCH v3 1/6] documentation/conf.py: define a manpage url MIME-Version: 1.0 Message-Id: <20250327-cc-vars-v3-1-742dbddce008@bootlin.com> References: <20250327-cc-vars-v3-0-742dbddce008@bootlin.com> In-Reply-To: <20250327-cc-vars-v3-0-742dbddce008@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=3311; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=F6zRFv1AUZjyBsGV9xMkP/MMyjxs1I7h18QeocGp9qw=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn5RVpkLCPa6dApAflWOrdy/Y1L4ZJRbqmPSLQ8 xX3BlGN2VKJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+UVaQAKCRDRgEFAKaOo NkDkEACJz9cS6UoTK6AvpL8x+fA4s+07c0AKwG+8lZdaayZ3kcUSnJjLRtK4peV0MpBP1O7Zamy PfOXb6ZC2URmmPw3J1U4qZ8/5I5f+943leQj9ghMMund7L6BVWbG1YqssVvh4ec07kc1ddDMgbF N4MxB/teCpQe5wpzP72LiYrpozVUlcG+W+VWGuoId9mAVqHkZkUr2R4Htro5YLs5PmuSaAtHvru ziqbOeEPFKDoo6Zk5UvnsrVkr8tLxvf/zJ88mH5zms890XIak+wsc1pFC4B7dGqo+bWXxTcVXFP xrgt2MGgm222OL/aAdWOPkSaNVufi4taFqYvtc9mRfXn4vrWiqKCpF8VXTeFUcJ7EKzl85/R6Ob 1X0wA13LtyJbHH5JcU/k7yCBvU126CrcADB5z5h+XXBZLbFQGOXB9RgYLaJitRLEJHB1qh1G734 sHTamu1rhSlppJ5tQJKqxdYORVe/j58FENV/8VZThAR43v+f0KnGpEFzrLoKgd+XKPJZujGfUG+ QvwGJu04ZUf6zXJXT+BA9Y5YD2qMoWUhOrfGrPPK5Pvynnt+CDUzpuL9ZwXkrCanKon0rItuwy6 og3Pcd1tlsVfkLpFukLNAr4z/tVU5lwE/ggeRYhp3yA/lhsyTAsZnTiMpn5iftUfxNDGL4LCSdr CIY92liQ1yowehQ== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgdduieektddvucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpedtteeuheejgfdtfeekteehueeugfejgedvleehieelteefkeegjeelueeugeelveenucffohhmrghinhepshhphhhinhigqdguohgtrdhorhhgpdifihhkihhpvgguihgrrdhorhhgpdguvggsihgrnhdrohhrghdphihotghtohhprhhojhgvtghtrdhorhhgpdhhvgdrnhgvthenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepfedprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghto hhprhhojhgvtghtrdhorhhgpdhrtghpthhtoheprghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmpdhrtghpthhtohepthhhohhmrghsrdhpvghtrgiiiihonhhisegsohhothhlihhnrdgtohhm 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 ; Thu, 27 Mar 2025 09:07:57 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6647 By defining the manpages_url we can use the :manpage: role in the documentation for providing links to manpages. See: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url Replace existing manpages links to use this role. Signed-off-by: Antonin Godard Reviewed-by: Quentin Schulz --- documentation/conf.py | 3 +++ documentation/overview-manual/concepts.rst | 2 +- documentation/overview-manual/yp-intro.rst | 2 +- documentation/ref-manual/variables.rst | 4 ++-- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/documentation/conf.py b/documentation/conf.py index 477e75112a..0352bbef20 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -111,6 +111,9 @@ extlinks = { 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None), } +# To able to use :manpage:`` in the docs. +manpages_url = 'https://manpages.debian.org/{path}' + # Intersphinx config to use cross reference with BitBake user manual intersphinx_mapping = { 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None) diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index e4d806f98f..416c28f0d9 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -2204,7 +2204,7 @@ require root privileges, the fact that some earlier steps ran in a fake root environment does not cause problems. The capability to run tasks in a fake root environment is known as -"`fakeroot `__", which is derived from +":manpage:`fakeroot `", which is derived from the BitBake keyword/variable flag that requests a fake root environment for a task. diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 4a27e12e01..11e6d99e32 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst @@ -400,7 +400,7 @@ Yocto Project: Autobuilder :doc:`here `. - *Pseudo:* Pseudo is the Yocto Project implementation of - `fakeroot `__, which is used to run + :manpage:`fakeroot `, which is used to run commands in an environment that seemingly has root privileges. During a build, it can be necessary to perform operations that diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 41bda5d0d6..4e675b6bfb 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -4514,8 +4514,8 @@ system and gives an overview of their function and contents. The value in :term:`INITSCRIPT_PARAMS` is passed through to the ``update-rc.d`` command. For more information on valid parameters, - please see the ``update-rc.d`` manual page at - https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html + please see the ``update-rc.d`` manual page at :manpage:`update-rc.d + `. :term:`INSANE_SKIP` Specifies the QA checks to skip for a specific package within a From patchwork Thu Mar 27 09:07:27 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 60058 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 D4648C3600B for ; Thu, 27 Mar 2025 09:07:57 +0000 (UTC) Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by mx.groups.io with SMTP id smtpd.web10.45788.1743066476464209099 for ; Thu, 27 Mar 2025 02:07:56 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=aPuwatEY; spf=pass (domain: bootlin.com, ip: 217.70.183.197, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 04E54432FC; Thu, 27 Mar 2025 09:07:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1743066475; 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=wcDCj0dNutkMe9R5K6+qXEXmHwHtRBZ1hSCly/CrcGc=; b=aPuwatEYz1BzG/NIFnO22rb5a/h/WBwpK+F/eoYDesvQBd87jB4Dq8tTIlM1pIc6QgpgGG 4rttrozQ6gY93SEr4iE45N3TiX19QPAe1YhY1oVZxWacc6CqOAKQVzuwC4640Hz1pzPSrM 5OGOwG+ufuvQNPmltvpCUciDTTekEoGk4JsZvFEJ6yKEDDrpI5LZMqZW+gZrjpv+3qZlY2 tnytSP2y9AUUJiauokDwzA7rTFww0uxLZRcQVhqLCXfM1hAYr1zGRVEp6kM/I3YvwhZKdV oIW/b9ruMRS5Z6r8sBD+uC+hcdwVgjHGOgArfO/YMXvTFgU8HsFwiDpCZV2NIg== From: Antonin Godard Date: Thu, 27 Mar 2025 10:07:27 +0100 Subject: [PATCH v3 2/6] ref-manual/variables.rst: add manpage links for toolchain variables MIME-Version: 1.0 Message-Id: <20250327-cc-vars-v3-2-742dbddce008@bootlin.com> References: <20250327-cc-vars-v3-0-742dbddce008@bootlin.com> In-Reply-To: <20250327-cc-vars-v3-0-742dbddce008@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=3615; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=DvfYFoHEeCDbSbKID4tQ9LcGYrA8VujN+WmEu1lnHvk=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn5RVp9F7D566lPEWMOMWE0r4PnpTWs/8tNd1uc h0qQNno1reJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+UVaQAKCRDRgEFAKaOo NtqPEACb6bOjP1dEL89GbB105nt55jBvlIw1/pi6qVvX06zF5zEPsdJ6zkAKpG+o5td6Agnq/O1 L4OgjWUxdHVfPggEPXGWbBDHn3Rve687DMjn4FNZRnVg4nTsEPIZtZzoO75fYqcK42cxpZoz0Mf RKrl9/rnu7i3Ft4ljq5YcD8I15PXm1zpimNjE2UrEI7yqwCcJ1anK7HmaAwgkiccMDErw+cHhQX eDL+PT1gFKrsojwx6+1m32lCJMgXxCM0vrJaHJwUtkAmyFqTbR68QrE+/bCcONudmwBSfmmrRf3 AZ09vv7EsdkY8110/CHLYZdnj3UrUJE4XVG1VLhewAHApA6+2EMw3gtnj63ltzfAAv6W10Tb0IE O5Dmp11mfyF+/XuDjRkhgIktOFRHY8wvh4zXX/S6aR7eWlzG8wDNOKjd2ZGNI8JiELeG5WuAfG2 z0CI5k6gen98RqNGj6vNdIZWtj+yS1YDl7gsiOUwML7pXOb9CkFuBIxdZmFmOG9qGa2vNdUXuyK PEtwpjqDOPxqFAFFlPiHYF2AZqcNDUvxyeSi5DX0HiiQf96vljsJgq3vMPruUqCY2Bx8sEr9DpR u3e4RCArSz3RgfDPSeRUAHOLwS8JCYNY4+VLpzXGq08quh/3Yk/U8EJtPpwWJ0xe6sewkiCP27R 2BaZ892hn6AWVTA== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgdduieektddvucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepfedprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhgpdhrtghpthhtoheprghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmpdhrtghpthhtohepthhhohhmrghsrdhpvghtrgiiiihonhhisegso hhothhlihhnrdgtohhm 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 ; Thu, 27 Mar 2025 09:07:57 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6646 Use the :manpage: role to provide links to common toolchain utilities. Signed-off-by: Antonin Godard Reviewed-by: Quentin Schulz --- documentation/ref-manual/variables.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 4e675b6bf..d98721818 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -143,7 +143,7 @@ system and gives an overview of their function and contents. information on how this variable is used. :term:`AR` - The minimal command and arguments used to run ``ar``. + The minimal command and arguments used to run :manpage:`ar `. :term:`ARCHIVER_MODE` When used with the :ref:`ref-classes-archiver` class, @@ -165,7 +165,8 @@ system and gives an overview of their function and contents. ``meta/classes/archiver.bbclass`` file in the :term:`Source Directory`. :term:`AS` - Minimal command and arguments needed to run the assembler. + Minimal command and arguments needed to run the :manpage:`assembler + `. :term:`ASSUME_PROVIDED` Lists recipe names (:term:`PN` values) BitBake does not @@ -5165,7 +5166,8 @@ system and gives an overview of their function and contents. ``LAYERVERSION_mylayer``). :term:`LD` - The minimal command and arguments used to run the linker. + The minimal command and arguments used to run the :manpage:`linker + `. :term:`LDFLAGS` Specifies the flags to pass to the linker. This variable is exported @@ -5771,7 +5773,7 @@ system and gives an overview of their function and contents. variable is set. :term:`NM` - The minimal command and arguments to run ``nm``. + The minimal command and arguments to run :manpage:`nm `. :term:`NO_GENERIC_LICENSE` Avoids QA errors when you use a non-common, non-CLOSED license in a @@ -5860,10 +5862,10 @@ system and gives an overview of their function and contents. NVDCVE_API_KEY = "fe753&7a2-1427-347d-23ff-b2e2b7ca5f3" :term:`OBJCOPY` - The minimal command and arguments to run ``objcopy``. + The minimal command and arguments to run :manpage:`objcopy `. :term:`OBJDUMP` - The minimal command and arguments to run ``objdump``. + The minimal command and arguments to run :manpage:`objdump `. :term:`OE_BINCONFIG_EXTRA_MANGLE` When inheriting the :ref:`ref-classes-binconfig` class, @@ -7174,7 +7176,7 @@ system and gives an overview of their function and contents. QA_EMPTY_DIRS_RECOMMENDATION:/dev = "but all devices must be created at runtime" :term:`RANLIB` - The minimal command and arguments to run ``ranlib``. + The minimal command and arguments to run :manpage:`ranlib `. :term:`RCONFLICTS` The list of packages that conflict with packages. Note that packages @@ -8914,8 +8916,8 @@ system and gives an overview of their function and contents. places stamps. The default directory is ``${TMPDIR}/stamps``. :term:`STRIP` - The minimal command and arguments to run ``strip``, which is used to - strip symbols. + The minimal command and arguments to run :manpage:`strip `, + which is used to strip symbols. :term:`SUMMARY` The short (72 characters or less) summary of the binary package for From patchwork Thu Mar 27 09:07:28 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 60063 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 EBD38C36013 for ; Thu, 27 Mar 2025 09:07:57 +0000 (UTC) Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by mx.groups.io with SMTP id smtpd.web11.45525.1743066476611510044 for ; Thu, 27 Mar 2025 02:07:57 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=bY0p4nnY; spf=pass (domain: bootlin.com, ip: 217.70.183.197, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 36EBB432FF; Thu, 27 Mar 2025 09:07:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1743066475; 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=LMbVSYE82Vph/8SxUjpWmH018f875t4I86lEiji4VjM=; b=bY0p4nnYu+axRWepKfdwvOoPkREvgGgtoggf83v8PRqD4w0WgOHdndEQFo2ZFnBzdbta3T QpMjy/yuVuw8sWu5wGlhDaDx3fYMQzPPBC4BWHSO/MzS+fv9jiJfCi8aLBNJbHVaBGfEkU sdP0edi+qXgR0ppOnRaL5hSG32Lla735OfYAtfBEz3flL8QMfzJJoxTUkibCFCc34BC1vs QRuKvAupiEDmvnqq1mlEG1sROUol8KvpgzAfbER/f/jDxPLZ38HSyrByUwA5ExljhlSgMh Dt6T67JUVWrcneIwMzZDl3bdimzXxrJIlm9WHsdtDpHXYAc5K1GW3yIvky3Kyw== From: Antonin Godard Date: Thu, 27 Mar 2025 10:07:28 +0100 Subject: [PATCH v3 3/6] ref-manual/variables.rst: add missing documentation for BUILD_* variables MIME-Version: 1.0 Message-Id: <20250327-cc-vars-v3-3-742dbddce008@bootlin.com> References: <20250327-cc-vars-v3-0-742dbddce008@bootlin.com> In-Reply-To: <20250327-cc-vars-v3-0-742dbddce008@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=16821; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=qTNyvP8g/7QocFK1D6OAYgOf6zTQcsIyCKnasNWWQIw=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn5RVpTp1NsoR8ZeO3fEV9J2aLjMRkxd6iPoS24 Je4Wh/9p7uJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+UVaQAKCRDRgEFAKaOo NlbSEACuWITnLHPveoGDBOk7p0ipeZRSkC0NaHNcKnaI1puk8XYgTDArvj//qkH7/Fne+WeBz3e J18vMIUVCd27Wqve/wjMQjWhEw0gD2d78+xxMUd7J+YgADa+F1jFirF8GflWuCr1HKULVPKNBKJ cbPSJze32Y/3H2e0Xzv2too1aCyGcQY3HuY6BcU/Kta/ZJFRTzV/bXF9Ix54PpqxRrWzF0EgmGw nEd4w8aSRaHJpBp8m53Cpkqqyq80+8XbXzGcLmvc12AIzfx4CH3ChkYupCZX73c+NfKHbAl1Uz3 NLdR/X9PGigbIGNv8PP63Rro3nWWhiZaY4TssglwqWiqi/u7QifkogMpjY4qi/TKKBSDQz+QV0w 6FMWcsKh5JIcf5lvdntizEqXcWF4U/FyP6ahmj2neKg7tQoYueU3LWTP6M828/Y0fttFPyb1bKb ABWKrj2ujQK7zHLFQ2xX3Iu1x96kpARU3p52FiPG3zGEHimMvJCKiZV1r4sKnyakqd5wSjo8egT CtCCuVr6R/+L8+lyHJIC5z7gfIWUOCrskRhqnM+7rcuUG35dn34mOqEBeKiZWHFdubmCK8ONLkj K6kdEOlqkl4jx9kkDMj5uQS9CjsE5pkJR2fMzbMoTi+fuuM2tObNsUWhL9HQI+ctRYQvinuXmzm Jr2sNvBnPwwIUJQ== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgdduieektddvucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepfedprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhgpdhrtghpthhtoheprghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmpdhrtghpthhtohepthhhohhmrghsrdhpvghtrgiiiihonhhisegso hhothhlihhnrdgtohhm 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 ; Thu, 27 Mar 2025 09:07:57 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6649 These toolchain variables are used in a native context. Some of the BUILD_* variables missed documentation. Also, some of the base commands were also not there so document them. Some of existing BUILD_* variable documentation were missing the note about their usage in a native context, so add it too so that all BUILD_* variables are documented the same way. [YOCTO #15719] Signed-off-by: Antonin Godard Reviewed-by: Quentin Schulz --- documentation/ref-manual/variables.rst | 250 ++++++++++++++++++++++++++++++--- 1 file changed, 230 insertions(+), 20 deletions(-) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index d98721818..0516c1816 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -986,55 +986,165 @@ system and gives an overview of their function and contents. variable is a useful pointer in case a bug in the software being built needs to be manually reported. + :term:`BUILD_AR` + Specifies the architecture-specific :manpage:`archiver ` for the + build host, and its default definition is derived in part from + :term:`BUILD_PREFIX`:: + + BUILD_AR = "${BUILD_PREFIX}ar" + + When building a :ref:`ref-classes-native` recipe, :term:`AR` is set to the + value of this variable by default. + + The :term:`BUILD_AR` variable should not be set manually, and is rarely + used in recipes as :term:`AR` contains the appropriate value depending on + the context (native or target recipes). Exception be made for target + recipes that need to use the :manpage:`archiver ` from the build + host at some point during the build. + :term:`BUILD_ARCH` Specifies the architecture of the build host (e.g. ``i686``). The OpenEmbedded build system sets the value of :term:`BUILD_ARCH` from the machine name reported by the ``uname`` command. + :term:`BUILD_AS` + Specifies the architecture-specific :manpage:`assembler ` for the + build host, and its default definition is derived in part from + :term:`BUILD_PREFIX`:: + + BUILD_AS = "${BUILD_PREFIX}as" + + When building a :ref:`ref-classes-native` recipe, :term:`AS` is set to the + value of this variable by default. + + The :term:`BUILD_AS` variable should not be set manually, and is rarely + used in recipes as :term:`AS` contains the appropriate value depending on + the context (native or target recipes). Exception be made for target + recipes that need to use the :manpage:`assembler ` from the build + host at some point during the build. + :term:`BUILD_AS_ARCH` Specifies the architecture-specific assembler flags for the build host. By default, the value of :term:`BUILD_AS_ARCH` is empty. + :term:`BUILD_CC` + Specifies the architecture-specific C compiler for the build host, + and its default definition is derived in part from :term:`BUILD_PREFIX` + and :term:`BUILD_CC_ARCH`:: + + BUILD_CC = "${CCACHE}${BUILD_PREFIX}gcc ${BUILD_CC_ARCH}" + + When building a :ref:`ref-classes-native` recipe, :term:`CC` is set to the + value of this variable by default. + + The :term:`BUILD_CC` variable should not be set manually, and is rarely + used in recipes as :term:`CC` contains the appropriate value depending on + the context (native or target recipes). Exception be made for target + recipes that need to use the compiler from the build host at some point + during the build. + :term:`BUILD_CC_ARCH` Specifies the architecture-specific C compiler flags for the build host. By default, the value of :term:`BUILD_CC_ARCH` is empty. :term:`BUILD_CCLD` - Specifies the linker command to be used for the build host when the C - compiler is being used as the linker. By default, :term:`BUILD_CCLD` - points to GCC and passes as arguments the value of - :term:`BUILD_CC_ARCH`, assuming - :term:`BUILD_CC_ARCH` is set. + Specifies the :manpage:`linker ` command to be used for the build + host when the C compiler is being used as the linker, and its default + definition is derived in part from :term:`BUILD_PREFIX` and + :term:`BUILD_CC_ARCH`:: + + BUILD_CCLD = "${BUILD_PREFIX}gcc ${BUILD_CC_ARCH}" + + When building a :ref:`ref-classes-native` recipe, :term:`CCLD` is set to + the value of this variable by default. + + The :term:`BUILD_CCLD` variable should not be set manually, and is rarely + used in recipes as :term:`CCLD` contains the appropriate value depending on + the context (native or target recipes). Exception be made for target + recipes that need to use the :manpage:`linker ` from the build host + at some point during the build. :term:`BUILD_CFLAGS` Specifies the flags to pass to the C compiler when building for the - build host. When building in the ``-native`` context, + build host. When building a :ref:`ref-classes-native` recipe, :term:`CFLAGS` is set to the value of this variable by default. + :term:`BUILD_CPP` + Specifies the C preprocessor command (to both the C and the C++ compilers) + when building for the build host, and its default definition is derived in + part from :term:`BUILD_PREFIX` and :term:`BUILD_CC_ARCH`:: + + BUILD_CPP = "${BUILD_PREFIX}gcc ${BUILD_CC_ARCH} -E" + + When building a :ref:`ref-classes-native` recipe, :term:`CPP` is set to + the value of this variable by default. + + The :term:`BUILD_CPP` variable should not be set manually, and is rarely + used in recipes as :term:`CPP` contains the appropriate value depending on + the context (native or target recipes). Exception be made for target + recipes that need to use the preprocessor from the build host at some + point during the build. + :term:`BUILD_CPPFLAGS` Specifies the flags to pass to the C preprocessor (i.e. to both the C and the C++ compilers) when building for the build host. When building in the ``-native`` context, :term:`CPPFLAGS` is set to the value of this variable by default. + :term:`BUILD_CXX` + Specifies the architecture-specific C++ compiler for the build host, + and its default definition is derived in part from :term:`BUILD_PREFIX` + and :term:`BUILD_CC_ARCH`:: + + BUILD_CXX = "${CCACHE}${BUILD_PREFIX}g++ ${BUILD_CC_ARCH}" + + When building a :ref:`ref-classes-native` recipe, :term:`CXX` is set to + the value of this variable by default. + + The :term:`BUILD_CXX` variable should not be set manually, and is rarely + used in recipes as :term:`CXX` contains the appropriate value depending on + the context (native or target recipes). Exception be made for target + recipes that need to use the C++ compiler from the build host at some + point during the build. + :term:`BUILD_CXXFLAGS` Specifies the flags to pass to the C++ compiler when building for the - build host. When building in the ``-native`` context, + build host. When building a :ref:`ref-classes-native` recipe, :term:`CXXFLAGS` is set to the value of this variable by default. :term:`BUILD_FC` - Specifies the Fortran compiler command for the build host. By - default, :term:`BUILD_FC` points to Gfortran and passes as arguments the - value of :term:`BUILD_CC_ARCH`, assuming - :term:`BUILD_CC_ARCH` is set. + Specifies the Fortran compiler command for the build host, and its default + definition is derived in part from :term:`BUILD_PREFIX` and + :term:`BUILD_CC_ARCH`:: + + BUILD_FC = "${BUILD_PREFIX}gfortran ${BUILD_CC_ARCH}" + + When building a :ref:`ref-classes-native` recipe, :term:`FC` is set to the + value of this variable by default. + + The :term:`BUILD_FC` variable should not be set manually, and is rarely + used in recipes as :term:`FC` contains the appropriate value depending on + the context (native or target recipes). Exception be made for target + recipes that need to use the Fortran compiler from the build host at some + point during the build. :term:`BUILD_LD` - Specifies the linker command for the build host. By default, - :term:`BUILD_LD` points to the GNU linker (ld) and passes as arguments - the value of :term:`BUILD_LD_ARCH`, assuming - :term:`BUILD_LD_ARCH` is set. + Specifies the linker command for the build host, and its default + definition is derived in part from :term:`BUILD_PREFIX` and + :term:`BUILD_LD_ARCH`:: + + BUILD_LD = "${BUILD_PREFIX}ld ${BUILD_LD_ARCH}" + + When building a :ref:`ref-classes-native` recipe, :term:`LD` is set to the + value of this variable by default. + + The :term:`BUILD_LD` variable should not be set manually, and is rarely + used in recipes as :term:`LD` contains the appropriate value depending on + the context (native or target recipes). Exception be made for target + recipes that need to use the linker from the build host at some point + during the build. :term:`BUILD_LD_ARCH` Specifies architecture-specific linker flags for the build host. By @@ -1042,10 +1152,58 @@ system and gives an overview of their function and contents. :term:`BUILD_LDFLAGS` Specifies the flags to pass to the linker when building for the build - host. When building in the ``-native`` context, + host. When building a :ref:`ref-classes-native` recipe, :term:`LDFLAGS` is set to the value of this variable by default. + :term:`BUILD_NM` + Specifies the architecture-specific utility to list symbols from object + files for the build host, and its default definition is derived in part + from :term:`BUILD_PREFIX`:: + + BUILD_NM = "${BUILD_PREFIX}nm" + + When building a :ref:`ref-classes-native` recipe, :term:`NM` is set to the + value of this variable by default. + + The :term:`BUILD_NM` variable should not be set manually, and is rarely + used in recipes as :term:`NM` contains the appropriate value depending on + the context (native or target recipes). Exception be made for target + recipes that need to use the utility from the build host at some point + during the build. + + :term:`BUILD_OBJCOPY` + Specifies the architecture-specific utility to copy object files for the + build host, and its default definition is derived in part from + :term:`BUILD_PREFIX`:: + + BUILD_OBJCOPY = "${BUILD_PREFIX}objcopy" + + When building a :ref:`ref-classes-native` recipe, :term:`OBJCOPY` is set + to the value of this variable by default. + + The :term:`BUILD_OBJCOPY` variable should not be set manually, and is + rarely used in recipes as :term:`OBJCOPY` contains the appropriate value + depending on the context (native or target recipes). Exception be made for + target recipes that need to use the utility from the build host at some + point during the build. + + :term:`BUILD_OBJDUMP` + Specifies the architecture-specific utility to display object files + information for the build host, and its default definition is derived in + part from :term:`BUILD_PREFIX`:: + + BUILD_OBJDUMP = "${BUILD_PREFIX}objdump" + + When building a :ref:`ref-classes-native` recipe, :term:`OBJDUMP` is set + to the value of this variable by default. + + The :term:`BUILD_OBJDUMP` variable should not be set manually, and is + rarely used in recipes as :term:`OBJDUMP` contains the appropriate value + depending on the context (native or target recipes). Exception be made for + target recipes that need to use the utility from the build host at some + point during the build. + :term:`BUILD_OPTIMIZATION` Specifies the optimization flags passed to the C compiler when building for the build host or the SDK. The flags are passed through @@ -1066,11 +1224,53 @@ system and gives an overview of their function and contents. build system uses the :term:`BUILD_PREFIX` value to set the :term:`TARGET_PREFIX` when building for :ref:`ref-classes-native` recipes. + :term:`BUILD_RANLIB` + Specifies the architecture-specific utility to generate indexes for + archives for the build host, and its default definition is derived in part + from :term:`BUILD_PREFIX`:: + + BUILD_RANLIB = "${BUILD_PREFIX}ranlib -D" + + When building a :ref:`ref-classes-native` recipe, :term:`RANLIB` is set to + the value of this variable by default. + + The :term:`BUILD_RANLIB` variable should not be set manually, and is + rarely used in recipes as :term:`RANLIB` contains the appropriate value + depending on the context (native or target recipes). Exception be made for + target recipes that need to use the utility from the build host at some + point during the build. + + :term:`BUILD_READELF` + Specifies the architecture-specific utility to display information about + ELF files for the build host, and its default definition is derived in + part from :term:`BUILD_PREFIX`:: + + BUILD_READELF = "${BUILD_PREFIX}readelf" + + When building a :ref:`ref-classes-native` recipe, :term:`READELF` is set + to the value of this variable by default. + + The :term:`BUILD_READELF` variable should not be set manually, and is + rarely used in recipes as :term:`READELF` contains the appropriate value + depending on the context (native or target recipes). Exception be made for + target recipes that need to use the utility from the build host at some + point during the build. + :term:`BUILD_STRIP` - Specifies the command to be used to strip debugging symbols from - binaries produced for the build host. By default, :term:`BUILD_STRIP` - points to - ``${``\ :term:`BUILD_PREFIX`\ ``}strip``. + Specifies the command to be used to strip debugging symbols from binaries + produced for the build host, and its default definition is derived in part + from :term:`BUILD_PREFIX`:: + + BUILD_STRIP = "${BUILD_PREFIX}strip" + + When building a :ref:`ref-classes-native` recipe, :term:`STRIP` is set to + the value of this variable by default. + + The :term:`BUILD_STRIP` variable should not be set manually, and is + rarely used in recipes as :term:`STRIP` contains the appropriate value + depending on the context (native or target recipes). Exception be made for + target recipes that need to use the utility from the build host at some + point during the build. :term:`BUILD_SYS` Specifies the system, including the architecture and the operating @@ -1275,6 +1475,10 @@ system and gives an overview of their function and contents. :term:`CC` The minimal command and arguments used to run the C compiler. + :term:`CCLD` + The minimal command and arguments used to run the linker when the C + compiler is being used as the linker. + :term:`CFLAGS` Specifies the flags to pass to the C compiler. This variable is exported to an environment variable and thus made visible to the @@ -2819,6 +3023,9 @@ system and gives an overview of their function and contents. :term:`FAKEROOTNOENV` See :term:`bitbake:FAKEROOTNOENV` in the BitBake manual. + :term:`FC` + The minimal command and arguments used to run the Fortran compiler. + :term:`FEATURE_PACKAGES` Defines one or more packages to include in an image when a specific item is included in :term:`IMAGE_FEATURES`. @@ -7313,6 +7520,9 @@ system and gives an overview of their function and contents. ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" sections in the BitBake User Manual for additional information on tasks and dependencies. + :term:`READELF` + The minimal command and arguments to run :manpage:`readelf `. + :term:`RECIPE_MAINTAINER` This variable defines the name and e-mail address of the maintainer of a recipe. Such information can be used by human users submitted changes, From patchwork Thu Mar 27 09:07:29 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 60061 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 00089C36012 for ; Thu, 27 Mar 2025 09:07:57 +0000 (UTC) Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by mx.groups.io with SMTP id smtpd.web11.45526.1743066476971029091 for ; Thu, 27 Mar 2025 02:07:57 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=CsILpI/t; spf=pass (domain: bootlin.com, ip: 217.70.183.197, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 6ECB943302; Thu, 27 Mar 2025 09:07:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1743066475; 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=+7SwiEWIoo8wUDFc0c+x/qzLIq3n1fTEk8eu1b1OjEs=; b=CsILpI/tA7flpHSQrzLLb8LTh4A6xHl/ECaJGDyMefcvhM2qtW9ANAz2awpgR3umaOctvm zZ+AmX/q4M8jNQ5mIcsG7upFTYOG+XZ7XI+RDscz3eTjgdV5rQ+bzDz2QqnYUhhtqTYyud 3thvh09qhx2IdZpC/MMN1ney+Vr1tFqVd7Qs9P3o+qVmikULl4aZqvtyyAsNkItQ6kBue+ U1PeVmOEg98l39xS4Fnb+moLG8i8kuJY3RDdGlwt6umh0V0MOg2CquKVF2Czd3kGGgTQhn /HLzc8pVaCDUjxA+bnu3chQI4JTRerFFnVv45CtfeMsc4O3AIBXSgGIJK8vFqg== From: Antonin Godard Date: Thu, 27 Mar 2025 10:07:29 +0100 Subject: [PATCH v3 4/6] ref-manual/variables.rst: document missing SDK_*_ARCH variables MIME-Version: 1.0 Message-Id: <20250327-cc-vars-v3-4-742dbddce008@bootlin.com> References: <20250327-cc-vars-v3-0-742dbddce008@bootlin.com> In-Reply-To: <20250327-cc-vars-v3-0-742dbddce008@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard , Quentin Schulz X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=2227; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=hZgO6vQMUrR0WG9nf0JHcb0/1ZMY/FLRGqAnbs8ccRw=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn5RVpPXeu2g4bjeRezD+Jm4ISP/OA81oLawHDH /MWpjBRk52JAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+UVaQAKCRDRgEFAKaOo Nj+IEACVS04SWWwRuXK1bmYRb2VEdEyl2Y83C3D6i4hRaWTLqeBKj9O8qMo7zA9WTF59qRYZUAp ECHBLqFclKKM1jdOvufwrWZCxuUqr76HwQIEH6cayJPSblmc9uOurpkc8qN6PaYLJmfQU8Eb0Mb fUKDFoiSvqdIi0PqBa9cqh3Jpdx1832sXL2wb/0F7LbE/mUoalHbhNYdRLxc75sJZbzrIrcE5UV vNagt6yIRnqivfQ6JQSpxvC3dmp7MdWkg3Edl6SSxyYz9NeuMSgPM2ieWC3yME/UBtLyUG25Jtr BX0QiYp+1B9wv3GH2Uh7LKU9oOFndbIg0FxjV8K0gTLbhH0VhIhI7BwN+Th2Y/xyAwi129YkQdc g9rNrCnm5thMB/JcK5XOx1Jm88rEXZSj7/dMCGogkWUGHU+e0H3f2HaFmwtWmeuo4x3g00E/PpC 4OZzhGonXcNUFdn2ZcK9bzcYouvxHNKbVfHvmJeyn2W7X30n5Ej3PVQrCs931suo4DyrTl1uboN P9q2t6vN2IXrkPzRMJ/jCCKgOqLjeYO3I8uSXFaHnPygtm7Qj+Ed7CB3DNveMLH+DbRT84qAtg+ FYBZ/BtQRpKJ1Y2VDDu+NmuJBbbZmBnvOz0rDsfK+aj2zz65o+BAIfT6ypbzntO+TMAT4+nprPF AjMrfi6QwyjxS/w== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgdduieektddvucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepgedprhgtphhtthhopehquhgvnhhtihhnrdhstghhuhhliiestghhvghrrhihrdguvgdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhgpdhrtghpthhtoheprghnthhonhhinhdrghhouggrrhgusegsohhothhli hhnrdgtohhmpdhrtghpthhtohepthhhohhmrghsrdhpvghtrgiiiihonhhisegsohhothhlihhnrdgtohhm 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 ; Thu, 27 Mar 2025 09:07:57 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6650 These variables control the flags for the assembler, compiler and linker when building for nativesdk recipes. Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard --- documentation/ref-manual/variables.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 0516c1816..4cb416bd0 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -7920,11 +7920,21 @@ system and gives an overview of their function and contents. Only one archive type can be specified. + :term:`SDK_AS_ARCH` + Specifies architecture-specific assembler flags when building + :ref:`ref-classes-nativesdk` recipes. By default, the value of + :term:`SDK_AS_ARCH` equals the one of :term:`BUILD_AS_ARCH`. + :term:`SDK_BUILDINFO_FILE` When using the :ref:`ref-classes-image-buildinfo` class, specifies the file in the SDK to write the build information into. The default value is "``/buildinfo``". + :term:`SDK_CC_ARCH` + Specifies the architecture-specific C compiler flags when building + :ref:`ref-classes-nativesdk` recipes. By default, the value of + :term:`SDK_CC_ARCH` equals the one of :term:`BUILD_CC_ARCH`. + :term:`SDK_CUSTOM_TEMPLATECONF` When building the extensible SDK, if :term:`SDK_CUSTOM_TEMPLATECONF` is set to "1" and a ``conf/templateconf.cfg`` file exists in the :term:`Build Directory` @@ -8006,6 +8016,11 @@ system and gives an overview of their function and contents. :term:`SDK_EXT_TYPE` is set to "minimal", and defaults to "1" if :term:`SDK_EXT_TYPE` is set to "full". + :term:`SDK_LD_ARCH` + Specifies architecture-specific linker flags when building + :ref:`ref-classes-nativesdk` recipes. By default, the value of + :term:`SDK_LD_ARCH` equals the one of :term:`BUILD_LD_ARCH`. + :term:`SDK_NAME` The base name for SDK output files. The default value (as set in ``meta-poky/conf/distro/poky.conf``) is derived from the From patchwork Thu Mar 27 09:07:30 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 60060 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 0FC80C36017 for ; Thu, 27 Mar 2025 09:07:58 +0000 (UTC) Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by mx.groups.io with SMTP id smtpd.web10.45789.1743066477164818133 for ; Thu, 27 Mar 2025 02:07:57 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=mO7N7oAt; spf=pass (domain: bootlin.com, ip: 217.70.183.197, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id AC4E443305; Thu, 27 Mar 2025 09:07:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1743066475; 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=uT/EiwlgzbOvu4bJfcCn/bSJk8HwvX+ooobDaKTpAJU=; b=mO7N7oAtaA00RxkFSIBQZpEUe80zQJ+CRIDUfclSnu30/PXow0acANLK835jDrpffVrAlj 59ljHZUvF45P5xW65nTD3PYZPBEG2EFXVnBxpXtZ55NcdoPN8iBHFroJkM/L5UD1rfD3cF lQJ3Ik66JM+mZUqiwWF/CuPGFuLazrev/lpX0gYuXnIQg1FmdrCEZT+IYzaQlofeJOS/Ts L1mRscy9o3+nS7Qn1MXZszXN6ACv2KwRmjnMgBc+JM7wMPw8RLxsvlw9wChBup18iE6yVp ycij+jkf9fo7WKHPi3pe+nKqyvVWFAM319+w9uFDJUkveUiO0nicK8STJrHrJQ== From: Antonin Godard Date: Thu, 27 Mar 2025 10:07:30 +0100 Subject: [PATCH v3 5/6] ref-manual/variables.rst: document HOST_*_ARCH variables MIME-Version: 1.0 Message-Id: <20250327-cc-vars-v3-5-742dbddce008@bootlin.com> References: <20250327-cc-vars-v3-0-742dbddce008@bootlin.com> In-Reply-To: <20250327-cc-vars-v3-0-742dbddce008@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard , Quentin Schulz X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=2041; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=J1Vr4B5X5KceuASvfzYZGkvXTJZQms1lJPT7Dl41Ixc=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn5RVpLtKlWCYDdFpasMLamzpzNRqB2kLgQKe1z uG22BsY9dyJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+UVaQAKCRDRgEFAKaOo NhMqD/9IgPEPHSZeWc70xA/KNF1Awx2M4JKWaQDDtAUyrYOeBeFE6H+Obrwy9bQNBGsqrmAETqE 1weZjAiQvUikIO6rxKKex+0wQnGKhk3l4FaiNc2q50JmguRQF9dd8K4yWN1xS+QxSkWBdZgFR5M XYHKBnfmWB7As+k1Bya5lkGC3lcZxgrkXxDgEE3KVLjl0m3dj99PN7lfZM2ezOhmU+IRJtBCTrG KRlYoPNCnVqlKvmwqwIl1wbsoajuup+OQ6fLyhbExUjW7rFwtOtJLvdf2LTf+xfbPZrclHUpVpf WlDemAPy8Rstd7ytYg3UFVAU7KOFysA+LXhW0l7/UP6KfKB90ShUv38RMEQEyW7Nv3q1qiy1EA/ 9g6JTPLdDxUBuvYynYUM/rB+Uv3ZjTzCUJG5ydyuWTkpl7RQSsGTsBT6FOif/9IMUKPiv5VOX+u +++ijBpiz10nKjkwGK8mw+vmC1YcyePZOMnl1K+1ueBYIwvpTIdoejaMSGuYP6gAjlRjKM4Jxai cVgkp0D9QPYkXFcS/dlw7p/s0RKs3RMfQRm3ZYInpCvDJ8WhIgFdyWlpIAOTYJ9sn6s+D1jsYpW z3gkyHFVkFNw6P/gMmt66KTvws1TutMTq6irrBis2K5Rr2nO631fFCZEGnA6K97PHfzDb7kOSCW on1oxriLlziY3aA== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgdduieektddvucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepgedprhgtphhtthhopehquhgvnhhtihhnrdhstghhuhhliiestghhvghrrhihrdguvgdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhgpdhrtghpthhtoheprghnthhonhhinhdrghhouggrrhgusegsohhothhli hhnrdgtohhmpdhrtghpthhtohepthhhohhmrghsrdhpvghtrgiiiihonhhisegsohhothhlihhnrdgtohhm 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 ; Thu, 27 Mar 2025 09:07:58 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6651 These variables control the flags for the assembler, compiler and linker, but depend on the context. Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard --- documentation/ref-manual/variables.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 4cb416bd0..c3ed1a106 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3673,6 +3673,20 @@ system and gives an overview of their function and contents. - mips - mipsel + :term:`HOST_AS_ARCH` + Specifies architecture-specific assembler flags. + + Default initialization for :term:`HOST_AS_ARCH` varies depending on what + is being built: + + - :term:`TARGET_AS_ARCH` when building for the + target + + - :term:`BUILD_AS_ARCH` when building for the build host (i.e. + ``-native``) + + - :term:`SDK_AS_ARCH` when building for an SDK (i.e. ``nativesdk-``) + :term:`HOST_CC_ARCH` Specifies architecture-specific compiler flags that are passed to the C compiler. @@ -3689,6 +3703,19 @@ system and gives an overview of their function and contents. - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e. ``nativesdk-``) + :term:`HOST_LD_ARCH` + Specifies architecture-specific linker flags. + + Default initialization for :term:`HOST_LD_ARCH` varies depending on what + is being built: + + - :term:`TARGET_LD_ARCH` when building for the target + + - :term:`BUILD_LD_ARCH` when building for the build host (i.e. + ``-native``) + + - :term:`SDK_LD_ARCH` when building for an SDK (i.e. ``nativesdk-``) + :term:`HOST_OS` Specifies the name of the target operating system, which is normally the same as the :term:`TARGET_OS`. The variable can From patchwork Thu Mar 27 09:07:31 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 60062 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 0F41FC36014 for ; Thu, 27 Mar 2025 09:07:58 +0000 (UTC) Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by mx.groups.io with SMTP id smtpd.web11.45527.1743066477427589820 for ; Thu, 27 Mar 2025 02:07:57 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=ETXMh1o7; spf=pass (domain: bootlin.com, ip: 217.70.183.197, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id E59AB432FB; Thu, 27 Mar 2025 09:07:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1743066476; 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=hGXF7rNfO0dq9z3gY0ip3d3ZRvCLdoGpY1yEEVdI9l4=; b=ETXMh1o7iO9w1IRNVUvzN8NJSz8vg43d/lCdqBTK5gpgv1CGxlKAsyRJ+JzlrCPhEtv0an QoXg9oNz8WQjboCI8nqJQDI+IjRz/LTWNIbwIB7KYys7ecOdfkGeVP1Uv5CLSIewf7Zgre fjUrvUruW0qMbFI/Z5LwHu80lChP0Rcnv5NJ2lwZ37HVxiFGB+cYChu5IIqOdKSEl1rie+ jJzwL6tPp6CaPR7xo7CT81Q9nAf8aYTnn7CdPNY8MDeqnBPbSrWFuZF6phA5Lk2hUp0qUB qjmnWe9d8Xjn1d8jdwOflTE4ZBmAi6EfSfk7vhzG5UOnEh7PdkXDjBgtsFkw+w== From: Antonin Godard Date: Thu, 27 Mar 2025 10:07:31 +0100 Subject: [PATCH v3 6/6] ref-manual/variables.rst: HOST_CC_ARCH: fix wrong SDK reference MIME-Version: 1.0 Message-Id: <20250327-cc-vars-v3-6-742dbddce008@bootlin.com> References: <20250327-cc-vars-v3-0-742dbddce008@bootlin.com> In-Reply-To: <20250327-cc-vars-v3-0-742dbddce008@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard , Quentin Schulz X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=1007; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=tSUOJPK1aKpFp/pQ8ZXRZoYk8/kGk1Y1NEoaH1Qp9zQ=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn5RVqWNo5RhF6Ei9NXEdybz0bf0z117rlbvuot cxv0QiOkISJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+UVagAKCRDRgEFAKaOo NiDWD/94OpE7xOrH9OCaJEg3WV2pIqVkb49mUAlOOPsTbETXXs/FrkEmEDrnWcqdGf/KWM/c8No GJ70lPZ1i7+skctBvVFkmipb8CxEcsXE804DzKJ9Uc5TvaU/3l2B3dJ3GQvKciLHHo75o/o1bDr O1BvNfohPs33/z+druPIzwOcrRAHdawDmTK43ITtyuffZDrd6gnXk7ar2GCthANBT7AFmA1z5Tt HmxoP0muMZjA7jQQSFVKNYGGVcwTvRaCycKQ9OXthSTeSVxL8Kdbja2tC5eoS3fKnEKqzISsSc9 lA/dMQ/Nij3l7f+SWsHoDN2NSJ4078xYa6avKZUpsOXnRenTAZaoUYEYcXJF+y3wbpR63l8UQ+S vHK8GtLE6xxM+ZKzxkU5UOhVIw7VaXm+TXMhPEaNF1kCDAKZyW41tRou6BbPTRPgaWqyge6sfqi dgWypBcrlLPIB5t+bGvc2p6IhieRkyIEK5kIyg9PqTn3hD8FsQeKTkPeAYqE8nB6+tCBuEMykMf 07Rx/J+bAelxuEJ/09yvCHXdsp5oHiUwgcYphUyryXmln3fRlb6QhpL96S0/iq00ZJHqxIjA8dK E4C3cVm87luSzSoS4yqqXf14p3SBfbA1SLe7W2H+9UzFLmBkyoo4W9Z09hUSvAqLA9Z0JfLVWL5 nAy2sWUpFgMVb/g== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgdduieektddvucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgepgeenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepgedprhgtphhtthhopehquhgvnhhtihhnrdhstghhuhhliiestghhvghrrhihrdguvgdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhgpdhrtghpthhtoheprghnthhonhhinhdrghhouggrrhgusegsohhothhli hhnrdgtohhmpdhrtghpthhtohepthhhohhmrghsrdhpvghtrgiiiihonhhisegsohhothhlihhnrdgtohhm 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 ; Thu, 27 Mar 2025 09:07:58 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6652 When building for nativesdk recipes, HOST_CC_ARCH equals SDK_CC_ARCH, not BUILDSDK_CC_ARCH which doesn't exist. Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard --- documentation/ref-manual/variables.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c3ed1a106..65dac9aa9 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3700,8 +3700,7 @@ system and gives an overview of their function and contents. - :term:`BUILD_CC_ARCH` when building for the build host (i.e. ``-native``) - - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e. - ``nativesdk-``) + - :term:`SDK_CC_ARCH` when building for an SDK (i.e. ``nativesdk-``) :term:`HOST_LD_ARCH` Specifies architecture-specific linker flags.