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 22/53] overview-manual/development-environment.rst: remove obsolete poky repo references
Date: Mon, 26 Jan 2026 16:22:55 +0100	[thread overview]
Message-ID: <DFYMH68TBJ0Y.2UHYWFH983C4G@bootlin.com> (raw)
In-Reply-To: <ed829b23-cc35-4191-8286-c07520bf0f4f@cherry.de>

Hi,

On Mon Jan 26, 2026 at 4:18 PM CET, Quentin Schulz wrote:
> Hi Antonin,
>
> On 1/26/26 3:57 PM, Antonin Godard wrote:
>> Hi,
>> 
>> On Tue Jan 13, 2026 at 2:49 PM CET, Quentin Schulz wrote:
>> [...]
>>>> +      :term:`BitBake` repositories. For example, if you have checked out the "&DISTRO_NAME_NO_CAP;"
>>>
>>> Do not use this branch as it will never exist as it points to the name
>>> of the not-yet-released version. You want to use
>>> DISTRO_NAME_NO_CAP_MINUS_ONE likely (or DISTRO_NAME_NO_CAP_LTS).
>> 
>> No? This is true for the dev version of the docs, but once the docs are
>> released, this equals to the current version of the docs you are reading.
>> 
>> [...]
>>>>    It is important to understand that Git tracks content change and not
>>>>    files. Git uses "branches" to organize different development efforts.
>>>> -For example, the ``poky`` repository has several branches that include
>>>> +For example, the :yocto_git:`yocto-docs </yocto-docs>` repository has several branches that include
>>>>    the current "&DISTRO_NAME_NO_CAP;" branch, the "master" branch, and many
>>>
>>> DISTRO_NAME_NO_CAP is wrong here, it's the not-yet-released version. We
>>> shouldn't be using that (or set_versions.py doesn't work right now). Or
>>> is it just wrong for the "master" branch of the docs maybe? Still,
>>> people will likely reach the official docs through the master branch?
>>> Should we show a warning on the docs for the master branch stating this
>>> applies only to unreleased software?
>> 
>> No, docs.yoctoproject.org shows the latest released version of the docs, which
>> is the tip of the whinlatter branch right now. The master version of the docs is
>> docs.yoctoproject.org/dev, and the master-next version of the docs is
>> docs.yoctoproject.org/next.
>> 
>
> Ack. FYI, the version is invalid though, c.f. 
> https://docs.yoctoproject.org/ref-manual/system-requirements.html#supported-linux-distributions 
> search for 5.3.999. So we should be wary of using that.

Correct, I'm also not a fan of that and find it confusing (a lot of people do)…
At the same time I wonder what else we could do/show when we're pointing to a
branch tip.

"5.3.999" -> "5.3 (latest)"?

> All good, got confused, sorry for the noise.

No worries!

Antonin

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



  reply	other threads:[~2026-01-26 15:23 UTC|newest]

