Cookbook: Difference between revisions

From Yocto Project
Jump to navigationJump to search
(Added 'Appliance How-Tos' section / Startup scripts link)
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This page collects working examples on how to use the Yocto Project. Please test all procedures before adding them to this page.
'''[WORK IN PROGRESS]
'''


== Yocto Project Quick Start Guide ==
This Yocto Project Cookbook collects working examples of how to use the Yocto Project, filling some of the gaps between the
[http://www.yoctoproject.org/docs/current/yocto-project-qs/yocto-project-qs.html Yocto Project Quick Start Guide] and the
[http://www.yoctoproject.org/docs/current/mega-manual/mega-manual.html full reference documentation]. Like any
cookbook, we'll include both basic and complex examples you can follow to learn about the pantry of
components and files available, and about the techniques for manipulating them using Yocto Project tools.


The official Quick Start Guide contains a step-by-step walkthrough showing how to set up your environment and perform your first build: [http://www.yoctoproject.org/docs/current/yocto-project-qs/yocto-project-qs.html Quick Start Guide]
We encourage you, the Yocto Project community, to add


== Yocto Project BSP How-Tos ==
* your own examples,
* pointers to training materials,
* tips,
* and any other material that may be helpful to new and experienced users of Yocto Project.


* TomZ's page on how to create and maintain a Yocto Project BSP: [[Yocto_BSP_One-Stop_Shop_(Documentation_Overview,_Getting_Started,_FAQs,_and_more)]]
''Please test all procedures before adding them to this page''; and if you do see a problem or improvement, start a  
[https://wiki.yoctoproject.org/wiki/index.php?title=Talk:Cookbook&action=edit discussion] (use the discussion tab at the top of this page)
, or edit the page itself!


* Examples section of the documentation: [http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#dev-manual-bsp-appendix Yocto Project Developer's Manual: Appendix A, BSP Development Example]
== Cookbook Topics ==


== Appliance How-Tos ==
* [[Cookbook:Example:Adding_packages_to_your_OS_image|Adding packages to your OS image]]
* [[Application Development with Extensible SDK]] (Test Kitchen)
* Understanding the fetch/unpack/configure/build/package pipeline
* Locating and understanding failures
* [[Cookbook:Example:Understanding the <code>tmp/work</code> directory structure]] (and what goes where)
* Intro to [[Writing Recipes|writing recipes]]
* [[Package management]]
* [[Application Development with Legacy SDK]] (Test Kitchen)
* [[Cookbook:Example:Configuring_your_kernel|Configuring your kernel]]
* [[Cookbook:Example:Upgrading_your_kernel|Upgrading your kernel]]
* What else ... ?


* [[Cookbook:Appliance:Startup_Scripts|Startup scripts]] - How to get things to happen / start automatically
== Other Links ==
 
;[http://www.yoctoproject.org/docs/current/yocto-project-qs/yocto-project-qs.html Quick Start Guide]
:The official Yocto Project Quick Start Guide contains a step-by-step walk-through showing how to set up your environment and perform your first build
 
;[http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#extendpoky Developer Manual: Common Tasks]
:The Common Tasks section of the Yocto Project Developer Manual's documentation discusses creating layers, customizing images, writing recipes, configuring and patching the kernel, performing automated runtime testing, and more.
 
;[https://www.yoctoproject.org/sites/default/files/ypdd-2016.04-san_diego.pdf Creating a Custom Embedded Linux Distribution for Any Embedded Device Presentation from ELC 2016 Dev Day]
:A good overview presentation from the Linux Foundation covering many topics for creating a custom embedded Linux distribution with Yocto Project.
 
 
Here are links that were in a previous version of this Cookbook. (Some seem rather outdated that we'll need to comb through, but we wanted to keep them around for now.)
 
;[[Yocto_BSP_One-Stop_Shop_(Documentation_Overview,_Getting_Started,_FAQs,_and_more)|Everything you need to know to create and maintain a Yocto BSP]]
:TomZ's page on how to create and maintain a Yocto Project BSP, including how to interact with the community
 
;[[Cookbook:Appliance:Startup_Scripts|Startup scripts]]
:How to get things to happen or start automatically:

Latest revision as of 22:21, 27 January 2017

[WORK IN PROGRESS]

This Yocto Project Cookbook collects working examples of how to use the Yocto Project, filling some of the gaps between the Yocto Project Quick Start Guide and the full reference documentation. Like any cookbook, we'll include both basic and complex examples you can follow to learn about the pantry of components and files available, and about the techniques for manipulating them using Yocto Project tools.

We encourage you, the Yocto Project community, to add

  • your own examples,
  • pointers to training materials,
  • tips,
  • and any other material that may be helpful to new and experienced users of Yocto Project.

Please test all procedures before adding them to this page; and if you do see a problem or improvement, start a discussion (use the discussion tab at the top of this page) , or edit the page itself!

Cookbook Topics

Other Links

Quick Start Guide
The official Yocto Project Quick Start Guide contains a step-by-step walk-through showing how to set up your environment and perform your first build
Developer Manual: Common Tasks
The Common Tasks section of the Yocto Project Developer Manual's documentation discusses creating layers, customizing images, writing recipes, configuring and patching the kernel, performing automated runtime testing, and more.
Creating a Custom Embedded Linux Distribution for Any Embedded Device Presentation from ELC 2016 Dev Day
A good overview presentation from the Linux Foundation covering many topics for creating a custom embedded Linux distribution with Yocto Project.


Here are links that were in a previous version of this Cookbook. (Some seem rather outdated that we'll need to comb through, but we wanted to keep them around for now.)

Everything you need to know to create and maintain a Yocto BSP
TomZ's page on how to create and maintain a Yocto Project BSP, including how to interact with the community
Startup scripts
How to get things to happen or start automatically: