From c06a654c1d14f20b31256298543e2e3504acc0a9 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 5 Jan 2018 14:03:53 -0800 Subject: overview-manual, ref-manual: Moved introductory material to overview manual Fixes [YOCTO #12370] Moved an introductory section for YP that was in the ref-manual to the beginning of the YP environment chapter of the overview-manual. Had to move a figure and update the makefile as well as adjust some links. (From yocto-docs rev: 8ec45f945a21b1f64e7529b95df6b5fb21e87449) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/Makefile | 3 +- .../overview-manual/figures/YP-flow-diagram.png | Bin 0 -> 190715 bytes .../overview-development-environment.xml | 117 ++++++++++++++++++++ .../ref-manual/figures/YP-flow-diagram.png | Bin 190715 -> 0 bytes documentation/ref-manual/introduction.xml | 120 +-------------------- 5 files changed, 121 insertions(+), 119 deletions(-) create mode 100644 documentation/overview-manual/figures/YP-flow-diagram.png delete mode 100644 documentation/ref-manual/figures/YP-flow-diagram.png (limited to 'documentation') diff --git a/documentation/Makefile b/documentation/Makefile index bb7f327598..4759a1d992 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -94,6 +94,7 @@ TARFILES = overview-style.css overview-manual.html figures/overview-title.png \ figures/source-fetching.png figures/patching.png figures/configuration-compile-autoreconf.png \ figures/analysis-for-package-splitting.png figures/image-generation.png \ figures/sdk-generation.png figures/images.png figures/sdk.png \ + figures/YP-flow-diagram.png \ eclipse MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse FIGURES = figures @@ -279,7 +280,7 @@ endif ifeq ($(DOC),ref-manual) XSLTOPTS = --xinclude ALLPREQ = html eclipse tarball -TARFILES = ref-manual.html ref-style.css figures/poky-title.png figures/YP-flow-diagram.png \ +TARFILES = ref-manual.html ref-style.css figures/poky-title.png \ figures/buildhistory.png figures/buildhistory-web.png \ figures/cross-development-toolchains.png \ figures/building-an-image.png \ diff --git a/documentation/overview-manual/figures/YP-flow-diagram.png b/documentation/overview-manual/figures/YP-flow-diagram.png new file mode 100644 index 0000000000..8264410504 Binary files /dev/null and b/documentation/overview-manual/figures/YP-flow-diagram.png differ diff --git a/documentation/overview-manual/overview-development-environment.xml b/documentation/overview-manual/overview-development-environment.xml index 32fe1816ab..d34f35ec88 100644 --- a/documentation/overview-manual/overview-development-environment.xml +++ b/documentation/overview-manual/overview-development-environment.xml @@ -21,6 +21,123 @@ syntax. +
+ Introduction + + + The Yocto Project is an open-source collaboration project whose + focus is for developers of embedded Linux systems. + Among other things, the Yocto Project uses an + OpenEmbedded build system. + The build system, which is based on the OpenEmbedded (OE) project and + uses the + BitBake tool, + constructs complete Linux images for architectures based on ARM, MIPS, + PowerPC, x86 and x86-64. + + Historically, the OpenEmbedded build system, which is the + combination of BitBake and OE components, formed a reference + build host that was known as + "Poky" + (Pah-kee). + The term "Poky", as used throughout the Yocto Project Documentation + set, can have different meanings. + + The Yocto Project provides various ancillary tools for the embedded + developer and also features the Sato reference User Interface, which + is optimized for stylus-driven, low-resolution screens. + + + + + + + + + + Here are some highlights for the Yocto Project: + + + + + Provides a recent Linux kernel along with a set of system + commands and libraries suitable for the embedded + environment. + + + Makes available system components such as X11, GTK+, Qt, + Clutter, and SDL (among others) so you can create a rich user + experience on devices that have display hardware. + For devices that do not have a display or where you wish to + use alternative UI frameworks, these components need not be + installed. + + + Creates a focused and stable core compatible with the + OpenEmbedded project with which you can easily and reliably + build and develop. + + + Fully supports a wide range of hardware and device emulation + through the Quick EMUlator (QEMU). + + + Provides a layer mechanism that allows you to easily extend + the system, make customizations, and keep them organized. + + + + + You can use the Yocto Project to generate images for many kinds + of devices. + As mentioned earlier, the Yocto Project supports creation of + reference images that you can boot within and emulate using QEMU. + The standard example machines target QEMU full-system + emulation for 32-bit and 64-bit variants of x86, ARM, MIPS, and + PowerPC architectures. + Beyond emulation, you can use the layer mechanism to extend + support to just about any platform that Linux can run on and that + a toolchain can target. + + + + Another Yocto Project feature is the Sato reference User + Interface. + This optional UI that is based on GTK+ is intended for devices with + restricted screen sizes and is included as part of the + OpenEmbedded Core layer so that developers can test parts of the + software stack. + + + + While the Yocto Project does not provide a strict testing framework, + it does provide or generate for you artifacts that let you perform + target-level and emulated testing and debugging. + Additionally, if you are an + Eclipse IDE user, you can + install an Eclipse Yocto Plug-in to allow you to develop within that + familiar environment. + + + + By default, using the Yocto Project to build an image creates a Poky + distribution. + However, you can create your own distribution by providing key + Metadata. + A good example is Angstrom, which has had a distribution + based on the Yocto Project since its inception. + Other examples include commercial distributions like + Wind River Linux, + Mentor Embedded Linux, + ENEA Linux + and others. + See the "Creating Your Own Distribution" + section in the Yocto Project Development Tasks Manual for more + information. + +
+
Open Source Philosophy diff --git a/documentation/ref-manual/figures/YP-flow-diagram.png b/documentation/ref-manual/figures/YP-flow-diagram.png deleted file mode 100644 index 8264410504..0000000000 Binary files a/documentation/ref-manual/figures/YP-flow-diagram.png and /dev/null differ diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index 588d392f8e..098dbc8a22 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml @@ -24,8 +24,8 @@ For introductory information on the Yocto Project, see the Yocto Project Website and the - "Introducing the Yocto Project Development Environment" - section. + "Yocto Project Development Environment" + chapter in the Yocto Project Overview Manual. @@ -43,122 +43,6 @@
-
- Introducing the Yocto Project Development Environment - - - The Yocto Project is an open-source collaboration project whose - focus is for developers of embedded Linux systems. - Among other things, the Yocto Project uses an - OpenEmbedded build system. - The build system, which is based on the OpenEmbedded (OE) project and - uses the - BitBake tool, constructs complete - Linux images for architectures based on ARM, MIPS, PowerPC, x86 and - x86-64. - - Historically, the OpenEmbedded build system, which is the - combination of BitBake and OE components, formed a reference - build host that was known as - "Poky" (Pah-kee). - The term "Poky", as used throughout the Yocto Project Documentation - set, can have different meanings. - - The Yocto Project provides various ancillary tools for the embedded - developer and also features the Sato reference User Interface, which - is optimized for stylus-driven, low-resolution screens. - - - - - - - - - - Here are some highlights for the Yocto Project: - - - - - Provides a recent Linux kernel along with a set of system - commands and libraries suitable for the embedded - environment. - - - Makes available system components such as X11, GTK+, Qt, - Clutter, and SDL (among others) so you can create a rich user - experience on devices that have display hardware. - For devices that do not have a display or where you wish to - use alternative UI frameworks, these components need not be - installed. - - - Creates a focused and stable core compatible with the - OpenEmbedded project with which you can easily and reliably - build and develop. - - - Fully supports a wide range of hardware and device emulation - through the Quick EMUlator (QEMU). - - - Provides a layer mechanism that allows you to easily extend - the system, make customizations, and keep them organized. - - - - - You can use the Yocto Project to generate images for many kinds - of devices. - As mentioned earlier, the Yocto Project supports creation of - reference images that you can boot within and emulate using QEMU. - The standard example machines target QEMU full-system - emulation for 32-bit and 64-bit variants of x86, ARM, MIPS, and - PowerPC architectures. - Beyond emulation, you can use the layer mechanism to extend - support to just about any platform that Linux can run on and that - a toolchain can target. - - - - Another Yocto Project feature is the Sato reference User - Interface. - This optional UI that is based on GTK+ is intended for devices with - restricted screen sizes and is included as part of the - OpenEmbedded Core layer so that developers can test parts of the - software stack. - - - - While the Yocto Project does not provide a strict testing framework, - it does provide or generate for you artifacts that let you perform - target-level and emulated testing and debugging. - Additionally, if you are an - Eclipse IDE user, you can - install an Eclipse Yocto Plug-in to allow you to develop within that - familiar environment. - - - - By default, using the Yocto Project to build an image creates a Poky - distribution. - However, you can create your own distribution by providing key - Metadata. - A good example is Angstrom, which has had a distribution - based on the Yocto Project since its inception. - Other examples include commercial distributions like - Wind River Linux, - Mentor Embedded Linux, - ENEA Linux - and others. - See the "Creating Your Own Distribution" - section in the Yocto Project Development Tasks Manual for more - information. - -
-
System Requirements -- cgit v1.2.3-54-g00ecf