Thread overview: 112+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-24 16:31 [PATCH 00/53] Remove obsolete poky repo references Antonin Godard
2025-12-24 16:31 ` [PATCH 01/53] transitioning-to-a-custom-environment.rst: remove " Antonin Godard
2026-01-13  9:58   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 02/53] dev-manual/start.rst: " Antonin Godard
2026-01-13 10:46   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 03/53] dev-manual/poky-manual-setup.rst: " Antonin Godard
2026-01-13 10:52   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 04/53] bsp-guide/bsp.rst: " Antonin Godard
2026-01-13 11:10   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 05/53] kernel-dev/advanced.rst: " Antonin Godard
2026-01-13 11:12   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 06/53] contributor-guide/submit-changes.rst: " Antonin Godard
2026-01-13 11:25   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 07/53] dev-manual/building.rst: " Antonin Godard
2026-01-13 11:30   ` [docs] " Quentin Schulz
2026-01-26 13:08     ` Antonin Godard
2025-12-24 16:31 ` [PATCH 08/53] dev-manual/debugging.rst: " Antonin Godard
2026-01-13 11:32   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 09/53] dev-manual/error-reporting-tool.rst: " Antonin Godard
2026-01-13 11:34   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 10/53] dev-manual/external-toolchain.rst: " Antonin Godard
2026-01-13 11:36   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 11/53] dev-manual/layers.rst: " Antonin Godard
2026-01-13 12:05   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 12/53] " Antonin Godard
2026-01-13 12:57   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 13/53] dev-manual/libraries.rst: " Antonin Godard
2026-01-13 12:59   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 14/53] dev-manual/new-recipe.rst: " Antonin Godard
2026-01-13 13:09   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 15/53] dev-manual/securing-images.rst: " Antonin Godard
2026-01-13 13:11   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 16/53] dev-manual/temporary-source-code.rst: " Antonin Godard
2026-01-13 13:11   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 17/53] dev-manual/wayland.rst: " Antonin Godard
2026-01-13 13:12   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 18/53] dev-manual/wic.rst: " Antonin Godard
2026-01-13 13:19   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 19/53] kernel-dev/common.rst: " Antonin Godard
2026-01-13 13:25   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 20/53] migration-guides/migration-1.4.rst: " Antonin Godard
2026-01-13 13:26   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 21/53] overview-manual/concepts.rst: " Antonin Godard
2026-01-13 13:31   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 22/53] overview-manual/development-environment.rst: " Antonin Godard
2026-01-13 13:49   ` [docs] " Quentin Schulz
2026-01-26 14:57     ` Antonin Godard
2026-01-26 15:18       ` Quentin Schulz
2026-01-26 15:22         ` Antonin Godard [this message]
2025-12-24 16:31 ` [PATCH 23/53] overview-manual/yp-intro.rst: " Antonin Godard
2026-01-13 13:55   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 24/53] ref-manual/classes.rst: " Antonin Godard
2026-01-13 14:00   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 25/53] ref-manual/images.rst: " Antonin Godard
2026-01-13 14:04   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 26/53] ref-manual/structure.rst: " Antonin Godard
2026-01-13 14:16   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 27/53] ref-manual/tasks.rst: " Antonin Godard
2026-01-13 14:17   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 28/53] ref-manual/variables.rst: " Antonin Godard
2026-01-13 14:22   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 29/53] sdk-manual/appendix-obtain.rst: " Antonin Godard
2026-01-13 14:23   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 30/53] sdk-manual/intro.rst: " Antonin Godard
2026-01-13 14:24   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 31/53] test-manual/runtime-testing.rst: " Antonin Godard
2026-01-13 14:24   ` [docs] " Quentin Schulz
2025-12-24 16:31 ` [PATCH 32/53] toaster-manual: " Antonin Godard
2026-01-13 14:41   ` [docs] " Quentin Schulz
2026-01-26 15:39     ` Antonin Godard
2025-12-24 16:31 ` [PATCH 33/53] README: " Antonin Godard
2026-01-13 14:44   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 34/53] contributor-guide/identify-component.rst: " Antonin Godard
2026-01-13 14:45   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 35/53] dev-manual/build-quality.rst: " Antonin Godard
2026-01-13 14:46   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 36/53] dev-manual/custom-distribution.rst: " Antonin Godard
2026-01-13 14:49   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 37/53] dev-manual/custom-template-configuration-directory.rst: " Antonin Godard
2026-01-13 14:50   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 38/53] dev-manual/init-manager.rst: " Antonin Godard
2026-01-13 14:50   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 39/53] dev-manual/licenses.rst: " Antonin Godard
2026-01-13 15:04   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 40/53] dev-manual/packages.rst: " Antonin Godard
2026-01-13 15:05   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 41/53] dev-manual/python-development-shell.rst: " Antonin Godard
2026-01-13 15:06   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 42/53] dev-manual/qemu.rst: " Antonin Godard
2026-01-13 15:08   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 43/53] dev-manual/upgrading-recipes.rst: " Antonin Godard
2026-01-13 15:09   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 44/53] dev-manual/vulnerabilities.rst: " Antonin Godard
2026-01-13 15:11   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 45/53] ref-manual/devtool-reference.rst: " Antonin Godard
2026-01-13 15:13   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 46/53] ref-manual/faq.rst: " Antonin Godard
2026-01-13 15:16   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 47/53] ref-manual/features.rst: " Antonin Godard
2026-01-13 15:17   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 48/53] ref-manual/release-process.rst: " Antonin Godard
2026-01-13 15:19   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 49/53] ref-manual/system-requirements.rst: " Antonin Godard
2026-01-13 15:21   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 50/53] ref-manual/yocto-project-supported-features.rst: remove obsolete poky repo reference Antonin Godard
2026-01-13 15:21   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 51/53] test-manual/reproducible-builds.rst: remove obsolete poky repo references Antonin Godard
2026-01-13 15:22   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 52/53] test-manual/understand-autobuilder.rst: " Antonin Godard
2026-01-13 15:23   ` [docs] " Quentin Schulz
2025-12-24 16:32 ` [PATCH 53/53] what-i-wish-id-known.rst: " Antonin Godard
2026-01-13 15:25   ` [docs] " Quentin Schulz

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=DFYMH68TBJ0Y.2UHYWFH983C4G@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