[8/8] docs: ref-manual: ref-structure: replace oe-init-build-env by &OE_INIT_FILE;

Submitted by Quentin Schulz on Oct. 4, 2020, 8:57 a.m. | Patch ID: 176961

Details

Message ID 20201004085728.8015-8-foss@0leil.net
State New
Headers show

Commit Message

Quentin Schulz Oct. 4, 2020, 8:57 a.m.
Signed-off-by: Quentin Schulz <foss@0leil.net>
---
 documentation/ref-manual/ref-structure.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Patch hide | download patch | download mbox

diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
index 32c2dbf23..a5b43259e 100644
--- a/documentation/ref-manual/ref-structure.rst
+++ b/documentation/ref-manual/ref-structure.rst
@@ -139,7 +139,7 @@  back to the Yocto Project, such as ``create-pull-request`` and
 
 .. _structure-core-script:
 
-``oe-init-build-env``
+``&OE_INIT_FILE;``
 ---------------------
 
 This script sets up the OpenEmbedded build environment. Running this
@@ -156,7 +156,7 @@  simple suggestions as to what to do next, including a list of some
 possible targets to build. Here is an example:
 ::
 
-   $ source oe-init-build-env
+   $ source &OE_INIT_FILE;
 
    ### Shell environment set up for builds. ###
 
@@ -170,7 +170,7 @@  possible targets to build. Here is an example:
 
    You can also run generated qemu images with a command like 'runqemu qemux86-64'
 
-The default output of the ``oe-init-build-env`` script is from the
+The default output of the ``&OE_INIT_FILE;`` script is from the
 ``conf-notes.txt`` file, which is found in the ``meta-poky`` directory
 within the :term:`Source Directory`. If you design a
 custom distribution, you can include your own version of this

Comments

Nicolas Dechesne Oct. 5, 2020, 8:01 a.m.
On Sun, Oct 4, 2020 at 10:58 AM Quentin Schulz <foss@0leil.net> wrote:
>
> Signed-off-by: Quentin Schulz <foss@0leil.net>
> ---
>  documentation/ref-manual/ref-structure.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
> index 32c2dbf23..a5b43259e 100644
> --- a/documentation/ref-manual/ref-structure.rst
> +++ b/documentation/ref-manual/ref-structure.rst
> @@ -139,7 +139,7 @@ back to the Yocto Project, such as ``create-pull-request`` and
>
>  .. _structure-core-script:
>
> -``oe-init-build-env``
> +``&OE_INIT_FILE;``
>  ---------------------

this change is interesting. What happens to links with :ref: here? can
we now use &OE_INIT_FILE; in :ref: links? we have several instances
like this:
:ref:`ref-manual/ref-structure:\`\`oe-init-build-env\`\``

I remember that I converted all instances of &OE_INIT_FILE; initially,
then I figured out how to have variables subst with poky.yaml.. so we
probably have plenty of places where we should use OE_INIT_FILE
again..

>
>  This script sets up the OpenEmbedded build environment. Running this
> @@ -156,7 +156,7 @@ simple suggestions as to what to do next, including a list of some
>  possible targets to build. Here is an example:
>  ::
>
> -   $ source oe-init-build-env
> +   $ source &OE_INIT_FILE;
>
>     ### Shell environment set up for builds. ###
>
> @@ -170,7 +170,7 @@ possible targets to build. Here is an example:
>
>     You can also run generated qemu images with a command like 'runqemu qemux86-64'
>
> -The default output of the ``oe-init-build-env`` script is from the
> +The default output of the ``&OE_INIT_FILE;`` script is from the
>  ``conf-notes.txt`` file, which is found in the ``meta-poky`` directory
>  within the :term:`Source Directory`. If you design a
>  custom distribution, you can include your own version of this
> --
> 2.26.2
>
>
> 
>
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#430): https://lists.yoctoproject.org/g/docs/message/430
Mute This Topic: https://lists.yoctoproject.org/mt/77295041/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Quentin Schulz Oct. 5, 2020, 8:10 a.m.
Hi Nicolas,

On Mon, Oct 05, 2020 at 10:01:15AM +0200, Nicolas Dechesne wrote:
> On Sun, Oct 4, 2020 at 10:58 AM Quentin Schulz <foss@0leil.net> wrote:
> >
> > Signed-off-by: Quentin Schulz <foss@0leil.net>
> > ---
> >  documentation/ref-manual/ref-structure.rst | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
> > index 32c2dbf23..a5b43259e 100644
> > --- a/documentation/ref-manual/ref-structure.rst
> > +++ b/documentation/ref-manual/ref-structure.rst
> > @@ -139,7 +139,7 @@ back to the Yocto Project, such as ``create-pull-request`` and
> >
> >  .. _structure-core-script:
> >
> > -``oe-init-build-env``
> > +``&OE_INIT_FILE;``
> >  ---------------------
> 
> this change is interesting. What happens to links with :ref: here? can

