From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
Antonin Godard <antonin.godard@bootlin.com>
Subject: [PATCH v2 1/8] conf.py: define new {oecore,bitbake,meta_yocto}_rev roles
Date: Fri, 20 Mar 2026 11:46:19 +0100 [thread overview]
Message-ID: <20260320-release-notes-6-0-v2-1-1bdb1eb142ae@bootlin.com> (raw)
In-Reply-To: <20260320-release-notes-6-0-v2-0-1bdb1eb142ae@bootlin.com>
Use the extlinks extension to create new roles to quickly reference a
commit from openembedded-core, bitbake, or meta-yocto.
For example, use as: :oecore_rev:`437e0419608e`.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/conf.py | 16 +++++++++++++---
1 file changed, 13 insertions(+), 3 deletions(-)
diff --git a/documentation/conf.py b/documentation/conf.py
index 5a69977cf..2b9f6e568 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -91,9 +91,17 @@ rst_prolog = """
.. |author| replace:: %s
""" % (project, copyright, author)
+# base url definitions
+oe_git_server = "https://git.openembedded.org"
+oecore_git = f"{oe_git_server}/openembedded-core"
+bitbake_git = f"{oe_git_server}/bitbake"
+yocto_git_server = "https://git.yoctoproject.org"
+meta_yocto = f"{yocto_git_server}/meta-yocto"
+
# external links and substitutions
extlinks = {
- 'bitbake_git': ('https://git.openembedded.org/bitbake%s', None),
+ 'bitbake_git': (f'{bitbake_git}%s', None),
+ 'bitbake_rev': (f'{bitbake_git}/commit/?id=%s', '%s'),
'cve_mitre': ('https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-%s', 'CVE-%s'),
'cve_nist': ('https://nvd.nist.gov/vuln/detail/CVE-%s', 'CVE-%s'),
'yocto_home': ('https://www.yoctoproject.org%s', None),
@@ -103,11 +111,13 @@ extlinks = {
'yocto_bugs': ('https://bugzilla.yoctoproject.org%s', None),
'yocto_ab': ('https://autobuilder.yoctoproject.org%s', None),
'yocto_docs': ('https://docs.yoctoproject.org%s', None),
- 'yocto_git': ('https://git.yoctoproject.org%s', None),
+ 'yocto_git': (f'{yocto_git_server}%s', None),
+ 'meta_yocto_rev': (f'{meta_yocto}/commit/?id=%s', '%s'),
'yocto_sstate': ('http://sstate.yoctoproject.org%s', None),
'oe_home': ('https://www.openembedded.org%s', None),
'oe_lists': ('https://lists.openembedded.org%s', None),
- 'oe_git': ('https://git.openembedded.org%s', None),
+ 'oe_git': (f'{oe_git_server}%s', None),
+ 'oecore_rev': (f'{oecore_git}/commit/?id=%s', '%s'),
'oe_wiki': ('https://www.openembedded.org/wiki%s', None),
'oe_layerindex': ('https://layers.openembedded.org%s', None),
'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),
--
2.53.0
next prev parent reply other threads:[~2026-03-20 10:46 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-03-20 10:46 [PATCH v2 0/8] Update the documentation for 6.0 (Wrynose) Antonin Godard
2026-03-20 10:46 ` Antonin Godard [this message]
2026-03-20 10:46 ` [PATCH v2 2/8] ref-manual/variables.rst: document qemuboot variables Antonin Godard
2026-03-20 10:46 ` [PATCH v2 3/8] ref-manual/variables.rst: SPDX_PACKAGE_URL: add missing parenthesis Antonin Godard
2026-03-20 10:46 ` [PATCH v2 4/8] ref-manual/variables.rst: document the LTO variable Antonin Godard
2026-03-20 10:46 ` [PATCH v2 5/8] ref-manual/variables.rst: document the SPDX_CONCLUDED_LICENSE variable Antonin Godard
2026-03-20 10:46 ` [PATCH v2 6/8] migration-guides: update 6.0 (Wrynose) release notes Antonin Godard
2026-03-20 10:46 ` [PATCH v2 7/8] docs-wide: add warning on disabled NPM fetcher Antonin Godard
2026-03-20 10:46 ` [PATCH v2 8/8] ref-manual/faq.rst: remove the CVS proxy note Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260320-release-notes-6-0-v2-1-1bdb1eb142ae@bootlin.com \
--to=antonin.godard@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=thomas.petazzoni@bootlin.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox