From patchwork Wed Oct 28 08:04:53 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 102251 Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.37904.1793174718403292127 for ; Wed, 28 Oct 2026 01:05:19 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=0agsm7y8; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id BAC8D1A1375 for ; Wed, 28 Oct 2026 08:05:16 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 8FE6160769 for ; Wed, 28 Oct 2026 08:05:16 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id CF5EC103290AD; Wed, 28 Oct 2026 09:05:15 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1793174716; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=qtZ26L1jOBVGbOKFRHtmDT+KNLW9APqwdfUfVr1Iozo=; b=0agsm7y8JBcOeuFPGNHN698X1DR3uCKvMm2h2B7urX92Km515O9mKPhsvk18qO6gA2Fczn VJ06Y4daBc/uLubevenxJS/ECO50Y8JiYcJE/tSKwMN7+42leU2d9yF7Lz7OrGm/DxyM0z knH914UJ5heEvyPPJWO7KA5b+qTyYvvHDN8JK9AL9cKEd+MX9tz4aQoosebvb/uWGHoHDq o9u+zm+kYU5LRPDNkZCwAgGwND8Qtyaxp/x0Cv0CVm8Az06iQviSCm57YcVHGOOJgbtiAc z2Noatu/x2eHRIRhGo20HjhOsM86h2PWETmqZBiKczguJTI2j029+Q8SRjxCGA== From: Antonin Godard Date: Wed, 28 Oct 2026 09:04:53 +0100 Subject: [PATCH 1/8] Pipfile: update dependencies for sphinx-tags MIME-Version: 1.0 Message-Id: <20261028-tags-v1-1-d5ad01019eae@bootlin.com> References: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> In-Reply-To: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> To: docs@lists.yoctoproject.org Cc: Antonin Godard , Thomas Petazzoni X-Mailer: b4 0.17-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=682; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=AE0X6RTupufkh+RPWbpaeci858/anrfy/1tqSUdW6I0=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBq4ay31S/wDIVJDRZCTeYnD0FknHKPwRAFCXYk0 VpEaTZRjM2JAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCauGstwAKCRDRgEFAKaOo NnlUD/9CFRRPzo7I+jmJzDpZolI6OTRQQA9rCQhUCoxLJ2SLNUYyhULZ7VE/aryApYghXkc3mhm 6ndxg7EPWKZik3CU+gmSv3SukLJDuQnBFrJKdI/gR0AYb5fpOIZ8o9jPGZgdNslvOCX3ydiMDMZ 1A6RhuEQCI0QKa0rye5n6hgsnUHXgjP+oq85s/bFBXlMC+p4GOyHVm0Iu9auTOP6I/MR9zTQmBl AkBFDDkDurdT6DSEH3GfswBkdbBKx5oDFwwcQWW8Iwr8kpZ21wBMSblIusAbHVIfyQ0gqL78QDx MokmSSBmKQVY8mJOTORgcHRrKVI1WqhqS1IkXpMfit6dFBx1bgZLBp7xd1ck0lN5Sj0sZ5yONYH mI7k+qcMhgvdZUYbz9iVJjCBt7oKAjkdNgsEh2Al6zy0kM2rFHi969GjVEtcRN6k6Cbzo+YVyVR 9TKCUGR0vB96JhMCUEzmWVkmS/a0gomAn/FwQuGptsqT0rIunD8i7k805YiOlBZt4dtNOYFJfXx mfMUI0JBnPCldVGxoESubHCoFTs8VOD1HISHjadRoeAU/IM6bRsnr3+Zbtv8XAzuOHGaOqNDKiJ +KaWclKZouG/R82Eb6AQwZY8vbInb4jqu/AUluaXSMcv3hE0ceak+ndrCj0rb3qHP0oM2tjKhYy LEm8godn8NUPNNg== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by lin-tor-korg-lkml-alma10-1 with HTTPS for ; Wed, 28 Oct 2026 08:05:23 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10728 To prepare for the sphinx-tags addition, update our requirements and add sphinx-tag, as well as sphinx-design which is a dependency of sphinx-tags. Signed-off-by: Antonin Godard --- documentation/Pipfile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/documentation/Pipfile b/documentation/Pipfile index f415cbf3f..c857d9940 100644 --- a/documentation/Pipfile +++ b/documentation/Pipfile @@ -12,6 +12,8 @@ sphinx = "*" sphinx-rtd-theme = "*" pyyaml = "*" sphinx-copybutton = "*" +sphinx-design = "*" +sphinx-tags = "*" # SVG to PNG only supported since 2.0.0 sphinxcontrib-svg2pdfconverter = ">=2.0.0" From patchwork Wed Oct 28 08:04:54 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 102252 Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.37906.1793174719087377997 for ; Wed, 28 Oct 2026 01:05:19 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=oWoiCmC2; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id 6E2FC1A1376 for ; Wed, 28 Oct 2026 08:05:17 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 3BEEB60769 for ; Wed, 28 Oct 2026 08:05:17 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 68A541032906B; Wed, 28 Oct 2026 09:05:16 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1793174716; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=ZrAW1IJ0eBIvr6imzk3aCIf8PXHbPxRM5pT9LRcqIlc=; b=oWoiCmC2cFq/gZHJRs0gDh0NAXKxsrSU/qu/3gUz/xZcWEXGpVZevlB+FdPcbTFWPlKXAd 8NC7tLY9M4pO4schgMqbdKN8yMirmhZDqqMX+Z3h5v2R3EGaQrocKaEkHh59KTYKmL/QNE jgSF8n234PfuV70GrKRAZ0PTch4u/amkdyK5sw+9YEBcVS3Jt96hvan4KMvHi/PvU/8Xvn 7yQ20AZYOl5WBIQEbMN/B6SaLDE4U7ZUFv2JNa7gCvR7Hgm8L9XMr3lP4Ljuo43rLSm1jd IfqmenOaUH1EGBlb3QFDSu6w1AN1ok8YCF+7tmI8b9RIEIFj7cC7jExO/WfP0w== From: Antonin Godard Date: Wed, 28 Oct 2026 09:04:54 +0100 Subject: [PATCH 2/8] tools/host_packages_scripts/pip3_docs.sh: update for sphinx-tags MIME-Version: 1.0 Message-Id: <20261028-tags-v1-2-d5ad01019eae@bootlin.com> References: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> In-Reply-To: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> To: docs@lists.yoctoproject.org Cc: Antonin Godard , Thomas Petazzoni X-Mailer: b4 0.17-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=993; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=Yw8pV7qIARAjZuxVw2qbNvbDQOGuM42IiRkPoJkh1ZQ=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBq4ay32xg4+YjrNEXyE4bD8L5GmjNW+J6JwbDG6 Jx4Vs8/wimJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCauGstwAKCRDRgEFAKaOo NsOyD/sHFItVZU8x3Ia9UDIxAJ+s6Oa9LI5X+Sh3U1ZlHNSD5KuuRs2IIzZ7puJY4FvvS8HzrSU L1wkf9WGrzg1MvcIKE5mvpriugBCbfPhxtQFxFoJkVbEHYftAA1HSMEB5oYWBagRh1duazFpQ5V /ISufEdl5wLoy9609KnFsu5I6RmurRet+Ju20pt6xIsn+nLGmVszIiwgoRSTyQBcniTe9LRfHKM eJBPaoeHhc6W227PKkuyhmvQKnCT/Iw6SltsH4cfKlnheJk71PCBeunFg8TjGCn8+XQBwvG7b2x x9C+hPZ4F/PQ0x7r4+PsTIpCX4uzItcgE9u0bqWiC7YVlx5u1htlmpSQV7flxQTC548F3KVEuo0 Z363Z9Y+QlDDqkmKD/ukt1rOCIe+jXXfXy6RUEwTKzSI0qH2LsSq1029iG5pH/GpXDTouBMikfp Gd3gul0PIqddk1IvmIYqCKmyjITSi2x4eQXJ6HU81sxT8eOlLabzSZTWVRVYHGLeGswzTbh9Bm4 8G9YS1VwFeRt78tRmPTvrkdr1DRLRsA14O6TVVC/aYZ6cW3aFicUc6/jUJrp0RZqD2uZbW22aNZ fI3UjG5tKwcqDjpV6PNK3Au2Okw6pG6QQFGNCt6zqvgXT9aPw0ne46H4g8mzFDcXxlD78I2KwOS KynnV8XrHum9/+w== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by lin-tor-korg-lkml-alma10-1 with HTTPS for ; Wed, 28 Oct 2026 08:05:23 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10729 To prepare for the sphinx-tags addition, update the container build scripts and add sphinx-tag, as well as sphinx-design which is a dependency of sphinx-tags. Signed-off-by: Antonin Godard --- documentation/tools/host_packages_scripts/pip3_docs.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/tools/host_packages_scripts/pip3_docs.sh b/documentation/tools/host_packages_scripts/pip3_docs.sh index 852845783..2a67f0d18 100644 --- a/documentation/tools/host_packages_scripts/pip3_docs.sh +++ b/documentation/tools/host_packages_scripts/pip3_docs.sh @@ -1,3 +1,3 @@ python3 -m venv --clear ./yocto-docs-venv . ./yocto-docs-venv/bin/activate -python3 -m pip install sphinx sphinx_rtd_theme pyyaml sphinx-copybutton 'sphinxcontrib-svg2pdfconverter>=2.0.0' +python3 -m pip install sphinx sphinx_rtd_theme pyyaml sphinx-copybutton sphinx-design sphinx-tags 'sphinxcontrib-svg2pdfconverter>=2.0.0' From patchwork Wed Oct 28 08:04:55 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 102253 Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.37907.1793174719719483143 for ; Wed, 28 Oct 2026 01:05:20 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=h+97m27s; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id E3BF01A1377 for ; Wed, 28 Oct 2026 08:05:17 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id B9CFE60769 for ; Wed, 28 Oct 2026 08:05:17 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 13F1A1032909C; Wed, 28 Oct 2026 09:05:17 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1793174717; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=V1vC7rhV0DBZWnPW2po+wGsIYyCsAIwxeA5NZhM/FfQ=; b=h+97m27s0o/PAMFsKcwFmAj89SLxZtUuEwEs5lZKmCdhajfjZRnnsSka4vq+IBgfIwx6zX 9+HXtVjmeo7Cnn3a0LWn/wZFEUt0eUWYvW845wcT972s8PQHyumkiVGmpsU43RmWhWJ0LY t8hdtptMovtKw2Uw5pd/y42fLzAlBeYoWeTbVzTCnDy5L655hafT+iFVcSTNsNSnJLn+Rh cyl90bpcYypLUIvBZ46GB6nTERHx5Qfc6IKMdgmzgPqgAILSb3/3YTyXGmSMOByb/0gJNR RE+kNzmbqDywyK70CJI5eGSobROh8dCZdugf2XrmA5VRb2jvv5+RIGxHhG9LWw== From: Antonin Godard Date: Wed, 28 Oct 2026 09:04:55 +0100 Subject: [PATCH 3/8] conf.py: enable the sphinx-tags extension MIME-Version: 1.0 Message-Id: <20261028-tags-v1-3-d5ad01019eae@bootlin.com> References: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> In-Reply-To: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> To: docs@lists.yoctoproject.org Cc: Antonin Godard , Thomas Petazzoni X-Mailer: b4 0.17-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=2257; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=vkrO+5Uh5UvmkBPuarjX2vi6Qqilg1UufDa5VajUTp4=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBq4ay3nMqT9dEo3n7tKE9VnGPNQsTvHhRSqBmdj Ih1ICDn4yWJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCauGstwAKCRDRgEFAKaOo Ng8ND/909uz8gByC3+dW0Q1DL70qn6n225KbPFIeHN4yCdU5ej7x55lObcm6GEdwKrMI1eefhg8 Shti0EVMBJsuHdmDoAbrFw3KO6X+jQPZkAYFmfWPDaMy/mPNpY5C+BNTgi9E7J6PUhTAygERpZy A+yeqkpn5SCn0hFLRDp8+Ur4IUzYee5goHcuhUVl/+jvcGuAdVF0BXSnYiP6pZNBfjdBzkVBbK6 001TC/GxuVJZ95jG+HyZ5O+aFITCYPd25it6edCXgUex0+LOG5Y6zazZKbw6pBoEJDyHLh31hBs dENAWsjcKAyG2fL3dKuqvFaDbiEcFPJY91ZSw95Zf8H30MI/cKqWoeE4O1GWvZiTWbuvO5eHWLb +R3rIAZdNLfQCdKu+iJM+h3hNVtcdklWh6Qz18Ak2lThnJ3JEgVnwf8UJFLXoak7iwALEeFlpEu x3tJPhB3uh1G1I8myng1n3dzLkUR7/AuYVdmZiUh/pX8jeNDDW4erQS9DVTKlMSpbMdZzxubl9W liHATj4wAFaAQPUM9/8w55E8ghGpGIrmYP2Uv970OPtKUvMYgicOsI8XmoGk9g3jB+XHibMEqrb cHDhUsSF8s9t0FRo3fL5iNwYTCSSFQ0JSCy1GWDhIUthCV/0e7iirkx88YodFp/7vzXnWml+zhY Lzceh66/YX10LpA== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by lin-tor-korg-lkml-alma10-1 with HTTPS for ; Wed, 28 Oct 2026 08:05:23 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10731 The sphinx-tags extension can be used to add tags to document, which then creates a section of the documentation with a list of tags which group documents. This should help users finding the different documents across the Yocto Project documentation which fall under a common category. Update the Makefile to remove the generated _tags/ directory on a make clean, and the .gitignore. Signed-off-by: Antonin Godard --- documentation/.gitignore | 1 + documentation/Makefile | 2 +- documentation/conf.py | 8 ++++++++ 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/documentation/.gitignore b/documentation/.gitignore index d6d020efb..84d82f45d 100644 --- a/documentation/.gitignore +++ b/documentation/.gitignore @@ -1,5 +1,6 @@ sphinx/__pycache__ _build/ +_tags/ Pipfile.lock poky.yaml sphinx-static/switchers.js diff --git a/documentation/Makefile b/documentation/Makefile index 2df23ebf4..f165e36c2 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -33,7 +33,7 @@ publish: Makefile checks epub latexpdf html singlehtml sed -i -e 's@index.html#@singleindex.html#@g' $(BUILDDIR)/$(DESTDIR)/singleindex.html clean: - @rm -rf $(BUILDDIR) poky.yaml sphinx-static/switchers.js releases.rst releases.json + @rm -rf $(BUILDDIR) _tags/ poky.yaml sphinx-static/switchers.js releases.rst releases.json checks: $(SOURCEDIR)/tools/check-glossaries --docs-dir $(SOURCEDIR) diff --git a/documentation/conf.py b/documentation/conf.py index d2252d5ab..75d062945 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -50,6 +50,7 @@ extensions = [ 'sphinx.ext.extlinks', 'sphinx.ext.intersphinx', 'sphinx_copybutton', + 'sphinx_tags', 'sphinxcontrib.rsvgconverter', 'yocto-vars' ] @@ -260,3 +261,10 @@ copybutton_prompt_is_regexp = True copybutton_only_copy_prompt_lines = True copybutton_remove_prompts = True copybutton_line_continuation_character = "\\" + +# -- sphinx_tags configuration ----------------------------------------------- + +tags_create_tags = True +tags_page_title = "Tag" +tags_page_header = "Document(s) with this tag" +tags_create_badges = True From patchwork Wed Oct 28 08:04:56 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 102254 Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.38063.1793174720372265097 for ; Wed, 28 Oct 2026 01:05:21 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=0VVKBHVL; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id B19A31A1378 for ; Wed, 28 Oct 2026 08:05:18 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 8722560769 for ; Wed, 28 Oct 2026 08:05:18 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 9CC7D103290C7; Wed, 28 Oct 2026 09:05:17 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1793174717; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=PpAr4AG6U26nO2uZE0XUoLGnmN6CukxIqNF6LfzDbAA=; b=0VVKBHVLjxj+fgIoWNBjvB/JcXUKAqh6uyglo4UZVXIaPqhFhZHIafpx0DHa94SZxWG3Dz CF0orxRWNOsO2rR2E8CW6/3ecYecuPY5AMmLal2WBzhab18agYPcvjPYY+J/S8bAj1UdBe kPe92ifF4OcLCW6PrXRFYWw/gEDEsfDnpEdBqnsD9b3CPDRHUhCJOl6Krh8rB0FH6xU2vN ghOc+vgrDbEm1WVmKui8MK4yI8eW8420aw56UXaBnq5ndjNLKqPIB4eMSBdt4LNlbkAfGa RnQNkFHP9pUvwZ9hGocKNvYFPgRfCFGf3IpZ1Is6ZNOfU90RM/9splphGSq+dw== From: Antonin Godard Date: Wed, 28 Oct 2026 09:04:56 +0100 Subject: [PATCH 4/8] sphinx-static/theme_overrides.css: customize tags appearance MIME-Version: 1.0 Message-Id: <20261028-tags-v1-4-d5ad01019eae@bootlin.com> References: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> In-Reply-To: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> To: docs@lists.yoctoproject.org Cc: Antonin Godard , Thomas Petazzoni X-Mailer: b4 0.17-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=1391; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=8ghw6dHYeLpgEuSPNuWaPVZcJvDi8WSQy+v1QsIbZd8=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBq4ay3T4M8tU0C/W42Q6mILCEhG/kae0GMnZn0V tcLkk8q7A6JAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCauGstwAKCRDRgEFAKaOo No7XD/wIeyj+ZM/Mp+GCzrAz5XA6zQZ7toMGiz4OyQeLaLhGqZo1Bb562U/SAhETkDBsTJlWFEm W86klEj8bPIYKOn9QDWzMP3QOUNxtZ1n/y+I18unT9JTesVpnY4PPz/Nnq7m7nvQJIvyh4QWLY+ jfYTzex1HrwLa31wC/W/C/aNLkfu550TofZRgGm4KD0VPofeMCuWA8N5By5g3fbBQu3dCSoRH6K xtazOfTrRXmF3UmQXteyxCKZsF7BTxerwXy9Yqdczijll4ad0Jf0OqjHeRkfS/oRVbxSlMgOEPV WVXK88KrveT4UgGk0985AYhkSEM0LRRj87YPL2XlGboIcpRab2dRymmwcUQ7s9KwbR9SN87fi4A yJZwRWZE60x9Cg+ivznWfxS0yy6mzifb7j76FnZXrbunLsFN4DlxOLUar+/o2CS0yC3wtsmlUmp uZuQld3wfC+hGZf29KPrzMhTM51s7Gryj2VEhDP27dEI9IP6SuJkMJ7wXm9D8ms42I7VtJyjjpj aCirdQl5jVnBBwh0WDTLDPbHiMLcEfjNsrevw2g2vZKQCES0dPI1OxJsQaM9vF5NVEfusX+xafj VhxzlukoPVO7QF8NAAPrAQm7iYFwRepmmKeFcCUNMeFLjjfc45WjRZ3ZXCju01Kdpq4v1KputYl lv3oLqzT0lG/bCg== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by lin-tor-korg-lkml-alma10-1 with HTTPS for ; Wed, 28 Oct 2026 08:05:24 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10732 Customize the tags appearance so that they match our color theme. This is a customization of the sphinx-design badges CSS the sphinx-tags extension makes use of when badges are enabled. Signed-off-by: Antonin Godard --- documentation/sphinx-static/theme_overrides.css | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/documentation/sphinx-static/theme_overrides.css b/documentation/sphinx-static/theme_overrides.css index 3823db820..4fe701dc7 100644 --- a/documentation/sphinx-static/theme_overrides.css +++ b/documentation/sphinx-static/theme_overrides.css @@ -140,6 +140,29 @@ section#welcome-to-the-yocto-project-documentation p.caption { border-radius: 0 0 4px 4px; } +/* Custom sphinx-design badge */ +.sd-badge { + display: inline-block; + padding: .35em .65em; + font-size: .75em; + font-weight: 700; + line-height: 1; + text-align: center; + white-space: nowrap; + vertical-align: baseline; + border-radius: .25rem; + color: #00557d !important; + background-color: #fcfcfc; + border-color: #00557d; + border-width: 1px; + border-style: solid; +} + +/* Remove the underline from the link in the badge */ +a.sd-badge { + text-decoration: none; +} + @media screen { .wy-nav-content { max-width: 1000px; From patchwork Wed Oct 28 08:04:57 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 102255 Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.38064.1793174721538370948 for ; Wed, 28 Oct 2026 01:05:21 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=aFVXcAlU; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id 6FC3E1A1379 for ; Wed, 28 Oct 2026 08:05:19 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 3FDD960769 for ; Wed, 28 Oct 2026 08:05:19 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 5A418103290C8; Wed, 28 Oct 2026 09:05:18 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1793174718; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=n0ILl5RDNpPtD+5dMKGEqZ6Md2mGkqWXatvpL+27Daw=; b=aFVXcAlUNlQnO/gE72ywbGc8lJDC/1ZU/WwEKHQxyK05sz/ZlIZemp+lsxh88bix532TCe gR5F+J46F2dYYkXVIkVzhFLlBvvIo21duFtdN35ROHibDfe6O0x0u0YcKhz3gbXM/QeY5W J8HgxsaSjS7z/nNr9xbxbxXTxiq063qyllxN9NZwuVxAJReOrnCjREL3S1N2OMI8Wn5/Qf l4DiYx0Qqf9kXN8Jxg1rdjdp3NtHsJEYGp5F4Q1pWrHNAQ2ubj8QqeciAJALgJD+vBLNj2 o1MRKV/NutwnxLdRbSBHObFlbaauAgkP6QMRhLu52j3uqvPwfqQ66DeXRP9ebA== From: Antonin Godard Date: Wed, 28 Oct 2026 09:04:57 +0100 Subject: [PATCH 5/8] Makefile: use splithtml tag for html target MIME-Version: 1.0 Message-Id: <20261028-tags-v1-5-d5ad01019eae@bootlin.com> References: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> In-Reply-To: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> To: docs@lists.yoctoproject.org Cc: Antonin Godard , Thomas Petazzoni X-Mailer: b4 0.17-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=1005; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=L3TIlLa3o5l5SxYWf1Sil/HHtmkkTZ6vMG8ZbLqXmQc=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBq4ay4fUeP+QmobtguixOqruPi68Me307FxFotK ma6o32KHsKJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCauGsuAAKCRDRgEFAKaOo No7LEACKPSngoz7rLAPOldg51afPlyqyRk4fy6HdyaXm2rsYZQg1qmBWRSPrfFDYixcUFr1aOoW ItREd0xGe1QtWa/BOv9pMpNnr4QAcSFaPbDhczk7CSh6tkO7dzGAI736zdsLI1N2fYWYPPeM/pQ HKhIctvKxtAPiNPX5UQ9u2X0OHjYs5zHB96Uhx7HdlBy6o4s3sNTw68pcmrajz49dB0CvV4Xjus UYtO8v/lrRzZ8fBaYXVkBMRXqxcm2ZvifX7jBZA9pIq+paFcI5ofkTjcSaIubWKH9FbtjP7bH/v iXQlduP01WFP+C/bDtKLcCUcqUxrGLJaly2HUi65tAlHvUJheoNL+tn0Zyc2Mbe1i9oxBvhL/ip JmtkT9+O6LlRuU4RVbXrFY6Rd2wceLC6tZeAxDMWRjOvTxgBgmEQAL2gFJXWDO5ih1ebwA6RVOK opInDuUTbmnpG9DQxFXFKGprBnMGJW43/LFWXdoOyZbSrNrVh74kgzWSkU/FF5opoIjvIkUlusr xPr4CCftfC1N6j7H90SShVxBC7YuyzsCzmyaSnyaZKXzgCMAkKKoEMerPfSm5dDw0pppt4bc/ex 7P/IEbsFwbDhix4OaTJAkOpIlqoxd3HOkcrUnbUMEKQe2WYlvikW8g41HSb0/ilWulkkQPz2a0o TBjcWEWohG87urg== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by lin-tor-korg-lkml-alma10-1 with HTTPS for ; Wed, 28 Oct 2026 08:05:24 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10733 Sphinx has the ability to include content based on tags in the documentation with the '.. only::' directive. As '.. only:: html' is common to _all_ HTML-based documents (html, singlehtml, epub), there was no way to differentiate the split HTML build from the others. For that reason, add the splithtml tag when building it. The goal is be able to to include content _only_ for this build type. Signed-off-by: Antonin Godard --- documentation/Makefile | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/documentation/Makefile b/documentation/Makefile index f165e36c2..2f2d6213d 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -55,6 +55,10 @@ latexpdf: all: html epub latexpdf +html: + $(SOURCEDIR)/set_versions.py + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" --tag splithtml $(SPHINXOPTS) + %: $(SOURCEDIR)/set_versions.py @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) From patchwork Wed Oct 28 08:04:58 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 102256 Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.37908.1793174721891402408 for ; Wed, 28 Oct 2026 01:05:22 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=ksTvQ33I; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id 34C121A1374 for ; Wed, 28 Oct 2026 08:05:20 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 0237660769 for ; Wed, 28 Oct 2026 08:05:20 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 10A551032906B; Wed, 28 Oct 2026 09:05:19 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1793174719; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=M6k/2f+9tZYUhghujiiDUbenubNwQKccn/KifXJPBEo=; b=ksTvQ33INjazimnexGyMuzbkgPCHskUGX0iyWWmUp1LjLwmU/F42eTUUt9XoZaKP648WaE /U09GK92BoHAIj1I8+nsdGZhszIIVT+UZs6WHOsP2UmpUJS/lEPMR1APX+TJwmJOp6WF0f Svlh6XKPOaIGUNl9fXsH7PH4dYVwB9lwgx01AoZ/tHR+4huLVFjePCIIgVFVE1drLkQMjL PzeqHMmb+Ho36Zm4t23HqNvKy/FxMeYWvPTA6TGimtwp5h00SzvBncc7blnzuDbFbuF6XJ YQHegiNIN/vVBzL6ejVOiG6xu825T/3bSeORs8PkXJeIdJzaEV6GJg9OerYwYw== From: Antonin Godard Date: Wed, 28 Oct 2026 09:04:58 +0100 Subject: [PATCH 6/8] docs-wide: tag sections MIME-Version: 1.0 Message-Id: <20261028-tags-v1-6-d5ad01019eae@bootlin.com> References: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> In-Reply-To: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> To: docs@lists.yoctoproject.org Cc: Antonin Godard , Thomas Petazzoni X-Mailer: b4 0.17-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=40918; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=1Q5iiEW6iKOiC4pwRew7WCk1ekFvx/VHB5CRh4o8a2U=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBq4ay4uNUjnFKY8rok3v2CmotDVuY1+TskN6AUV bfKawDp8gWJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCauGsuAAKCRDRgEFAKaOo NjaBEACODh/U+Bja1nj0D3jPCfRt0CspB8O9VzWTXShlFftCb4jp98ZAgoC9OA0CwXqgyAvBRE0 4wBE+NDKp3/VRQ15yAiaVidsN3Kuwoo554SS2MxCsBj5MVJFzVednD7wT1iPcUtNHfGLv8aack8 n7HcDI2Ru8FlHBlEImi0P5PfJmcKzXVAobiObvH/tuS7Tpt75po7XKNMCTF9OXcNyshDrSGsg4Z rLAQiVqyl5+arKSr1U/0RI3GznnvwIZhYRANxrorM4q8EB5jfWukurlmsM5ni0MwSDlpRj8PQw0 Doq3inkGaBC1v/8EmXbNDGrCWXg8Hd2IJuo1gd2DzTeEKer80VCjEjeotCc121AY4Vt4qiFDgzk PYnjWze4Fsre6Rz8Lf+6FO4q/jWOqzFESzukkXqE1gy/mcbE9TtiZy8+fopzTXDnkOH1Q0SEf7I KsZ+g8kFADE3E+lP75LDI6UJzaVxQ96SLhzdVuM8XxkXRNrGsEIduirTOkFWM94XaMi91HhHur3 Z73872ODJqWtFWOmaIiKv1aIrNRXA4tRe+60PLotx6mM2EzU8CwBDsLl6o6rOHmfndAVWmgSimQ 7MCTyTLpvDIjTivvafQ8gBFHYgB1wt46MSdIQ2LyfXm8+3AAolR5lx0jHSfl0TJNxQtly3C86oG qGLoJ4BFSSXzsNw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by lin-tor-korg-lkml-alma10-1 with HTTPS for ; Wed, 28 Oct 2026 08:05:24 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10734 Make use of the sphinx-tags extension to tag section with category. After this commit, the following tags (with appearance count) are created: - app-dev (2) - build-configuration (7) - cli-tool (8) - config-fragments (2) - contributing (5) - conventions (2) - debugging (7) - devtool (3) - distro (1) - fakeroot (1) - flashing (2) - hash-equivalence (2) - host-configuration (12) - image-customization (2) - libraries (2) - license-compliance (2) - linux-kernel (1) - multiconfig (1) - oe-concepts (5) - packaging (1) - profiling (1) - pseudo (1) - qemu (1) - release-process (2) - reproducibility (1) - runtime-testing (2) - sdk (1) - security (7) - sstate (3) - target-configuration (5) - toolchains (4) - wic (2) The rationale was to create distinctive tags that could allow sections from different parts of the documentation to be linked together. Some tags only have one count: those still improve discoverability when looking at the tags overview page. Tags are only compatible with the regular HTML build (not singlehtml or epub). For that reason use the .. only directive to show them only for splithtml. Signed-off-by: Antonin Godard --- documentation/contributor-guide/identify-component.rst | 4 ++++ documentation/contributor-guide/recipe-style-guide.rst | 4 ++++ documentation/contributor-guide/report-defect.rst | 4 ++++ documentation/contributor-guide/submit-changes.rst | 4 ++++ documentation/conventions.rst | 4 ++++ documentation/dev-manual/bblock.rst | 3 +++ documentation/dev-manual/bmaptool.rst | 4 ++++ documentation/dev-manual/build-quality.rst | 3 +++ documentation/dev-manual/building.rst | 3 +++ documentation/dev-manual/creating-fragments.rst | 4 ++++ documentation/dev-manual/custom-distribution.rst | 4 ++++ documentation/dev-manual/custom-template-configuration-directory.rst | 3 +++ documentation/dev-manual/customizing-images.rst | 3 +++ documentation/dev-manual/debugging.rst | 3 +++ documentation/dev-manual/development-shell.rst | 3 +++ documentation/dev-manual/device-manager.rst | 3 +++ documentation/dev-manual/devtool.rst | 4 ++++ documentation/dev-manual/disk-space.rst | 4 ++++ documentation/dev-manual/efficiently-fetching-sources.rst | 3 +++ documentation/dev-manual/error-reporting-tool.rst | 3 +++ documentation/dev-manual/external-scm.rst | 3 +++ documentation/dev-manual/external-toolchain.rst | 4 ++++ documentation/dev-manual/gobject-introspection.rst | 3 +++ documentation/dev-manual/hashequivserver.rst | 4 ++++ documentation/dev-manual/init-manager.rst | 4 ++++ documentation/dev-manual/layers.rst | 3 +++ documentation/dev-manual/libraries.rst | 3 +++ documentation/dev-manual/licenses.rst | 3 +++ documentation/dev-manual/limiting-resources.rst | 4 ++++ documentation/dev-manual/multiconfig.rst | 4 ++++ documentation/dev-manual/new-machine.rst | 3 +++ documentation/dev-manual/new-recipe.rst | 3 +++ documentation/dev-manual/packages.rst | 3 +++ documentation/dev-manual/poky-manual-setup.rst | 4 ++++ documentation/dev-manual/prebuilt-libraries.rst | 3 +++ documentation/dev-manual/python-development-shell.rst | 3 +++ documentation/dev-manual/qemu.rst | 4 ++++ documentation/dev-manual/quilt.rst | 3 +++ documentation/dev-manual/sbom.rst | 4 ++++ documentation/dev-manual/speeding-up-build.rst | 3 +++ documentation/dev-manual/sstate-mirrors-setup.rst | 4 ++++ documentation/dev-manual/start.rst | 4 ++++ documentation/dev-manual/temporary-source-code.rst | 4 ++++ documentation/dev-manual/upgrading-recipes.rst | 3 +++ documentation/dev-manual/wayland.rst | 3 +++ documentation/dev-manual/wic.rst | 3 +++ documentation/dev-manual/x32-psabi.rst | 3 +++ documentation/kernel-dev/index.rst | 4 ++++ documentation/overview-manual/concepts.rst | 4 ++++ documentation/overview-manual/development-environment.rst | 4 ++++ documentation/overview-manual/yp-intro.rst | 4 ++++ documentation/profile-manual/index.rst | 4 ++++ documentation/ref-manual/devtool-reference.rst | 4 ++++ documentation/ref-manual/fragments.rst | 4 ++++ documentation/ref-manual/kickstart.rst | 4 ++++ documentation/ref-manual/release-process.rst | 4 ++++ documentation/sdk-manual/index.rst | 4 ++++ documentation/security-manual/build-process-security.rst | 4 ++++ documentation/security-manual/read-only-rootfs.rst | 3 +++ documentation/security-manual/securing-images.rst | 3 +++ documentation/security-manual/sstate-signing.rst | 4 ++++ documentation/security-manual/vulnerabilities.rst | 3 +++ documentation/security-reference/index.rst | 4 ++++ documentation/test-manual/ptest.rst | 4 ++++ documentation/test-manual/reproducible-builds.rst | 4 ++++ documentation/test-manual/runtime-testing.rst | 3 +++ documentation/test-manual/test-process.rst | 4 ++++ documentation/toaster-manual/index.rst | 4 ++++ 68 files changed, 242 insertions(+) diff --git a/documentation/contributor-guide/identify-component.rst b/documentation/contributor-guide/identify-component.rst index 3fbd9553e..760801a67 100644 --- a/documentation/contributor-guide/identify-component.rst +++ b/documentation/contributor-guide/identify-component.rst @@ -20,3 +20,7 @@ If the issue is in the core metadata layer (OpenEmbedded-Core) or in BitBake, issues can be reported in the :yocto_bugs:`Yocto Project Bugzilla <>`. The :yocto_lists:`yocto ` mailing list is a general "catch-all" location where questions can be sent if you can't work out where something should go. + +.. only:: splithtml + + .. tags:: contributing diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst index fe12a8e6d..38c15813f 100644 --- a/documentation/contributor-guide/recipe-style-guide.rst +++ b/documentation/contributor-guide/recipe-style-guide.rst @@ -440,3 +440,7 @@ you can use `Git` configuration settings:: .. note:: Patches generated or updated by ``devtool`` are created with no signature. + +.. only:: splithtml + + .. tags:: contributing, conventions diff --git a/documentation/contributor-guide/report-defect.rst b/documentation/contributor-guide/report-defect.rst index 8ef133b84..23b8a5e93 100644 --- a/documentation/contributor-guide/report-defect.rst +++ b/documentation/contributor-guide/report-defect.rst @@ -65,3 +65,7 @@ medium and long term. We do encourage people to file bugs so issues are at least known about. It helps other users when they find somebody having the same issue as they do, and an issue that is unknown is much less likely to ever be fixed! + +.. only:: splithtml + + .. tags:: contributing diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 589545074..9eafb239d 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst @@ -898,3 +898,7 @@ Foundation policy, specifically: Additionally, the contributor should provide notice and attribution of such third party rights, along with information about the applicable license terms, with their contribution. + +.. only:: splithtml + + .. tags:: contributing diff --git a/documentation/conventions.rst b/documentation/conventions.rst index 3bba4223a..aeb360cf4 100644 --- a/documentation/conventions.rst +++ b/documentation/conventions.rst @@ -54,3 +54,7 @@ command: # This is a comment, not a command to run as root. $ bitbake core-image-minimal + +.. only:: splithtml + + .. tags:: conventions diff --git a/documentation/dev-manual/bblock.rst b/documentation/dev-manual/bblock.rst index b9d6606a9..bd4afd0bd 100644 --- a/documentation/dev-manual/bblock.rst +++ b/documentation/dev-manual/bblock.rst @@ -127,3 +127,6 @@ the following:: SIGGEN_LOCKEDSIGS_x86_64 += "python3-native:do_create_manifest:24f0abbec221d27bbb2909b6e846288b12cab419f1faf9f5006ed80423d37e28" SIGGEN_LOCKEDSIGS_x86_64 += "python3-native:do_addto_recipe_sysroot:bcb6a1905f113128de3f88d702b706befd6a786267c045ee82532759a7c214d7" +.. only:: splithtml + + .. tags:: host-configuration, cli-tool diff --git a/documentation/dev-manual/bmaptool.rst b/documentation/dev-manual/bmaptool.rst index b145974c6..c60904603 100644 --- a/documentation/dev-manual/bmaptool.rst +++ b/documentation/dev-manual/bmaptool.rst @@ -64,3 +64,7 @@ For help on the ``bmaptool`` command, use the following command:: is simply a transitional package which exists solely to ensure backward compatibility and smooth upgrades from older installations. + +.. only:: splithtml + + .. tags:: cli-tool, flashing diff --git a/documentation/dev-manual/build-quality.rst b/documentation/dev-manual/build-quality.rst index dc10d1f05..8be07cdbb 100644 --- a/documentation/dev-manual/build-quality.rst +++ b/documentation/dev-manual/build-quality.rst @@ -406,3 +406,6 @@ Here is a sample screenshot of the interface: .. image:: figures/buildhistory-web.png :width: 100% +.. only:: splithtml + + .. tags:: cli-tool, build-configuration diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst index d36a523f5..69f212f34 100644 --- a/documentation/dev-manual/building.rst +++ b/documentation/dev-manual/building.rst @@ -852,3 +852,6 @@ directory: those recipes to set :term:`SRCREV` to specific versions of the software. +.. only:: splithtml + + .. tags:: build-configuration diff --git a/documentation/dev-manual/creating-fragments.rst b/documentation/dev-manual/creating-fragments.rst index cd87341e9..42efa785a 100644 --- a/documentation/dev-manual/creating-fragments.rst +++ b/documentation/dev-manual/creating-fragments.rst @@ -144,3 +144,7 @@ You can then use the :ref:`ref-bitbake-config-build-enable-fragment` command to set a value to the ``CUSTOM_VARIABLE`` variable:: $ bitbake-config-build enable-fragment custom-builtin-fragment/somevalue + +.. only:: splithtml + + .. tags:: build-configuration, config-fragments diff --git a/documentation/dev-manual/custom-distribution.rst b/documentation/dev-manual/custom-distribution.rst index 7129439dd..6d8968022 100644 --- a/documentation/dev-manual/custom-distribution.rst +++ b/documentation/dev-manual/custom-distribution.rst @@ -139,3 +139,7 @@ This is fine, however if you do this you should keep the following in mind: - More generally, the Poky distribution configuration enables a lot more than you likely need for your production use case. You should evaluate *every* configuration choice made in your copy to determine if it is needed. + +.. only:: splithtml + + .. tags:: build-configuration, distro diff --git a/documentation/dev-manual/custom-template-configuration-directory.rst b/documentation/dev-manual/custom-template-configuration-directory.rst index 7febc8c4a..2160d94e4 100644 --- a/documentation/dev-manual/custom-template-configuration-directory.rst +++ b/documentation/dev-manual/custom-template-configuration-directory.rst @@ -50,3 +50,6 @@ when running the ``oe-init-build-env`` setup script. These can be edited further if needed to improve or change the build configurations available to the users, and provide useful summaries and detailed usage notes. +.. only:: splithtml + + .. tags:: build-configuration diff --git a/documentation/dev-manual/customizing-images.rst b/documentation/dev-manual/customizing-images.rst index ab12e342b..15f2a8a6d 100644 --- a/documentation/dev-manual/customizing-images.rst +++ b/documentation/dev-manual/customizing-images.rst @@ -220,3 +220,6 @@ unsets the variable in a configuration file:: Having no default hostname in the filesystem is suitable for environments that use dynamic hostnames such as virtual machines. +.. only:: splithtml + + .. tags:: image-customization diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst index 62e19a6c8..a7370ce6e 100644 --- a/documentation/dev-manual/debugging.rst +++ b/documentation/dev-manual/debugging.rst @@ -1276,3 +1276,6 @@ Here are some other tips that you might find useful: that are purely internal and have a limited scope (e.g. internal variables used to implement a single ``.bbclass`` file). +.. only:: splithtml + + .. tags:: debugging diff --git a/documentation/dev-manual/development-shell.rst b/documentation/dev-manual/development-shell.rst index be26bcffc..c3bc6dd98 100644 --- a/documentation/dev-manual/development-shell.rst +++ b/documentation/dev-manual/development-shell.rst @@ -80,3 +80,6 @@ terminal window. - It is also worth noting that ``devshell`` still works over X11 forwarding and similar situations. +.. only:: splithtml + + .. tags:: debugging diff --git a/documentation/dev-manual/device-manager.rst b/documentation/dev-manual/device-manager.rst index cc27b667a..be7f9c53b 100644 --- a/documentation/dev-manual/device-manager.rst +++ b/documentation/dev-manual/device-manager.rst @@ -72,3 +72,6 @@ your :ref:`structure-build-conf-local.conf` configuration file:: # VIRTUAL-RUNTIME_dev_manager = "busybox-mdev" # VIRTUAL-RUNTIME_dev_manager = "systemd" +.. only:: splithtml + + .. tags:: build-configuration diff --git a/documentation/dev-manual/devtool.rst b/documentation/dev-manual/devtool.rst index 3abec4a41..9de9e1352 100644 --- a/documentation/dev-manual/devtool.rst +++ b/documentation/dev-manual/devtool.rst @@ -1760,3 +1760,7 @@ target machine. device (e.g. RPM or OPKG). Consequently, you should not intermingle ``devtool deploy-target`` and package manager operations on the target device. Doing so could result in a conflicting set of files. + +.. only:: splithtml + + .. tags:: app-dev, cli-tool, devtool diff --git a/documentation/dev-manual/disk-space.rst b/documentation/dev-manual/disk-space.rst index ee02b2670..4a013a80d 100644 --- a/documentation/dev-manual/disk-space.rst +++ b/documentation/dev-manual/disk-space.rst @@ -59,3 +59,7 @@ Run ``sstate-cache-management.py`` for more details about this script. As this command is much more cautious and selective, removing only cache files, it will execute much slower than the simple ``find`` command described above. Therefore, it may not be your best option to trim huge cache directories. + +.. only:: splithtml + + .. tags:: host-configuration diff --git a/documentation/dev-manual/efficiently-fetching-sources.rst b/documentation/dev-manual/efficiently-fetching-sources.rst index ab72e8dd2..a4df5e524 100644 --- a/documentation/dev-manual/efficiently-fetching-sources.rst +++ b/documentation/dev-manual/efficiently-fetching-sources.rst @@ -66,3 +66,6 @@ variation of the BitBake command guarantees that you have all the sources for that BitBake target should you disconnect from the Internet and want to do the build later offline. +.. only:: splithtml + + .. tags:: host-configuration diff --git a/documentation/dev-manual/error-reporting-tool.rst b/documentation/dev-manual/error-reporting-tool.rst index dabade078..ee93877bb 100644 --- a/documentation/dev-manual/error-reporting-tool.rst +++ b/documentation/dev-manual/error-reporting-tool.rst @@ -81,3 +81,6 @@ If you want to set up your own error reporting server, you can obtain the code from the Git repository at :yocto_git:`/error-report-web/`. Instructions on how to set it up are in the README document. +.. only:: splithtml + + .. tags:: cli-tool, contributing, debugging diff --git a/documentation/dev-manual/external-scm.rst b/documentation/dev-manual/external-scm.rst index bab5055f7..da0f250ad 100644 --- a/documentation/dev-manual/external-scm.rst +++ b/documentation/dev-manual/external-scm.rst @@ -69,3 +69,6 @@ development source for numerous packages. The ``poky-bleeding`` distribution is not tested on a regular basis. Keep this in mind if you use it. +.. only:: splithtml + + .. tags:: host-configuration diff --git a/documentation/dev-manual/external-toolchain.rst b/documentation/dev-manual/external-toolchain.rst index 94b4e67a8..50a6cbb18 100644 --- a/documentation/dev-manual/external-toolchain.rst +++ b/documentation/dev-manual/external-toolchain.rst @@ -40,3 +40,7 @@ supporting GNU toolchains released by ARM. You can find further information by reading about the :term:`TCMODE` variable in the Yocto Project Reference Manual's variable glossary. + +.. only:: splithtml + + .. tags:: toolchains diff --git a/documentation/dev-manual/gobject-introspection.rst b/documentation/dev-manual/gobject-introspection.rst index 8203f17f0..0f6834515 100644 --- a/documentation/dev-manual/gobject-introspection.rst +++ b/documentation/dev-manual/gobject-introspection.rst @@ -153,3 +153,6 @@ Here are know issues in GObject Introspection Support: under 32-bit host machines. In particular, "qemumips64" is known to not work under i686. +.. only:: splithtml + + .. tags:: target-configuration diff --git a/documentation/dev-manual/hashequivserver.rst b/documentation/dev-manual/hashequivserver.rst index 0a67e79b6..a17456daa 100644 --- a/documentation/dev-manual/hashequivserver.rst +++ b/documentation/dev-manual/hashequivserver.rst @@ -127,3 +127,7 @@ This will make Hash Equivalence related changes be printed on the console, such as:: NOTE: Task :do_ unihash changed to dc0da29c62a2d78d8d853fbb9c173778fe7d6fa4a68c67494b17afffe8ca1894 + +.. only:: splithtml + + .. tags:: hash-equivalence, host-configuration diff --git a/documentation/dev-manual/init-manager.rst b/documentation/dev-manual/init-manager.rst index c9d344a88..d7e81d29a 100644 --- a/documentation/dev-manual/init-manager.rst +++ b/documentation/dev-manual/init-manager.rst @@ -160,3 +160,7 @@ increasing levels of complexity and functionality: .. [#footnote-systemd-size] Using systemd increases the ``core-image-minimal`` image size by 160\% for ``qemux86-64`` on Mickledore (4.2), compared to SysVinit. + +.. only:: splithtml + + .. tags:: target-configuration diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst index 5c8bf32b4..0f0629e9f 100644 --- a/documentation/dev-manual/layers.rst +++ b/documentation/dev-manual/layers.rst @@ -986,3 +986,6 @@ above: Both the ``create-layers-setup`` and the ``setup-layers`` provided several additional options that customize their behavior - you are welcome to study them via ``--help`` command line parameter. +.. only:: splithtml + + .. tags:: oe-concepts diff --git a/documentation/dev-manual/libraries.rst b/documentation/dev-manual/libraries.rst index d7b9f0cfc..142d33e9e 100644 --- a/documentation/dev-manual/libraries.rst +++ b/documentation/dev-manual/libraries.rst @@ -236,3 +236,6 @@ the following in your recipe:: DEPENDS = "clutter-1.8" +.. only:: splithtml + + .. tags:: libraries, target-configuration diff --git a/documentation/dev-manual/licenses.rst b/documentation/dev-manual/licenses.rst index 46a5a69dd..be6de5097 100644 --- a/documentation/dev-manual/licenses.rst +++ b/documentation/dev-manual/licenses.rst @@ -531,3 +531,6 @@ the license from the fetched source:: NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" +.. only:: splithtml + + .. tags:: license-compliance, target-configuration diff --git a/documentation/dev-manual/limiting-resources.rst b/documentation/dev-manual/limiting-resources.rst index 93c20c44c..a34d33085 100644 --- a/documentation/dev-manual/limiting-resources.rst +++ b/documentation/dev-manual/limiting-resources.rst @@ -147,3 +147,7 @@ details. This variable has no effect when any of :term:`BB_PRESSURE_MAX_CPU`, :term:`BB_PRESSURE_MAX_IO` or :term:`BB_PRESSURE_MAX_MEMORY` is set, as it was designed for systems that do not have pressure information available. + +.. only:: splithtml + + .. tags:: host-configuration diff --git a/documentation/dev-manual/multiconfig.rst b/documentation/dev-manual/multiconfig.rst index 58ff95c17..c8662ad3d 100644 --- a/documentation/dev-manual/multiconfig.rst +++ b/documentation/dev-manual/multiconfig.rst @@ -310,3 +310,7 @@ We can then add a :ref:`ref-tasks-install` task to ``my-parent-firmware``:: Doing the above will allow the firmware binary to be transferred and packaged into the Linux context and rootfs. + +.. only:: splithtml + + .. tags:: multiconfig, toolchains diff --git a/documentation/dev-manual/new-machine.rst b/documentation/dev-manual/new-machine.rst index b4d29027b..09cd0c4c3 100644 --- a/documentation/dev-manual/new-machine.rst +++ b/documentation/dev-manual/new-machine.rst @@ -116,3 +116,6 @@ Here is an example for "qemuarm" machine:: DISPLAY_DPI=150 DISPLAY_SUBPIXEL_ORDER=vrgb +.. only:: splithtml + + .. tags:: oe-concepts diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst index a270d82b5..159b35330 100644 --- a/documentation/dev-manual/new-recipe.rst +++ b/documentation/dev-manual/new-recipe.rst @@ -1676,3 +1676,6 @@ in the BitBake User Manual. might wish to use. If in doubt, you should check with multiple implementations --- including those from BusyBox. +.. only:: splithtml + + .. tags:: oe-concepts diff --git a/documentation/dev-manual/packages.rst b/documentation/dev-manual/packages.rst index 380d806be..17b960b80 100644 --- a/documentation/dev-manual/packages.rst +++ b/documentation/dev-manual/packages.rst @@ -1171,3 +1171,6 @@ packages:: PACKAGE_ADD_METADATA_IPK = "Vendor: CustomIpk\nGroup:Applications/Spreadsheets" +.. only:: splithtml + + .. tags:: packaging diff --git a/documentation/dev-manual/poky-manual-setup.rst b/documentation/dev-manual/poky-manual-setup.rst index ca8539b6b..76a889315 100644 --- a/documentation/dev-manual/poky-manual-setup.rst +++ b/documentation/dev-manual/poky-manual-setup.rst @@ -160,3 +160,7 @@ an entire Linux distribution, including the toolchain, from source. #. **Exit QEMU:** Exit QEMU by either clicking on the shutdown icon or by typing ``Ctrl-C`` in the QEMU transcript window from which you evoked QEMU. + +.. only:: splithtml + + .. tags:: build-configuration diff --git a/documentation/dev-manual/prebuilt-libraries.rst b/documentation/dev-manual/prebuilt-libraries.rst index 9cc8bd2d9..fa1091010 100644 --- a/documentation/dev-manual/prebuilt-libraries.rst +++ b/documentation/dev-manual/prebuilt-libraries.rst @@ -207,3 +207,6 @@ versioned library example. The "magic" is setting the :term:`SOLIBS` and install -m 0755 ${UNPACKDIR}/libfoo.so ${D}${libdir} } +.. only:: splithtml + + .. tags:: libraries diff --git a/documentation/dev-manual/python-development-shell.rst b/documentation/dev-manual/python-development-shell.rst index 034100ae8..7e1a5c9c1 100644 --- a/documentation/dev-manual/python-development-shell.rst +++ b/documentation/dev-manual/python-development-shell.rst @@ -47,3 +47,6 @@ controls what type of shell is opened. When you are finished using ``pydevshell``, you can exit the shell either by using Ctrl+d or closing the terminal window. +.. only:: splithtml + + .. tags:: debugging diff --git a/documentation/dev-manual/qemu.rst b/documentation/dev-manual/qemu.rst index d7e0b2f2f..856a372fb 100644 --- a/documentation/dev-manual/qemu.rst +++ b/documentation/dev-manual/qemu.rst @@ -477,3 +477,7 @@ command line: readable or writable and "slirp-enabled". - ``publicvnc``: Enables a VNC server open to all hosts. + +.. only:: splithtml + + .. tags:: debugging, qemu diff --git a/documentation/dev-manual/quilt.rst b/documentation/dev-manual/quilt.rst index 59240705a..5c589572d 100644 --- a/documentation/dev-manual/quilt.rst +++ b/documentation/dev-manual/quilt.rst @@ -87,3 +87,6 @@ Follow these general steps: SRC_URI += "file://my_changes.patch" +.. only:: splithtml + + .. tags:: app-dev, cli-tool diff --git a/documentation/dev-manual/sbom.rst b/documentation/dev-manual/sbom.rst index 45b63ed8e..0783c6a6d 100644 --- a/documentation/dev-manual/sbom.rst +++ b/documentation/dev-manual/sbom.rst @@ -96,3 +96,7 @@ See also Joshua Watt's presentations at FOSDEM 2023 and `SPDX in the Yocto Project `__ at FOSDEM 2024. + +.. only:: splithtml + + .. tags:: license-compliance, security diff --git a/documentation/dev-manual/speeding-up-build.rst b/documentation/dev-manual/speeding-up-build.rst index 262935313..10e73a597 100644 --- a/documentation/dev-manual/speeding-up-build.rst +++ b/documentation/dev-manual/speeding-up-build.rst @@ -107,3 +107,6 @@ that can help you speed up the build: the static libraries. If so, you might need to exclude them as well. +.. only:: splithtml + + .. tags:: host-configuration diff --git a/documentation/dev-manual/sstate-mirrors-setup.rst b/documentation/dev-manual/sstate-mirrors-setup.rst index e69aa00d1..92abd4387 100644 --- a/documentation/dev-manual/sstate-mirrors-setup.rst +++ b/documentation/dev-manual/sstate-mirrors-setup.rst @@ -192,3 +192,7 @@ module, the following logs are shown: Some artifacts may be found (returning 200 above). Some others will not be found because the expected artifacts on the client is not present on the server, in which case the client will rebuild the task (and its dependencies). + +.. only:: splithtml + + .. tags:: host-configuration, sstate diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 81466ca40..7d3ba99fc 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst @@ -537,3 +537,7 @@ Where To Go From Here - Configure your build: follow :ref:`overview-manual/concepts:User Configuration`. - Learn how and what to build with :term:`BitBake`: follow :doc:`/dev-manual/building`. + +.. only:: splithtml + + .. tags:: host-configuration diff --git a/documentation/dev-manual/temporary-source-code.rst b/documentation/dev-manual/temporary-source-code.rst index cb27d2207..b8bdf80e0 100644 --- a/documentation/dev-manual/temporary-source-code.rst +++ b/documentation/dev-manual/temporary-source-code.rst @@ -73,3 +73,7 @@ build system uses to build the package would be as follows:: To learn how to use ``devtool`` to add, modify, upgrade recipes and more, see the :ref:`dev-manual/devtool:Using the \`\`devtool\`\` command-line tool` section of this Development Tasks Manual. + +.. only:: splithtml + + .. tags:: debugging diff --git a/documentation/dev-manual/upgrading-recipes.rst b/documentation/dev-manual/upgrading-recipes.rst index f4b9df241..41cb39f96 100644 --- a/documentation/dev-manual/upgrading-recipes.rst +++ b/documentation/dev-manual/upgrading-recipes.rst @@ -397,3 +397,6 @@ To manually upgrade recipe versions, follow these general steps: builds work and any testing is successful, you can create commits for any changes in the layer holding your upgraded recipe. +.. only:: splithtml + + .. tags:: devtool diff --git a/documentation/dev-manual/wayland.rst b/documentation/dev-manual/wayland.rst index ec8ed86c1..5f814f9d3 100644 --- a/documentation/dev-manual/wayland.rst +++ b/documentation/dev-manual/wayland.rst @@ -88,3 +88,6 @@ the CLI, you need to do the following after your image is built: user@machine:~$ weston +.. only:: splithtml + + .. tags:: image-customization diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst index 85160bbdf..2f8351cd4 100644 --- a/documentation/dev-manual/wic.rst +++ b/documentation/dev-manual/wic.rst @@ -795,3 +795,6 @@ the existing kernel, and then inserts a new kernel: Using ``bmaptool`` is generally 10 to 20 times faster than using ``dd``. +.. only:: splithtml + + .. tags:: cli-tool, flashing, wic diff --git a/documentation/dev-manual/x32-psabi.rst b/documentation/dev-manual/x32-psabi.rst index 4ee5a5379..ec671b313 100644 --- a/documentation/dev-manual/x32-psabi.rst +++ b/documentation/dev-manual/x32-psabi.rst @@ -52,3 +52,6 @@ the x32 psABI. Here is an example:: $ bitbake core-image-sato +.. only:: splithtml + + .. tags:: target-configuration diff --git a/documentation/kernel-dev/index.rst b/documentation/kernel-dev/index.rst index bd20e371e..417e52150 100644 --- a/documentation/kernel-dev/index.rst +++ b/documentation/kernel-dev/index.rst @@ -17,4 +17,8 @@ Yocto Project Linux Kernel Development Manual maint-appx faq +.. only:: splithtml + + .. tags:: linux-kernel + .. include:: /boilerplate.rst diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 1e9c6d3a6..cca4764a8 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -2371,3 +2371,7 @@ executes to accomplish that. .. image:: svg/bitbake_tasks_map.* :width: 100% + +.. only:: splithtml + + .. tags:: fakeroot, hash-equivalence, oe-concepts, pseudo, toolchains, sstate diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 920908577..08b7af040 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst @@ -630,3 +630,7 @@ source licensing during the lifecycle of a product created using the Yocto Project, see the ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" section in the Yocto Project Development Tasks Manual. + +.. only:: splithtml + + .. tags:: host-configuration diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index ef7e66d03..fcf7ab561 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst @@ -751,3 +751,7 @@ helpful for getting started: dependencies for libraries or for other recipes as well as configuration and compilation options. Related recipes are consolidated into a layer. + +.. only:: splithtml + + .. tags:: oe-concepts diff --git a/documentation/profile-manual/index.rst b/documentation/profile-manual/index.rst index 0270932ca..b5a9b5552 100644 --- a/documentation/profile-manual/index.rst +++ b/documentation/profile-manual/index.rst @@ -15,4 +15,8 @@ Yocto Project Profiling and Tracing Manual usage examples +.. only:: splithtml + + .. tags:: debugging, profiling + .. include:: /boilerplate.rst diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index 3445d1b4e..76ad38149 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst @@ -690,3 +690,7 @@ and create a remote debugging configuration for the recipe. Similarly to For further details on the ``devtool ide-sdk`` command, see the ":doc:`/sdk-manual/extensible`" chapter in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. + +.. only:: splithtml + + .. tags:: devtool diff --git a/documentation/ref-manual/fragments.rst b/documentation/ref-manual/fragments.rst index c5640b826..2a04c4a96 100644 --- a/documentation/ref-manual/fragments.rst +++ b/documentation/ref-manual/fragments.rst @@ -289,3 +289,7 @@ The ``core/yocto-autobuilder/multilib-x86-lib64`` fragment enables :ref:`multilib ` configurations for supporting 64-bit libraries on 32-bit :wikipedia:`X86 ` builds. + +.. only:: splithtml + + .. tags:: cli-tool, config-fragments diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index 14aff6025..2918d778b 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst @@ -243,3 +243,7 @@ the current file. For example: include common.wks.inc bootloader --configfile="directdisk-bootloader-config.cfg" + +.. only:: splithtml + + .. tags:: wic diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst index a75d916bf..430eb1e76 100644 --- a/documentation/ref-manual/release-process.rst +++ b/documentation/ref-manual/release-process.rst @@ -389,3 +389,7 @@ takes the Autobuilder workers several hours. Finally, in addition to the Autobuilder's tests, the Yocto Project QA team also performs testing on a variety of platforms, which includes actual hardware, to ensure expected results. + +.. only:: splithtml + + .. tags:: release-process diff --git a/documentation/sdk-manual/index.rst b/documentation/sdk-manual/index.rst index a5c35caba..53638f1a5 100644 --- a/documentation/sdk-manual/index.rst +++ b/documentation/sdk-manual/index.rst @@ -18,4 +18,8 @@ Yocto Project Application Development and Software Development Kits (SDK/eSDK) M appendix-customizing appendix-customizing-standard +.. only:: splithtml + + .. tags:: sdk, toolchains + .. include:: /boilerplate.rst diff --git a/documentation/security-manual/build-process-security.rst b/documentation/security-manual/build-process-security.rst index 0c8da967a..ec1ef068a 100644 --- a/documentation/security-manual/build-process-security.rst +++ b/documentation/security-manual/build-process-security.rst @@ -48,3 +48,7 @@ consider that: being set up in such a way that if such an issue were ever discovered, which at some point could happen, the build environments themselves could be simply destroyed and rebuilt cleanly, i.e. they're disposable. + +.. only:: splithtml + + .. tags:: security diff --git a/documentation/security-manual/read-only-rootfs.rst b/documentation/security-manual/read-only-rootfs.rst index 823ddcecd..bdd073001 100644 --- a/documentation/security-manual/read-only-rootfs.rst +++ b/documentation/security-manual/read-only-rootfs.rst @@ -87,3 +87,6 @@ make sure that you configure processes and applications that attempt these types of writes do so to directories with write access (e.g. ``/tmp`` or ``/var/run``). +.. only:: splithtml + + .. tags:: security diff --git a/documentation/security-manual/securing-images.rst b/documentation/security-manual/securing-images.rst index 3aa55c2aa..105739090 100644 --- a/documentation/security-manual/securing-images.rst +++ b/documentation/security-manual/securing-images.rst @@ -138,3 +138,6 @@ The Yocto Project provides tools for making your image more secure. You can find these tools in the ``meta-security`` layer of the :yocto_git:`Yocto Project Source Repositories <>`. +.. only:: splithtml + + .. tags:: security diff --git a/documentation/security-manual/sstate-signing.rst b/documentation/security-manual/sstate-signing.rst index 74a5d6bf0..c7a751be9 100644 --- a/documentation/security-manual/sstate-signing.rst +++ b/documentation/security-manual/sstate-signing.rst @@ -283,3 +283,7 @@ Let's verify that signature verification works: As you can see, this does not prevent :term:`BitBake` from continuing, but the real task is executed instead of re-using the shared state. + +.. only:: splithtml + + .. tags:: host-configuration, security, sstate diff --git a/documentation/security-manual/vulnerabilities.rst b/documentation/security-manual/vulnerabilities.rst index 38fbd2c7e..e8e368e28 100644 --- a/documentation/security-manual/vulnerabilities.rst +++ b/documentation/security-manual/vulnerabilities.rst @@ -515,3 +515,6 @@ Example of output for a CVE rejected by the Linux CNA: "description": "Rejected by CNA" } +.. only:: splithtml + + .. tags:: security diff --git a/documentation/security-reference/index.rst b/documentation/security-reference/index.rst index c20a54d1a..bf3a77d57 100644 --- a/documentation/security-reference/index.rst +++ b/documentation/security-reference/index.rst @@ -11,4 +11,8 @@ Yocto Project Security Reference security-team reporting-vulnerabilities +.. only:: splithtml + + .. tags:: security + .. include:: /boilerplate.rst diff --git a/documentation/test-manual/ptest.rst b/documentation/test-manual/ptest.rst index 2b8672214..10019705c 100644 --- a/documentation/test-manual/ptest.rst +++ b/documentation/test-manual/ptest.rst @@ -184,3 +184,7 @@ test. Here is what you have to do for each recipe: ``install-ptest`` to run the tests. If this is not enough, you need to create a ``do_install_ptest`` function and make sure it gets called after the "make install-ptest" completes. + +.. only:: splithtml + + .. tags:: runtime-testing diff --git a/documentation/test-manual/reproducible-builds.rst b/documentation/test-manual/reproducible-builds.rst index 4e39cf3f7..e57b5ed25 100644 --- a/documentation/test-manual/reproducible-builds.rst +++ b/documentation/test-manual/reproducible-builds.rst @@ -165,3 +165,7 @@ You can have finer control on the test with: - :term:`OEQA_REPRODUCIBLE_TEST_TARGET`: lists recipes to be built, - :term:`OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS`: lists recipes that will be built using :ref:`Shared State `. + +.. only:: splithtml + + .. tags:: reproducibility diff --git a/documentation/test-manual/runtime-testing.rst b/documentation/test-manual/runtime-testing.rst index 5a7193f01..251eb3294 100644 --- a/documentation/test-manual/runtime-testing.rst +++ b/documentation/test-manual/runtime-testing.rst @@ -598,3 +598,6 @@ Once the test is complete, the packages are removed from the DUT:: ] } +.. only:: splithtml + + .. tags:: runtime-testing diff --git a/documentation/test-manual/test-process.rst b/documentation/test-manual/test-process.rst index 00215385b..102638b1d 100644 --- a/documentation/test-manual/test-process.rst +++ b/documentation/test-manual/test-process.rst @@ -97,3 +97,7 @@ The next steps include: - A final decision on whether to release is made by the YP TSC who have final oversight on release readiness. + +.. only:: splithtml + + .. tags:: release-process diff --git a/documentation/toaster-manual/index.rst b/documentation/toaster-manual/index.rst index 3ff4c6913..b9c008378 100644 --- a/documentation/toaster-manual/index.rst +++ b/documentation/toaster-manual/index.rst @@ -15,4 +15,8 @@ Toaster User Manual setup-and-use reference +.. only:: splithtml + + .. tags:: host-configuration + .. include:: /boilerplate.rst From patchwork Wed Oct 28 08:04:59 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 102257 Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.37909.1793174722393035124 for ; Wed, 28 Oct 2026 01:05:22 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=qxeUqCch; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id BE1851A1375 for ; Wed, 28 Oct 2026 08:05:20 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 92DB660769 for ; Wed, 28 Oct 2026 08:05:20 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id D94FA1032909C; Wed, 28 Oct 2026 09:05:19 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1793174720; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=KoAYpQmnzSb1EoD0Sz2nAoPSJAM80WHWHQ5YAOUtRkk=; b=qxeUqCch2oKg8mx0AxhL8q3X4F93vbq0O3xnOaMMr020Z0ju7KU0ydypEnGGk0ifxeB09V 1XKG1UUgucrqUsThAMUvt0KZq/0wLAcSHvfkhjK085QeTzMJCGrVKn8ukrNhdTLfFsl3i9 qe5urA+VSZJSy3kz784oVq93hkH9HAb7RV7zPekQ4bQbFWtfQQsy4rO7lsQiTJjtjQD8jq qtD7L4338Expr3GhJIhcAUUqyZleXnXBw7ySnk2m1N668VRGkTwpAGXYG18uCMIS7gIiY3 eb0HjLyXM8n9IDGtoLsB9Kxox1uA1VV/qA/yKSjm+eUrHwiEfGkGR518N6CkDA== From: Antonin Godard Date: Wed, 28 Oct 2026 09:04:59 +0100 Subject: [PATCH 7/8] index.rst: link to the tags overview page for splithtml MIME-Version: 1.0 Message-Id: <20261028-tags-v1-7-d5ad01019eae@bootlin.com> References: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> In-Reply-To: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> To: docs@lists.yoctoproject.org Cc: Antonin Godard , Thomas Petazzoni X-Mailer: b4 0.17-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=1492; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=Jr6jUpTgj5LdOJe7WlQn3Q6fJIlu5wzxTfPTG1cPLpI=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBq4ay4QpwjrugJQbfCzmiiJUPLFm1Qgtdzzcj6V gCPmHwc/J+JAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCauGsuAAKCRDRgEFAKaOo NtYTD/wP1gFQgV9G1A7y9dpi2/e5V+TIAhqDuxYz/jdA9MEuq3LfrjWKLIbnlvwzxbAMp53FtbO DfoIHzbtbs1AlEMyHS7Cp6ZBx595h8XRrM4xDmRymafc2AOzNdPwkMwo8lLG+WuIBG4kxzn0Gtr TwLGWMtIkDF72ml9PWNkyiQgO8SqMM8U7MPM6ZaveL4hRPxYHbezcZbQHw6M0ngT1WS1Rt+5wUW vSJowsqdTjJRD3wDAiw2i4/NE2EuRx1X7AFQa30YpubusR8dWdkgfLFG0ecXTYi1WnceEY4JMal jQrxn+TwX10bzSn/xXn74VlJrQHsBk0diDeNqAmcSw+Ai0/EJkcgapSK8fFCTcInWF6nGsR+a6b CqbkDDF3+fUoyyiXfTMhgHiXgVjTC/gFUtFM6u7hg2BhK9RjjbGeTLd3+xiNcaMpK0mv4/vCiyN ZRbB0pFakgZONDVPw+HCVhLekKcvp0LO/Lrsk0p7P5ex1MGRlk1fmGQqBTdKvugYwAED0GGKRxK CADdFA4eCb2iNOndaZZuBJBDV516h4FRIUIr401Yk3Kh0jUuTZ2R1f0ycGqKxWhoOlghM+joM9x KLn3uQB0Oe70bQHZcoGImQZYBvbfhLeTqM65rUzldt4zJUBfdM4rXl9ccATr970JxPICX94essN h175onYNtmpvgOA== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by lin-tor-korg-lkml-alma10-1 with HTTPS for ; Wed, 28 Oct 2026 08:05:24 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10735 The sphinx-tag extension only works for the splithtml build type. However, adding a toctree entry with the '.. only::' directive is not possible with Sphinx (see the warning admonition in [1]). For that reason, only add a sentence that references this tag overview page. [1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-only Signed-off-by: Antonin Godard --- documentation/index.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/documentation/index.rst b/documentation/index.rst index 72e51a445..a150ab605 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -41,6 +41,17 @@ Additional introductory resources. - `Technical Overview (external website) `__ - `Tips and Tricks Wiki (external website) `__ +.. + The conditional note below cannot hold a toctree directive properly: the + toctree addition would appear in all documentation types (singlehtml, pdf, + ...). Use a bare sentence instead as tags are only supported in the "html" + sphinx build mode. + +.. only:: splithtml + + Sections of this documentation are also grouped by categories with tags. An + overview is available at the following page: :ref:`tagoverview`. + Contributing to the Yocto Project ================================= From patchwork Wed Oct 28 08:05:00 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 102258 Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.37910.1793174723568310613 for ; Wed, 28 Oct 2026 01:05:23 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=cT3FvuIA; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id EBF731A1376 for ; Wed, 28 Oct 2026 08:05:21 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id B9C3060769 for ; Wed, 28 Oct 2026 08:05:21 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 6F77F103290AA; Wed, 28 Oct 2026 09:05:20 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1793174720; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=iLlBrDdLsuCw2tuRZAiMnQlFMiGROOvfxeaCSrHNn9U=; b=cT3FvuIA4RRLVecyblxsWpIfSXPH1ilWMBccvQuUY32mOKqYo9pDphxZenaG0Ma7beQnh3 MI+MNW7OjWvMNDA03Klu8LR99F3erhBXbUOMkusDYuFYAX6QltpO5KDbzWYHiPSh8/qXfz DEOmu5Ur1L201ADcW35lYzAvvnCu3v3zPHHOykSAE15U7bIxS1YdZYHJFeiwoGVf0EqzDx bJnrNC/cT+cTi2tyU75GH8Ll3N2+mJQ+2rkkkZPgOKhBbTca3uK9EYjA9wAo3GmFDvngm1 qCiNm3LlkFQGM5gCnJ1NIWlQX9QJF7GcXWPvnJlBNbqwZ6vxE49HFiiGS2fiVg== From: Antonin Godard Date: Wed, 28 Oct 2026 09:05:00 +0100 Subject: [PATCH 8/8] standards.md: add note about document tags MIME-Version: 1.0 Message-Id: <20261028-tags-v1-8-d5ad01019eae@bootlin.com> References: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> In-Reply-To: <20261028-tags-v1-0-d5ad01019eae@bootlin.com> To: docs@lists.yoctoproject.org Cc: Antonin Godard , Thomas Petazzoni X-Mailer: b4 0.17-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=1106; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=wkLGor74JflFHsf+vNYzw7NMUom0LKzBGrdGGo+QKNQ=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBq4ay4iXaJDZU06Phgd0xGZAGKVnW5GZv+0YeeE T1+o2L3sdOJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCauGsuAAKCRDRgEFAKaOo NunyD/48UcgPvqRl4xsz4vCJeCNmftv6xjOz9Q928rYrJFFPR1tJ90gBwCVBSa1ARsB6e8xSu5R u3fX+dcI1efdemdG4/lp+cGVy43h6x0T1Kwh4Qqam0Flmli/PV+On+BueUhXcuMyR/aRFqnA9yq 2/O5eIlkmR+tRGehXJWQsW1T4XokxQAiNzPAtcmBBxXADNVtFhlpHbxqBdz7COfj9BboFsSzJ4P 9dUzfB8TRmESauJDFFSSDzg0ES+KgY0hemHEEFKDhAVI1jzznR8mL1RUEnnds9dwWFYCY0z4RIb Z4ZSCFJgKXRgxYpM76wPg0Apj1ZOETBQOYxict8RvNLdwwT2+AN4/gCggER6OHxgL54tv8gZclL Dv6a4ZB8MRkajqLyng4Z4hf7D4XDBQodqk2ComzRGGRj92AcGqlaH14+YDGc7BFz/LA8JoMOwgN vItnLOXp6CdrZpgiq+HpsRtb+MtmOZGixQ7ibCqY4US/rBeQflip5kEt+N54wh7zYqFgT/gqQk7 LZxsMlTpl54csQMQnINZr0Lq8STkGAGZqHuY5MSDEI8eSB2T99WA0IxVBxonJW1QKP7SocIfzcQ d9iPOtvfT7k6delk9udoD1b4y3IM5Dcby77df9yFSexiYhFG9f+CHY165gH+QnFAo17dLBGvnK7 7nxGndd231nYuUQ== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by lin-tor-korg-lkml-alma10-1 with HTTPS for ; Wed, 28 Oct 2026 08:05:24 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10736 Add a note on adding tags to new documents. Signed-off-by: Antonin Godard --- documentation/standards.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/documentation/standards.md b/documentation/standards.md index 30d48a5bb..64b4cf13c 100644 --- a/documentation/standards.md +++ b/documentation/standards.md @@ -137,6 +137,21 @@ Note that only "absolute" paths (starting with a '/') are allowed. The root directory of that path is documentation/, that is, :doc:`/bsp-manual/index` points at documentation/bsp-manual/index.rst. +## Tagging new sections + +When adding a new document, consider adding one or more tags at the bottom of +the file with the following format: + +```rst +.. only:: splithtml + + .. tags:: , , ... +``` + +When adding tags, try to use one of the existing tags (see +https://docs.yoctoproject.org/_tags/tagsindex.html#tagoverview), unless none of +these fit for the document being added. + ## Adding screenshots The preferred format for adding screenshots is