dev manual inconsistently encourages changing "poky" checkout locally

dev manual inconsistently encourages changing "poky" checkout locally

[Robert P. J. Day]

  while at least one of the other YP docs stresses to never, ever,
ever mess with your checkout of poky, the dev manual here:

https://docs.yoctoproject.org/dev-manual/start.html#cloning-the-poky-repository

  reads: "Your local repository of poky is identical to the upstream
  poky repository at the time from which it was cloned. As you work
  with the local branch, you can periodically use the git pull --rebase
  command to be sure you are up-to-date with the upstream branch."

that seems inconsistent. does that merit rewording?

rday

Re: [docs] dev manual inconsistently encourages changing "poky" checkout locally

[Alexander Kanavin]

Can you point to the 'other doc' please? I think the idea is that one
never makes local modifications to poky, but pulling in upstream
changes is fine.

Alex

On Fri, 20 Jun 2025 at 11:05, Robert P. J. Day via
lists.yoctoproject.org <rpjday=crashcourse.ca@lists.yoctoproject.org>
wrote:
>
>
>   while at least one of the other YP docs stresses to never, ever,
> ever mess with your checkout of poky, the dev manual here:
>
> https://docs.yoctoproject.org/dev-manual/start.html#cloning-the-poky-repository
>
>   reads: "Your local repository of poky is identical to the upstream
>   poky repository at the time from which it was cloned. As you work
>   with the local branch, you can periodically use the git pull --rebase
>   command to be sure you are up-to-date with the upstream branch."
>
> that seems inconsistent. does that merit rewording?
>
> rday
>
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#7118): https://lists.yoctoproject.org/g/docs/message/7118
> Mute This Topic: https://lists.yoctoproject.org/mt/113739433/1686489
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [alex.kanavin@gmail.com]
> -=-=-=-=-=-=-=-=-=-=-=-
>

Re: [docs] dev manual inconsistently encourages changing "poky" checkout locally

[Robert P. J. Day]

On Fri, 20 Jun 2025, Alexander Kanavin wrote:

> Can you point to the 'other doc' please? I think the idea is that one
> never makes local modifications to poky, but pulling in upstream
> changes is fine.
>
> Alex

  it's point 5 here:

https://docs.yoctoproject.org/what-i-wish-id-known.html

>
> On Fri, 20 Jun 2025 at 11:05, Robert P. J. Day via
> lists.yoctoproject.org <rpjday=crashcourse.ca@lists.yoctoproject.org>
> wrote:
> >
> >
> >   while at least one of the other YP docs stresses to never, ever,
> > ever mess with your checkout of poky, the dev manual here:
> >
> > https://docs.yoctoproject.org/dev-manual/start.html#cloning-the-poky-repository
> >
> >   reads: "Your local repository of poky is identical to the upstream
> >   poky repository at the time from which it was cloned. As you work
> >   with the local branch, you can periodically use the git pull --rebase
> >   command to be sure you are up-to-date with the upstream branch."
> >
> > that seems inconsistent. does that merit rewording?
> >
> > rday
> >
> >
> > -=-=-=-=-=-=-=-=-=-=-=-
> > Links: You receive all messages sent to this group.
> > View/Reply Online (#7118): https://lists.yoctoproject.org/g/docs/message/7118
> > Mute This Topic: https://lists.yoctoproject.org/mt/113739433/1686489
> > Group Owner: docs+owner@lists.yoctoproject.org
> > Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [alex.kanavin@gmail.com]
> > -=-=-=-=-=-=-=-=-=-=-=-
> >
>

Re: [docs] dev manual inconsistently encourages changing "poky" checkout locally

[Alexander Kanavin]

On Fri, 20 Jun 2025 at 11:44, Robert P. J. Day <rpjday@crashcourse.ca> wrote:
>   it's point 5 here:
>
> https://docs.yoctoproject.org/what-i-wish-id-known.html

"Never modify the POKY layer. Never. Ever. When you update to the next
release, you’ll lose all of your work. ALL OF IT."

I'm not sure what this point wants to say to be honest. Can't make sense of it.

Alex

Re: [docs] dev manual inconsistently encourages changing "poky" checkout locally

[Antonin Godard]

On Fri Jun 20, 2025 at 11:47 AM CEST, Alexander Kanavin via lists.yoctoproject.org wrote:
> On Fri, 20 Jun 2025 at 11:44, Robert P. J. Day <rpjday@crashcourse.ca> wrote:
>>   it's point 5 here:
>>
>> https://docs.yoctoproject.org/what-i-wish-id-known.html
>
> "Never modify the POKY layer. Never. Ever. When you update to the next
> release, you’ll lose all of your work. ALL OF IT."
>
> I'm not sure what this point wants to say to be honest. Can't make sense of it.

While the what-i-wish-id-known document is pretty clear about it, it's true that
saying "As you work with the local branch, you can periodically use the git pull
--rebase command to be sure you are up-to-date with the upstream branch." when
speaking about the poky repository kind of imply local modifications. And these
two documents are unrelated.

So all-in-all, I think what we want to remove here is the "--rebase" flag.
That's the only thing implying local modifications to poky. Using "git pull" is
fine. I'd take a patch.

Antonin

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