| Message ID | 20240523135628.3076018-2-michael.opdenacker@bootlin.com |
|---|---|
| State | New |
| Headers | show |
| Series | [1/3] migration-guides: placeholder files for 5.1 | expand |
Hi Michael, On Thu, 23 May 2024 at 14:56, Michael Opdenacker via lists.yoctoproject.org <michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote: > > From: Michael Opdenacker <michael.opdenacker@bootlin.com> > > Note that this doesn't touch the "Source Fetching" section > in overview-manual/concepts.rst yet, as the unpack implementation > may not be finalized yet. > > Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> > --- > documentation/ref-manual/tasks.rst | 8 ++++---- > documentation/ref-manual/variables.rst | 5 +++++ > 2 files changed, 9 insertions(+), 4 deletions(-) > > diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst > index 2e4b23408d..70c0dea3bb 100644 > --- a/documentation/ref-manual/tasks.rst > +++ b/documentation/ref-manual/tasks.rst > @@ -412,12 +412,12 @@ them. You can learn more by looking at the > ------------- > > Unpacks the source code into a working directory pointed to by > -``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` > -variable also plays a role in where unpacked source files ultimately > -reside. For more information on how source files are unpacked, see the > +``${``\ :term:`UNPACKDIR`\ ``}``. Another, legacy way to specify > +this directory is through the :term:`S` and :term:`WORKDIR` variables. I find this sentence a little confusing to read. "Another, legacy" suggests you've already given a method that was legacy. But here you're really saying "Another way, which is legacy". Perhaps this could be phrased differently, e.g. "A legacy way to specify this directory is through..." Also it doesn't really tell you how to use S and WORKDIR. I wonder if you need to mention these at all, given they'll be described elsewhere in the document. Why point a user to something legacy? Thanks, Andrew Murray
Hi Andy On 5/23/24 at 16:15, Andrew Murray wrote: > Hi Michael, > > On Thu, 23 May 2024 at 14:56, Michael Opdenacker via > lists.yoctoproject.org > <michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote: >> From: Michael Opdenacker <michael.opdenacker@bootlin.com> >> >> Note that this doesn't touch the "Source Fetching" section >> in overview-manual/concepts.rst yet, as the unpack implementation >> may not be finalized yet. >> >> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> >> --- >> documentation/ref-manual/tasks.rst | 8 ++++---- >> documentation/ref-manual/variables.rst | 5 +++++ >> 2 files changed, 9 insertions(+), 4 deletions(-) >> >> diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst >> index 2e4b23408d..70c0dea3bb 100644 >> --- a/documentation/ref-manual/tasks.rst >> +++ b/documentation/ref-manual/tasks.rst >> @@ -412,12 +412,12 @@ them. You can learn more by looking at the >> ------------- >> >> Unpacks the source code into a working directory pointed to by >> -``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` >> -variable also plays a role in where unpacked source files ultimately >> -reside. For more information on how source files are unpacked, see the >> +``${``\ :term:`UNPACKDIR`\ ``}``. Another, legacy way to specify >> +this directory is through the :term:`S` and :term:`WORKDIR` variables. > I find this sentence a little confusing to read. > > "Another, legacy" suggests you've already given a method that was > legacy. But here you're really saying "Another way, which is legacy". > Perhaps this could be phrased differently, e.g. "A legacy way to > specify this directory is through..." > > Also it doesn't really tell you how to use S and WORKDIR. I wonder if > you need to mention these at all, given they'll be described elsewhere > in the document. Why point a user to something legacy? This definitely makes sense, thanks! I simplified my paragraph as follows: Unpacks the source code into a working directory pointed to by ``${``\ :term:`UNPACKDIR`\ ``}``. A legacy way to specify this directory is through the :term:`S` and :term:`WORKDIR` variables. For more information on how source files are unpacked, see the ":ref:`overview-manual/concepts:source fetching`" section in the Yocto Project Overview and Concepts Manual. Thanks again Cheers Michael.
On Fri, 24 May 2024 at 09:26, Michael Opdenacker <michael.opdenacker@bootlin.com> wrote: > > Hi Andy > > On 5/23/24 at 16:15, Andrew Murray wrote: > > Hi Michael, > > > > On Thu, 23 May 2024 at 14:56, Michael Opdenacker via > > lists.yoctoproject.org > > <michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote: > >> From: Michael Opdenacker <michael.opdenacker@bootlin.com> > >> > >> Note that this doesn't touch the "Source Fetching" section > >> in overview-manual/concepts.rst yet, as the unpack implementation > >> may not be finalized yet. > >> > >> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> > >> --- > >> documentation/ref-manual/tasks.rst | 8 ++++---- > >> documentation/ref-manual/variables.rst | 5 +++++ > >> 2 files changed, 9 insertions(+), 4 deletions(-) > >> > >> diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst > >> index 2e4b23408d..70c0dea3bb 100644 > >> --- a/documentation/ref-manual/tasks.rst > >> +++ b/documentation/ref-manual/tasks.rst > >> @@ -412,12 +412,12 @@ them. You can learn more by looking at the > >> ------------- > >> > >> Unpacks the source code into a working directory pointed to by > >> -``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` > >> -variable also plays a role in where unpacked source files ultimately > >> -reside. For more information on how source files are unpacked, see the > >> +``${``\ :term:`UNPACKDIR`\ ``}``. Another, legacy way to specify > >> +this directory is through the :term:`S` and :term:`WORKDIR` variables. > > I find this sentence a little confusing to read. > > > > "Another, legacy" suggests you've already given a method that was > > legacy. But here you're really saying "Another way, which is legacy". > > Perhaps this could be phrased differently, e.g. "A legacy way to > > specify this directory is through..." > > > > Also it doesn't really tell you how to use S and WORKDIR. I wonder if > > you need to mention these at all, given they'll be described elsewhere > > in the document. Why point a user to something legacy? > > This definitely makes sense, thanks! > > I simplified my paragraph as follows: > > Unpacks the source code into a working directory pointed to by > ``${``\ :term:`UNPACKDIR`\ ``}``. A legacy way to specify > this directory is through the :term:`S` and :term:`WORKDIR` variables. > For more information on how source files are unpacked, see the > ":ref:`overview-manual/concepts:source fetching`" > section in the Yocto Project Overview and Concepts Manual. That looks good. Feel free to add my: Reviewed-by: Andrew Murray <amurray@thegoodpenguin.co.uk>
On 5/24/24 at 12:01, Andrew Murray wrote: > That looks good. Feel free to add my: > > Reviewed-by: Andrew Murray <amurray@thegoodpenguin.co.uk> Done. Many thanks for the review! Cheers Michael.
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 2e4b23408d..70c0dea3bb 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -412,12 +412,12 @@ them. You can learn more by looking at the ------------- Unpacks the source code into a working directory pointed to by -``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` -variable also plays a role in where unpacked source files ultimately -reside. For more information on how source files are unpacked, see the +``${``\ :term:`UNPACKDIR`\ ``}``. Another, legacy way to specify +this directory is through the :term:`S` and :term:`WORKDIR` variables. +For more information on how source files are unpacked, see the ":ref:`overview-manual/concepts:source fetching`" section in the Yocto Project Overview and Concepts Manual and also see -the :term:`WORKDIR` and :term:`S` variable descriptions. +the :term:`UNPACKDIR`, :term:`WORKDIR` and :term:`S` variable descriptions. Manually Called Tasks ===================== diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 546c674699..07b5b6f95c 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -9698,6 +9698,11 @@ system and gives an overview of their function and contents. :ref:`ref-classes-insane` class and is only enabled if the recipe inherits the :ref:`ref-classes-autotools` class. + :term:`UNPACKDIR` + This variable, used by the :ref:`ref-classes-base` class, + specifies where fetches sources should be unpacked by the + :ref:`ref-tasks-unpack` task. + :term:`UPDATERCPN` For recipes inheriting the :ref:`ref-classes-update-rc.d` class, :term:`UPDATERCPN`