public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: Quentin Schulz <quentin.schulz@cherry.de>
To: antonin.godard@bootlin.com, docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: Re: [docs] [PATCH v2 22/56] overview-manual/development-environment.rst: remove obsolete poky repo references
Date: Wed, 28 Jan 2026 12:11:16 +0100	[thread overview]
Message-ID: <a16f5edc-d51a-4efb-a7b7-3d81092df3fc@cherry.de> (raw)
In-Reply-To: <20260127-remove-poky-references-v2-22-74bf80cc4e5a@bootlin.com>

Hi Antonin,

On 1/27/26 9:19 AM, Antonin Godard via lists.yoctoproject.org wrote:
> Remove references to the Poky repository, replace by OpenEmbedded-Core.
> Replace the poky examples for the Git section by yocto-docs.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   .../overview-manual/development-environment.rst    | 83 +++++++++++-----------
>   1 file changed, 41 insertions(+), 42 deletions(-)
> 
> diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst
> index ab9bd084c..0402e3456 100644
> --- a/documentation/overview-manual/development-environment.rst
> +++ b/documentation/overview-manual/development-environment.rst
> @@ -148,44 +148,42 @@ code browser is organized into categories by function such as IDE
>   Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. From the
>   interface, you can click on any particular item in the "Name" column and
>   see the URL at the bottom of the page that you need to clone a Git
> -repository for that particular item. Having a local Git repository of
> -the :term:`Source Directory`, which
> -is usually named "poky", allows you to make changes, contribute to the
> +repository for that particular item. Having a local Git clone of
> +these repositories allows you to make changes, contribute to the
>   history, and ultimately enhance the Yocto Project's tools, Board Support
>   Packages, and so forth.
>   
>   For any supported release of Yocto Project, you can also go to the
> -:yocto_home:`Yocto Project Website <>` and select the "DOWNLOADS"
> -item from the "SOFTWARE" menu and get a released tarball of the ``poky``
> -repository, any supported BSP tarball, or Yocto Project tools. Unpacking
> +:yocto_home:`Yocto Project Website <>` and select the "RELEASES"
> +item from the "DEVELOPMENT" menu and get a released tarball of the

Why making it harder to maintain by telling the user where to click 
instead of just providing a direct link which we can check with 
linkcheck if we want to?

s/RELEASES/Releases/

s/DEVELOPMENT/Development/

[...]

> --  :yocto_home:`DOWNLOADS page </software-overview/downloads/>`:
> -   The :yocto_home:`Yocto Project website <>` includes a "DOWNLOADS" page accessible
> +-  :yocto_home:`RELEASES page </development/releases/>`:
> +   The :yocto_home:`Yocto Project website <>` includes a "RELEASES" page accessible
>      through the "SOFTWARE" menu that allows you to download any Yocto

through the "Development" menu.

Also, they all are capitalized but not uppercase, i.e. Releases and not 
RELEASES.

>      Project release, tool, and Board Support Package (BSP) in tarball
>      form. The hyperlinks point to the tarballs under
> @@ -230,11 +228,11 @@ and so forth.
>      ":doc:`/contributor-guide/identify-component`"
>      section of the Yocto Project and OpenEmbedded Contributor Guide.
>   
> -The Yocto Project ``poky`` Git repository also has an upstream
> -contribution Git repository named ``poky-contrib``. You can see all the
> +The Yocto Project Git repositories may also have upstream
> +contribution Git repositories suffixed with ``-contrib``. You can see all the
>   branches in this repository using the web interface of the

Reported in v1:

You mention there can be multiple repositories but here you say "this
repository" which is confusing. Maybe use one of the contrib git repos
as example.

[...]

