[v2,4/8] docs: remove OE_INIT_FILE variable

Submitted by Quentin Schulz on Oct. 5, 2020, 6:37 p.m. | Patch ID: 176989

Details

Message ID 20201005183728.9832-4-foss@0leil.net
State New
Headers show

Commit Message

Quentin Schulz Oct. 5, 2020, 6:37 p.m.
There's probably no need for such a variable (the name of the script is
unlikely to change any time soon) and not all instances of
oe-init-build-env were actually using this variable.

For consistency sake, let's just remove the OE_INIT_FILE variable.

Suggested-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
---

added in v2

 documentation/adt-manual/adt-prepare.rst                    | 2 +-
 documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst | 2 +-
 documentation/bsp-guide/bsp.rst                             | 2 +-
 documentation/poky.yaml                                     | 1 -
 documentation/ref-manual/ref-structure.rst                  | 5 ++---
 5 files changed, 5 insertions(+), 7 deletions(-)

Patch hide | download patch | download mbox

diff --git a/documentation/adt-manual/adt-prepare.rst b/documentation/adt-manual/adt-prepare.rst
index 9b6bd0514..eac03785b 100644
--- a/documentation/adt-manual/adt-prepare.rst
+++ b/documentation/adt-manual/adt-prepare.rst
@@ -107,7 +107,7 @@  the tarball using either of these methods:
       configuration information.
 
    $ cd ~ $ git clone git://git.yoctoproject.org/poky $ cd poky $ git
-   checkout -b DISTRO_NAME origin/DISTRO_NAME $ source OE_INIT_FILE $
+   checkout -b DISTRO_NAME origin/DISTRO_NAME $ source oe-init-build-env $
    bitbake adt-installer
 
 Configuring and Running the ADT Installer Script
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
index 7e24b9e68..55939e3b2 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
@@ -177,7 +177,7 @@  an entire Linux distribution, including the toolchain, from source.
    .. code-block:: shell
 
       $ cd ~/poky
-      $ source &OE_INIT_FILE;
+      $ source oe-init-build-env
       You had no conf/local.conf file. This configuration file has therefore been
       created for you with some default values. You may wish to edit it to, for
       example, select a different MACHINE (target hardware). See conf/local.conf
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 024a240c2..7954f08b7 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -233,7 +233,7 @@  section.
    setup script to define the OpenEmbedded build environment on your
    build host. ::
 
-      $ source &OE_INIT_FILE;
+      $ source oe-init-build-env
 
    Among other things, the script creates the :term:`Build Directory`, which is
    ``build`` in this case and is located in the :term:`Source Directory`.  After
diff --git a/documentation/poky.yaml b/documentation/poky.yaml
index ec21271a3..14f45055d 100644
--- a/documentation/poky.yaml
+++ b/documentation/poky.yaml
@@ -58,7 +58,6 @@  YOCTO_DOCS_BRIEF_URL : "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/brief-yoctoprojectq
 YOCTO_ADTPATH_DIR : "/opt/poky/&DISTRO;"
 YOCTO_POKY_TARBALL : "&YOCTO_POKY;.tar.bz2"
 OE_INIT_PATH : "&YOCTO_POKY;/oe-init-build-env"
-OE_INIT_FILE : "oe-init-build-env"
 UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git-core diffstat unzip texinfo gcc-multilib \
      build-essential chrpath socat cpio python3 python3-pip python3-pexpect \
      xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
