summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-04-06 21:41:17 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-04-06 22:29:49 +0100
commit37ff21babee0674bb3ed8415aa341c1b8e71036f (patch)
treef558a01f8da53275b960385033a5452e876ac768
parent44d0532c8930d4c9bcdefebb15837acf1fd839d4 (diff)
downloadpoky-37ff21babee0674bb3ed8415aa341c1b8e71036f.tar.gz
overview-manual: style improvements
- A few style improvements - Fix a few typos (From yocto-docs rev: 116484a850bdd9b8b648d919fd9c8858f6c55e21) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/overview-manual/yp-intro.rst54
1 files changed, 28 insertions, 26 deletions
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index 176e5b24c3..b146db5e4d 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -41,9 +41,9 @@ Features
41The following list describes features and advantages of the Yocto 41The following list describes features and advantages of the Yocto
42Project: 42Project:
43 43
44- *Widely Adopted Across the Industry:* Semiconductor, operating 44- *Widely Adopted Across the Industry:* Many semiconductor, operating
45 system, software, and service vendors exist whose products and 45 system, software, and service vendors adopt and support the Yocto
46 services adopt and support the Yocto Project. For a look at the Yocto 46 Project in their products and services. For a look at the Yocto
47 Project community and the companies involved with the Yocto Project, 47 Project community and the companies involved with the Yocto Project,
48 see the "COMMUNITY" and "ECOSYSTEM" tabs on the 48 see the "COMMUNITY" and "ECOSYSTEM" tabs on the
49 :yocto_home:`Yocto Project <>` home page. 49 :yocto_home:`Yocto Project <>` home page.
@@ -53,8 +53,8 @@ Project:
53 create and supply BSPs that support their hardware. If you have 53 create and supply BSPs that support their hardware. If you have
54 custom silicon, you can create a BSP that supports that architecture. 54 custom silicon, you can create a BSP that supports that architecture.
55 55
56 Aside from lots of architecture support, the Yocto Project fully 56 Aside from broad architecture support, the Yocto Project fully
57 supports a wide range of device emulation through the Quick EMUlator 57 supports a wide range of devices emulated by the Quick EMUlator
58 (QEMU). 58 (QEMU).
59 59
60- *Images and Code Transfer Easily:* Yocto Project output can easily 60- *Images and Code Transfer Easily:* Yocto Project output can easily
@@ -78,10 +78,10 @@ Project:
78 you need for embedded devices. You only add the feature support or 78 you need for embedded devices. You only add the feature support or
79 packages that you absolutely need for the device. For devices that 79 packages that you absolutely need for the device. For devices that
80 have display hardware, you can use available system components such 80 have display hardware, you can use available system components such
81 as X11, GTK+, Qt, Clutter, and SDL (among others) to create a rich 81 as X11, Wayland, GTK+, Qt, Clutter, and SDL (among others) to create
82 user experience. For devices that do not have a display or where you 82 a rich user experience. For devices that do not have a display or
83 want to use alternative UI frameworks, you can choose to not install 83 where you want to use alternative UI frameworks, you can choose to
84 these components. 84 not build these components.
85 85
86- *Comprehensive Toolchain Capabilities:* Toolchains for supported 86- *Comprehensive Toolchain Capabilities:* Toolchains for supported
87 architectures satisfy most use cases. However, if your hardware 87 architectures satisfy most use cases. However, if your hardware
@@ -431,11 +431,14 @@ activities using the Yocto Project:
431 431
432 During a build, it can be necessary to perform operations that 432 During a build, it can be necessary to perform operations that
433 require system administrator privileges. For example, file ownership 433 require system administrator privileges. For example, file ownership
434 or permissions might need definition. Pseudo is a tool that you can 434 or permissions might need to be defined. Pseudo is a tool that you
435 either use directly or through the environment variable 435 can either use directly or through the environment variable
436 ``LD_PRELOAD``. Either method allows these operations to succeed as 436 ``LD_PRELOAD``. Either method allows these operations to succeed as
437 if system administrator privileges exist even when they do not. 437 if system administrator privileges exist even when they do not.
438 438
439 Thanks to Pseudo, the Yocto Project never needs root privileges to
440 build images for your target system.
441
439 You can read more about Pseudo in the "`Fakeroot and 442 You can read more about Pseudo in the "`Fakeroot and
440 Pseudo <#fakeroot-and-pseudo>`__" section. 443 Pseudo <#fakeroot-and-pseudo>`__" section.
441 444
@@ -574,11 +577,11 @@ Development Methods
574The Yocto Project development environment usually involves a 577The Yocto Project development environment usually involves a
575:term:`Build Host` and target 578:term:`Build Host` and target
576hardware. You use the Build Host to build images and develop 579hardware. You use the Build Host to build images and develop
577applications, while you use the target hardware to test deployed 580applications, while you use the target hardware to execute deployed
578software. 581software.
579 582
580This section provides an introduction to the choices or development 583This section provides an introduction to the choices or development
581methods you have when setting up your Build Host. Depending on the your 584methods you have when setting up your Build Host. Depending on your
582particular workflow preference and the type of operating system your 585particular workflow preference and the type of operating system your
583Build Host runs, several choices exist that allow you to use the Yocto 586Build Host runs, several choices exist that allow you to use the Yocto
584Project. 587Project.
@@ -593,7 +596,7 @@ Project.
593 system running Linux as its native operating system allows you to 596 system running Linux as its native operating system allows you to
594 develop software by directly using the 597 develop software by directly using the
595 :term:`BitBake` tool. You can 598 :term:`BitBake` tool. You can
596 accomplish all aspects of development from a familiar shell of a 599 accomplish all aspects of development from a regular shell in a
597 supported Linux distribution. 600 supported Linux distribution.
598 601
599 For information on how to set up a Build Host on a system running 602 For information on how to set up a Build Host on a system running
@@ -622,7 +625,7 @@ Project.
622 section in the Yocto Project Development Tasks Manual. 625 section in the Yocto Project Development Tasks Manual.
623 626
624- *Windows Subsystem For Linux (WSLv2):* You may use Windows Subsystem 627- *Windows Subsystem For Linux (WSLv2):* You may use Windows Subsystem
625 For Linux v2 to set up a build host using Windows 10. 628 For Linux v2 to set up a Build Host using Windows 10.
626 629
627 .. note:: 630 .. note::
628 631
@@ -631,8 +634,7 @@ Project.
631 still decide to use WSL please upgrade to WSLv2. 634 still decide to use WSL please upgrade to WSLv2.
632 635
633 The Windows Subsystem For Linux allows Windows 10 to run a real Linux 636 The Windows Subsystem For Linux allows Windows 10 to run a real Linux
634 kernel inside of a lightweight utility virtual machine (VM) using 637 kernel inside of a lightweight virtual machine (VM).
635 virtualization technology.
636 638
637 For information on how to set up a Build Host with WSLv2, see the 639 For information on how to set up a Build Host with WSLv2, see the
638 ":ref:`dev-manual/start:setting up to use windows subsystem for linux (wslv2)`" 640 ":ref:`dev-manual/start:setting up to use windows subsystem for linux (wslv2)`"
@@ -641,10 +643,9 @@ Project.
641- *Toaster:* Regardless of what your Build Host is running, you can use 643- *Toaster:* Regardless of what your Build Host is running, you can use
642 Toaster to develop software using the Yocto Project. Toaster is a web 644 Toaster to develop software using the Yocto Project. Toaster is a web
643 interface to the Yocto Project's :term:`OpenEmbedded Build System`. 645 interface to the Yocto Project's :term:`OpenEmbedded Build System`.
644 The interface 646 The interface allows you to configure and run your builds. Information
645 enables you to configure and run your builds. Information about 647 about builds is collected and stored in a database. You can use Toaster
646 builds is collected and stored in a database. You can use Toaster to 648 to configure and start builds on multiple remote build servers.
647 configure and start builds on multiple remote build servers.
648 649
649 For information about and how to use Toaster, see the 650 For information about and how to use Toaster, see the
650 :doc:`/toaster-manual/index`. 651 :doc:`/toaster-manual/index`.
@@ -816,9 +817,9 @@ helpful for getting started:
816 isolate information used when building for multiple architectures. 817 isolate information used when building for multiple architectures.
817 Layers are hierarchical in their ability to override previous 818 Layers are hierarchical in their ability to override previous
818 specifications. You can include any number of available layers from 819 specifications. You can include any number of available layers from
819 the Yocto Project and customize the build by adding your layers after 820 the Yocto Project and customize the build by adding your own layers
820 them. You can search the Layer Index for layers used within Yocto 821 after them. You can search the Layer Index for layers used within
821 Project. 822 Yocto Project.
822 823
823 For more detailed information on layers, see the 824 For more detailed information on layers, see the
824 ":ref:`dev-manual/common-tasks:understanding and creating layers`" 825 ":ref:`dev-manual/common-tasks:understanding and creating layers`"
@@ -851,7 +852,7 @@ helpful for getting started:
851 BitBake is similar to the ``make`` tool. 852 BitBake is similar to the ``make`` tool.
852 853
853 During a build process, the build system tracks dependencies and 854 During a build process, the build system tracks dependencies and
854 performs a native or cross-compilation of the package. As a first 855 performs a native or cross-compilation of each package. As a first
855 step in a cross-build setup, the framework attempts to create a 856 step in a cross-build setup, the framework attempts to create a
856 cross-compiler toolchain (i.e. Extensible SDK) suited for the target 857 cross-compiler toolchain (i.e. Extensible SDK) suited for the target
857 platform. 858 platform.
@@ -878,7 +879,8 @@ helpful for getting started:
878 subtle meanings. For example, the packages referred to in the 879 subtle meanings. For example, the packages referred to in the
879 ":ref:`ref-manual/system-requirements:required packages for the build host`" 880 ":ref:`ref-manual/system-requirements:required packages for the build host`"
880 section in the Yocto Project Reference Manual are compiled binaries 881 section in the Yocto Project Reference Manual are compiled binaries
881 that, when installed, add functionality to your Linux distribution. 882 that, when installed, add functionality to your host Linux
883 distribution.
882 884
883 Another point worth noting is that historically within the Yocto 885 Another point worth noting is that historically within the Yocto
884 Project, recipes were referred to as packages - thus, the existence 886 Project, recipes were referred to as packages - thus, the existence