diff mbox series

[v3,1/8] conf.py: define new {oecore,bitbake,meta_yocto}_rev roles

Message ID 20260323-release-notes-6-0-v3-1-844ec702f95b@bootlin.com
State Under Review
Headers show
Series Update the documentation for 6.0 (Wrynose) | expand

Commit Message

Antonin Godard March 23, 2026, 8:49 a.m. UTC 
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(-)

Comments

Quentin Schulz March 23, 2026, 10:11 a.m. UTC | #1 
Hi Antonin,

On 3/23/26 9:49 AM, Antonin Godard via lists.yoctoproject.org wrote:
> 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`.
> 

No, please use the full git sha. The link caption will have the reduced 
sha when generated by Sphinx. This may be something we want to add to 
the standard.md for example?

At least, don't give incorrect instructions in the commit log :)



> 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..31fa8346d 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"

For consistency, maybe name this meta_yocto_git?

With the change in the commit log,

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin
diff mbox series

Patch

diff --git a/documentation/conf.py b/documentation/conf.py
index 5a69977cf..31fa8346d 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', '%.7s'),
     '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', '%.7s'),
     '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', '%.7s'),
     '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),