OpenBMC meta layer guidelines
While most of these could be called "rules", in specific scenarios might be actively against the intended goals. This is why each guideline has a very large "Why" section, to ensure that the intent is being met, and that if exceptions to the rules exist, then can be understood and managed by the project. In general, if there's a question, and the community agrees, these guidelines can be overridden on a case by case basis.
- Meta layers should not patch projects that exist within the openBMC tree.
Why? In general, keeping the codebase building in the long term is difficult. Opening the possibility that patches exist that repo maintainers aren't aware of makes it much more likely that a single machine breaks, or we have behavior differences between two repos. Also, in general, the maintainer is there to ensure that the greater community, features, and codebase are prioritized over any one patch, and generally does so in code review. If patches are checked into meta layers, generally the maintainer is not a reviewer, thereby defeating most of the purpose of the role of the maintainer.
What should I do instead? Discuss with the project maintainers and the community about whether or not the feature you're building needs to be configurable, or if it can be applied to all projects. If it can be applied to all, simply check it into the master branch through a gerrit review, and follow the processes outlined for the repository. If it needs to be per-project or per-machine configurable, check it in under a compile time option, at the suggestion of the maintainer, and add a PACKAGECONFIG entry that can be set to enable it.
- Meta layers should not patch Yocto recipes and projects.
Why? Yocto itself is an open source project that accepts contributions. The more changes that OpenBMC stacks against Yocto recipes, the more unmaintainable it becomes, and the longer it takes to rebase to new Yocto versions. In general, the Yocto community is as responsive (sometimes much faster) than the OpenBMC community in regards to pull requests.
What should I do instead? Submit any changes needed to the Yocto upstream repositories, using their process. If the Yocto process has gone several weeks without responses, cherry-pick the commit into the OpenBMC tree, with a pointer to the review in the commit message.
- Meta layers should avoid EXTRA_OEMAKE, EXTRA_OEMESON, arguments in meta layers and bbappends
Why? There are some OpenBMC projects that are utilized outside of OpenBMC. As such, there are configuration items that are not intended to be used in OpenBMC, or configuration items that would pose a security risk. Also, as options change and are deprecated, the project needs a single place to update the available config items and dependencies. In addition, subprojects might change their build tooling, for example from autotools to meson, in pursuit of other goals. Having tool-specific configurations makes that change far more difficult to do.
What should I do instead? In the root recipe, add a PACKAGECONFIG entry for the feature in question, then use that to enable said feature in your meta layer.
- Meta layers should not have recipes that point to proprietary licensed code.
Why? OpenBMC is an open source project, and is intended to be built from source, with appropriate distribution licenses such that it can be reused. Pointing to commercially licensed repositories actively opposes that goal.
What should I do instead? Find an equivalent open source project that meets the needs, or request that the project owner relicenses their project.
- Meta layers recipes should only point to well maintained open source projects
Why? Without this guideline, a loophole is present that allows OpenBMC developers to bypass code review by pointing the upstream recipe to a public repository that they control, but which OpenBMC has no input on the content of. This splits the discussion forums in unproductive ways, and prevents all the other good processes within OpenBMC like bug tracking and continuous integration from having an effect.
What should I do instead? The advice tends to be on a case by case basis, but if the code is only intended for use on OpenBMC, then push a design doc, and push the code to openbmc gerrit under the openbmc/openbmc repository where it can be reviewed, along with an OWNERS file, signaling your willingness to maintain this project. Then, once the community has looked through your design, a repo will be created for code to be pushed to. If you're pulling in code from a dead project, inquire to the community through the mailing list or discord whether or not the OpenBMC community would be willing to adopt support and maintenance of said project.
- Don't use SRCREV={autorev} in a recipe.
Why? Repository branches can change at any time. Pointing to an autorev revision increases the likelihood that builds break, and makes builds far less reproducible. In addition, having an accounting of exactly what is in your build prevents errors when a repo is quietly updated while working, and suddenly changes significantly.
What should I do instead? Point SRCREV to a specific commit of the repository, and increase the revision either via the autobump script in CI, which can be requested on the mailing list, or manually as new revisions exist.