Documentation Decoder: Difference between revisions
From Yocto Project
Jump to navigationJump to search
Henry Bruce (talk | contribs) No edit summary |
(→List of Manual Pages: Update documentation URLs) |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
== URL Decoder == | == URL Decoder == | ||
Many different Yocto Project documentation pages are returned by Google searches and it can be hard to know what's what. | Many different Yocto Project documentation pages are returned by Google searches and it can be hard to know what's what. | ||
You should be sure that an URL returned by a search engine represents the actual version of the manual in which you are interested. | |||
Searches many times return very old versions of a manual. | |||
URLs use the following format: <tt>https://docs.yoctoproject.org/release/name/name</tt>. | |||
With this format, the "release" string specifies the Yocto Project release associated with the manual. | |||
The "name" string represents the manual's folder name. | |||
You can find the list of the current folder strings in the next section. | |||
Here is an example for the "Yocto Project Reference Manual" for release 3.3: <tt>https://docs.yoctoproject.org/3.3/ref-manual/</tt> | |||
You can use the string <tt>current</tt> rather than a specific release number (e.g. 3.3) to go to the latest released version of a manual. | |||
For example, to access the latest Yocto Project Development Tasks Manual, use the <tt>https://docs.yoctoproject.org/current/dev-manual/</tt> URL.<br/> | |||
== List of Manual Pages == | == List of Manual Pages == | ||
Here is a list of documentation page | Here is a list of documentation page names and brief descriptions of their purposes. | ||
:[ | This list represents the latest Yocto Project release: | ||
:[ | :[https://docs.yoctoproject.org/current/brief-yoctoprojectqs/ brief-yoctoprojectqs]. A very brief quick start to get you going. | ||
:[ | :[https://docs.yoctoproject.org/current/overview-manual/ overview-manual]. Presents Yocto Project overview and conceptual information. | ||
:[ | :[https://docs.yoctoproject.org/current/dev-manual/ dev-manual]. A development tasks manual. Provides procedures for common and not-so-common development tasks. | ||
:[ | :[https://docs.yoctoproject.org/current/sdk-manual/ sdk-manual]. Describes how to build and use Yocto Project SDKs for application development. | ||
:[ | :[https://docs.yoctoproject.org/current/bsp-guide/ bsp-guide]. Describes how to use or create a Board Support Package (BSP)layer for your hardware platform. | ||
:[ | :[https://docs.yoctoproject.org/current/kernel-dev/ kernel-dev]. The kernel development manual, which is often used in conjunction with BSP guide. | ||
:[ | :[https://docs.yoctoproject.org/current/profile-manual/ profile-manual] Presents information on profiling and tracing. | ||
:[https://docs.yoctoproject.org/current/toaster-manual/ toaster-manual]. Describes how to use "Toaster". which is a web interface to the Yocto Project's OpenEmbedded build system. | |||
:[https://docs.yoctoproject.org/current/ref-manual/index.html ref-manual]. Gathers together Yocto Project reference material, which consists of variable descriptions, class descriptions, and so forth. | |||
:[https://docs.yoctoproject.org/current/singleindex.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. | |||
Latest revision as of 14:38, 30 July 2021
URL Decoder
Many different Yocto Project documentation pages are returned by Google searches and it can be hard to know what's what. You should be sure that an URL returned by a search engine represents the actual version of the manual in which you are interested. Searches many times return very old versions of a manual.
URLs use the following format: https://docs.yoctoproject.org/release/name/name. With this format, the "release" string specifies the Yocto Project release associated with the manual. The "name" string represents the manual's folder name. You can find the list of the current folder strings in the next section.
Here is an example for the "Yocto Project Reference Manual" for release 3.3: https://docs.yoctoproject.org/3.3/ref-manual/
You can use the string current rather than a specific release number (e.g. 3.3) to go to the latest released version of a manual.
For example, to access the latest Yocto Project Development Tasks Manual, use the https://docs.yoctoproject.org/current/dev-manual/ URL.
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.
