[1/8] dev-manual-common-tasks: Fix refs to testing branches

Submitted by Paul Barker on Nov. 11, 2020, 4:07 p.m. | Patch ID: 177925

Details

Message ID 20201111160800.5669-1-pbarker@konsulko.com
State New
Headers show

Commit Message

Paul Barker Nov. 11, 2020, 4:07 p.m.
After discussions on IRC with Ross we concluded that the `ross/mut`
branch shouldn't really be listed in the docs as it's more of a personal
test branch. Instead we should list the -next branches for
openembedded-core and poky.

Signed-off-by: Paul Barker <pbarker@konsulko.com>
---
 .../dev-manual/dev-manual-common-tasks.rst    | 35 ++++++++++++-------
 1 file changed, 23 insertions(+), 12 deletions(-)

Patch hide | download patch | download mbox

diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index 27aacde60..698b27377 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -10665,18 +10665,29 @@  to a contribution repository that is upstream. See the ":ref:`gs-git-workflows-a
 section in the Yocto Project Overview and Concepts Manual for additional
 concepts on working in the Yocto Project development environment.
 
-Two commonly used testing repositories exist for OpenEmbedded-Core:
-
--  *"ross/mut" branch:* The "mut" (master-under-test) tree exists in the
-   ``poky-contrib`` repository in the
-   :yocto_git:`Yocto Project source repositories <>`.
-
--  *"master-next" branch:* This branch is part of the main "poky"
-   repository in the Yocto Project source repositories.
-
-Maintainers use these branches to test submissions prior to merging
-patches. Thus, you can get an idea of the status of a patch based on
-whether the patch has been merged into one of these branches.
+Maintainers commonly use ``-next`` branches to test submissions prior to
+merging patches. Thus, you can get an idea of the status of a patch based on
+whether the patch has been merged into one of these branches. The commonly
+used testing branches for OpenEmbedded-Core are as follows:
+
+-  *openembedded-core "master-next" branch:* This branch is part of the
+   `openembedded-core <https://git.openembedded.org/openembedded-core/>`__
+   repository on git.openembedded.org and contains proposed changes to the
+   core metadata.
+
+-  *poky "master-next" branch:* This branch is part of the
+   `poky <https://git.yoctoproject.org/cgit/cgit.cgi/poky/>`__
+   repository on git.yoctoproject.org and combines proposed changes to
+   bitbake, the core metadata and the poky distro.
+
+Similarly, stable branches maintained by the project may have corresponding
+``-next`` branches which collect proposed changes. For example,
+``dunfell-next`` and ``gatesgarth-next`` branches in both the
+"openembdedded-core" and "poky" repositories.
+
+Other layers may have similar testing branches but there is no formal
+requirement or standard for these so please check the documentation for the
+layers you are contributing to.
 
 .. note::
 

Comments

Paul Barker Nov. 11, 2020, 4:27 p.m.
On Wed, 11 Nov 2020 at 16:08, Paul Barker <pbarker@konsulko.com> wrote:
>
> After discussions on IRC with Ross we concluded that the `ross/mut`
> branch shouldn't really be listed in the docs as it's more of a personal
> test branch. Instead we should list the -next branches for
> openembedded-core and poky.
>
> Signed-off-by: Paul Barker <pbarker@konsulko.com>

Cc: Ross.

