diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml index 7314b04d78..e9d639a511 100644 --- a/documentation/poky-ref-manual/introduction.xml +++ b/documentation/poky-ref-manual/introduction.xml @@ -5,166 +5,134 @@ Introduction
- Welcome to Poky! + Introduction - Poky is the build tool in the Yocto Project. - The Yocto Project uses Poky to build images (kernel, system, and application software) for - targeted hardware. - - - - Before diving into Poky, it helps to have an understanding of the Yocto Project. - Especially useful for newcomers is the information in the Yocto Project Quick Start, which - you can find on the Yocto Project website. - Specifically, the guide is - at . - -
- -
- What is Poky? - - - Within the Yocto Project, Poky provides an open source, full-platform build tool based on - Linux, X11, Matchbox, GTK+, Pimlico, Clutter, - and other GNOME Mobile technologies. - It provides a focused and stable subset of OpenEmbedded upon which you can easily and - reliably build and develop. - Poky fully supports a wide range of x86, ARM, MIPS and PowerPC hardware and device virtualization. - - - - Poky is primarily a platform builder that generates filesystem images - based on open source software such as the Kdrive X server, the Matchbox - window manager, the GTK+ toolkit and the D-Bus message bus system. While images - for many kinds of devices can be generated, the standard example - machines target QEMU full-system emulation (x86, ARM, MIPS and PowerPC) and - real reference boards for each of these architectures. - Poky's ability to boot inside a QEMU - emulator makes it particularly suitable as a test platform for developing embedded software. - - - - An important component integrated within Poky is Sato, a GNOME Mobile-based - user interface environment. - It is designed to work well with screens that use very high DPI and have restricted - sizes, such as those often found on smartphones and PDAs. - Because Sato is coded for speed and efficiency, it works smoothly on hand-held and - other embedded hardware. - It sits nicely on top of any device that uses the GNOME Mobile stack and it results in - a well-defined user experience. - - - - - - - - - The Sato Desktop - A screenshot from a machine running a Poky built image - - - - - - Poky has a growing open source community and is also backed up by commercial organizations - including Intel® Corporation. + This manual provides reference information for the current release of the Yocto Project. + The Yocto Project is an open-source collaboration project focused on embedded Linux + developers. + Amongst other things, the Yocto Project uses the Poky build tool to + construct complete Linux images. + You can find complete introductory and getting started information on the Yocto Project + by reading the + + Yocto Project Quick Start. + You can also find lots of information on the Yocto Project on the + Yocto Project website.
Documentation Overview - The sections in this reference manual describe different aspects of Poky. - The 'Using Poky' section provides an overview of the components - that make up Poky followed by information about using Poky and debugging images created in - the Yocto Project. - The 'Extending Poky' and - 'Board Support Packages' sections provide information - about how to extend and customize Poky along with advice on how to manage these changes. - The 'Platform Development with Poky' section provides information about - interaction between Poky and target hardware for common platform development tasks such as software - development, debugging and profiling. - The rest of the manual consists of several reference sections, each providing details on a specific - area of Poky functionality. - - - - This manual applies to Poky Release 5.0 (Bernard). + This reference manual consists of the following: + + + Using the Yocto Project: This chapter + provides an overview of the components that make up the Yocto Project + followed by information about debugging images created in the Yocto Project. + + + Extending the Yocto Project: This chapter + provides information about how to extend and customize the Yocto Project + along with advice on how to manage these changes. + + Board Support Packages (BSP) - Developer's Guide: + This chapter describes the example filesystem layout for BSP development and + the click-through licensing scheme. + + Platform Development With the Yocto Project: + This chapter describes application development, debugging, and profiling using + the Yocto Project. + + Reference: Directory Structure: + This appendix describes the directory structure of the Yocto Project files. + The Yocto Project files represent the file structure or Git repository created + as a result of setting up the Yocto Project on your host development system. + + + Reference: BitBake: + This appendix provides an overview of the BitBake tool and its role within + the Yocto Project. + + Reference: Classes: + This appendix describes the classes used in the Yocto Project. + + Reference: Images: + This appendix describes the standard images that the Yocto Project supports. + + + Reference: Features: + This appendix describes mechanisms for creating distribution, machine, and image + features during the build process using the Yocto Project. + + Reference: Variables Glossary: + This appendix presents most Yocto Project variables. + Entries describe the function of the variable and how to apply them. + + + Reference: Variable Locality + (Distro, Machine, Recipe, etc.): + This appendix provides variable locality or context. + + Reference: FAQ: + This appendix provides answers for commonly asked questions in the Yocto Project + development environment. + + Reference: Contributing to the Yocto Project: + This appendix provides guidance on how you can contribute back to the Yocto + Project. +
- System Requirements +System Requirements - Although we recommend Debian-based distributions - (Ubuntu 10.04 or newer) as the host system for Poky, nothing in Poky is - distribution-specific. Consequently, other distributions should work as long - as the appropriate prerequisites are installed. For example, we know of Poky being used - successfully on Redhat, SUSE, Gentoo and Slackware host systems. - For information on what you need to develop images using Yocto Project and Poky, - you should see the Yocto Project Quick Start on the - Yocto Project website. - The direct link to the quick start is - . + For system Yocto Project system requirements, see the + + What You Need and How You Get It section in the + + Yocto Project Quick Start.
- Obtaining Poky - -
- Releases - - Periodically, we make releases of Poky available - at . - These releases are more stable and more rigorously tested than the nightly development images. - -
- -
- Nightly Builds - - - We make nightly builds of Poky for testing purposes and to make the - latest developments available. The output from these builds is available - at . - The numbers used in the builds increase for each subsequent build and can be used to - reference a specific build. - - - - Automated builds are available for "standard" Poky and for Poky SDKs and toolchains. - Additionally, testing versions such as poky-bleeding can be made available as - 'experimental' builds. - The toolchains can - be used either as external standalone toolchains or can be combined with Poky as a - pre-built toolchain to reduce build time. Using the external toolchains is simply a - case of untarring the tarball into the root of your system (it only creates files in - /opt/poky) and then enabling the option - in local.conf. - -
- -
- Development Checkouts - - - Poky is available from our git repository located at - git://git.yoctoproject.org/poky.git; a web interface to the repository - can be accessed at . - - - - The 'master' is where the development work takes place and you should use this if you're - interested in working with the latest cutting-edge developments. It is possible for the trunk - to suffer temporary periods of instability while new features are developed. - If these periods of instability are undesirable, we recommend using one of the release branches. - -
+ Obtaining the Yocto Project + + The Yocto Project development team makes the Yocto Project available through a number + of methods: + + Releases: Stable, tested releases are available through + . + Nightly Builds: These releases are available at + . + These builds include Yocto Project releases, meta-toolchain tarballs, and + experimental builds. + Yocto Project Website: You can find releases + of the Yocto Project and supported BSPs at the + Yocto Project website. + Along with these downloads, you can find lots of other information at this site. + + +
+ +
+ Development Checkouts + + Development using the Yocto Project requires a local copy of the Yocto Project files. + You can get these files by downloading a Yocto Project release tarball and unpacking it, + or by establishing a Git repository of the files. + For information on both these methods, see + + Getting Setup section in + + The Yocto Project Development Manual. + +
+