All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Antonin Godard" <antonin.godard@bootlin.com>
To: <patrick.vogelaar.dev@mailbox.org>,
	<bitbake-devel@lists.openembedded.org>
Cc: <docs@lists.yoctoproject.org>
Subject: Re: [docs][PATCH] doc: enhance SRCREV_FORMAT description
Date: Fri, 12 Sep 2025 17:02:46 +0200	[thread overview]
Message-ID: <DCQWVNMF7OTP.2YR0N4S0VTCCE@bootlin.com> (raw)
In-Reply-To: <20250910145400.232143-1-patrick.vogelaar.dev@mailbox.org>

On Wed Sep 10, 2025 at 4:54 PM CEST, Patrick Vogelaar via lists.yoctoproject.org wrote:
> Adding documentation for having an empty first component for the
> SRCREV_FORMAT.
>
> Signed-off-by: Patrick Vogelaar <patrick.vogelaar.dev@mailbox.org>
> ---
>  .../bitbake-user-manual-ref-variables.rst                   | 6 ++++++
>  1 file changed, 6 insertions(+)
>
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> index 810f88689..07e754096 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> @@ -1670,6 +1670,12 @@ overview of their function and contents.
>        ``AUTOINC`` placeholder is added and if needed. And, this placeholder
>        is placed at the start of the returned string.
>  
> +      The :term:`SRCREV_FORMAT` can also take the form "_component2".
> +      This assumes that there is a component in the :term:`SRC_URI` that does not
> +      have a name assigned. While this is not considered good practice, it can be
> +      usefull if a ``.bbappend`` file needs to extend the :term:`SRC_URI` with

s/usefull/useful/

> +      an additional repository.
> +
>     :term:`STAMP`
>        Specifies the base path used to create recipe stamp files. The path
>        to an actual stamp file is constructed by evaluating this string and

This is not a good practice, albeit useful. So what is the good practice, in the
case where I _do_ want an additional git remote source to be fetched? Modify
the original SRC_URI to include a name for the first component, and do 

SRCREV_FORMAT = "component1_component2"

as usual?

This doesn't sound practical so I'm leaning towards your solution. But if this
is something we should really never do, then I'm wondering if we should document
it here…

Antonin

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



  reply	other threads:[~2025-09-12 15:02 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-10 14:54 [docs][PATCH] doc: enhance SRCREV_FORMAT description Patrick Vogelaar
2025-09-12 15:02 ` Antonin Godard [this message]
2025-09-12 16:22   ` [bitbake-devel] " patrick.vogelaar.dev

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=DCQWVNMF7OTP.2YR0N4S0VTCCE@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=bitbake-devel@lists.openembedded.org \
    --cc=docs@lists.yoctoproject.org \
    --cc=patrick.vogelaar.dev@mailbox.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.