> ---
>  .../dev-manual/dev-manual-common-tasks.rst    | 35 ++++++++++++-------
>  1 file changed, 23 insertions(+), 12 deletions(-)
>
> diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
> index 27aacde60..698b27377 100644
> --- a/documentation/dev-manual/dev-manual-common-tasks.rst
> +++ b/documentation/dev-manual/dev-manual-common-tasks.rst
> @@ -10665,18 +10665,29 @@ to a contribution repository that is upstream. See the ":ref:`gs-git-workflows-a
>  section in the Yocto Project Overview and Concepts Manual for additional
>  concepts on working in the Yocto Project development environment.
>
> -Two commonly used testing repositories exist for OpenEmbedded-Core:
> -
> --  *"ross/mut" branch:* The "mut" (master-under-test) tree exists in the
> -   ``poky-contrib`` repository in the
> -   :yocto_git:`Yocto Project source repositories <>`.
> -
> --  *"master-next" branch:* This branch is part of the main "poky"
> -   repository in the Yocto Project source repositories.
> -
> -Maintainers use these branches to test submissions prior to merging
> -patches. Thus, you can get an idea of the status of a patch based on
> -whether the patch has been merged into one of these branches.
> +Maintainers commonly use ``-next`` branches to test submissions prior to
> +merging patches. Thus, you can get an idea of the status of a patch based on
> +whether the patch has been merged into one of these branches. The commonly
> +used testing branches for OpenEmbedded-Core are as follows:
> +
> +-  *openembedded-core "master-next" branch:* This branch is part of the
> +   `openembedded-core <https://git.openembedded.org/openembedded-core/>`__
> +   repository on git.openembedded.org and contains proposed changes to the
> +   core metadata.
> +
> +-  *poky "master-next" branch:* This branch is part of the
> +   `poky <https://git.yoctoproject.org/cgit/cgit.cgi/poky/>`__
> +   repository on git.yoctoproject.org and combines proposed changes to
> +   bitbake, the core metadata and the poky distro.
> +
> +Similarly, stable branches maintained by the project may have corresponding
> +``-next`` branches which collect proposed changes. For example,
> +``dunfell-next`` and ``gatesgarth-next`` branches in both the
> +"openembdedded-core" and "poky" repositories.
> +
> +Other layers may have similar testing branches but there is no formal
> +requirement or standard for these so please check the documentation for the
> +layers you are contributing to.
>
>  .. note::
>
> --
> 2.20.1
>
Quentin Schulz Nov. 11, 2020, 4:28 p.m.
Hi Paul,

On Wed, Nov 11, 2020 at 04:07:53PM +0000, Paul Barker wrote:
> After discussions on IRC with Ross we concluded that the `ross/mut`
> branch shouldn't really be listed in the docs as it's more of a personal
> test branch. Instead we should list the -next branches for
> openembedded-core and poky.
> 
> Signed-off-by: Paul Barker <pbarker@konsulko.com>
> ---
>  .../dev-manual/dev-manual-common-tasks.rst    | 35 ++++++++++++-------
>  1 file changed, 23 insertions(+), 12 deletions(-)
> 
> diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
> index 27aacde60..698b27377 100644
> --- a/documentation/dev-manual/dev-manual-common-tasks.rst
> +++ b/documentation/dev-manual/dev-manual-common-tasks.rst
> @@ -10665,18 +10665,29 @@ to a contribution repository that is upstream. See the ":ref:`gs-git-workflows-a
>  section in the Yocto Project Overview and Concepts Manual for additional
>  concepts on working in the Yocto Project development environment.
>  
> -Two commonly used testing repositories exist for OpenEmbedded-Core:
> -
> --  *"ross/mut" branch:* The "mut" (master-under-test) tree exists in the
> -   ``poky-contrib`` repository in the
> -   :yocto_git:`Yocto Project source repositories <>`.
> -
> --  *"master-next" branch:* This branch is part of the main "poky"
> -   repository in the Yocto Project source repositories.
> -
> -Maintainers use these branches to test submissions prior to merging
> -patches. Thus, you can get an idea of the status of a patch based on
> -whether the patch has been merged into one of these branches.
> +Maintainers commonly use ``-next`` branches to test submissions prior to
> +merging patches. Thus, you can get an idea of the status of a patch based on
> +whether the patch has been merged into one of these branches. The commonly
> +used testing branches for OpenEmbedded-Core are as follows:
> +
> +-  *openembedded-core "master-next" branch:* This branch is part of the
> +   `openembedded-core <https://git.openembedded.org/openembedded-core/>`__

Side note: should we add a :oe_git: directive as we already have :yocto_git:?

> +   repository on git.openembedded.org and contains proposed changes to the
> +   core metadata.
> +
> +-  *poky "master-next" branch:* This branch is part of the
> +   `poky <https://git.yoctoproject.org/cgit/cgit.cgi/poky/>`__

:yocto_git:`poky </cgit/cgit.cgi/poky/>`

> +   repository on git.yoctoproject.org and combines proposed changes to

