13d551562SPatrick Williams# phosphor-dbus-interfaces
2388b58f9SPatrick Williams
3*a1347418SPatrick WilliamsYAML descriptors of standard D-Bus interfaces. The format is described by the
4*a1347418SPatrick Williams[sdbusplus binding generation tool sdbus++][].
5f7616bc6SMatt Spinler
6e8821cc8SPatrick WilliamsBefore defining a new D-Bus interface or modifying an existing one, please read
7e8821cc8SPatrick Williamsthrough the documented set of the common [requirements and expectations][].
8e8821cc8SPatrick Williams
90894943fSPatrick Williams## Building
10f7616bc6SMatt Spinler
110894943fSPatrick WilliamsThis project can be built with `meson`. The typical `meson` workflow is:
120894943fSPatrick Williams`meson builddir && ninja -C builddir`.
130894943fSPatrick Williams
14*a1347418SPatrick WilliamsThe meson files used to handle the YAML files are automatically generated and
15*a1347418SPatrick Williamsfound under the `gen` subdirectory. When adding or removing YAML files, this
16*a1347418SPatrick Williamsmust be regenerated. This can be done with the helper script found in the `gen`
17*a1347418SPatrick Williamssubdirectory: `cd gen && ./regenerate-meson`.
180894943fSPatrick Williams
190894943fSPatrick Williams## Configuration
200894943fSPatrick Williams
2154ed0a11SShawn McCarneyOnly the xyz/openbmc_project and org/freedesktop interfaces are built by
2254ed0a11SShawn McCarneydefault. Other interfaces can be enabled by meson options:
230894943fSPatrick Williams
240894943fSPatrick Williams- com/ibm - `-Ddata_com_ibm=true`
250894943fSPatrick Williams- org/open_power - `-Ddata_org_open_power=true`
260894943fSPatrick Williams
27297845b9SVishwanatha SubbannaExample: `meson builddir -Ddata_com_ibm=true && ninja -C builddir`
28388b58f9SPatrick Williams
290894943fSPatrick Williams## References
3083185d5fSSantosh Puranik
31*a1347418SPatrick Williams[sdbusplus binding generation tool sdbus++]:
32*a1347418SPatrick Williams  https://github.com/openbmc/sdbusplus/blob/master/README.md#binding-generation-tool
33e8821cc8SPatrick Williams[requirements and expectations]: requirements.md
34