> @@ -449,19 +446,19 @@ The most common use is to checkout a working branch that matches a
>   specific Yocto Project release. Here is an example::
>   
>      $ cd ~
> -   $ git clone git://git.yoctoproject.org/poky
> -   $ cd poky
> +   $ git clone git://git.yoctoproject.org/yocto-docs
> +   $ cd yocto-docs
>      $ git fetch --tags
> -   $ git checkout tags/rocko-18.0.0 -b my_rocko-18.0.0
> +   $ git checkout tags/&DISTRO_NAME_NO_CAP;-&DISTRO; -b my_&DISTRO_NAME_NO_CAP;-&DISTRO;
>   
>   In this example, the name
>   of the top-level directory of your local Yocto Project repository is
> -``poky``. After moving to the ``poky`` directory, the ``git fetch``
> +``yocto-docs``. After moving to the ``yocto-docs`` directory, the ``git fetch``
>   command makes all the upstream tags available locally in your
>   repository. Finally, the ``git checkout`` command creates and checks out
> -a branch named "my-rocko-18.0.0" that is based on the upstream branch
> +a branch named "my_&DISTRO_NAME_NO_CAP;-&DISTRO;" that is based on the upstream branch
>   whose "HEAD" matches the commit in the repository associated with the
> -"rocko-18.0.0" tag. The files in your repository now exactly match that
> +"&DISTRO_NAME_NO_CAP;-&DISTRO;" tag. The files in your repository now exactly match that

