public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: "Antonin Godard" <antonin.godard@bootlin.com>
To: "Quentin Schulz" <quentin.schulz@cherry.de>,
	<docs@lists.yoctoproject.org>
Cc: "Thomas Petazzoni" <thomas.petazzoni@bootlin.com>
Subject: Re: [docs] [PATCH 1/8] conf.py: define new {oecore,bitbake,meta_yocto}_rev roles
Date: Thu, 05 Mar 2026 16:15:22 +0100	[thread overview]
Message-ID: <DGUY43IUX7B0.2AAGJEI0AT2S9@bootlin.com> (raw)
In-Reply-To: <d9b03e70-0027-4406-9577-f389f4721e93@cherry.de>

Hi,

On Thu Mar 5, 2026 at 11:56 AM CET, Quentin Schulz wrote:
> Hi Antonin,
>
> On 3/2/26 10:37 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`.
>> 
>> 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..f3234b241 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_baseurl = "https://git.openembedded.org/"
>> +oecore_git_baseurl = f"{oe_git_baseurl}/openembedded-core"
>> +bitbake_git_baseurl = f"{oe_git_baseurl}/bitbake"
>> +yocto_git_baseurl = "https://git.openembedded.org/"
>
> Well, thanks to my company's wonderful mail server this is broken but... 
> this should be git.yoctoproject.org and not git.openembedded.org.

Darn, thanks for spotting that.

>> +meta_yocto_baseurl = f"{yocto_git_baseurl}/meta-yocto"
>> +
>
> Small nitpick here, I think we should make it easier to distinguish the 
> server URLs from the repo URLs.
>
> What about something like
>
> oe_git_server = "https://git.openembedded.org/"
> oecore_git_baseurl = f"{oe_git_server}/openembedded-core"
>
> for example?
>
> Not sure we need _baseurl, it's kinda implied if we have oecore_git?

I'll take your suggestion, thanks!

Antonin


  reply	other threads:[~2026-03-05 15:15 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-02  9:37 [PATCH 0/8] Update the documentation for 6.0 (Wrynose) Antonin Godard
2026-03-02  9:37 ` [PATCH 1/8] conf.py: define new {oecore,bitbake,meta_yocto}_rev roles Antonin Godard
2026-03-05 10:56   ` [docs] " Quentin Schulz
2026-03-05 15:15     ` Antonin Godard [this message]
2026-03-02  9:37 ` [PATCH 2/8] ref-manual/variables.rst: document qemuboot variables Antonin Godard
2026-03-02  9:37 ` [PATCH 3/8] ref-manual/variables.rst: SPDX_PACKAGE_URL: add missing parenthesis Antonin Godard
2026-03-05 10:59   ` [docs] " Quentin Schulz
2026-03-02  9:37 ` [PATCH 4/8] ref-manual/variables.rst: document the LTO variable Antonin Godard
2026-03-02  9:37 ` [PATCH 5/8] ref-manual/variables.rst: document the SPDX_CONCLUDED_LICENSE variable Antonin Godard
2026-03-05 11:00   ` [docs] " Quentin Schulz
2026-03-02  9:37 ` [PATCH 6/8] migration-guides: update 6.0 (Wrynose) release notes Antonin Godard
2026-03-05 11:42   ` [docs] " Quentin Schulz
2026-03-20 10:44     ` Antonin Godard
2026-03-20 12:19       ` Quentin Schulz
2026-03-20 12:40         ` Antonin Godard
2026-03-02  9:37 ` [PATCH 7/8] docs-wide: add warning on disabled NPM fetcher Antonin Godard
2026-03-05 11:47   ` [docs] " Quentin Schulz
2026-03-02  9:37 ` [PATCH 8/8] ref-manual/faq.rst: remove the CVS proxy note Antonin Godard
2026-03-05 11:48   ` [docs] " Quentin Schulz
2026-04-07 13:11 ` [PATCH 0/8] Update the documentation for 6.0 (Wrynose) 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=DGUY43IUX7B0.2AAGJEI0AT2S9@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=quentin.schulz@cherry.de \
    --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