Documentation Decoder: Difference between revisions
From Yocto Project
Jump to navigationJump to search
| Line 6: | Line 6: | ||
== List of Manual Pages == | == List of Manual Pages == | ||
Here is a list of documentation page names and brief descriptions of their purposes: | Here is a list of documentation page names and brief descriptions of their purposes. | ||
:[http://www.yoctoproject.org/docs/current/ | This list represents the latest Yocto Project release: | ||
:[http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html dev-manual]. | :[http://www.yoctoproject.org/docs/current/brief-yoctoprojectqs/brief-yoctoprojectqs.html brief-yoctoprojectqs]. A very brief quick start to get you going. | ||
:[http://www.yoctoproject.org/docs/current/sdk-manual/sdk-manual.html sdk-manual]. Describes how to use Yocto | :[http://www.yoctoproject.org/docs/current/overview-manual/overview-manual.html overview-manual]. Presents Yocto Project overview and conceptual information. | ||
:[http://www.yoctoproject.org/docs/current/bsp-guide/bsp-guide.html bsp-guide]. Describes how to use or create a | :[http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html dev-manual]. A development tasks manual. Provides procedures for common and not-so-common development tasks. | ||
:[http://www.yoctoproject.org/docs/current/kernel-dev/kernel-dev.html kernel-dev]. | :[http://www.yoctoproject.org/docs/current/sdk-manual/sdk-manual.html sdk-manual]. Describes how to build and use Yocto Project SDKs for application development. | ||
:[http://www.yoctoproject.org/docs/current/toaster-manual/toaster-manual.html toaster-manual]. Toaster is a web interface to the Yocto Project's OpenEmbedded build system. | :[http://www.yoctoproject.org/docs/current/bsp-guide/bsp-guide.html bsp-guide]. Describes how to use or create a Board Support Package (BSP)layer for your hardware platform. | ||
:[http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html ref-manual]. | :[http://www.yoctoproject.org/docs/current/kernel-dev/kernel-dev.html kernel-dev]. The kernel development manual, which is often used in conjunction with BSP guide. | ||
:[http://www.yoctoproject.org/docs/current/mega-manual/mega-manual.html mega-manual]. All of the above rolled into one mega manual. | :[http://www.yoctoproject.org/docs/current/profile-manual/profile-manual.html profile-manual] Presents information on profiling and tracing. | ||
:[http://www.yoctoproject.org/docs/current/toaster-manual/toaster-manual.html toaster-manual]. Describes how to use "Toaster". which is a web interface to the Yocto Project's OpenEmbedded build system. | |||
:[http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html ref-manual]. Gathers together Yocto Project reference material, which consists of variable descriptions, class descriptions, and so forth. | |||
:[http://www.yoctoproject.org/docs/current/mega-manual/mega-manual.html 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. | |||
Revision as of 16:03, 30 October 2018
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.1.1: http://www.yoctoproject.org/docs/2.1.1/ref-manual/ref-manual.html
Note that current can be used in place of the current release number.
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.
