summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2021-06-16 17:11:48 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-06-21 11:09:56 +0100
commit773f5bbde73e9447beab83d36b743c97b71adfff (patch)
treeaa85e1b676c013dbb1bcce3459013e5e301bc4fd
parentcdbbdb28a46293fcdb939bbf14f58fab0ccb94ea (diff)
downloadpoky-773f5bbde73e9447beab83d36b743c97b71adfff.tar.gz
README.poky: Formatting and content cleanup
The README is rather out of date, update the content with the new content properly in markdown format. (From meta-yocto rev: d72000219ad03bb8e08c1cc84f6dbf44931155bf) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--meta-poky/README.poky.md93
1 files changed, 53 insertions, 40 deletions
diff --git a/meta-poky/README.poky.md b/meta-poky/README.poky.md
index 2ba3b5c03e..289373f944 100644
--- a/meta-poky/README.poky.md
+++ b/meta-poky/README.poky.md
@@ -1,71 +1,84 @@
1Poky 1Poky
2==== 2====
3 3
4Poky is an integration of various components to form a complete prepackaged 4Poky is an integration of various components to form a pre-packaged
5build system and development environment. It features support for building 5build system and development environment which is used as a development and
6customised embedded device style images. There are reference demo images 6validation tool by the [Yocto Project](http://www.yoctoproject.org/). It
7featuring a X11/Matchbox/GTK themed UI called Sato. The system supports 7features support for building customised embedded style device images
8cross-architecture application development using QEMU emulation and a 8and custom containers. There are reference demo images ranging from X11/GTK+
9standalone toolchain and SDK with IDE integration. 9 to Weston, commandline and more. The system supports cross-architecture
10application development using QEMU emulation and a standalone toolchain and
11SDK suitable for IDE integration.
10 12
11Additional information on the specifics of hardware that Poky supports 13Additional information on the specifics of hardware that Poky supports
12is available in README.hardware. Further hardware support can easily be added 14is available in README.hardware. Further hardware support can easily be added
13in the form of layers which extend the systems capabilities in a modular way. 15in the form of BSP layers which extend the systems capabilities in a modular way.
16Many layers are available and can be found through the
17[layer index](https://layers.openembedded.org/).
14 18
15As an integration layer Poky consists of several upstream projects such as 19As an integration layer Poky consists of several upstream projects such as
16BitBake, OpenEmbedded-Core, Yocto documentation and various sources of information 20[BitBake](https://git.openembedded.org/bitbake/),
17e.g. for the hardware support. Poky is in turn a component of the Yocto Project. 21[OpenEmbedded-Core](https://git.openembedded.org/openembedded-core/),
22[Yocto documentation](http://git.yoctoproject.org/cgit.cgi/yocto-docs/),
23the '[meta-yocto](http://git.yoctoproject.org/cgit.cgi/meta-yocto/)' layer
24which has configuration and hardware support components. These components
25are all part of the Yocto Project and OpenEmbedded ecosystems.
18 26
19The Yocto Project has extensive documentation about the system including a 27The Yocto Project has extensive documentation about the system including a
20reference manual which can be found at: 28reference manual which can be found at <https://docs.yoctoproject.org/>
21 http://yoctoproject.org/documentation
22
23OpenEmbedded-Core is a layer containing the core metadata for current versions
24of OpenEmbedded. It is distro-less (can build a functional image with
25DISTRO = "nodistro") and contains only emulated machine support.
26
27For information about OpenEmbedded, see the OpenEmbedded website:
28 http://www.openembedded.org/
29 29
30OpenEmbedded is the build architecture used by Poky and the Yocto project.
31For information about OpenEmbedded, see the
32[OpenEmbedded website](http://www.openembedded.org/).
30 33
31Contribution Guidelines 34Contribution Guidelines
32======================= 35-----------------------
36
37The project works using a mailing list patch submission process. Patches
38should be sent to the mailing list for the repository the components
39originate from (see below). Throughout the Yocto Project, the README
40files in the component in question should detail where to send patches,
41who the maintainers are and where bugs should be reported.
33 42
34A guide to submitting patches to OpenEmbedded is available at: 43A guide to submitting patches to OpenEmbedded is available at:
35 44
36http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded 45<http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded>
37 46
38There is good documentation on how to write/format patches at: 47There is good documentation on how to write/format patches at:
39 48
40https://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines 49<https://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines>
41
42 50
43Where to Send Patches 51Where to Send Patches
44===================== 52---------------------
45 53
46As Poky is an integration repository (built using a tool called combo-layer), 54As Poky is an integration repository (built using a tool called combo-layer),
47patches against the various components should be sent to their respective 55patches against the various components should be sent to their respective
48upstreams: 56upstreams:
49 57
50bitbake: 58OpenEmbedded-Core (files in meta/, meta-selftest/, meta-skeleton/, scripts/):
51 Git repository: http://git.openembedded.org/bitbake/ 59
52 Mailing list: bitbake-devel@lists.openembedded.org 60- Git repository: <https://git.openembedded.org/openembedded-core/>
61- Mailing list: openembedded-core@lists.openembedded.org
62
63BitBake (files in bitbake/):
64
65- Git repository: <https://git.openembedded.org/bitbake/>
66- Mailing list: bitbake-devel@lists.openembedded.org
67
68Documentation (files in documentation/):
69
70- Git repository: <https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/>
71- Mailing list: docs@lists.yoctoproject.org
53 72
54documentation: 73meta-yocto (files in meta-poky/, meta-yocto-bsp/):
55 Git repository: http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/
56 Mailing list: docs@lists.yoctoproject.org
57 74
58meta-poky, meta-yocto-bsp: 75- Git repository: <http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto>
59 Git repository: http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto(-bsp) 76- Mailing list: poky@lists.yoctoproject.org
60 Mailing list: poky@lists.yoctoproject.org
61 77
62Everything else should be sent to the OpenEmbedded Core mailing list. If in 78If in doubt, check the openembedded-core git repository for the content you
63doubt, check the oe-core git repository for the content you intend to modify. 79intend to modify as most files are from there unless clearly one of the above
64Before sending, be sure the patches apply cleanly to the current oe-core git 80categories. Before sending, be sure the patches apply cleanly to the current
65repository. 81git repository branch in question.
66 82
67 Git repository: http://git.openembedded.org/openembedded-core/ 83[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/765/badge)](https://bestpractices.coreinfrastructure.org/projects/765)
68 Mailing list: openembedded-core@lists.openembedded.org
69 84
70Note: The scripts directory should be treated with extra care as it is a mix of
71oe-core and poky-specific files from meta-poky.