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