Maybe s/git.yoctoproject.org/&YOCTO_GIT_URL;/ ? Not convinced though, no
hard feeling if this is not taken into account.

Thanks,
Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#597): https://lists.yoctoproject.org/g/docs/message/597
Mute This Topic: https://lists.yoctoproject.org/mt/78185911/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Richard Purdie Nov. 11, 2020, 5:07 p.m.
On Wed, 2020-11-11 at 16:27 +0000, Paul Barker wrote:
> On Wed, 11 Nov 2020 at 16:08, Paul Barker <pbarker@konsulko.com>
> wrote:
> > After discussions on IRC with Ross we concluded that the `ross/mut`
> > branch shouldn't really be listed in the docs as it's more of a
> > personal
> > test branch. Instead we should list the -next branches for
> > openembedded-core and poky.
> > 
> > Signed-off-by: Paul Barker <pbarker@konsulko.com>
> 
> Cc: Ross.

Just for reference the testing manual was written around 12-18 months
ago and reflected the status quo at that time. The world has changed a
bit.

Cheers,

Richard
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#600): https://lists.yoctoproject.org/g/docs/message/600
Mute This Topic: https://lists.yoctoproject.org/mt/78185911/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Nicolas Dechesne Nov. 11, 2020, 5:25 p.m.
On Wed, Nov 11, 2020 at 5:28 PM Quentin Schulz
<quentin.schulz@streamunlimited.com> wrote:
>
> Hi Paul,
>
> On Wed, Nov 11, 2020 at 04:07:53PM +0000, Paul Barker wrote:
> > After discussions on IRC with Ross we concluded that the `ross/mut`
> > branch shouldn't really be listed in the docs as it's more of a personal
> > test branch. Instead we should list the -next branches for
> > openembedded-core and poky.
> >
> > Signed-off-by: Paul Barker <pbarker@konsulko.com>
> > ---
> >  .../dev-manual/dev-manual-common-tasks.rst    | 35 ++++++++++++-------
> >  1 file changed, 23 insertions(+), 12 deletions(-)
> >
> > diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
> > index 27aacde60..698b27377 100644
> > --- a/documentation/dev-manual/dev-manual-common-tasks.rst
> > +++ b/documentation/dev-manual/dev-manual-common-tasks.rst
> > @@ -10665,18 +10665,29 @@ to a contribution repository that is upstream. See the ":ref:`gs-git-workflows-a
> >  section in the Yocto Project Overview and Concepts Manual for additional
> >  concepts on working in the Yocto Project development environment.
> >
> > -Two commonly used testing repositories exist for OpenEmbedded-Core:
> > -
> > --  *"ross/mut" branch:* The "mut" (master-under-test) tree exists in the
> > -   ``poky-contrib`` repository in the
> > -   :yocto_git:`Yocto Project source repositories <>`.
> > -
> > --  *"master-next" branch:* This branch is part of the main "poky"
> > -   repository in the Yocto Project source repositories.
> > -
> > -Maintainers use these branches to test submissions prior to merging
> > -patches. Thus, you can get an idea of the status of a patch based on
> > -whether the patch has been merged into one of these branches.
> > +Maintainers commonly use ``-next`` branches to test submissions prior to
> > +merging patches. Thus, you can get an idea of the status of a patch based on
> > +whether the patch has been merged into one of these branches. The commonly
> > +used testing branches for OpenEmbedded-Core are as follows:
> > +
> > +-  *openembedded-core "master-next" branch:* This branch is part of the
> > +   `openembedded-core <https://git.openembedded.org/openembedded-core/>`__
>
> Side note: should we add a :oe_git: directive as we already have :yocto_git:?
>
> > +   repository on git.openembedded.org and contains proposed changes to the
> > +   core metadata.
> > +
> > +-  *poky "master-next" branch:* This branch is part of the
> > +   `poky <https://git.yoctoproject.org/cgit/cgit.cgi/poky/>`__
>
> :yocto_git:`poky </cgit/cgit.cgi/poky/>`
>
> > +   repository on git.yoctoproject.org and combines proposed changes to
>
> Maybe s/git.yoctoproject.org/&YOCTO_GIT_URL;/ ? Not convinced though, no
> hard feeling if this is not taken into account.