Technicality but I believe this is incorrect in git. The only thing that 
matters is you check out a tag. The tag may not necessarily be on a 
branch (it is for us, but it doesn't *have* to be). Also, HEAD of 
whinlatter may not be the latest release tag so that is actually incorrect.

I guess we could make this a bit more palatable (and proper) by 
rewording to:

that is based on the upstream tag in the repository.

Maybe? Separate patch/series though, not a blocker here.

Cheers,
Quentin


  reply	other threads:[~2026-01-28 11:12 UTC|newest]

Thread overview: 92+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-27  8:18 [PATCH v2 00/56] Remove obsolete poky repo references Antonin Godard
2026-01-27  8:18 ` [PATCH v2 01/56] transitioning-to-a-custom-environment.rst: remove " Antonin Godard
2026-01-27  8:18 ` [PATCH v2 02/56] dev-manual/poky-manual-setup.rst: " Antonin Godard
2026-01-27 10:55   ` [docs] " Quentin Schulz
2026-01-27  8:18 ` [PATCH v2 03/56] dev-manual/start.rst: " Antonin Godard
2026-01-27 11:14   ` [docs] " Quentin Schulz
2026-01-27  8:18 ` [PATCH v2 04/56] bsp-guide/bsp.rst: " Antonin Godard
2026-01-27 11:27   ` [docs] " Quentin Schulz
2026-01-29 11:17     ` Antonin Godard
2026-01-27  8:19 ` [PATCH v2 05/56] kernel-dev/advanced.rst: " Antonin Godard
2026-01-27 13:05   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 06/56] contributor-guide/submit-changes.rst: " Antonin Godard
2026-01-27 13:37   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 07/56] dev-manual/building.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 08/56] dev-manual/debugging.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 09/56] dev-manual/error-reporting-tool.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 10/56] dev-manual/external-toolchain.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 11/56] dev-manual/layers.rst: " Antonin Godard
2026-01-27 15:18   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 12/56] " Antonin Godard
2026-01-27 15:29   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 13/56] dev-manual/libraries.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 14/56] dev-manual/new-recipe.rst: " Antonin Godard
2026-01-27 15:39   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 15/56] dev-manual/securing-images.rst: " Antonin Godard
2026-01-27 15:44   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 16/56] dev-manual/temporary-source-code.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 17/56] dev-manual/wayland.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 18/56] dev-manual/wic.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 19/56] kernel-dev/common.rst: " Antonin Godard
2026-01-27 17:41   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 20/56] migration-guides/migration-1.4.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 21/56] overview-manual/concepts.rst: " Antonin Godard
2026-01-27 17:58   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 22/56] overview-manual/development-environment.rst: " Antonin Godard
2026-01-28 11:11   ` Quentin Schulz [this message]
2026-01-27  8:19 ` [PATCH v2 23/56] overview-manual/yp-intro.rst: " Antonin Godard
2026-01-28 11:32   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 24/56] ref-manual/classes.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 25/56] ref-manual/images.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 26/56] ref-manual/structure.rst: " Antonin Godard
2026-01-28 11:48   ` [docs] " Quentin Schulz
2026-01-29 14:11     ` Antonin Godard
2026-01-27  8:19 ` [PATCH v2 27/56] ref-manual/tasks.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 28/56] ref-manual/variables.rst: " Antonin Godard
2026-01-28 13:36   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 29/56] sdk-manual/appendix-obtain.rst: " Antonin Godard
2026-01-28 13:36   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 30/56] sdk-manual/intro.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 31/56] test-manual/runtime-testing.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 32/56] README: " Antonin Godard
2026-01-28 13:40   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 33/56] README: replace obsolete substitution variables Antonin Godard
2026-01-27  8:19 ` [PATCH v2 34/56] contributor-guide/identify-component.rst: remove obsolete poky repo references Antonin Godard
2026-01-27  8:19 ` [PATCH v2 35/56] dev-manual/build-quality.rst: " Antonin Godard
2026-01-28 13:41   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 36/56] dev-manual/custom-distribution.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 37/56] dev-manual/custom-template-configuration-directory.rst: " Antonin Godard
2026-01-28 13:47   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 38/56] dev-manual/init-manager.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 39/56] dev-manual/licenses.rst: " Antonin Godard
2026-01-28 13:54   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 40/56] dev-manual/licenses.rst: instruct to use git-archive instead of removing .git Antonin Godard
2026-01-28 13:57   ` Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 41/56] dev-manual/packages.rst: remove obsolete poky repo references Antonin Godard
2026-01-28 14:01   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 42/56] dev-manual/python-development-shell.rst: " Antonin Godard
2026-01-28 14:02   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 43/56] dev-manual/qemu.rst: " Antonin Godard
2026-01-28 14:03   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 44/56] dev-manual/upgrading-recipes.rst: " Antonin Godard
2026-01-28 14:09   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 45/56] dev-manual/vulnerabilities.rst: " Antonin Godard
2026-01-28 14:11   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 46/56] ref-manual/devtool-reference.rst: " Antonin Godard
2026-01-28 14:15   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 47/56] ref-manual/faq.rst: " Antonin Godard
2026-01-28 14:23   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 48/56] ref-manual/features.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 49/56] ref-manual/release-process.rst: " Antonin Godard
2026-01-27  8:19 ` [PATCH v2 50/56] ref-manual/release-process.rst: remove repeated "in the" Antonin Godard
2026-01-28 14:27   ` Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 51/56] ref-manual/system-requirements.rst: remove obsolete poky repo references Antonin Godard
2026-01-28 14:48   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 52/56] ref-manual/system-requirements.rst: fix wrong path to install-buildtools Antonin Godard
2026-01-28 15:02   ` Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 53/56] ref-manual/yocto-project-supported-features.rst: remove obsolete poky repo reference Antonin Godard
2026-01-27  8:19 ` [PATCH v2 54/56] test-manual/reproducible-builds.rst: remove obsolete poky repo references Antonin Godard
2026-01-27  8:19 ` [PATCH v2 55/56] test-manual/understand-autobuilder.rst: " Antonin Godard
2026-01-28 15:03   ` [docs] " Quentin Schulz
2026-01-27  8:19 ` [PATCH v2 56/56] what-i-wish-id-known.rst: " Antonin Godard
2026-01-28 15:08   ` [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=a16f5edc-d51a-4efb-a7b7-3d81092df3fc@cherry.de \
    --to=quentin.schulz@cherry.de \
    --cc=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --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