diff --git a/documentation/Makefile b/documentation/Makefile index f2afc23628..bb8d6a5749 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -90,6 +90,7 @@ ALLPREQ = html eclipse tarball TARFILES = getting-started-style.css getting-started.html figures/getting-started-title.png \ figures/git-workflow.png figures/source-repos.png figures/index-downloads.png \ figures/yp-download.png figures/YP-flow-diagram.png figures/key-dev-elements.png \ + figures/poky-reference-distribution.png \ eclipse MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse FIGURES = figures @@ -274,7 +275,7 @@ TARFILES = mega-manual.html mega-style.css \ figures/sdk-generation.png figures/recipe-workflow.png \ figures/build-workspace-directory.png figures/mega-title.png \ figures/toaster-title.png figures/hosted-service.png \ - figures/simple-configuration.png \ + figures/simple-configuration.png figures/poky-reference-distribution.png \ figures/compatible-layers.png figures/import-layer.png figures/new-project.png \ figures/sdk-environment.png figures/sdk-installed-standard-sdk-directory.png \ figures/sdk-devtool-add-flow.png figures/sdk-installed-extensible-sdk-directory.png \ diff --git a/documentation/getting-started/figures/poky-reference-distribution.png b/documentation/getting-started/figures/poky-reference-distribution.png new file mode 100644 index 0000000000..7133d43f53 Binary files /dev/null and b/documentation/getting-started/figures/poky-reference-distribution.png differ diff --git a/documentation/getting-started/getting-started-yp-intro.xml b/documentation/getting-started/getting-started-yp-intro.xml index 617e562753..964a500ad4 100644 --- a/documentation/getting-started/getting-started-yp-intro.xml +++ b/documentation/getting-started/getting-started-yp-intro.xml @@ -933,6 +933,142 @@
Reference Embedded Distribution (Poky) + + "Poky", which is pronounced Pock-ee, is the + name of the Yocto Project's reference distribution or Reference OS + Kit. + Poky contains the + OpenEmbedded Build System + build system + (BitBake and + OpenEmbedded Core) + as well as a set of + metadata to get + you started building your own distro. + In other words, Poky is a base specification of the functionality + needed for a typical embedded system as well as the components + from the Yocto Project that allow you to build a distribution into + a usable binary image. + + + + Poky is a combined repository of BitBake, OpenEmbedded-Core + (found in meta), + meta-poky, + meta-yocto-bsp, and documentation provided + all together and known to work well together. + You can view the Poky repository as part of the + Source Repositories. + + If you are interested in all the contents of the + poky Git repository, see the + "Top-Level Core Components" + section in the Yocto Project Reference Manual. + + + + + The following figure illustrates what generally comprises Poky: + + + + BitBake is a task executor and scheduler that is the heart of + the OpenEmbedded build system. + + + meta-poky, which is Poky-specific + metadata. + + + meta-yocto-bsp, which is Yocto + Project-specific Board Support Packages (BSPs). + + + OpenEmbedded-Core (OE-Core) metadata, which includes + shared configurations, global variable definitions, + shared classes, packaging, and recipes. + Classes define the encapsulation and inheritance of build + logic. + Recipes are the logical units of software and images + to be built. + + + Documentation, which contains the Yocto Project source + files used to make the set of user manuals. + + + + While Poky is a "complete" distribution specification and is + tested and put through QA, you cannot use it as a product + "out of the box" in its current form. + + + + + To use the Yocto Project tools, you can use Git to clone (download) + the Poky repository then use your local copy of the reference + distribution to bootstrap your own distribution. + + Poky does not contain binary files. + It is a working example of how to build your own custom Linux distribution + from source. + + + + + Poky has a regular, well established, six-month release cycle + under its own version. + Major releases occur at the same time major releases (point + releases) occur for the Yocto Project, which are typically in the + Spring and Fall. + For more information on the Yocto Project release schedule and + cadence, see the + "Yocto Project Releases and the Stable Release Process" + chapter in the Yocto Project Reference Manual. + + + + Much has been said about Poky being a "default configuration." + A default configuration provides a starting image footprint. + You can use Poky out of the box to create an image ranging from a + shell-accessible minimal image all the way up to a Linux + Standard Base-compliant image that uses a GNOME Mobile and + Embedded (GMAE) based reference user interface called Sato. + + + + One of the most powerful properties of Poky is that every aspect + of a build is controlled by the metadata. + You can use metadata to augment these base image types by + adding metadata layers that extend functionality. + These layers can provide, for example, an additional software + stack for an image type, add a board support package (BSP) for + additional hardware, or even create a new image type. + + + + Metadata is loosely grouped into configuration files or package + recipes. + A recipe is a collection of non-executable metadata used by + BitBake to set variables or define additional build-time tasks. + A recipe contains fields such as the recipe description, the recipe + version, the license of the package and the upstream source + repository. + A recipe might also indicate that the build process uses autotools, + make, distutils or any other build process, in which case the basic + functionality can be defined by the classes it inherits from + the OE-Core layer's class definitions in + ./meta/classes. + Within a recipe you can also define additional tasks as well as + task prerequisites. + Recipe syntax through BitBake also supports both + _prepend and _append + operators as a method of extending task functionality. + These operators inject code into the beginning or end of a task. + For information on these BitBake operators, see the + "Appending and Prepending (Override Style Syntax)" + section in the BitBake User's Manual. +
diff --git a/documentation/mega-manual/figures/poky-reference-distribution.png b/documentation/mega-manual/figures/poky-reference-distribution.png new file mode 100644 index 0000000000..7133d43f53 Binary files /dev/null and b/documentation/mega-manual/figures/poky-reference-distribution.png differ