I've replaced a bunch of broken refs to this section in other files. The ref to
use is actually :ref:`structure-core-script`.

> we now use &OE_INIT_FILE; in :ref: links? we have several instances
> like this:
> :ref:`ref-manual/ref-structure:\`\`oe-init-build-env\`\``
> 

Those should be converted to use :ref:`structure-core-script` instead.
In the manuals I've reviewed, documentation/ref-manual/ref-terms.rst is
the only one with such a change to make.

> I remember that I converted all instances of &OE_INIT_FILE; initially,
> then I figured out how to have variables subst with poky.yaml.. so we
> probably have plenty of places where we should use OE_INIT_FILE
> again..
> 

BTW, what's the logic behind replacing oe-init-build-env with
&OE_INIT_FILE; ? There's probably a sed to make tree wide to replace
those :)

Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#433): https://lists.yoctoproject.org/g/docs/message/433
Mute This Topic: https://lists.yoctoproject.org/mt/77295041/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Nicolas Dechesne Oct. 5, 2020, 8:13 a.m.
On Mon, Oct 5, 2020 at 10:10 AM Quentin Schulz
<quentin.schulz@streamunlimited.com> wrote:
>
> Hi Nicolas,
>
> On Mon, Oct 05, 2020 at 10:01:15AM +0200, Nicolas Dechesne wrote:
> > On Sun, Oct 4, 2020 at 10:58 AM Quentin Schulz <foss@0leil.net> wrote:
> > >
> > > Signed-off-by: Quentin Schulz <foss@0leil.net>
> > > ---
> > >  documentation/ref-manual/ref-structure.rst | 6 +++---
> > >  1 file changed, 3 insertions(+), 3 deletions(-)
> > >
> > > diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
> > > index 32c2dbf23..a5b43259e 100644
> > > --- a/documentation/ref-manual/ref-structure.rst
> > > +++ b/documentation/ref-manual/ref-structure.rst
> > > @@ -139,7 +139,7 @@ back to the Yocto Project, such as ``create-pull-request`` and
> > >
> > >  .. _structure-core-script:
> > >
> > > -``oe-init-build-env``
> > > +``&OE_INIT_FILE;``
> > >  ---------------------
> >
> > this change is interesting. What happens to links with :ref: here? can
>
> I've replaced a bunch of broken refs to this section in other files. The ref to
> use is actually :ref:`structure-core-script`.
>
> > we now use &OE_INIT_FILE; in :ref: links? we have several instances
> > like this:
> > :ref:`ref-manual/ref-structure:\`\`oe-init-build-env\`\``
> >
>
> Those should be converted to use :ref:`structure-core-script` instead.
> In the manuals I've reviewed, documentation/ref-manual/ref-terms.rst is
> the only one with such a change to make.
>
> > I remember that I converted all instances of &OE_INIT_FILE; initially,
> > then I figured out how to have variables subst with poky.yaml.. so we
> > probably have plenty of places where we should use OE_INIT_FILE
> > again..
> >
>
> BTW, what's the logic behind replacing oe-init-build-env with
> &OE_INIT_FILE; ? There's probably a sed to make tree wide to replace
> those :)

Just to be consistent.. if we have a variable for it, we should use
it.. though I am not convinced we needed a variable in the first
place.. i am not sure we plan to change that script name often ;) so
we should have OE_INIT_FILE and use it everywhere, or remove it, no?

