openbmc/docs/hw-vendor-repos-policy.md

13 OpenBMC Github project is made. It starts with the requirements and then some
19 OpenBMC architecture (bitbake, d-bus, phosphor-dbus-interfaces, ...).
22 guidelines to be used by the OpenBMC TOF in their decision to approve or not
26 following requirements to be eligible for a repository under OpenBMC:
34 5. It is a feature that is believed to be generally useful to the OpenBMC
38 6. It has an active OpenBMC community member that is willing to be a maintainer
41 under OpenBMC (vs. a recipe in OpenBMC that points to an external repository).
43 A repository must be hosted under OpenBMC if:
45 1. The repository depends on other OpenBMC-hosted repositories
47 If someone wishes to create a recipe within OpenBMC to point to an external
50 1. If the repository is utilized by other projects outside of OpenBMC then it
51    may be better suited outside of OpenBMC and utilized via a bitbake recipe
53 If a recipe is created within OpenBMC (in any meta-X layer) to point to an
58    within OpenBMC
63 Note that when a recipe is non-OpenBMC specific, but useful to OpenBMC, it
75 To add a hardware specific repository to OpenBMC, it should meet the following
81 Some hardware vendor features which have no real synergy with OpenBMC, for
83 may be better suited to be hosted externally to OpenBMC.
94 To add a vendor-specific repository to OpenBMC, it should meet the following
97 1. It consumes OpenBMC D-Bus APIs
98    - This indicates a synergy between this feature and OpenBMC
102 As OpenBMC has grown, so has the need for software function that is tied to
104 first users of OpenBMC and a search for "openpower" in the openbmc github
108 OpenBMC in general is to be agnostic of the hardware it is managing, but that is
114 is why OpenBMC has a openpower-occ-control repository.
118 why OpenBMC has a peci-pcie repository.
121 for hosting a hardware/vendor specific repository within the openbmc github
124 1. Where does the OpenBMC community draw the line between what goes into the
125    OpenBMC organization and what should not?
127 2. If a repository doesn't belong in the OpenBMC organization, what determines
128    if a bitbake recipe can be added to OpenBMC to point to a vendors repository
129    outside of the OpenBMC org?
135 OpenBMC wants to enable as many machines as possible with as many common paths
139 Within OpenBMC there are two areas of "vendor specific" repositories:
147 We need a policy within OpenBMC on how we handle each of these types of
150 The OpenBMC project has a fairly extensive CI process, it has many great code
153 repositories that are hosted within OpenBMC. Having the source under the OpenBMC
158 repositories utilized by OpenBMC. It is always going to be easier to coordinate
159 big changes like that on repositories hosted within OpenBMC directly (vs. trying
162 OpenBMC already hosts 100+ repositories, which can be very daunting to someone
172 layers, and vendor specific features should be in distro features. OpenBMC is
179 assessing a request for a vendor specific repository within OpenBMC.
182 [upstream]: https://github.com/openbmc/docs/blob/master/kernel-development.md
183 [tof]: https://github.com/openbmc/technical-oversight-forum/issues