[PATCH] ref-manual: add potential of parallelism to defn of "Task"

[PATCH] ref-manual: add potential of parallelism to defn of "Task"

[Robert P. J. Day]

Emphasize that tasks can be done in parallel.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 32658051a..1a1f8dbee 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -367,10 +367,16 @@ universal, the list includes them just in case:
      section in the Yocto Project Overview and Concepts Manual.

    :term:`Task`
-      A unit of execution for BitBake (e.g.
+      A per-recipe unit of execution for BitBake (e.g.
       :ref:`ref-tasks-compile`,
       :ref:`ref-tasks-fetch`,
       :ref:`ref-tasks-patch`, and so forth).
+      One of the major benefits of the build system is that, since each
+      recipe will typically spawn the execution of numerous tasks, it is
+      entirely possible that many tasks can execute in parallel, with
+      the fetch task of one recipe being done simultaneously with the
+      build task of another, and so forth, potentially up to the
+      parallelism limit of your build system.

    :term:`Toaster`
       A web interface to the Yocto Project's :term:`OpenEmbedded Build System`.

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                         http://crashcourse.ca

LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

Re: [docs] [PATCH] ref-manual: add potential of parallelism to defn of "Task"

[Quentin Schulz]

Hi Robert,

On Mon, Sep 06, 2021 at 08:44:30AM -0400, Robert P. J. Day wrote:
> 
> Emphasize that tasks can be done in parallel.
> 
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> 
> ---
> 
> diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
> index 32658051a..1a1f8dbee 100644
> --- a/documentation/ref-manual/terms.rst
> +++ b/documentation/ref-manual/terms.rst
> @@ -367,10 +367,16 @@ universal, the list includes them just in case:
>       section in the Yocto Project Overview and Concepts Manual.
> 
>     :term:`Task`
> -      A unit of execution for BitBake (e.g.
> +      A per-recipe unit of execution for BitBake (e.g.
>        :ref:`ref-tasks-compile`,
>        :ref:`ref-tasks-fetch`,
>        :ref:`ref-tasks-patch`, and so forth).
> +      One of the major benefits of the build system is that, since each
> +      recipe will typically spawn the execution of numerous tasks, it is
> +      entirely possible that many tasks can execute in parallel, with
> +      the fetch task of one recipe being done simultaneously with the

:ref:`ref-tasks-fetch`

> +      build task of another, and so forth, potentially up to the
> +      parallelism limit of your build system.
> 

I'm not entirely sure now, but I'm wondering if this does not apply to
tasks within a recipe too?

Let's say you have the following task dependency tree:

	 do_install
	  /	 \
do_something	do_another_thing
	  \	 /
	  do_build

I would assume that do_something and do_another_thing can happen at the
same time (or in any variable order).

I think it'd be worth mentioning if that happens to be correct.

In any case,

Reviewed-by: Quentin Schulz <foss@0leil.ṅet>

Thanks!
Quentin

Re: [docs] [PATCH] ref-manual: add potential of parallelism to defn of "Task"

[Robert P. J. Day]

On Mon, 6 Sep 2021, Quentin Schulz wrote:

> Hi Robert,
>
> On Mon, Sep 06, 2021 at 08:44:30AM -0400, Robert P. J. Day wrote:
> >
> > Emphasize that tasks can be done in parallel.
> >
> > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> >
> > ---
> >
> > diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
> > index 32658051a..1a1f8dbee 100644
> > --- a/documentation/ref-manual/terms.rst
> > +++ b/documentation/ref-manual/terms.rst
> > @@ -367,10 +367,16 @@ universal, the list includes them just in case:
> >       section in the Yocto Project Overview and Concepts Manual.
> >
> >     :term:`Task`
> > -      A unit of execution for BitBake (e.g.
> > +      A per-recipe unit of execution for BitBake (e.g.
> >        :ref:`ref-tasks-compile`,
> >        :ref:`ref-tasks-fetch`,
> >        :ref:`ref-tasks-patch`, and so forth).
> > +      One of the major benefits of the build system is that, since each
> > +      recipe will typically spawn the execution of numerous tasks, it is
> > +      entirely possible that many tasks can execute in parallel, with
> > +      the fetch task of one recipe being done simultaneously with the
>
> :ref:`ref-tasks-fetch`
>
> > +      build task of another, and so forth, potentially up to the
> > +      parallelism limit of your build system.
> >
>
> I'm not entirely sure now, but I'm wondering if this does not apply to
> tasks within a recipe too?

  ... snip ...

i'd thought of that but decided to keep it brief, but thinking about
it, it would take only a few additional words to mention parallelism
within a single recipe.

rday