>
> Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#435): https://lists.yoctoproject.org/g/docs/message/435
Mute This Topic: https://lists.yoctoproject.org/mt/77295041/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Quentin Schulz Oct. 5, 2020, 8:15 a.m.
On Mon, Oct 05, 2020 at 10:13:57AM +0200, Nicolas Dechesne wrote:
> On Mon, Oct 5, 2020 at 10:10 AM Quentin Schulz
> <quentin.schulz@streamunlimited.com> wrote:
> >
> > Hi Nicolas,
> >
> > On Mon, Oct 05, 2020 at 10:01:15AM +0200, Nicolas Dechesne wrote:
> > > On Sun, Oct 4, 2020 at 10:58 AM Quentin Schulz <foss@0leil.net> wrote:
> > > >
> > > > Signed-off-by: Quentin Schulz <foss@0leil.net>
> > > > ---
> > > >  documentation/ref-manual/ref-structure.rst | 6 +++---
> > > >  1 file changed, 3 insertions(+), 3 deletions(-)
> > > >
> > > > diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
> > > > index 32c2dbf23..a5b43259e 100644
> > > > --- a/documentation/ref-manual/ref-structure.rst
> > > > +++ b/documentation/ref-manual/ref-structure.rst
> > > > @@ -139,7 +139,7 @@ back to the Yocto Project, such as ``create-pull-request`` and
> > > >
> > > >  .. _structure-core-script:
> > > >
> > > > -``oe-init-build-env``
> > > > +``&OE_INIT_FILE;``
> > > >  ---------------------
> > >
> > > this change is interesting. What happens to links with :ref: here? can
> >
> > I've replaced a bunch of broken refs to this section in other files. The ref to
> > use is actually :ref:`structure-core-script`.
> >
> > > we now use &OE_INIT_FILE; in :ref: links? we have several instances
> > > like this:
> > > :ref:`ref-manual/ref-structure:\`\`oe-init-build-env\`\``
> > >
> >
> > Those should be converted to use :ref:`structure-core-script` instead.
> > In the manuals I've reviewed, documentation/ref-manual/ref-terms.rst is
> > the only one with such a change to make.
> >
> > > I remember that I converted all instances of &OE_INIT_FILE; initially,
> > > then I figured out how to have variables subst with poky.yaml.. so we
> > > probably have plenty of places where we should use OE_INIT_FILE
> > > again..
> > >
> >
> > BTW, what's the logic behind replacing oe-init-build-env with
> > &OE_INIT_FILE; ? There's probably a sed to make tree wide to replace
> > those :)
> 
> Just to be consistent.. if we have a variable for it, we should use
> it.. though I am not convinced we needed a variable in the first
> place.. i am not sure we plan to change that script name often ;) so
> we should have OE_INIT_FILE and use it everywhere, or remove it, no?
> 

Indeed. Soooo? Do we remove it or nah :)?

Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#436): https://lists.yoctoproject.org/g/docs/message/436
Mute This Topic: https://lists.yoctoproject.org/mt/77295041/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Nicolas Dechesne Oct. 5, 2020, 9:20 a.m.
On Mon, Oct 5, 2020 at 10:15 AM Quentin Schulz
<quentin.schulz@streamunlimited.com> wrote:
>
> On Mon, Oct 05, 2020 at 10:13:57AM +0200, Nicolas Dechesne wrote:
> > On Mon, Oct 5, 2020 at 10:10 AM Quentin Schulz
> > <quentin.schulz@streamunlimited.com> wrote:
> > >
> > > Hi Nicolas,
> > >
> > > On Mon, Oct 05, 2020 at 10:01:15AM +0200, Nicolas Dechesne wrote:
> > > > On Sun, Oct 4, 2020 at 10:58 AM Quentin Schulz <foss@0leil.net> wrote:
> > > > >
> > > > > Signed-off-by: Quentin Schulz <foss@0leil.net>
> > > > > ---
> > > > >  documentation/ref-manual/ref-structure.rst | 6 +++---
> > > > >  1 file changed, 3 insertions(+), 3 deletions(-)
> > > > >
> > > > > diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
> > > > > index 32c2dbf23..a5b43259e 100644
> > > > > --- a/documentation/ref-manual/ref-structure.rst
> > > > > +++ b/documentation/ref-manual/ref-structure.rst
> > > > > @@ -139,7 +139,7 @@ back to the Yocto Project, such as ``create-pull-request`` and
> > > > >
> > > > >  .. _structure-core-script:
> > > > >
> > > > > -``oe-init-build-env``
> > > > > +``&OE_INIT_FILE;``
> > > > >  ---------------------
> > > >
> > > > this change is interesting. What happens to links with :ref: here? can
> > >
> > > I've replaced a bunch of broken refs to this section in other files. The ref to
> > > use is actually :ref:`structure-core-script`.
> > >
> > > > we now use &OE_INIT_FILE; in :ref: links? we have several instances
> > > > like this:
> > > > :ref:`ref-manual/ref-structure:\`\`oe-init-build-env\`\``
> > > >
> > >
> > > Those should be converted to use :ref:`structure-core-script` instead.
> > > In the manuals I've reviewed, documentation/ref-manual/ref-terms.rst is
> > > the only one with such a change to make.
> > >
> > > > I remember that I converted all instances of &OE_INIT_FILE; initially,
> > > > then I figured out how to have variables subst with poky.yaml.. so we
> > > > probably have plenty of places where we should use OE_INIT_FILE
> > > > again..
> > > >
> > >
> > > BTW, what's the logic behind replacing oe-init-build-env with
> > > &OE_INIT_FILE; ? There's probably a sed to make tree wide to replace
> > > those :)
> >
> > Just to be consistent.. if we have a variable for it, we should use
> > it.. though I am not convinced we needed a variable in the first
> > place.. i am not sure we plan to change that script name often ;) so
> > we should have OE_INIT_FILE and use it everywhere, or remove it, no?
> >
>
> Indeed. Soooo? Do we remove it or nah :)?

