From patchwork Wed Mar 26 13:21:37 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 59985 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 676D9C36008 for ; Wed, 26 Mar 2025 13:21:49 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web10.22220.1742995308324041803 for ; Wed, 26 Mar 2025 06:21:48 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=MOLfCTft; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 855684439E; Wed, 26 Mar 2025 13:21:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1742995306; 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=sS6U9MEnT44zlUTMQyVlRRKE4T9nOHlGLritS48BEKg=; b=MOLfCTftk7mNmQySWqlO2xNgGHI5H4gVjb0CAQdHNUiCIjDfSkfA5UtW8vpwwS74yjx4HY HC8mbR4rvQk8qO3bvNxBGFJ95v0BZeHBfPkQxQMdUeUqsiP8CaUCuciIzlTs79ycUniND1 mq7EMMCDOjd3zTmt1jnpsE2PObpk891fO9kA8vhls22M6HoYidooCUaYiA8oSUzS9S1qa7 JbwBlkJ9xGAA8I84/EDXMEMJkCAtVJ8zCRYNWPaV03+z4KOVLnBa6V+QTX7U5g6f7FiZNO NPc+czcCSTpcFyCb0uTsdP3H0VKKKVM7MR/q5kPhhhOo/8jhF1i7nqsSR+1sQw== From: Antonin Godard Date: Wed, 26 Mar 2025 14:21:37 +0100 Subject: [PATCH v2 1/6] documentation/conf.py: define a manpage url MIME-Version: 1.0 Message-Id: <20250326-cc-vars-v2-1-36b80c64c4a9@bootlin.com> References: <20250326-cc-vars-v2-0-36b80c64c4a9@bootlin.com> In-Reply-To: <20250326-cc-vars-v2-0-36b80c64c4a9@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=3257; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=7WfuX7NTeotdljywjB/zvpXh6XjKJYX+VXJyWzB8i9c=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn4/9pqYKLHPgr51qioIKT/xcKgDrlheHT5RMaK 7iyDpYKikuJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+P/aQAKCRDRgEFAKaOo NnuHEACxvkoEZULK5tJiPeLN6CfXQqYkgzH0w44OvFsjc6ZNhhQ9hNMp4Y0i/fAklqkCchY3FA+ 2XXpTOMfERQ8vjkjmcWrS9js3F5BSTk7ItZWY9JgJZgHzLV0izaisFwU7VE57CNl9ZCXYp8PGPk StOZei7P47SlD3nCgn7gKgzVbk57xDb7cN9rQU1jS10QcZrSSVrpQnaJJx39ouPQdAZYJlCbnlM 9jwH14Ur39P6RNsxNcxd4WCO3IYNSaVE6Yf1udD4A0P0hPy6iOx2CmZ+DIdtwML8rujgWcfe9EU xrbbfDWKb4Zw89Ae5Kj4m5zHW/Kp58lRXmQPk+/rQ8PBM4Lka8MzcG2ti40zsctk1eFL8iXuhjJ ve1CQM6F8DHsModc3vvNIoBaSQGT/zuwiq/JEF5J06Eq7jY3CDYGvXFvNSDLTZPoTWsqqTlQBLI QlfirNxqCD2Irb9K16eUlQy0kesemoU2Z6VhdxGfRv9UYDUHW+ORWHedz08myIqUxJ340uwUD+K GgnEibN4xiCSJmunYtd2LSgalnsQ/0NHnYYFU20PPRPDH1tfc0ikhpRJWwdPecld9ZvArKBI0Wv LwjRClbONtDI++ES/ufl/5KZu7kICjQ9oppm/XnfHxIvH5g8uN5F19k2axwkq1Ppy0zc7TS7j2v 3EwytY5AOtQ2rlw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgdduieehieefucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpedtteeuheejgfdtfeekteehueeugfejgedvleehieelteefkeegjeelueeugeelveenucffohhmrghinhepshhphhhinhigqdguohgtrdhorhhgpdifihhkihhpvgguihgrrdhorhhgpdguvggsihgrnhdrohhrghdphihotghtohhprhhojhgvtghtrdhorhhgpdhhvgdrnhgvthenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepfedprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugess ghoohhtlhhinhdrtghomhdprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtlhhinhdrtghomhdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhg X-GND-Sasl: antonin.godard@bootlin.com List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 26 Mar 2025 13:21:49 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6635 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 --- documentation/conf.py | 3 +++ documentation/overview-manual/concepts.rst | 2 +- documentation/overview-manual/yp-intro.rst | 2 +- documentation/ref-manual/variables.rst | 3 +-- 4 files changed, 6 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..25cac82816 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..d3037329d3 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..2b31bc7b00 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -4514,8 +4514,7 @@ 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 Wed Mar 26 13:21:38 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 59982 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 6B8B5C3600C for ; Wed, 26 Mar 2025 13:21:49 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web11.22292.1742995308282294687 for ; Wed, 26 Mar 2025 06:21:48 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=JD4UjUIK; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id B312B443A1; Wed, 26 Mar 2025 13:21:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1742995306; 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=vyGdM6qZn6gQJbInVdjoLmKXQ7RHZ+HlH9KFtfydELE=; b=JD4UjUIK2DkFUF5iwba5q+IesiAouM4d8dZfot5Kt5XE9Jop7yxPwCqn4ttZib9aCxvy8K DhXVYG/xILtnNe8blJgP/6sKYHcueSOMiOwIeNWypmzFT85XVOqsPfOKsKHqRiPDx4+6rc kos7WD06fEckaZSH6ScDiVHHHKNoFP0xDUSFs5opL/Lz7XH7Fxlt/rSbRXkx9+HlYCXOgs ugxZ6UUFnnmucXTdKqXYo2EgDfD2xITrMclx32TTsXx22qM6xJixIrh2HDjTxi8hHIVqAc zHnltR1aJpabKfvZenJf+rJ0oWP5KMOFFIKfc7HT47d7F3UCLlD1fJ4Rl69ynA== From: Antonin Godard Date: Wed, 26 Mar 2025 14:21:38 +0100 Subject: [PATCH v2 2/6] ref-manual/variables.rst: add manpage links for toolchain variables MIME-Version: 1.0 Message-Id: <20250326-cc-vars-v2-2-36b80c64c4a9@bootlin.com> References: <20250326-cc-vars-v2-0-36b80c64c4a9@bootlin.com> In-Reply-To: <20250326-cc-vars-v2-0-36b80c64c4a9@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=3525; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=/SOAnkBBzSRLjr2cDfp6WCzPbx0bsOlaW9OXtQoAZdc=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn4/9p5NHtU/hQ4Z4P+fxnsC1BeaTTVcncWspzD eV4lnZGVUiJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+P/aQAKCRDRgEFAKaOo NuiIEACJGvFvfPl43fZX790TN++gTfrtrioM9sXfC/xTPhv2p/WcX9JSTtiH9p7Au/A2dUZK3GK K2+16aweFLI7PvmOnEunHhSq7SeY4ushS5FVRCSWih/d7pugzBHGMaivlAr9iUEtUVG2Di7cZmy 11TLej7uiAdrSnOP946S+nEbVwHfHSD8a0kkABR3eJN2MYjPbqrypoTe2COPD1rGKKx1Mcv40g3 md7OkijSAgJTIHpw7HkpQv9K5rF2CHk3EOZxScGZpv0tgxGW4lvc7uouXDw0FAErTojsY6Tgj9/ dXVrw9Fc8/4ITnJjDWbYuYpucwHdvL/3N6k5L8MKAhZddaOquosLiBN/iZ7stjQUU9K5ZZwXuv3 F+JiTOFAlQILU3EpJDovWNgYDeUHjsblNQrDz4pGV+hSCIwEBXx/r7uMnyELTufRfcJG0ApIu/C rqs8HN6toNdIo8UmII9b9UYFYIzmvp5uohGUS8F7PSB6e5fiSzR+fje+/06Ck9j8ihcSAfH1VCJ WmrHXMEtBA8hHi3prmi0GKgDh2/bOONnKjwPMt28wI7vd9v3d9EluaVo5wQRH+iDqGFxXOKvyvk JjSUDxp/H3r72w4TV1BO2IO0L/mmgtLhla+VEUIG5R0RgxA3D8kg/6iQciqhnPfz3XjJgMs3rik 6lJJK8maO7E7npw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgdduieehieefucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepfedprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtlhhinhdrtghomhdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhpr hhojhgvtghtrdhorhhg X-GND-Sasl: antonin.godard@bootlin.com List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 26 Mar 2025 13:21:49 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6636 Use the :manpage: role to provide links to common toolchain utilities. Signed-off-by: Antonin Godard --- documentation/ref-manual/variables.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 2b31bc7b0..ccb4e0de2 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,7 @@ 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 @@ -5164,7 +5164,7 @@ 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 @@ -5770,7 +5770,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 @@ -5859,10 +5859,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, @@ -7173,7 +7173,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 @@ -8913,8 +8913,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 Wed Mar 26 13:21:39 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 59986 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 801EAC3600B for ; Wed, 26 Mar 2025 13:21:49 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web11.22293.1742995308328763008 for ; Wed, 26 Mar 2025 06:21:48 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=OHIqYekL; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id E7C81443A3; Wed, 26 Mar 2025 13:21:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1742995307; 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=ENmcXhIli8klya6xCEOdRxNaYpMmBzPunolZwxhZv+g=; b=OHIqYekLlVmW05sP4z+7ktNe8sinPd+O1v+sw1xop0v4606cqsUbMRzAzCJohEXqPOR10w 7rGAxF/J59tV87dFqp0kmCYAcBMXAbKTb33Fp41YLod4bS6fnRbs2thzuHPG8CfsLwOGnI +gZCc8ATwlID/EeMHPwhxdsvFUXxE635fg++u/0XBjmQabuNmt6MuI/9+gbVEFOQ+OUFe2 wBTtK7x22EkZzBG20+F9p4qtcmaTb9omTNVB3aGRbR0YP7UwSxXLQrwU2IwSrX07OLC+hr tj9pgpwDUA5xTX1IaZ926ZBvm/h1N5t3Z3JXMfCs9nicf/amJOee1Q577YcxMw== From: Antonin Godard Date: Wed, 26 Mar 2025 14:21:39 +0100 Subject: [PATCH v2 3/6] ref-manual/variables.rst: add missing documentation for BUILD_* variables MIME-Version: 1.0 Message-Id: <20250326-cc-vars-v2-3-36b80c64c4a9@bootlin.com> References: <20250326-cc-vars-v2-0-36b80c64c4a9@bootlin.com> In-Reply-To: <20250326-cc-vars-v2-0-36b80c64c4a9@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=14649; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=/Lg5fkuPowsYcQrOSjGWBM/MPA9KDqc5I3e3c+8TdXY=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn4/9pHl8Y18rNs0CJwBGzxXTzUBobZFUYrEkt3 09UVk69C1CJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+P/aQAKCRDRgEFAKaOo NhNREADLX74of0CmAMtas9piaU+soK421E6VGDnXDUNw8RPBVlO7zvClcsAGLIF4gEqthE0WEBf jky0unahIwM9dRDCoP2JAe/LTFSEd0gVGCtVQ6EsT/XshDgjBgheTqe7bNiXFiQcPfoLxr6uq5s 3A7mLhGxjMHtDrUjefK5v6I+/Mlyem0BxPoywbDv3JQfc6tJ3NkA+rJ9R5U8XAiVIKP98yMIWHg nBAq9I+a3gbNyHVlgWSxalXhSBBdDIXNKl30dxJfftn6LZkYnXVTt2S1QEXCZuqRkZ5L7jU4hhT uOwjkirr318awiaTARAp1jqIbA4F5MKldOR2mbh6GdnOuHljGJahgknYf5LEhodTuMDuNnpKwPt qVnIsm6eSEjkiP2MI46msx9BrE6A5lh8qg9xYf35KQZHT+2TDq8X3CIfXK9849omE+SMaln9Txi W73YG4H5hsCtyM5HVKIGEJpLn0xBo0igUiLejLARUEQXyzSAR1FD7ND6Bs9ZY7aQd9CbnYqz/th 4/NlooJe4WN/rHelz51ImxK1fFnGTi4LwknFhcdVw57qrIk255sh50KfQLeNT4biHNj0+f6iL4s 0mKjG7wjI0eIiX0RD6Qu+IDFC2aj9/YTuSPvgz7kR7LMk6ji6gXzSSfnGIN3E8/DLppTz9E9Vxe panKDWWLh8gBAmA== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgdduieehieefucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgepudenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepfedprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtlhhinhdrtghomhdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhpr hhojhgvtghtrdhorhhg X-GND-Sasl: antonin.godard@bootlin.com List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 26 Mar 2025 13:21:49 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6637 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 --- documentation/ref-manual/variables.rst | 222 ++++++++++++++++++++++++++++++--- 1 file changed, 202 insertions(+), 20 deletions(-) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index ccb4e0de2..9ee63622f 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -985,55 +985,149 @@ 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 should not + be used in recipes directly since :term:`AR` will hold the correct value + depending on the context. + :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 should not + be used in recipes directly since :term:`AS` will hold the correct value + depending on the context. + :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 should not + be used in recipes directly since :term:`CC` will hold the correct value + depending on the context. + :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 should not + be used in recipes directly since :term:`CCLD` will hold the correct value + depending on the context. :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 should not + be used in recipes directly since :term:`CPP` will hold the correct value + depending on the context. + :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 should not + be used in recipes directly since :term:`CXX` will hold the correct value + depending on the context. + :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 should not + be used in recipes directly since :term:`FC` will hold the correct value + depending on the context. :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 should not + be used in recipes directly since :term:`LD` will hold the correct value + depending on the context. :term:`BUILD_LD_ARCH` Specifies architecture-specific linker flags for the build host. By @@ -1041,10 +1135,52 @@ 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 should not + be used in recipes directly since :term:`NM` will hold the correct value + depending on the context. + + :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 should + not be used in recipes directly since :term:`OBJCOPY` will hold the + correct value depending on the context. + + :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 should + not be used in recipes directly since :term:`OBJDUMP` will hold the + correct value depending on the context. + :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 @@ -1065,11 +1201,47 @@ 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 should + not be used in recipes directly since :term:`RANLIB` will hold the correct + value depending on the context. + + :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 should + not be used in recipes directly since :term:`READELF` will hold the + correct value depending on the context. + :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 should + not be used in recipes directly since :term:`STRIP` will hold the correct + value depending on the context. :term:`BUILD_SYS` Specifies the system, including the architecture and the operating @@ -1274,6 +1446,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 @@ -2818,6 +2994,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`. @@ -7310,6 +7489,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 Wed Mar 26 13:21:40 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 59983 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 83424C36013 for ; Wed, 26 Mar 2025 13:21:49 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web10.22221.1742995308617551658 for ; Wed, 26 Mar 2025 06:21:48 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=RjHRQkcV; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 2D813443A0; Wed, 26 Mar 2025 13:21:47 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1742995307; 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=TUMYDs7i7zLexU5JMnXD3N/6axu8HTkzvSYB7DSLQXA=; b=RjHRQkcVA1tDeB7jJ4LMy8tCUK8yyqPnJOMYjfAjwDAPid1f6uE6r0V6lo0H34NvkqYfB7 CsPYKBNc73FI8sb5YMPLTAuhgjMBpIFgRT/5E4Pmbzx0ZqRkzEi0znm+RzfykSQ0401dqY Qog/JbgwU0dDzmUM2jtOvoVXfAl6IiU03lWBKTMpnKBNjPRbACTkfydzSbXZotzJwuv8Xy KKfcLN4aoyCPOo7VrsBq1i9WNlsQwkCM6HoQuwBxM+O5UzGlNZM8PsyGE7UiXQUNuP8UGd HwuAszugIrAWbqLioKhRysQ2iz4dj/ArPzcPunDAW45wk52TJuhK2PL9zmxrQw== From: Antonin Godard Date: Wed, 26 Mar 2025 14:21:40 +0100 Subject: [PATCH v2 4/6] ref-manual/variables.rst: document missing SDK_*_ARCH variables MIME-Version: 1.0 Message-Id: <20250326-cc-vars-v2-4-36b80c64c4a9@bootlin.com> References: <20250326-cc-vars-v2-0-36b80c64c4a9@bootlin.com> In-Reply-To: <20250326-cc-vars-v2-0-36b80c64c4a9@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=2171; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=D8XMaY5cr7BGmks0BZCKbwxlWoeTnAd44MEC4knkKYY=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn4/9pcTmiybXArBywQmE70gt2bRrBgjiH44Pi9 7XYJysnVMiJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+P/aQAKCRDRgEFAKaOo NtcxD/0WI/VYoVeHA3S0UUGY3IpLqSL5/yMEDfsZ+ae8iYivRBmUuNA9Ff4JzBUH3Rt38f2sbG8 K67KnSoQvIZfksCW+lQak2d2/r2SiLLQLldqrTmKux4vf8AEGak51d3pHPcKoC1nkmDU/zcUVAH sb9x8q7olFY6BpqU5goYIfAhoSiTlFnvSPZYheUtGymbG5jrGDb8fALCjv6owJY13jujo1ylW2f xBZwFB21Q8Nqn8Yc1iOar/8ER3qNz/dl3vhxbMR/Vxr05lE2nxJ6RVSz+DHJTxU/HaWcsInuwNd iBkP1nZn2uRGyuQE3yhzLUgEFj6q58ORol58fk4QHE6UL7zfE73J8PX3XN6T6Z+mAjjM2I5RfED 3xG+SZ4SBnxFsZwplebBUDrlkYBVoGGJCQoH4hrCuAz/UwWverAb4VVVY5IZoQWH8KlZnsKz7JI 4U35mDIsJbTVZJcXvof7cQ7rc3shxRhcbU/+mYuDxjqI7miyPHP5/r/YJxgU7+0EX+XP9sychfO VfA0NmX72yAyi0/qb6GD+4/AalWSrpjFhop5HXWNqPK0rGI/io/8jAxSk9R6w4o+o5vsrfVIbhN rZfKEP7aBVKV8kbXBGJKlC2f9x6GPM8xOQVO3S7Diy9T+K8Ga+zhakPyc4b2NJ5smRYKzNpWX/N bHaTYeWITbhnhnw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgdduieehieegucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepfedprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtlhhinhdrtghomhdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhpr hhojhgvtghtrdhorhhg X-GND-Sasl: antonin.godard@bootlin.com List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 26 Mar 2025 13:21:49 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6638 These variables control the flags for the assembler, compiler and linker when building for nativesdk recipes. Signed-off-by: Antonin Godard Reviewed-by: Quentin Schulz --- 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 9ee63622f..2e57685ac 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -7889,11 +7889,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` @@ -7975,6 +7985,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 Wed Mar 26 13:21:41 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 59984 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 8DDA5C36012 for ; Wed, 26 Mar 2025 13:21:49 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web11.22294.1742995308823696375 for ; Wed, 26 Mar 2025 06:21:49 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=pQGBosFc; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 635CF443A4; Wed, 26 Mar 2025 13:21:47 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1742995307; 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=4x+KkDtN3au+IlyXf7HI/GTJe3Cm3Yct8Q9Va9lzoaM=; b=pQGBosFcyx5qaAlCznRWV5d3TCQT0IqbcDClvfuTfTnGnY20dx3Li7jE3vtHsrLCUHi6HC qu6Bx+Nx5jWlLYvFZ/yH2pBU/P9pmiUIyOagZlwN3kilkub4xxUyWHyNe/BKKODFLP5Pqm cfiSYp/vC/NeAqJ9OxwPQGkIy5FF0y5/ImrrDgWPpp3P7Ca9RlEU60yeDqGwBuVhl1f5/R ficEyg/IQKangdFZj7x7mj0WkNwoIFj8b4vGXn5OJXN/rZRATeBlGWCIhMJbJKY+a6yoHw Lyi7aWXDYVaQRRg2UGE6gplMvEDmb3GKqEM5sl7Nf2L+vK5hSyfrjot4k50nPA== From: Antonin Godard Date: Wed, 26 Mar 2025 14:21:41 +0100 Subject: [PATCH v2 5/6] ref-manual/variables.rst: document HOST_*_ARCH variables MIME-Version: 1.0 Message-Id: <20250326-cc-vars-v2-5-36b80c64c4a9@bootlin.com> References: <20250326-cc-vars-v2-0-36b80c64c4a9@bootlin.com> In-Reply-To: <20250326-cc-vars-v2-0-36b80c64c4a9@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=mZAfn+aFuTLIC1VNC+Q3Gpi6AOTF5mVvGJWo7Ui/1eA=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn4/9plcfLKo4Fpe4CmRSeTbaeYBA3vHBnSCacH gBkJQzMMdGJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+P/aQAKCRDRgEFAKaOo Np23D/92jSXq8dPJvFIQ+HVpm3PL1jy96/BHIReoo+72XWO3meD6WwnQ/3UmTwRjjSf+HPaqe7O A2z814NmomMos7/PU61GQyjULW5bsu2D1SmAPnM4iK53BcHXNbWwFU/87WL1IOy1SCTas+ugbQg SjyYoZ9B0Mn+3Bsj2lmStNre0QgvJUZ+bhlYk6b/bg2ZLCY9nDOW/J7Gx3Y2s8dw3hLC2zFaXqz 1C4uEubdbpg8dnhCXdJuMgHFXWIZ7MNQnVI2x1d+7CM4qjeqEBr8RMOissDiAl/XWX4Wh0e94D9 m3rQNIWPUluCj/U3UwjD5QTyRBOhTEnff3z3kEP8NsjSh2diLzUoaX6M/v27QqNuX/SESDyrTqS 4bLnSWp0uIMxxmMlA5OI4e75Pk4/Q/a/Scyb7Mr4n5wivst/fg2InTBqagakEsVl14ITgOj0WPb GHHlXrDSsxwUn0rcEswg8OQwqgkTzbCmUVF5VnDXE8/8ERl7orV6J2qnsuPP95b59+A4dgrjZRw tgquBst5atDP/+XSqQ7Go79O0v6tMYOmw9zBJ8kaXLidr/Tl7i91LMYp+SDIO9Pij4pgOJOAJg0 /3JS/4zYs+Ew5uB/ThUY9iY1U+7Mzs5i1uJ68L4nGrULo0Cv+6/9xfAZ5jYe5b2bEhcZK4zizHq Obsr9C1uOKUtW+w== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgdduieehieegucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepgedprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdprhgtphhtthhopehquhgvnhhtihhnrdhstghhuhhliiestghhvghrrhihrdguvgdprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtl hhinhdrtghomhdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhg X-GND-Sasl: antonin.godard@bootlin.com List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 26 Mar 2025 13:21:49 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6639 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 2e57685ac..b7c5ddf1c 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3644,6 +3644,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. @@ -3660,6 +3674,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 Wed Mar 26 13:21:42 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 59987 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 7CE55C36008 for ; Wed, 26 Mar 2025 13:21:59 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web10.22222.1742995309122656634 for ; Wed, 26 Mar 2025 06:21:49 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=F/8LD+Zx; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 9A4ED443A7; Wed, 26 Mar 2025 13:21:47 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1742995307; 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=+bHrYLLbRlYtLhSKqX1HEiur/MxOO6T2JunHuoJlsR0=; b=F/8LD+ZxYXf1vmh97P4Jd3mKcxORjxFLhjj/BCyPnxAoVp7D52FLmTL7qkdnUjP8YA9LZN 3T+LTJ4OrkQzk7sbwdFpy5sT0oh4AzjQz4hMH/evI1x+oidOtw8dO0hK6zz9u7nXcCsECF rtSImTyQ9FygECxuG6iKOhpuNwfJ+0LAkhkygZKPOsg0i07SNAemZdJUtsCSleJ5mx73ib OeJn8CZz8hEE9GLW65vrdYhNcE8ruX0IeSYANYbgOqfTQRw778MoD4aHRL5dQMAiPLYrtj +E675SYpq9hVsnAx+i5e/fhTeNGT87hjZK2Ao9dI08zf5g8NLwU3VZnYpbSq7Q== From: Antonin Godard Date: Wed, 26 Mar 2025 14:21:42 +0100 Subject: [PATCH v2 6/6] ref-manual/variables.rst: HOST_CC_ARCH: fix wrong SDK reference MIME-Version: 1.0 Message-Id: <20250326-cc-vars-v2-6-36b80c64c4a9@bootlin.com> References: <20250326-cc-vars-v2-0-36b80c64c4a9@bootlin.com> In-Reply-To: <20250326-cc-vars-v2-0-36b80c64c4a9@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=cjHHvb93u6gS7PKhlzVHN5pQOMb5bNxecPGpXmApPwE=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn4/9psG89omd5BB19u07FePF6kNUb30buTC9fy 1vm0lKPOPOJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+P/aQAKCRDRgEFAKaOo Np6BEADMgdbJL7nEnfwkWkyz2r0+EBGo5Qo0f/9/5R7ufAq63pUL2vKSWRZdquCtbDRW6Fk5zwZ ko05rYyXbRlcerZ+uara1Qo3XP17PMQd740WZ27UgOtOQcoe839H6hUrsrsBSskwckRiyCWZ4zl g0pH/jWCKbfhB/iCn2Y/RTPUuRtjtSWxvmti4QoBKm7N6AJz3wTIS1NAAw58s10e3PESgo/ebsc EksKsW3dzfPCrFMiKoKVTWpyab7E37Goez/ve5MUD1RJQ75qYIxi0QbJvzEvWDhGtwmTaz2rLcL z/Fe191SbHRUHQ4oST3FUibsv5aMDDNVhfsAnoXmilKoNDjOldGsT8GhQNcxwrX8Crv2UVyF7kb hoR4KQKGBUAAyBiDtHBPV8ORlwmLK6DnMBbwYhcoe46w+AhL/T4ZNH+NNzMjMAlc8HEhdoQH1j4 Tvm1C/vWYvHgSJK+KA9HVS+JA1QzAJ2gPjNSfURlT5IAoVGb4x2VZWAL7i105Y6QPqYeCAhGZ/g PXXU/Cyf2PjERQSs0m1Ywg7/ddel3C6OmO3CKEKkG+fxwGXoHXQ8EObFRL01uzwUj+qL7K/gfVE FUWs9+6FxwpHicZaILRavXlyeCaeNWXCbyO2aHdWj2DSjUON2clr7SO8/iu3VwHTfKOb34C8Pjx Blst7NTisAXwaVw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgdduieehieegucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepgedprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdprhgtphhtthhopehquhgvnhhtihhnrdhstghhuhhliiestghhvghrrhihrdguvgdprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtl hhinhdrtghomhdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhg X-GND-Sasl: antonin.godard@bootlin.com List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 26 Mar 2025 13:21:59 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6640 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 b7c5ddf1c..557c7fb92 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3671,8 +3671,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.