xref: /OK3568_Linux_fs/yocto/meta-poky/README.poky.md (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunPoky
2*4882a593Smuzhiyun====
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunPoky is an integration of various components to form a pre-packaged
5*4882a593Smuzhiyunbuild system and development environment which is used as a development and
6*4882a593Smuzhiyunvalidation tool by the [Yocto Project](https://www.yoctoproject.org/). It
7*4882a593Smuzhiyunfeatures support for building customised embedded style device images
8*4882a593Smuzhiyunand custom containers. There are reference demo images ranging from X11/GTK+
9*4882a593Smuzhiyun to Weston, commandline and more. The system supports cross-architecture
10*4882a593Smuzhiyunapplication development using QEMU emulation and a standalone toolchain and
11*4882a593SmuzhiyunSDK suitable for IDE integration.
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunAdditional information on the specifics of hardware that Poky supports
14*4882a593Smuzhiyunis available in README.hardware. Further hardware support can easily be added
15*4882a593Smuzhiyunin the form of BSP layers which extend the systems capabilities in a modular way.
16*4882a593SmuzhiyunMany layers are available and can be found through the
17*4882a593Smuzhiyun[layer index](https://layers.openembedded.org/).
18*4882a593Smuzhiyun
19*4882a593SmuzhiyunAs an integration layer Poky consists of several upstream projects such as
20*4882a593Smuzhiyun[BitBake](https://git.openembedded.org/bitbake/),
21*4882a593Smuzhiyun[OpenEmbedded-Core](https://git.openembedded.org/openembedded-core/),
22*4882a593Smuzhiyun[Yocto documentation](https://git.yoctoproject.org/cgit.cgi/yocto-docs/),
23*4882a593Smuzhiyunthe '[meta-yocto](https://git.yoctoproject.org/cgit.cgi/meta-yocto/)' layer
24*4882a593Smuzhiyunwhich has configuration and hardware support components. These components
25*4882a593Smuzhiyunare all part of the Yocto Project and OpenEmbedded ecosystems.
26*4882a593Smuzhiyun
27*4882a593SmuzhiyunThe Yocto Project has extensive documentation about the system including a
28*4882a593Smuzhiyunreference manual which can be found at <https://docs.yoctoproject.org/>
29*4882a593Smuzhiyun
30*4882a593SmuzhiyunOpenEmbedded is the build architecture used by Poky and the Yocto project.
31*4882a593SmuzhiyunFor information about OpenEmbedded, see the
32*4882a593Smuzhiyun[OpenEmbedded website](https://www.openembedded.org/).
33*4882a593Smuzhiyun
34*4882a593SmuzhiyunContribution Guidelines
35*4882a593Smuzhiyun-----------------------
36*4882a593Smuzhiyun
37*4882a593SmuzhiyunThe project works using a mailing list patch submission process. Patches
38*4882a593Smuzhiyunshould be sent to the mailing list for the repository the components
39*4882a593Smuzhiyunoriginate from (see below). Throughout the Yocto Project, the README
40*4882a593Smuzhiyunfiles in the component in question should detail where to send patches,
41*4882a593Smuzhiyunwho the maintainers are and where bugs should be reported.
42*4882a593Smuzhiyun
43*4882a593SmuzhiyunA guide to submitting patches to OpenEmbedded is available at:
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun<https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded>
46*4882a593Smuzhiyun
47*4882a593SmuzhiyunThere is good documentation on how to write/format patches at:
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun<https://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines>
50*4882a593Smuzhiyun
51*4882a593SmuzhiyunWhere to Send Patches
52*4882a593Smuzhiyun---------------------
53*4882a593Smuzhiyun
54*4882a593SmuzhiyunAs Poky is an integration repository (built using a tool called combo-layer),
55*4882a593Smuzhiyunpatches against the various components should be sent to their respective
56*4882a593Smuzhiyunupstreams:
57*4882a593Smuzhiyun
58*4882a593SmuzhiyunOpenEmbedded-Core (files in meta/, meta-selftest/, meta-skeleton/, scripts/):
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun- Git repository: <https://git.openembedded.org/openembedded-core/>
61*4882a593Smuzhiyun- Mailing list: openembedded-core@lists.openembedded.org
62*4882a593Smuzhiyun
63*4882a593SmuzhiyunBitBake (files in bitbake/):
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun- Git repository: <https://git.openembedded.org/bitbake/>
66*4882a593Smuzhiyun- Mailing list: bitbake-devel@lists.openembedded.org
67*4882a593Smuzhiyun
68*4882a593SmuzhiyunDocumentation (files in documentation/):
69*4882a593Smuzhiyun
70*4882a593Smuzhiyun- Git repository: <https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/>
71*4882a593Smuzhiyun- Mailing list: docs@lists.yoctoproject.org
72*4882a593Smuzhiyun
73*4882a593Smuzhiyunmeta-yocto (files in meta-poky/, meta-yocto-bsp/):
74*4882a593Smuzhiyun
75*4882a593Smuzhiyun- Git repository: <https://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto>
76*4882a593Smuzhiyun- Mailing list: poky@lists.yoctoproject.org
77*4882a593Smuzhiyun
78*4882a593SmuzhiyunIf in doubt, check the openembedded-core git repository for the content you
79*4882a593Smuzhiyunintend to modify as most files are from there unless clearly one of the above
80*4882a593Smuzhiyuncategories. Before sending, be sure the patches apply cleanly to the current
81*4882a593Smuzhiyungit repository branch in question.
82*4882a593Smuzhiyun
83*4882a593Smuzhiyun[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/765/badge)](https://bestpractices.coreinfrastructure.org/projects/765)
84*4882a593Smuzhiyun
85