heh.. I haven't been able to decide so far, but now that you insist
;-) I think we should remove OE_INIT_FILE everywhere.. and just keep
things simple..

>
> Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#438): https://lists.yoctoproject.org/g/docs/message/438
Mute This Topic: https://lists.yoctoproject.org/mt/77295041/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Quentin Schulz Oct. 5, 2020, 9:40 a.m.
On Mon, Oct 05, 2020 at 11:20:36AM +0200, Nicolas Dechesne wrote:
> > > Just to be consistent.. if we have a variable for it, we should use
> > > it.. though I am not convinced we needed a variable in the first
> > > place.. i am not sure we plan to change that script name often ;) so
> > > we should have OE_INIT_FILE and use it everywhere, or remove it, no?
> > >
> >
> > Indeed. Soooo? Do we remove it or nah :)?
> 
> heh.. I haven't been able to decide so far, but now that you insist
> ;-) I think we should remove OE_INIT_FILE everywhere.. and just keep
> things simple..
> 

Didn't know I had this power in my hands :D

OK, so what about this patch, do you still take it and I do a sed
s/&OE_INIT_FILE;/oe-init-build-env/ tree wide and send a patch for that?

Or do you want the sed patch before this one so we don't touch
any of the OE_INIT_FILE stuff in this patch?

Another suggestion?

Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#439): https://lists.yoctoproject.org/g/docs/message/439
Mute This Topic: https://lists.yoctoproject.org/mt/77295041/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Nicolas Dechesne Oct. 5, 2020, 9:45 a.m.
On Mon, Oct 5, 2020 at 11:40 AM Quentin Schulz
<quentin.schulz@streamunlimited.com> wrote:
>
> On Mon, Oct 05, 2020 at 11:20:36AM +0200, Nicolas Dechesne wrote:
> > > > Just to be consistent.. if we have a variable for it, we should use
> > > > it.. though I am not convinced we needed a variable in the first
> > > > place.. i am not sure we plan to change that script name often ;) so
> > > > we should have OE_INIT_FILE and use it everywhere, or remove it, no?
> > > >
> > >
> > > Indeed. Soooo? Do we remove it or nah :)?
> >
> > heh.. I haven't been able to decide so far, but now that you insist
> > ;-) I think we should remove OE_INIT_FILE everywhere.. and just keep
> > things simple..
> >
>
> Didn't know I had this power in my hands :D
>
> OK, so what about this patch, do you still take it and I do a sed
> s/&OE_INIT_FILE;/oe-init-build-env/ tree wide and send a patch for that?
>
> Or do you want the sed patch before this one so we don't touch
> any of the OE_INIT_FILE stuff in this patch?

Now, that we have made a decision.. it should be *instead of* this patch.

>
> Another suggestion?
>
> Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#440): https://lists.yoctoproject.org/g/docs/message/440
Mute This Topic: https://lists.yoctoproject.org/mt/77295041/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-
Quentin Schulz Oct. 5, 2020, 9:53 a.m.
On Mon, Oct 05, 2020 at 11:45:15AM +0200, Nicolas Dechesne wrote:
> On Mon, Oct 5, 2020 at 11:40 AM Quentin Schulz
> <quentin.schulz@streamunlimited.com> wrote:
> >
> > On Mon, Oct 05, 2020 at 11:20:36AM +0200, Nicolas Dechesne wrote:
> > > > > Just to be consistent.. if we have a variable for it, we should use
> > > > > it.. though I am not convinced we needed a variable in the first
> > > > > place.. i am not sure we plan to change that script name often ;) so
> > > > > we should have OE_INIT_FILE and use it everywhere, or remove it, no?
> > > > >
> > > >
> > > > Indeed. Soooo? Do we remove it or nah :)?
> > >
> > > heh.. I haven't been able to decide so far, but now that you insist
> > > ;-) I think we should remove OE_INIT_FILE everywhere.. and just keep
> > > things simple..
> > >
> >
> > Didn't know I had this power in my hands :D
> >
> > OK, so what about this patch, do you still take it and I do a sed
> > s/&OE_INIT_FILE;/oe-init-build-env/ tree wide and send a patch for that?
> >
> > Or do you want the sed patch before this one so we don't touch
> > any of the OE_INIT_FILE stuff in this patch?
> 
> Now, that we have made a decision.. it should be *instead of* this patch.
> 

Sorry, it's Monday... connections haven't all been made in the brain :)

It was wrt typo fixes in Patch 4 IIRC which "fixes" OE_INIT_FILE typos.
Fixing something that's gone a few patches later is a bit funny :)
Nothing big :)

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