Documentation Decoder: Difference between revisions
From Yocto Project
Jump to navigationJump to search
Henry Bruce (talk | contribs) (Created page with "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: <tt>http://www.yoctopr...") |
Henry Bruce (talk | contribs) No edit summary |
||
| Line 3: | Line 3: | ||
Here is a list of documentation page name and a brief description of their purpose | Here is a list of documentation page name and a brief description of their purpose | ||
:[http://www.yoctoproject.org/docs/current/yocto-project-qs/yocto-project-qs.html yocto-project-qs]. Quick start guide to get you going. | :[http://www.yoctoproject.org/docs/current/yocto-project-qs/yocto-project-qs.html yocto-project-qs]. Quick start guide to get you going. | ||
:[http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html dev-manual]. Conceptual and procedural information that covers common development tasks | :[http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html dev-manual]. Conceptual and procedural information that covers common development tasks. | ||
:[http://www.yoctoproject.org/docs/current/sdk-manual/sdk-manual.html sdk-manual]. Describes how to use Yocto built SDKs for application development. | |||
:[http://www.yoctoproject.org/docs/current/bsp-guide/bsp-guide.html bsp-guide]. Describes how to use or create a board support package layer for your hardware platform. | |||
:[http://www.yoctoproject.org/docs/current/kernel-dev/kernel-dev.html kernel-dev]. Kernel development manual. Often used in conjunction with BSP guide. | |||
:[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/ref-manual/ref-manual.html ref-manual]. Material suited for reference rather than procedures. Come here for the details. | |||
Revision as of 20:13, 25 August 2016
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 quick start guide for release 2.1: http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html
Note that current can be used in place of the current release number. There is also a latest tag which refers to documentation in progress and is best avoided.
Here is a list of documentation page name and a brief description of their purpose
- yocto-project-qs. Quick start guide to get you going.
- dev-manual. Conceptual and procedural information that covers common development tasks.
- sdk-manual. Describes how to use Yocto built SDKs for application development.
- bsp-guide. Describes how to use or create a board support package layer for your hardware platform.
- kernel-dev. Kernel development manual. Often used in conjunction with BSP guide.
- toaster-manual. Toaster is a web interface to the Yocto Project's OpenEmbedded build system.
- ref-manual. Material suited for reference rather than procedures. Come here for the details.
