-
Notifications
You must be signed in to change notification settings - Fork 257
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README with enhanced information and communication channels
Enhanced the README file by adding detailed maintenance policies for the `meta-freescale` layer, including information about branch management and release cycles. Additionally, included specifics about the maintained branches such as `master`, `scarthgap`, `nanbield`, and `kirkstone`. This update aims to provide users with a clearer understanding of the project's maintenance practices and available branches. Signed-off-by: Otavio Salvador <[email protected]>
- Loading branch information
Showing
1 changed file
with
35 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,47 @@ | ||
| OpenEmbedded/Yocto BSP layer for Freescale's platforms | ||
| ====================================================== | ||
| # OpenEmbedded/Yocto Project BSP Layer for NXP's Platforms | ||
|
|
||
| This layer provides support for Freescale's platforms for use with | ||
| OpenEmbedded and/or Yocto. | ||
| Welcome to `meta-freescale`. This document outlines our commitment to providing consistent support and updates in alignment with the Yocto Project LTS release schedule. | ||
|
|
||
| This layer provides support for NXP's platforms for use with OpenEmbedded and/or Yocto Project. | ||
|
|
||
| ### Dependencies | ||
|
|
||
| This layer depends on: | ||
|
|
||
| URI: git://git.openembedded.org/openembedded-core | ||
| branch: master | ||
| revision: HEAD | ||
| - URI: git://git.openembedded.org/openembedded-core | ||
| - Branch: master | ||
| - Revision: HEAD | ||
|
|
||
| ## Branches | ||
|
|
||
| - **master:** This is our primary development branch, receiving continuous bug fixes and BSP upgrades. It represents the latest and greatest version, ensuring compatibility with the most recent Yocto Project release. | ||
| - **scarthgap:** Associated with Yocto Project 5.0 (LTS), maintained until April 2028 for bug fixes and until April 2026 for BSP backports. | ||
| - **nanbield:** Corresponding to Yocto Project 4.3, it's maintained until May 2024 for bug fixes and BSP backports. | ||
| - **kirkstone:** Tied to Yocto Project 4.0 (LTS), supported until April 2026 for bug fixes and until April 2024 for BSP backports. | ||
|
|
||
| ## Maintenance Policy | ||
|
|
||
| - **Latest and Greatest (Master):** Continuous attention to bug fixes and BSP upgrades, ensuring that our users have access to the latest enhancements and improvements. | ||
| - **Stable Releases:** Each stable release is maintained until the subsequent version is released. This includes backports for BSP and critical bug fixes, along with updates for security vulnerabilities (CVEs). | ||
| - **Long-Term Support (LTS) Releases:** These are maintained for the duration of Yocto Project's LTS support. We prioritize bug fixes, security vulnerabilities (CVEs) updates, and BSP backports to ensure stability and reliability. | ||
|
|
||
| This policy ensures that our users can rely on consistent support and updates, backed by our commitment to delivering high-quality BSP layers. | ||
|
|
||
| Contributing | ||
| ------------ | ||
| ## Release Cycle | ||
|
|
||
| Please submit any patches against the `meta-freescale` layer by using the | ||
| GitHub pull-request feature. Fork the repo, make a branch, do the | ||
| work, rebase from upstream, create the pull request. | ||
| - **Yocto Project LTS Releases:** Our LTS branches follow the Yocto Project LTS release schedule, which involves a four-year maintenance period. A new LTS version is typically released every two years. | ||
| - **Stable Releases:** We aim to provide stable releases every six months, aligning with the pace of Yocto Project's stable releases. | ||
|
|
||
| For some useful guidelines to be followed when submitting patches, | ||
| please refer to: | ||
| http://openembedded.org/wiki/Commit_Patch_Message_Guidelines | ||
| ## Contributing | ||
|
|
||
| Pull requests will be discussed within the GitHub pull-request | ||
| infrastructure. If you want to get informed on new PRs and the | ||
| follow-up discussions please use the GitHub's notification system. | ||
| Please submit any patches against the `meta-freescale` layer by using the GitHub pull-request feature. Fork the repo, create a branch, do the work, rebase from upstream, and then create the pull request. | ||
|
|
||
| Mailing list: | ||
| For useful guidelines on submitting patches, please refer to the [Commit Patch Message Guidelines](http://openembedded.org/wiki/Commit_Patch_Message_Guidelines). | ||
|
|
||
| https://lists.yoctoproject.org/g/meta-freescale | ||
| Pull requests will be discussed within the GitHub pull-request infrastructure. If you want to stay informed about new PRs and follow-up discussions, please use GitHub's notification system. Additionally, feel free to open GitHub issues for bug reports, feature requests, or general discussions. | ||
|
|
||
| Source code: | ||
| ## Communication | ||
|
|
||
| https://github.com/Freescale/meta-freescale | ||
| - **GitHub Issues:** [meta-freescale issues](https://github.com/Freescale/meta-freescale/issues) | ||
| - **GitHub Discussions:** [meta-freescale discussions](https://github.com/Freescale/meta-freescale/discussions) | ||
| - **Pull Requests:** [meta-freescale pull requests](https://github.com/Freescale/meta-freescale/pulls) |