diff options
Diffstat (limited to 'documentation/overview-manual/development-environment.rst')
| -rw-r--r-- | documentation/overview-manual/development-environment.rst | 88 |
1 files changed, 39 insertions, 49 deletions
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 43a6f1b480..d79173ff55 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst @@ -39,10 +39,9 @@ Linus Torvalds in 1991. Conversely, a good example of a non-open source project is the Windows family of operating systems developed by Microsoft Corporation. -Wikipedia has a good historical description of the Open Source -Philosophy `here <https://en.wikipedia.org/wiki/Open_source>`__. You can -also find helpful information on how to participate in the Linux -Community +Wikipedia has a good :wikipedia:`historical description of the Open Source +Philosophy <Open_source>`. You can also find helpful information on how +to participate in the Linux Community `here <https://www.kernel.org/doc/html/latest/process/index.html>`__. The Development Host @@ -94,7 +93,7 @@ are several ways of working in the Yocto Project environment: through your Linux distribution and the Yocto Project. For a general flow of the build procedures, see the - ":ref:`dev-manual/common-tasks:building a simple image`" + ":ref:`dev-manual/building:building a simple image`" section in the Yocto Project Development Tasks Manual. - *Board Support Package (BSP) Development:* Development of BSPs @@ -132,6 +131,14 @@ are several ways of working in the Yocto Project environment: Toaster and on how to use Toaster in general, see the :doc:`/toaster-manual/index`. +- *Using the VSCode Extension:* You can use the `Yocto Project BitBake + <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ + extension for Visual Studio Code to start your BitBake builds through a + graphical user interface. + + Learn more about the VSCode Extension on the `extension's marketplace page + <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__. + Yocto Project Source Repositories ================================= @@ -170,10 +177,9 @@ these tarballs gives you a snapshot of the released files. In summary, here is where you can get the project files needed for development: -- :yocto_git:`Source Repositories: <>` This area contains IDE - Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and - Yocto Metadata Layers. You can create local copies of Git - repositories for each of these areas. +- :yocto_git:`Source Repositories: <>` This area contains Poky, Yocto + documentation, metadata layers, and Linux kernel. You can create local + copies of Git repositories for each of these areas. .. image:: figures/source-repos.png :width: 100% @@ -182,28 +188,17 @@ development: see the ":ref:`dev-manual/start:accessing source repositories`" Section in the Yocto Project Development Tasks Manual. -- :yocto_dl:`Index of /releases: </releases>` This is an index - of releases such as Poky, Pseudo, installers for cross-development - toolchains, miscellaneous support and all released versions of Yocto - Project in the form of images or tarballs. Downloading and extracting - these files does not produce a local copy of the Git repository but - rather a snapshot of a particular release or image. - - .. image:: figures/index-downloads.png - :align: center - :width: 50% - - For steps on how to view and access these files, see the - ":ref:`dev-manual/start:accessing index of releases`" - section in the Yocto Project Development Tasks Manual. +- :yocto_dl:`Yocto release archives: </releases/yocto>` This is where you can + download tarballs corresponding to each Yocto Project release. Downloading + and extracting these files does not produce a local copy of a Git repository + but rather a snapshot corresponding to a particular release. -- *"DOWNLOADS" page for the* :yocto_home:`Yocto Project Website <>` *:* - - The Yocto Project website includes a "DOWNLOADS" page accessible +- :yocto_home:`DOWNLOADS page </software-overview/downloads/>`: + The :yocto_home:`Yocto Project website <>` includes a "DOWNLOADS" page accessible through the "SOFTWARE" menu that allows you to download any Yocto Project release, tool, and Board Support Package (BSP) in tarball - form. The tarballs are similar to those found in the - :yocto_dl:`Index of /releases: </releases>` area. + form. The hyperlinks point to the tarballs under + :yocto_dl:`/releases/yocto/`. .. image:: figures/yp-download.png :width: 100% @@ -245,8 +240,8 @@ and so forth. For information on finding out who is responsible for (maintains) a particular area of code in the Yocto Project, see the - ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" - section of the Yocto Project Development Tasks Manual. + ":doc:`../contributor-guide/identify-component`" + section of the Yocto Project and OpenEmbedded Contributor Guide. The Yocto Project ``poky`` Git repository also has an upstream contribution Git repository named ``poky-contrib``. You can see all the @@ -277,8 +272,8 @@ push them into the "contrib" area and subsequently request that the maintainer include them into an upstream branch. This process is called "submitting a patch" or "submitting a change." For information on submitting patches and changes, see the -":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" -section in the Yocto Project Development Tasks Manual. +":doc:`../contributor-guide/submit-changes`" section in the Yocto Project +and OpenEmbedded Contributor Guide. In summary, there is a single point of entry for changes into the development branch of the Git repository, which is controlled by the @@ -341,11 +336,10 @@ Book <https://book.git-scm.com>`__. software on which to develop. The Yocto Project has two scripts named ``create-pull-request`` and ``send-pull-request`` that ship with the release to facilitate this workflow. You can find these scripts in - the ``scripts`` folder of the - :term:`Source Directory`. For information + the ``scripts`` folder of the :term:`Source Directory`. For information on how to use these scripts, see the - ":ref:`dev-manual/common-tasks:using scripts to push a change upstream and request a pull`" - section in the Yocto Project Development Tasks Manual. + ":ref:`contributor-guide/submit-changes:using scripts to push a change upstream and request a pull`" + section in the Yocto Project and OpenEmbedded Contributor Guide. - *Patch Workflow:* This workflow allows you to notify the maintainer through an email that you have a change (or patch) you would like @@ -353,8 +347,8 @@ Book <https://book.git-scm.com>`__. this type of change, you format the patch and then send the email using the Git commands ``git format-patch`` and ``git send-email``. For information on how to use these scripts, see the - ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" - section in the Yocto Project Development Tasks Manual. + ":doc:`../contributor-guide/submit-changes`" section in the Yocto Project + and OpenEmbedded Contributor Guide. Git === @@ -608,26 +602,22 @@ licensing structures in place. License evolution for both Open Source and Free Software has an interesting history. If you are interested in this history, you can find basic information here: -- `Open source license - history <https://en.wikipedia.org/wiki/Open-source_license>`__ +- :wikipedia:`Open source license history <Open-source_license>` -- `Free software license - history <https://en.wikipedia.org/wiki/Free_software_license>`__ +- :wikipedia:`Free software license history <Free_software_license>` In general, the Yocto Project is broadly licensed under the Massachusetts Institute of Technology (MIT) License. MIT licensing permits the reuse of software within proprietary software as long as the license is distributed with that software. Patches to the Yocto Project follow the upstream licensing scheme. You can find information on the -MIT license `here <https://en.wikipedia.org/wiki/MIT_License>`__. +MIT license :wikipedia:`here <MIT_License>`. When you build an image using the Yocto Project, the build process uses a known list of licenses to ensure compliance. You can find this list in -the :term:`Source Directory` at -``meta/files/common-licenses``. Once the build completes, the list of -all licenses found and used during that build are kept in the -:term:`Build Directory` at -``tmp/deploy/licenses``. +the :term:`Source Directory` at ``meta/files/common-licenses``. Once the +build completes, the list of all licenses found and used during that build +are kept in the :term:`Build Directory` at ``tmp/deploy/licenses``. If a module requires a license that is not in the base list, the build process generates a warning during the build. These tools make it easier @@ -652,5 +642,5 @@ Project uses in the ``meta/files/common-licenses`` directory in your For information that can help you maintain compliance with various open source licensing during the lifecycle of a product created using the Yocto Project, see the -":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" +":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" section in the Yocto Project Development Tasks Manual. |