diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 2ffa3a6d8..c43c3ddca 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst @@ -21,11 +21,8 @@ build a reference embedded OS called Poky. you want to use Yocto Project on to build an image (:term:`Build Host`) is not a native Linux system, you can still perform these steps by using - CROss PlatformS (CROPS) and setting up a Poky container. See the - :ref:`dev-manual/start:setting up to use cross platforms (crops)` - section - in the Yocto Project Development Tasks Manual for more - information. + an :wikipedia:`OCI container ` (using + `Docker `__ or `Podman `__). - You may use version 2 of Windows Subsystem For Linux (WSL 2) to set up a build host using Windows 10 or later, Windows Server 2019 or later. diff --git a/documentation/bsp-manual/bsp.rst b/documentation/bsp-manual/bsp.rst index 25c1a2eb6..168d64e6e 100644 --- a/documentation/bsp-manual/bsp.rst +++ b/documentation/bsp-manual/bsp.rst @@ -147,8 +147,7 @@ section. #. *Set Up the Build Environment:* Be sure you are set up to use BitBake in a shell. See the ":ref:`dev-manual/start:preparing the build host`" section in the Yocto Project Development Tasks Manual for information on how - to get a build host ready that is either a native Linux machine or a machine - that uses CROPS. + to get a :term:`build host` ready. #. *Prepare the Source Repositories*: diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 44604595a..3b8e2334a 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst @@ -261,11 +261,10 @@ Preparing the Build Host This section provides procedures to set up a system to be used as your :term:`Build Host` for development using the Yocto Project. Your build host can be a native -Linux machine (recommended), it can be a machine (Linux, Mac, or -Windows) that uses `CROPS `__, -which leverages `Docker Containers `__ or it -can be a Windows machine capable of running version 2 of Windows Subsystem -For Linux (WSL 2). +Linux machine (recommended), it can be an :wikipedia:`OCI container +` (such as `Docker `__ or +`Podman `__), or it can be a Windows machine capable of +running version 2 of Windows Subsystem For Linux (WSL 2). .. note:: @@ -349,101 +348,6 @@ the `Yocto Project BitBake `__ extension accordingly. -Setting Up to Use CROss PlatformS (CROPS) ------------------------------------------ - -With `CROPS `__, which -leverages `Docker Containers `__, you can -create a Yocto Project development environment that is operating system -agnostic. You can set up a container in which you can develop using the -Yocto Project on a Windows, Mac, or Linux machine. - -Follow these general steps to prepare a Windows, Mac, or Linux machine -as your Yocto Project build host: - -#. *Determine What Your Build Host Needs:* - `Docker `__ is a software - container platform that you need to install on the build host. - Depending on your build host, you might have to install different - software to support Docker containers. Go to the Docker installation - page and read about the platform requirements in "`Supported - Platforms `__" - your build host needs to run containers. - -#. *Choose What To Install:* Depending on whether or not your build host - meets system requirements, you need to install "Docker CE Stable" or - the "Docker Toolbox". Most situations call for Docker CE. However, if - you have a build host that does not meet requirements (e.g. - Pre-Windows 10 or Windows 10 "Home" version), you must install Docker - Toolbox instead. - -#. *Go to the Install Site for Your Platform:* Click the link for the - Docker edition associated with your build host's native software. For - example, if your build host is running Microsoft Windows Version 10 - and you want the Docker CE Stable edition, click that link under - "Supported Platforms". - -#. *Install the Software:* Once you have understood all the - pre-requisites, you can download and install the appropriate - software. Follow the instructions for your specific machine and the - type of the software you need to install: - - - Install `Docker Desktop on - Windows `__ - for Windows build hosts that meet requirements. - - - Install `Docker Desktop on - MacOs `__ - for Mac build hosts that meet requirements. - - - Install `Docker Engine on - CentOS `__ - for Linux build hosts running the CentOS distribution. - - - Install `Docker Engine on - Debian `__ - for Linux build hosts running the Debian distribution. - - - Install `Docker Engine for - Fedora `__ - for Linux build hosts running the Fedora distribution. - - - Install `Docker Engine for - Ubuntu `__ - for Linux build hosts running the Ubuntu distribution. - -#. *Optionally Orient Yourself With Docker:* If you are unfamiliar with - Docker and the container concept, you can learn more here - - https://docs.docker.com/get-started/. - -#. *Launch Docker or Docker Toolbox:* You should be able to launch - Docker or the Docker Toolbox and have a terminal shell on your - development host. - -#. *Set Up the Containers to Use the Yocto Project:* Go to - https://github.com/crops/docker-win-mac-docs/wiki and follow - the directions for your particular build host (i.e. Linux, Mac, or - Windows). - - Once you complete the setup instructions for your machine, you have - the Poky, Extensible SDK, and Toaster containers available. You can - click those links from the page and learn more about using each of - those containers. - -Once you have a container set up, everything is in place to develop just -as if you were running on a native Linux machine. If you are going to -use the Poky container, see the -":ref:`dev-manual/start:preparing the Poky reference distro`" -section. If you are going to use the Extensible SDK container, see the -":doc:`/sdk-manual/extensible`" Chapter in the Yocto -Project Application Development and the Extensible Software Development -Kit (eSDK) manual. If you are going to use the Toaster container, see -the ":doc:`/toaster-manual/setup-and-use`" -section in the Toaster User Manual. If you are a VSCode user, you can configure -the `Yocto Project BitBake -`__ -extension accordingly. - Setting Up to Use Windows Subsystem For Linux (WSL 2) ----------------------------------------------------- diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 0921139bd..cdba7c50c 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst @@ -58,16 +58,12 @@ Project. Most find that it is best to have a native Linux machine function as the development host. However, it is possible to use a system that does not run Linux as its operating system as your development host. When you have a Mac or Windows-based system, you can -set it up as the development host by using -`CROPS `__, which leverages -`Docker Containers `__. Once you take the steps -to set up a CROPS machine, you effectively have access to a shell +set it up as the development host by using an :wikipedia:`OCI container +` (using `Docker `__ or +`Podman `__). Once you take the steps +to set up container, you effectively have access to a shell environment that is similar to what you see when using a Linux-based -development host. For the steps needed to set up a system using CROPS, -see the -":ref:`dev-manual/start:setting up to use cross platforms (crops)`" -section in -the Yocto Project Development Tasks Manual. +development host. If your development host is going to be a system that runs a Linux distribution, you must still take steps to prepare the system @@ -87,7 +83,7 @@ are several ways of working in the Yocto Project environment: which uses BitBake, in a command-line environment from a shell on your development host. You can accomplish this from a host that is a - native Linux machine or from a host that has been set up with CROPS. + native Linux machine or from a container. Either way, you create, modify, and build images and applications all within a shell-based environment using components and tools available through your Linux distribution and the Yocto Project. diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 6e8b72249..ef7e66d03 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst @@ -287,13 +287,6 @@ Development Tools Here are tools that help you develop images and applications using the Yocto Project: -- *CROPS:* `CROPS `__ is an - open source, cross-platform development framework that leverages - `Docker Containers `__. CROPS provides an - easily managed, extensible environment that allows you to build - binaries for a variety of architectures on Windows, Linux and Mac OS - X hosts. - - *devtool:* This command-line tool is available as part of the extensible SDK (eSDK) and is its cornerstone. You can use ``devtool`` to help build, test, and package software within the eSDK. You can @@ -513,9 +506,9 @@ Linux. Build Appliance was useful as a way to try out development in the Yocto Project environment. -#. *CROPS:* The final and best solution available now for developing - using the Yocto Project on a system not native to Linux is with - :ref:`CROPS `. +#. *CROPS:* Used to be a solution available for developing + using the Yocto Project on a system not native to Linux (see + https://github.com/crops/poky-container). Development Methods =================== @@ -549,25 +542,10 @@ Build Host runs, you have several choices. ":ref:`dev-manual/start:setting up a native linux host`" section in the Yocto Project Development Tasks Manual. -- *CROss PlatformS (CROPS):* Typically, you use - `CROPS `__, which leverages - `Docker Containers `__, to set up a Build - Host that is not running Linux (e.g. Microsoft Windows or macOS). - - .. note:: - - You can, however, use CROPS on a Linux-based system. - - CROPS is an open source, cross-platform development framework that - provides an easily managed, extensible environment for building - binaries targeted for a variety of architectures on Windows, macOS, - or Linux hosts. Once the Build Host is set up using CROPS, you can - prepare a shell environment to mimic that of a shell being used on a - system natively running Linux. - - For information on how to set up a Build Host with CROPS, see the - ":ref:`dev-manual/start:setting up to use cross platforms (crops)`" - section in the Yocto Project Development Tasks Manual. +- *OCI Containers:* Typically, you use an :wikipedia:`OCI container + ` (with `Docker `__ or + `Podman `__ for example), to set up a :term:`Build + Host` that is not running Linux (e.g. Microsoft Windows or macOS). - *Windows Subsystem For Linux (WSL 2):* You may use Windows Subsystem For Linux version 2 to set up a Build Host using Windows 10 or later, diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst index a6f2da052..24a8e17b3 100644 --- a/documentation/sdk-manual/appendix-obtain.rst +++ b/documentation/sdk-manual/appendix-obtain.rst @@ -96,8 +96,7 @@ build the SDK installer. Follow these steps: #. *Set Up the Build Environment:* Be sure you are set up to use BitBake in a shell. See the ":doc:`/dev-manual/start`" section in the Yocto Project Development Tasks Manual for information on how - to get a build host ready that is either a native Linux machine or a - machine that uses CROPS. + to get a :term:`build host` ready. #. *Make Sure You Are Building an Installer for the Correct Machine:* Check to be sure that your :term:`MACHINE` variable in the ``local.conf``