index 93807b52a..5a074a258 100644
--- a/documentation/ref-manual/ref-structure.rst
+++ b/documentation/ref-manual/ref-structure.rst
@@ -188,7 +188,7 @@  your choice. For example, the following command creates a Build
 Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`:
 ::
 
-   $ source OE_INIT_FILE ~/mybuilds
+   $ source oe-init-build-env ~/mybuilds
 
 The OpenEmbedded build system uses the template configuration files, which
 are found by default in the ``meta-poky/conf/`` directory in the Source
@@ -200,8 +200,7 @@  information.
 .. note::
 
    The OpenEmbedded build system does not support file or directory
-   names that contain spaces. If you attempt to run the
-   OE_INIT_FILE
+   names that contain spaces. If you attempt to run the ``oe-init-build-env``
    script from a Source Directory that contains spaces in either the
    filenames or directory names, the script returns an error indicating
    no such file or directory. Be sure to use a Source Directory free of

Comments

Nicolas Dechesne Oct. 6, 2020, 6:58 a.m.
On Mon, Oct 5, 2020 at 8:38 PM Quentin Schulz <foss@0leil.net> wrote:
>
> There's probably no need for such a variable (the name of the script is
> unlikely to change any time soon) and not all instances of
> oe-init-build-env were actually using this variable.
>
> For consistency sake, let's just remove the OE_INIT_FILE variable.
>
> Suggested-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
> Signed-off-by: Quentin Schulz <foss@0leil.net>

Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>

> ---
>
> added in v2
>
>  documentation/adt-manual/adt-prepare.rst                    | 2 +-
>  documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst | 2 +-
>  documentation/bsp-guide/bsp.rst                             | 2 +-
>  documentation/poky.yaml                                     | 1 -
>  documentation/ref-manual/ref-structure.rst                  | 5 ++---
>  5 files changed, 5 insertions(+), 7 deletions(-)
>
> diff --git a/documentation/adt-manual/adt-prepare.rst b/documentation/adt-manual/adt-prepare.rst
> index 9b6bd0514..eac03785b 100644
> --- a/documentation/adt-manual/adt-prepare.rst
> +++ b/documentation/adt-manual/adt-prepare.rst
> @@ -107,7 +107,7 @@ the tarball using either of these methods:
>        configuration information.
>
>     $ cd ~ $ git clone git://git.yoctoproject.org/poky $ cd poky $ git
> -   checkout -b DISTRO_NAME origin/DISTRO_NAME $ source OE_INIT_FILE $
> +   checkout -b DISTRO_NAME origin/DISTRO_NAME $ source oe-init-build-env $
>     bitbake adt-installer
>
>  Configuring and Running the ADT Installer Script
> diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
> index 7e24b9e68..55939e3b2 100644
> --- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
> +++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
> @@ -177,7 +177,7 @@ an entire Linux distribution, including the toolchain, from source.
>     .. code-block:: shell
>
>        $ cd ~/poky
> -      $ source &OE_INIT_FILE;
> +      $ source oe-init-build-env
>        You had no conf/local.conf file. This configuration file has therefore been
>        created for you with some default values. You may wish to edit it to, for
>        example, select a different MACHINE (target hardware). See conf/local.conf
> diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
> index 024a240c2..7954f08b7 100644
> --- a/documentation/bsp-guide/bsp.rst
> +++ b/documentation/bsp-guide/bsp.rst
> @@ -233,7 +233,7 @@ section.
>     setup script to define the OpenEmbedded build environment on your
>     build host. ::
>
> -      $ source &OE_INIT_FILE;
> +      $ source oe-init-build-env
>
>     Among other things, the script creates the :term:`Build Directory`, which is
>     ``build`` in this case and is located in the :term:`Source Directory`.  After
> diff --git a/documentation/poky.yaml b/documentation/poky.yaml
> index ec21271a3..14f45055d 100644
> --- a/documentation/poky.yaml
> +++ b/documentation/poky.yaml
> @@ -58,7 +58,6 @@ YOCTO_DOCS_BRIEF_URL : "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/brief-yoctoprojectq
>  YOCTO_ADTPATH_DIR : "/opt/poky/&DISTRO;"
>  YOCTO_POKY_TARBALL : "&YOCTO_POKY;.tar.bz2"
>  OE_INIT_PATH : "&YOCTO_POKY;/oe-init-build-env"
> -OE_INIT_FILE : "oe-init-build-env"
>  UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git-core diffstat unzip texinfo gcc-multilib \
>       build-essential chrpath socat cpio python3 python3-pip python3-pexpect \
>       xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \
> diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
> index 93807b52a..5a074a258 100644
> --- a/documentation/ref-manual/ref-structure.rst
> +++ b/documentation/ref-manual/ref-structure.rst
> @@ -188,7 +188,7 @@ your choice. For example, the following command creates a Build
>  Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`:
>  ::
>
> -   $ source OE_INIT_FILE ~/mybuilds
> +   $ source oe-init-build-env ~/mybuilds
>
>  The OpenEmbedded build system uses the template configuration files, which
>  are found by default in the ``meta-poky/conf/`` directory in the Source
> @@ -200,8 +200,7 @@ information.
>  .. note::
>
>     The OpenEmbedded build system does not support file or directory
> -   names that contain spaces. If you attempt to run the
> -   OE_INIT_FILE
> +   names that contain spaces. If you attempt to run the ``oe-init-build-env``
>     script from a Source Directory that contains spaces in either the
>     filenames or directory names, the script returns an error indicating
>     no such file or directory. Be sure to use a Source Directory free of
> --
> 2.26.2
>
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#450): https://lists.yoctoproject.org/g/docs/message/450
Mute This Topic: https://lists.yoctoproject.org/mt/77325774/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-