From patchwork Mon Mar 31 15:04:45 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 60338 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 3E220C36018 for ; Mon, 31 Mar 2025 15:05:03 +0000 (UTC) Received: from relay4-d.mail.gandi.net (relay4-d.mail.gandi.net [217.70.183.196]) by mx.groups.io with SMTP id smtpd.web11.54559.1743433497259543744 for ; Mon, 31 Mar 2025 08:04:57 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=mK+OQEmr; spf=pass (domain: bootlin.com, ip: 217.70.183.196, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 9EE0E4452D; Mon, 31 Mar 2025 15:04:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1743433495; 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=m4gVV9dh2hjG4/KCRFMzslxzD7/Ni2tTDZyQakfX/GI=; b=mK+OQEmr+fnr++DYH0jQrzAUcW8v2nK6ZuV8LESAL/Qk9AP2tCLgTkCi7zhpVlvJvLDL6S evlVYlT7iZzk9fFPKvcPaU5sfL5h6px8LThvOD48JKDz51YUQ97chCg+mSHx+VkLQbNpEQ 3LJlu7Kj3Pf3EqRx4aEmgzOMbOKE1aJsqAfWPwdnHy7aDdSvSh9Wlk3Kvc69HpkZvJypJS uAwcR18xyPyfcvfncLuOFL4lcpspIULu3ejoQUkBDL0E4j5bc8FynlPpU8VuL9a43BLDuc QMSMYAVrZPEcyXGNSI40NPOoYvqxtBuWl9RiwgQabUlSbXN90GPjpK3eHovcwQ== From: Antonin Godard Date: Mon, 31 Mar 2025 17:04:45 +0200 Subject: [PATCH v4 1/6] documentation/conf.py: define a manpage url MIME-Version: 1.0 Message-Id: <20250331-cc-vars-v4-1-2281f4c47652@bootlin.com> References: <20250331-cc-vars-v4-0-2281f4c47652@bootlin.com> In-Reply-To: <20250331-cc-vars-v4-0-2281f4c47652@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=3343; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=ne+QialOdtfnlahvHQ/OHnZTV9Ck64417p7P+E+WWOY=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn6q8W1xAeblKk0qQVtnl/dpt3RJZgv2S3qxcup aRJC+RpbRmJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+qvFgAKCRDRgEFAKaOo NrIID/9Tfa2tSvOhvjvDY3SMB4XlZUnrsZHiqQn0Le48LyE8FUrNRSxDvByed6YbV0n0foH+jsW xQD2nB0leZaY/PntfJMX9ejAMA4Asj5NzNXfKLBlPCxofoKl01PgQOON/TGugq63z2dF844akf/ 9tSjB7xrfxzS6qAETlwZzTmykJqs/9DGk87gmypF0YmYFgkDUaLiPsIecToQgsKqhPYpiCGU31P 9RWkvctK34fZBIoSbjdLIPMrLpYOYTsoSv3wTChs8svKyVfvrofpbnm76/tbscPBBWL5roCQlng R0/vEVGjlKjE1Y4GAaXo0eQ1gomeHfgLEL0qpYblamrRqXF/x3CjuGmz5IP7jgsyWaBXGcmF3vP 2aCfwz2AXKz6TlpaXNHM9rps43MR9/RrKTzR9w6gR7hGBEoCQaoxfoAzf+dUmyRdrm7Je3ARCuL 6NGkw3bCnkeZewDLQfJiWuZnBhTZV3ByjIzrnqBH2YdCSiwPsIsSib4MZmOl3uM+RA3YjtEij4q 8UyRGVtd50i2CiA2dsLk1xMnH+9XdujV6qYwDrDBvTvf8WrtgxTmzcp7R6OCPOYnYUxLDtLgDsj n9zHeSUuLIXhMrbT5P6Zpo8FhFCa1IYohPX2DIUZiI5yZzHWMeygSpTVSLueDobHu3LrycSLiFu 3+7PzF2BmJw2+Rw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgddukedtvdegucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpedtteeuheejgfdtfeekteehueeugfejgedvleehieelteefkeegjeelueeugeelveenucffohhmrghinhepshhphhhinhigqdguohgtrdhorhhgpdifihhkihhpvgguihgrrdhorhhgpdguvggsihgrnhdrohhrghdphihotghtohhprhhojhgvtghtrdhorhhgpdhhvgdrnhgvthenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepgedprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhni hessghoohhtlhhinhdrtghomhdprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdprhgtphhtthhopehquhgvnhhtihhnrdhstghhuhhliiestghhvghrrhihrdguvgdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhg 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 ; Mon, 31 Mar 2025 15:05:03 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6687 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. Reviewed-by: Quentin Schulz 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..2aceeb8e79 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -111,6 +111,9 @@ extlinks = { 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None), } +# To be 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 62e339ed81..8e612d061a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -4539,8 +4539,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 manual page: :manpage:`update-rc.d `. :term:`INSANE_SKIP` Specifies the QA checks to skip for a specific package within a From patchwork Mon Mar 31 15:04:46 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 60337 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 1F25CC36010 for ; Mon, 31 Mar 2025 15:05:03 +0000 (UTC) Received: from relay4-d.mail.gandi.net (relay4-d.mail.gandi.net [217.70.183.196]) by mx.groups.io with SMTP id smtpd.web10.54803.1743433497396184509 for ; Mon, 31 Mar 2025 08:04:57 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=XbIBeApf; spf=pass (domain: bootlin.com, ip: 217.70.183.196, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id DF25544535; Mon, 31 Mar 2025 15:04:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1743433496; 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=MSN7aQqBuEhGbJRugU6ea3BWt68D3lmB3WdDmNNQB6A=; b=XbIBeApfM4aoZowQwzS+LQA7b/s8PtL0ipIi90ggTCyFEKi2Qkepw3lQQFxVm9NqvnhK4h 3ZZEEiStOL4aANY+SFafanf0ihgUlBlcFPa+M+vuTXNIJg1EbAnxrrQ4A0aEBhMrJXnZHe 4ch+RXaoKhe8jg9Lep5BSo5zgt2Ed+U4beN/7H4xd/lqfo0XgrmKpZt98uPoAgAWDOZscN UkEaQ3tIvJp5l/OPJrO0JWQ6+jYt12DL7YD5zURucX4h/Y7xrrSAgzMCvqHYPw7d4/vNQU 8wrjH0Tzy0hpf+honnIi9llZCmSa+1dYa5QtPPbaMqDc/JbbQ2wuSIzPKqSV0w== From: Antonin Godard Date: Mon, 31 Mar 2025 17:04:46 +0200 Subject: [PATCH v4 2/6] ref-manual/variables.rst: add manpage links for toolchain variables MIME-Version: 1.0 Message-Id: <20250331-cc-vars-v4-2-2281f4c47652@bootlin.com> References: <20250331-cc-vars-v4-0-2281f4c47652@bootlin.com> In-Reply-To: <20250331-cc-vars-v4-0-2281f4c47652@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=3671; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=rgP9c16jT2aBYsuPpv1u7g3odTdEAqs9hKk/Pqvm3lo=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn6q8WKGuIJ6KkBMdJi1WpQsJF0ZdBOaQ9O6iNr rjFmMg7gMmJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+qvFgAKCRDRgEFAKaOo NpI4D/sFNCURFcckvSPAeMP1eb/QG/MILifto1Uy+WURm/pfq5nSmREezHZjjRLTM3v5qj+pB4t fWJg2zpIVCIvG966P6b7Pvg/zZOpLxTpcfLJ2o95IfsSVGS8YMpnAzbFh6MTWNdy13SBAOBH7e8 ocXBljDOXgyIMAjiWyNYbnK9QD4Cr8Uy2Wqi+G0hCiH5flgiS+GEL5BQF6W3nAPeWreBIlYC9dc mK7AuoW3kbitMVEpDl1/QsJvs/clnTS4PKaeuEuFAEArAmfun9kHMizcX0npNSaaXaa/8lXm9Sq cIxtYWBdpUKG8Lc8YKo5RtrTVouNW3sQX6qiv/iyBMtmB6cIv+yKpYN3DjeHy6IWZlBhXnvJ3RC xdWiQfb453WeVBOsWeQV79tPSfzgjcdHuiAGfUWdTeSOpvtBEG99DIXUQsZ55MoRQY0rogASVpU UUxGn0Pg3ICtT5tsPU0wMBn2TMGTgwIOTjzw3hXvELClro+j0+uOasNgMMb5/Q46w1vXxkeAQyy QQ/mVYCRSGGfio65bqAoHmwHFDiBphdGKybclXeSgIPhwigKKPukiADcODEcGiKsWeSBFcJyCoV Jim8K8cSWo4phAr8k32lknTZm+pwPjpo7Adrx15EWzNtMMJ3TKIzGgPkSwc5e4IZLM/rGt2JC9N NMv5aVO6kCvksEg== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgddukedtvdegucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepgedprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtlhhinhdrtghomhdprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdprhgtphhtthhopehquhgvnhhtihhnrdhstghhuhhliiestghhv ghrrhihrdguvgdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhg 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 ; Mon, 31 Mar 2025 15:05:03 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6688 Use the :manpage: role to provide links to common toolchain utilities. Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard --- 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 8e612d061..8ff051327 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 @@ -5189,7 +5190,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 @@ -5804,7 +5806,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 @@ -5905,10 +5907,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, @@ -7229,7 +7231,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 @@ -8974,8 +8976,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 Mon Mar 31 15:04:47 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 60339 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 32E59C36017 for ; Mon, 31 Mar 2025 15:05:03 +0000 (UTC) Received: from relay4-d.mail.gandi.net (relay4-d.mail.gandi.net [217.70.183.196]) by mx.groups.io with SMTP id smtpd.web10.54804.1743433497636831524 for ; Mon, 31 Mar 2025 08:04:58 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=BmK3yNG6; spf=pass (domain: bootlin.com, ip: 217.70.183.196, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 26906444FB; Mon, 31 Mar 2025 15:04:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1743433496; 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=+zacmciXQTxcxNh833LTt9/Hy3tcSZA+WEhTU5+wBIE=; b=BmK3yNG6187Z1GQsX5tQTYnwLusbchrm/gfAyPlyY53oPGPh4cP7gcQS0obv/PPPlJKKEw wZv0vKtm7/86X2ENHnXBhxYhQWZP9jf/7PgQZYkscZnciGJdtABXmdW0BJxiHQRg4tXEry jZxbrezsxOeeLgXDHalpxrzrTCh9qFA63xWmEBzM3EU4sFXnNQAGpb83+Av2WDH/VODArn UXVI34k36pvakZsQjo4mFivdZXjrpFr2X5rWrJcuioVcR9sc2z5FxFZkpnEkkUm1UW+J6z GjoZMBB2DQLnjzPUWNf3ED6zPivowfZxJJ5Ez4zsKFmgu0gk48SRV7yThjjGRA== From: Antonin Godard Date: Mon, 31 Mar 2025 17:04:47 +0200 Subject: [PATCH v4 3/6] ref-manual/variables.rst: add missing documentation for BUILD_* variables MIME-Version: 1.0 Message-Id: <20250331-cc-vars-v4-3-2281f4c47652@bootlin.com> References: <20250331-cc-vars-v4-0-2281f4c47652@bootlin.com> In-Reply-To: <20250331-cc-vars-v4-0-2281f4c47652@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=16894; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=JH3zrxKVHUBuNoa0eP5MI0286xWMwzOXubLcI9huWvQ=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn6q8WrH1nPLLEpaTRjaCdH/SjrSZHolbBUL99k 9ZGHOaLJvGJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+qvFgAKCRDRgEFAKaOo NmhcD/9fUf3GmNrCqtXgndjAVd7Qfre48/FvpoRrl4i2E10jaDWx8ydaF+xh5xny7wps08KP0px GQrep0+4DgZ4DqPzOdlLaZiMxGcxopVm9WJFrV3TMpJKDexZSHDJRv/fdF0EOrgMDtyJZxAkERd XuIOPyfOPtocyS6gox8UY7VVf6F3RGWx03q3jF1yA1oYCKQr6K1DNa8tNIvPoTATME4KwSLBkL3 wkt1q6rFQe2VCUwwXklhuSdrZgyOCtoa0JayhhmbWhpVbzkSv0UISocTQCRp9zr58SIKP9wPY8b tOTuewP3SFKsNOdnyoiilCyqbrmF311Baj3FNHfk+gnMT+0JcVo1LEFgBzwZ1oD8heqgnda/vqL Tw+jYl4JdLyX/M1VjR6IIiyVaIGLG4ZxHNBw+FBD50XPLhoiknjC48PckF6ctddfshPeT4C/QAd uLfGFHD5T6jUHKdtymyPdWrZwDFb7QfmbFYrL6FCDGxlOh65tqx0jC0F5AJMWEbfNzq4Yow/IRM ysbuIeYPVVdii200N/YIfsXV4tnW3IBjK3b9NMjV8XD6qFUta7Ejaw20Zyi1MbnBv6b7wh7vUBC FoD0yW8oJcbIYIDBfrhoaK0wt8oRTZ0Wd53xFkqc8afKVyp/dXhIMjXj4eD39XcAGyuLcuJMlug yMYYBmA/1A4kptw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgddukedtvdegucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepgedprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtlhhinhdrtghomhdprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdprhgtphhtthhopehquhgvnhhtihhnrdhstghhuhhliiestghhv ghrrhihrdguvgdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhg 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 ; Mon, 31 Mar 2025 15:05:03 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6689 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] Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard --- 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 8ff051327..526297b15 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -995,55 +995,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 ${BUILD_AS_ARCH}" + + 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 @@ -1051,10 +1161,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 @@ -1075,11 +1233,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 @@ -1284,6 +1484,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 @@ -2839,6 +3043,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`. @@ -7368,6 +7575,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 Mon Mar 31 15:04:48 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 60336 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 1AD27C36016 for ; Mon, 31 Mar 2025 15:05:03 +0000 (UTC) Received: from relay4-d.mail.gandi.net (relay4-d.mail.gandi.net [217.70.183.196]) by mx.groups.io with SMTP id smtpd.web11.54560.1743433498025745293 for ; Mon, 31 Mar 2025 08:04:58 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=WVrvQRGn; spf=pass (domain: bootlin.com, ip: 217.70.183.196, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 6E1D94453B; Mon, 31 Mar 2025 15:04:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1743433496; 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=8Rkp+X+zJ3aPw8viOTv+nyIpydPUOCVloBr1myp1b64=; b=WVrvQRGnOVKgRWDsDkRhiUchZzyUy33mbM+BJoS5lURutdxUFMH67DtjXFfLw+WmpPYAMR UT1/fFSL9Bbt3PKMCX97OXrYGNMGnelmoQYWrsR6OdugZuI2JTHRMNW8qoYQ4LuaTc7GAh 1pRlhaTQ7mzipZ7eWnboBRZDoB8GcawwCtfqazHPG7Bx6TuzBGmwPEEK0jlF1D5bAEdTKW PudCGGoIehPj5eZsg0ZehmW0zbSck0Sbq8Ffkr3LS+YHoJhxVOtJ4tzgDMLPAyXXgRNhaN Uk1t6Vu5d+BmPAoNPh04UBwSDcWByoJh5rZU9RzI3yrg0LUhXwMlyW/pkYDQyg== From: Antonin Godard Date: Mon, 31 Mar 2025 17:04:48 +0200 Subject: [PATCH v4 4/6] ref-manual/variables.rst: document missing SDK_*_ARCH variables MIME-Version: 1.0 Message-Id: <20250331-cc-vars-v4-4-2281f4c47652@bootlin.com> References: <20250331-cc-vars-v4-0-2281f4c47652@bootlin.com> In-Reply-To: <20250331-cc-vars-v4-0-2281f4c47652@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=Z0teodrn6Dx4d6xhbBaZH9qtZ0wcPDqgK6gygGH7krU=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn6q8Wh3k4oxHL6a8jbyg3HpSZi4aqPUSXZt0GX 91ZDeM/hOyJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+qvFgAKCRDRgEFAKaOo NjTkD/0Wcj+Gyl+HTaRoWYHjdZjo51uddjj5QQ44RWg8KJaWBOvLwC3zLn1gpUVTrquhBCfpVLX jhgLAnpllo155nB69i/CxrTFFfJ5tieS8z3pe9hRENHxate9aq3WDIeLDXmv3t1HciIP3ssoOmx briBzFvdP6r3690tIBdxIc2vyMiCGlTFcXAo0KECafEKzFPWSUQ5DKtjZhY+IRoQtAZKiNd83JP waKf8pexg5ZwSGZ1irdbyn6iKFGGXi/xzF+lHeKbTjIKZ9ceAuWWEhbrJR8NSFCyRAJs0v0D+59 12BXjYdZy7mDby24lfA669yihAeMf58b/RKt+vJG9+/3q4LEEtP65kBOaWmAaNY1bAvJA5i3V35 hxEaGCgqdz6uhbQSgQ93OmZkS9rpCOeIKhD7MLXtVt/3vkjP/e4R2JWB5DtzHiMWmJB1qFqme8g YOt/OE+T2KDlmI5y69nYRGEjFV3nb2C+sHPFDxsfzZrBasE4kKfi3e42pmbeebeUJU2185+Gp2c lK4ehR/YrRaEDI4bN6DeSWfQ8TkAq2sD/C4sAhmSp1dUcHJ7gPTEX8TeUE0bboqpFrHfcQ0iUB3 QYfEQZd/oxuPHRBXAbcAKAdgY3rScRqud4ehPNJ4GQwRhP3yiCylZF4+lVsi1W/GzVHZaBlp1zh abIfasJFeRFzF2A== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgddukedtvdegucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepgedprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtlhhinhdrtghomhdprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdprhgtphhtthhopehquhgvnhhtihhnrdhstghhuhhliiestghhv ghrrhihrdguvgdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhg 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 ; Mon, 31 Mar 2025 15:05:03 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6690 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 526297b15..c18dbdd78 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -7975,11 +7975,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` @@ -8061,6 +8071,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 Mon Mar 31 15:04:49 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 60335 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 07912C3600B for ; Mon, 31 Mar 2025 15:05:03 +0000 (UTC) Received: from relay4-d.mail.gandi.net (relay4-d.mail.gandi.net [217.70.183.196]) by mx.groups.io with SMTP id smtpd.web10.54805.1743433498162163069 for ; Mon, 31 Mar 2025 08:04:58 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=h2/I2PCd; spf=pass (domain: bootlin.com, ip: 217.70.183.196, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id A8152444ED; Mon, 31 Mar 2025 15:04:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1743433496; 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=HvJya4aYP4uHh/qMltHn38A+EAEy03jqG9r5ZDnNKZI=; b=h2/I2PCdp5pqo38DRBo33HnQ5Yyiu+AvGEs4DcdbyBZH04XzzzWTbmmzne6KobXnb7nP2Y K7k9gzgqexnbc+v8c0rws3zZV+J3Pqpq5GPNSa70iDwunBq4wcVH2Vsh8pCAMMCIJygSyF J2rPzslEhFTHLJuQlJJoRIaN5No3EpZ0UGFKlAuvcdeUoN6ypDNxyAk8U/9MEgbr3r++ur NG1hopwKYzjrkK+UI9nmt346EsQwduVapViwrrqd639JsM4muGM+NnpK29x1QJjQKzbYX0 nGDbONyB1LeC1z28Hbasiskis82udp5PMiO6yPmfgMDmLi7OhOD4JLJw05SNWQ== From: Antonin Godard Date: Mon, 31 Mar 2025 17:04:49 +0200 Subject: [PATCH v4 5/6] ref-manual/variables.rst: document HOST_*_ARCH variables MIME-Version: 1.0 Message-Id: <20250331-cc-vars-v4-5-2281f4c47652@bootlin.com> References: <20250331-cc-vars-v4-0-2281f4c47652@bootlin.com> In-Reply-To: <20250331-cc-vars-v4-0-2281f4c47652@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=GHx5o9mANTbD3MyTVyJEPt4s4ZbKsmfaZl9I6UkaTSk=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn6q8WYudzc6HRzEmR+VDKiw0g4Kh1PhKZq6U5f ubW+1vv2ZKJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+qvFgAKCRDRgEFAKaOo NpZZEAChtobAXrEq3IIDp/k9sNEYAimcK6IIZU7Am0COdIDpHCSynAyzju8CFScMtCzHy8+8hBR /wjwl8gujvrUczPShRb6f+Vtun4weM1XJQCglLyJd+uBM3OfSGtLFhDiISLxidwj2VsaZH6/bC0 hgcdTvAdoLT5jUdi6L1aHMy1193y8VKqG8w7OgIzwYZs695bWKUtVzOgUoxgxhlI1ciN7jQBTVY ZnlYvr+atDvE1wCm4O4DevaYrLKJxpunA9D/vtcc+t7ODiB72R3PfjaKLFL8/ult7USCK3hWLan m2tScmrPJqWKFAVTjCjhmfS0Y8///jt+psGQD2eEzE46gkJ/c0Bh12YbZpT/dmMpqrYo7ZXidqJ id+90l3U0ujgzJyDkurRk36+yf8e60JnIyj06h2fXK9GEQKnvu8zghBLa4yNYSizVk6LRuXEv7W JUay0pwk60chr7+VU3Bss40h7mHBgN8mfJa7HloxHF/RJkG1XJs6LhEc4i30ZnEqHJqsviSS/Sb jtLKXROIDRfTJZmf5It0k9hs9TwBKSrdcsqG8i48viP9dqOO2HKYM3WtU4VodEAfEzC9dRWkqtp Mf6NaynEGkcT0BPZd0TXp1K2TUyU7ucZYFpRHYF2BrZFXlguxuzi6okCnHsMkQhU3+5nJLfB9is ZkGZ+Ker426QNoQ== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgddukedtvdegucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepgedprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtlhhinhdrtghomhdprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdprhgtphhtthhopehquhgvnhhtihhnrdhstghhuhhliiestghhv ghrrhihrdguvgdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhg 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 ; Mon, 31 Mar 2025 15:05:03 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6691 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 c18dbdd78..15e950859 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3698,6 +3698,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. @@ -3714,6 +3728,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 Mon Mar 31 15:04:50 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 60334 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 0B05DC3600C for ; Mon, 31 Mar 2025 15:05:03 +0000 (UTC) Received: from relay4-d.mail.gandi.net (relay4-d.mail.gandi.net [217.70.183.196]) by mx.groups.io with SMTP id smtpd.web11.54561.1743433498430226618 for ; Mon, 31 Mar 2025 08:04:58 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=m2P9lVoV; spf=pass (domain: bootlin.com, ip: 217.70.183.196, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id EB5EC44539; Mon, 31 Mar 2025 15:04:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1743433497; 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=btYOpd2xd3rCTHBNwIDcX1fjEN4KDkoDtqBoT+oZvKE=; b=m2P9lVoVt6zoUV0leUPprWzhc1od74psK1tL1VdjW/twfXjlMR4WtaEBlfZkashQZyLRWa XnRvUhrxYfsd9SuxKxOY5CtB03Jxx4bJMPlvZRPQZSo5ikzC72zlSGsgE2XneEvaXFp92J R1TbmsxDYAxYGJbbglG9L3O1NkS5RKEo8SOUAoCe92gHZkN8xFMkRlZDIa8Hz0Jms+fodK mHrHPMF1abpHSmDNqOkd+wuLeB5nUBfutQRAcIQ9EmmJaKS/9ZIw9ZagaSLkNwD0o0MUjG O/IA9OyPeIPQgqKXG+R6B2ZkPPtB2qLm3KgY3fIpEHZ+d6YpEjfYi1TaGdtkvg== From: Antonin Godard Date: Mon, 31 Mar 2025 17:04:50 +0200 Subject: [PATCH v4 6/6] ref-manual/variables.rst: HOST_CC_ARCH: fix wrong SDK reference MIME-Version: 1.0 Message-Id: <20250331-cc-vars-v4-6-2281f4c47652@bootlin.com> References: <20250331-cc-vars-v4-0-2281f4c47652@bootlin.com> In-Reply-To: <20250331-cc-vars-v4-0-2281f4c47652@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=dwzfYhYXYJ2jl6x6ly/dQfuzDQyZkRRAlo7Sv3L+B1k=; b=owEBbQKS/ZANAwAIAdGAQUApo6g2AcsmYgBn6q8W56knMzsIc5vifE3oZkeraoqFBI2kLjr6T u9f82buLZSJAjMEAAEIAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCZ+qvFgAKCRDRgEFAKaOo NiySEACfc3Y2YNRKXvVH4Cnl/0ENRmfw5O4q0yn2y843sGFKNYfonAENWEOi+PPwHHaX6ptrB1O UDSZ+hp0JVT5zxS2bNAj9uD3fWKItj4934Gpdbhih7eWWk7cy+WsoXkg5scXMC6iyf5OhU5eSFG Ld3MvKMPuTW4PxjwJzv2F2xT8wWy0JSLIwrDGVgjWGrLd3MFKBjK5wMp5kyOiH5cXjFIyechpTv FKVB+YbWNA9yiqSkxxY3+SafrEmWngohNz8XfVxKhHAH49g+Q5K64r+VYaLQ3cq6DRjkUKLMvhU SrjPsQgYch9Y1SHicEEFdjy37EpAD0EGsGnM9X8Uvq3SDxM/SqsCHpJrZ+QM+pHI49bmXT7pVqS rx+RM5UMyH6RQA3fNc/IvSY5kCNDr1l6sm9kd1fLwtWNSI/UH40MUMksLVKi5AZpKpSRR1+edc0 g5BHIsXmfxiXPmRN30kmIIMbbFSf2yw+q1IuJLEi3z2U6CIGjh6T+8qRGA2Ftao1O0Upzx0saBD MjHWLrECL8Zuni06Gbgk/LGJJTxPgnkUL4R/n4l3zHNdpYSEeUfEWTr/nhzse8SJG3TgYyWe7sV 2LsPFiZN8ITV5kqq6Tu/ZN+KewCsdCgw4OgBhhyJ9uqMpfu4zE81ZerpR82vXIUgTr/Tio04saY PL3nXf84+3Dc9Bg== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgddukedtvdegucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhfffugggtgffkfhgjvfevofesthejredtredtjeenucfhrhhomheptehnthhonhhinhcuifhouggrrhguuceorghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmqeenucggtffrrghtthgvrhhnpeehieeguefhfeegheffgfeuieetheeileefheejkeetgfekueehueeluddvlefghfenucfkphepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelnecuvehluhhsthgvrhfuihiivgepgeenucfrrghrrghmpehinhgvthepvdgrtddumegtsgdugeemheehieemjegrtddtmeejtgehtgemiegruggvmeejleegkeemgedtheelpdhhvghloheplgduvdejrddtrddurddungdpmhgrihhlfhhrohhmpegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdpnhgspghrtghpthhtohepgedprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtlhhinhdrtghomhdprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomhdprhgtphhtthhopehquhgvnhhtihhnrdhstghhuhhliiestghhv ghrrhihrdguvgdprhgtphhtthhopeguohgtsheslhhishhtshdrhihotghtohhprhhojhgvtghtrdhorhhg 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 ; Mon, 31 Mar 2025 15:05:03 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6692 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 15e950859..0f65620a5 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3725,8 +3725,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.