Documentation Decoder

URL Decoder

Many different Yocto Project documentation pages are returned by Google searches and it can be hard to know what's what.

URLs have the following format: http://www.yoctoproject.org/docs/release/name/name.html.

Here is an example for the "Yocto Project Reference Manual" for release 2.5.1: http://www.yoctoproject.org/docs/2.5.1/ref-manual/ref-manual.html

You can use the string current rather than a specific release number (e.g. 2.5.1) to go to the latest released version of a manual.

List of Manual Pages

Here is a list of documentation page names and brief descriptions of their purposes. This list represents the latest Yocto Project release:

brief-yoctoprojectqs. A very brief quick start to get you going.

overview-manual. Presents Yocto Project overview and conceptual information.

dev-manual. A development tasks manual. Provides procedures for common and not-so-common development tasks.

sdk-manual. Describes how to build and use Yocto Project SDKs for application development.

bsp-guide. Describes how to use or create a Board Support Package (BSP)layer for your hardware platform.

kernel-dev. The kernel development manual, which is often used in conjunction with BSP guide.

profile-manual Presents information on profiling and tracing.

toaster-manual. Describes how to use "Toaster". which is a web interface to the Yocto Project's OpenEmbedded build system.

ref-manual. Gathers together Yocto Project reference material, which consists of variable descriptions, class descriptions, and so forth.

mega-manual. All of the above rolled into one "mega manual". You can use this manual to quickly search for terms and stings throughout the Yocto Project manual set.