or :yocto_git:`/` like we do in other places? It would render as
https://git.yoctoproject.org/ , not git.yoctoproject.org, but I think
it's better, no?

>
> Thanks,
> Quentin
>
> 
>
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#601): https://lists.yoctoproject.org/g/docs/message/601
Mute This Topic: https://lists.yoctoproject.org/mt/78185911/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Quentin Schulz Nov. 11, 2020, 5:29 p.m.
On Wed, Nov 11, 2020 at 06:25:45PM +0100, Nicolas Dechesne wrote:
> On Wed, Nov 11, 2020 at 5:28 PM Quentin Schulz
> <quentin.schulz@streamunlimited.com> wrote:
> >
> > Hi Paul,
> >
> > On Wed, Nov 11, 2020 at 04:07:53PM +0000, Paul Barker wrote:
> > > After discussions on IRC with Ross we concluded that the `ross/mut`
> > > branch shouldn't really be listed in the docs as it's more of a personal
> > > test branch. Instead we should list the -next branches for
> > > openembedded-core and poky.
> > >
> > > Signed-off-by: Paul Barker <pbarker@konsulko.com>
> > > ---
> > >  .../dev-manual/dev-manual-common-tasks.rst    | 35 ++++++++++++-------
> > >  1 file changed, 23 insertions(+), 12 deletions(-)
> > >
> > > diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
> > > index 27aacde60..698b27377 100644
> > > --- a/documentation/dev-manual/dev-manual-common-tasks.rst
> > > +++ b/documentation/dev-manual/dev-manual-common-tasks.rst
> > > @@ -10665,18 +10665,29 @@ to a contribution repository that is upstream. See the ":ref:`gs-git-workflows-a
> > >  section in the Yocto Project Overview and Concepts Manual for additional
> > >  concepts on working in the Yocto Project development environment.
> > >
> > > -Two commonly used testing repositories exist for OpenEmbedded-Core:
> > > -
> > > --  *"ross/mut" branch:* The "mut" (master-under-test) tree exists in the
> > > -   ``poky-contrib`` repository in the
> > > -   :yocto_git:`Yocto Project source repositories <>`.
> > > -
> > > --  *"master-next" branch:* This branch is part of the main "poky"
> > > -   repository in the Yocto Project source repositories.
> > > -
> > > -Maintainers use these branches to test submissions prior to merging
> > > -patches. Thus, you can get an idea of the status of a patch based on
> > > -whether the patch has been merged into one of these branches.
> > > +Maintainers commonly use ``-next`` branches to test submissions prior to
> > > +merging patches. Thus, you can get an idea of the status of a patch based on
> > > +whether the patch has been merged into one of these branches. The commonly
> > > +used testing branches for OpenEmbedded-Core are as follows:
> > > +
> > > +-  *openembedded-core "master-next" branch:* This branch is part of the
> > > +   `openembedded-core <https://git.openembedded.org/openembedded-core/>`__
> >
> > Side note: should we add a :oe_git: directive as we already have :yocto_git:?
> >
> > > +   repository on git.openembedded.org and contains proposed changes to the
> > > +   core metadata.
> > > +
> > > +-  *poky "master-next" branch:* This branch is part of the
> > > +   `poky <https://git.yoctoproject.org/cgit/cgit.cgi/poky/>`__
> >
> > :yocto_git:`poky </cgit/cgit.cgi/poky/>`
> >
> > > +   repository on git.yoctoproject.org and combines proposed changes to
> >
> > Maybe s/git.yoctoproject.org/&YOCTO_GIT_URL;/ ? Not convinced though, no
> > hard feeling if this is not taken into account.
> 
> or :yocto_git:`/` like we do in other places? It would render as
> https://git.yoctoproject.org/ , not git.yoctoproject.org, but I think
> it's better, no?
> 

+1 for the obvious, completely missed it.

Though, now, not sure we need to state that it's from
git.yoctoproject.org while actually giving a direct link to the poky
repo a few words before?

Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#602): https://lists.yoctoproject.org/g/docs/message/602
Mute This Topic: https://lists.yoctoproject.org/mt/78185911/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-