diff mbox series

[1/2] conf.py: add a bitbake_git extlink

Message ID 20241030-layer-confs-v1-1-0f7dcf460e27@bootlin.com
State New
Headers show
Series Document how to provide configuration from layer.conf | expand

Commit Message

Antonin Godard Oct. 30, 2024, 9:23 a.m. UTC
To make references to the bitbake repo, add an extlink for it and use it
in the docs with ":bitbake_git:`lib/bb/utils.py </tree/lib/bb/utils.py>`".

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/conf.py | 1 +
 1 file changed, 1 insertion(+)

Comments

Quentin Schulz Oct. 30, 2024, 10:21 a.m. UTC | #1
Hi Antonin,

On 10/30/24 10:23 AM, Antonin Godard via lists.yoctoproject.org wrote:
> To make references to the bitbake repo, add an extlink for it and use it
> in the docs with ":bitbake_git:`lib/bb/utils.py </tree/lib/bb/utils.py>`".
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>

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

I believe we could also migrate a few oe_git to bitbake_git now across 
the docs?

git grep 'oe_git.*bitbake' should help you identify those.

Thanks!
Quentin
Antonin Godard Oct. 30, 2024, 10:31 a.m. UTC | #2
Hi Quentin,

On Wed Oct 30, 2024 at 11:21 AM CET, Quentin Schulz wrote:
> Hi Antonin,
>
> On 10/30/24 10:23 AM, Antonin Godard via lists.yoctoproject.org wrote:
>> To make references to the bitbake repo, add an extlink for it and use it
>> in the docs with ":bitbake_git:`lib/bb/utils.py </tree/lib/bb/utils.py>`".
>>
>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
>
> I believe we could also migrate a few oe_git to bitbake_git now across
> the docs?
>
> git grep 'oe_git.*bitbake' should help you identify those.

Surely, I think there is also a lot of `poky_git` usage while it should be
`oe_git`… I have a note to fix that in my todo. :)

> Thanks!
> Quentin

Thank you,
Antonin

--
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
diff mbox series

Patch

diff --git a/documentation/conf.py b/documentation/conf.py
index 35c5c14535ba67aae3554819b55f0fb52a9d0027..d45aab45241fdce0e7eb3938e7562168752d7c93 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -90,6 +90,7 @@  rst_prolog = """
 
 # external links and substitutions
 extlinks = {
+    'bitbake_git': ('https://git.openembedded.org/bitbake%s', None),
     'cve': ('https://nvd.nist.gov/vuln/detail/CVE-%s', 'CVE-%s'),
     'cve_mitre': ('https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-%s', 'CVE-%s'),
     'yocto_home': ('https://www.yoctoproject.org%s', None),